Monitoring reference: metrics and alert rules

This reference describes the metrics exposed by the OpenSearch Dashboards Prometheus exporter and lists the default alert rules shipped with the charm.

Metrics

The Prometheus exporter is automatically installed by the OpenSearch Dashboards snap using: The Prometheus Exporter for OpenSearch Dashboards.

The meaning of the metrics collected can be found in the README of the exporter.

To ensure you are referencing the latest default alert rules, check the source file of alert definitions in the repository’s prometheus_alerts.yaml file.

Default alert rules

Alert

Severity

Notes

OpenSearchDashboardsScrapeFailed

critical

Triggered when the prometheus scrape fails.

OpenSearchDashboardsRed

critical

OpenSearch Dashboards status can turn red for the following reasons:

  • Incompatibility between OpenSearch Dashboards and OpenSearch Service

  • Insufficient memory

  • OpenSearch is in red state

OpenSearchDashboardsYellow

warning

Triggered when OpenSearch Dashboards is yellow. Dashboard plugins might be degraded or shards may be relocating or initializing.

OpenSearchDashboardsPluginRed

critical

Triggered when OpenSearch Dashboards plugin or core component are in red state.

OpenSearchDashboardsPluginYellow

warning

Triggered when OpenSearch Dashboards plugin or core component are in yellow state.

OpenSearchDashboardsNoMetrics

warning

Triggered when exporter failed to collect status metrics.

OpenSearchDashboardsLongResponseTime

high

Triggered when the server is up and responsive, however with a high latency.