Gatus Health Check and Monitoring Charm

Learn about configurations >

• announcements | string

  List of announcements to send. YAML structured with an announcements top-level key, same as the standard Gatus configuration file. See https://github.com/TwiN/gatus?tab=readme-ov-file#announcements.

• app-port | int

  Default: 8080

  Default port where the application will listen on.

• app-secret-key | string

  Long secret you can use for sessions, csrf or any other thing where you need a random secret shared by all units

• app-secret-key-id | secret

  This configuration is similar to app-secret-key, but instead accepts a Juju user secret ID. The secret should contain a single key, "value", which maps to the actual application secret key. To create the secret, run the following command: juju add-secret my-app-secret-key value=<secret-string> && juju grant-secret my-app-secret-key my-app, and use the output secret ID to configure this option.

• endpoints | string

  List of endpoints to monitor. YAML structured with an endpoints top-level key, same as the standard Gatus configuration file. See https://github.com/TwiN/gatus?tab=readme-ov-file#endpoints.

• log-level | string

  Default: info

  Configures the log level of Gatus.

  Acceptable values are: "info", "debug", "warn", "error" and "fatal"

• mattermost-alerting | string

  Juju Secret ID including secrets used for Mattermost alerting.

  The secret may contain the following keys:

  • default: The default webhook URL for Mattermost alerts. Required for any Mattermost alerting.
  • <channel-name>: Optional additional per-channel webhook URLs, e.g. team-name or alerts-channel. These can be referenced in the endpoints config using the [webhook-url:<channel-name>] placeholder syntax to specify per-endpoint webhook overrides.

• mattermost-insecure | boolean

  Whether to use an insecure connection to Mattermost.

• metrics-path | string

  Default: /metrics

  Path where the prometheus metrics will be scraped.

• metrics-port | int

  Default: 8080

  Port where the prometheus metrics will be scraped.

• oidc-allowed-subjects | string

  Optional comma-separated list of subject identifiers (e.g. email addresses) that are allowed to access the Gatus dashboard after authenticating via the oauth relation. If empty, all authenticated users are allowed.

• oidc-redirect-path | string

  Default: /authorization-code/callback

  The callback path that Gatus listens on for the OAuth/OIDC redirect. This must match the path registered with your identity provider. Gatus uses /authorization-code/callback by default. Generally, you should not need to change this.

• oidc-scopes | string

  Default: openid

  Space-separated list of OIDC scopes to request from the identity provider. The openid scope is mandatory and must always be included. Generally, you should not need to change this.

• ui-dark-mode | boolean

  Default: True

  Whether to enable dark mode by default. Note that this is superseded by the user's operating system theme preferences.

• ui-dashboard-heading | string

  Default: Health Dashboard

  Dashboard title between header and endpoints.

• ui-dashboard-subheading | string

  Default: Monitor the health of your endpoints in real-time

  Dashboard description between header and endpoints.

• ui-default-filter-by | string

  Default: none

  Default filter option for endpoints in the dashboard. Can be "none", "failing", or "unstable". Note that user preferences override this.

• ui-default-sort-by | string

  Default: name

  Default sorting option for endpoints in the dashboard. Can be "name", "group", or "health". Note that user preferences override this.

• ui-header | string

  Default: Gatus

  The header text to display in the Gatus UI.

• ui-logo | string

  The logo to display in the Gatus UI. Defaults to the Gatus logo.