---
title: Charmhub | Deploy Opensearch Dashboards using Charmhub - The Open Operator
  Collection
description: Deploy the latest version of Opensearch Dashboards on any cloud.
url: https://charmhub.io/opensearch-dashboards/docs/h-monitoring
---

# Opensearch Dashboards

[Canonical](https://charmhub.io/publisher/data-platform "View all packages from Canonical")

* [Canonical](https://charmhub.io/publisher/data-platform "View all packages from Canonical")

Platform:

24.04

22.04

2/stable 66

```
juju deploy opensearch-dashboards --channel 2/stable
```

[Learn to deploy on juju >](https://juju.is/docs/juju/manage-applications)

---

#### Contacts

##### Maintainers

+ [Canonical Data Platform Team](mailto:data-platform@lists.launchpad.net)

* [Submit a bug](https://github.com/canonical/opensearch-dashboards-operator/issues)

---

Share your thoughts on this charm with the community on discourse.

[Join the discussion](https://discourse.charmhub.io/)

# Monitoring (COS)

The Canonical Observability Stack (COS) is a set of tools that facilitates gathering, processing, visualizing, and setting up alerts on telemetry signals generated by workloads in and outside of Juju.

The OpenSearch Dashboards charm can use COS to connect to Grafana and Prometheus to use monitoring, alert rules, and log features.

> See: [How to enable monitoring](https://charmhub.io/opensearch-dashboards/docs/h-monitoring-enable) via COS and Grafana

## [Summary](https://charmhub.io/opensearch-dashboards/docs/h-monitoring#p-36094-summary)

* [Metrics](https://charmhub.io/opensearch-dashboards/docs/h-monitoring#metrics-3)
* [Alert rules](https://charmhub.io/opensearch-dashboards/docs/h-monitoring#alert-rules-4)
* [Logs](https://charmhub.io/opensearch-dashboards/docs/h-monitoring#logs-6)

## [Metrics](https://charmhub.io/opensearch-dashboards/docs/h-monitoring#p-36094-metrics)

The Prometheus exporter is automatically installed by the OpenSearch Dashboards snap using: [The Prometheus Exporter for OpenSearch Dashboards](https://github.com/canonical/prometheus-opensearch-dashboards-exporter)

The meaning of the metrics collected can be found in the [README](https://github.com/canonical/prometheus-opensearch-dashboards-exporter?tab=readme-ov-file#metrics) 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](https://github.com/canonical/opensearch-dashboards-operator/blob/2/edge/src/alert_rules/prometheus/prometheus_alerts.yaml) file

### [Default alert rules](https://charmhub.io/opensearch-dashboards/docs/h-monitoring#p-36094-default-alert-rules)

| Alert | Severity | Notes |
| --- | --- | --- |
| OpenSearchDashboardsScrapeFailed |  | Triggered when the prometheus scrape fails. |
| OpenSearchDashboardsRed |  | 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 |  | Triggered when OpenSearch Dashboards is yellow. Dashboard plugins might be degraded or shards may be relocating or initializing |
|
| OpenSearchDashboardsPluginRed |  | Triggered when OpenSearch Dashboards plugin or core component are in red state |
| OpenSearchDashboardsPluginYellow |  | Triggered when OpenSearch Dashboards plugin or core component are in yellow state |
| OpenSearchDashboardsNoMetrics |  | Triggered when exporter failed to collect status metrics. |
| OpenSearchDashboardsLongResponseTime |  | Triggered when the server is up and responsive, however with a high latency. |

## [Logs](https://charmhub.io/opensearch-dashboards/docs/h-monitoring#p-36094-logs)

All the logs from the OpenSearch Dashboards payload are available in the Grafana web interface at `Home > Explore`

To get OpenSearch Dashboards logs, go to the `Label filters` field and set to `juju_application = opensearch-dashboards`, select one operation, e.g. `Line contains` and run the query.

> See also: [How to connect to the Grafana web interface](https://charmhub.io/opensearch-dashboards/docs/h-monitoring-enable#connect-to-the-grafana-web-interface)

---