Larissa Wandzura
91a72f2572
* created new configure folder, rewrote intro page * updated configure doc * updated query editor * updates to template variables * added troubleshooting doc, fixed heading issues * fix linter issues * added alerting doc * corrected title * final edits * fixed linter issue * added deprecation comment per feedback * ran prettier
4.4 KiB
aliases, description, keywords, labels, menuTitle, title, weight, refs
| aliases | description | keywords | labels | menuTitle | title | weight | refs | |||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
Guide for using Elasticsearch in Grafana |
|
|
Elasticsearch | Elasticsearch data source | 325 |
|
Elasticsearch data source
Elasticsearch is a search and analytics engine used for a variety of use cases. You can create many types of queries to visualize logs or metrics stored in Elasticsearch, and annotate graphs with log events stored in Elasticsearch.
The following resources will help you get started with Elasticsearch and Grafana:
- What is Elasticsearch?
- Configure the Elasticsearch data source
- Elasticsearch query editor
- Elasticsearch template variables
- Elasticsearch annotations
- Elasticsearch alerting
- Troubleshooting issues with the Elasticsearch data source
Key capabilities
The Elasticsearch data source supports:
- Metrics queries: Aggregate and visualize numeric data using bucket and metric aggregations.
- Log queries: Search, filter, and explore log data with Lucene query syntax.
- Annotations: Overlay Elasticsearch events on your dashboard graphs.
- Alerting: Create alerts based on Elasticsearch query results.
Before you begin
Before you configure the Elasticsearch data source, you need:
- An Elasticsearch instance (v7.17+, v8.x, or v9.x)
- Network access from Grafana to your Elasticsearch server
- Appropriate user credentials or API keys with read access
{{< admonition type="note" >}} If you use Amazon OpenSearch Service (the successor to Amazon Elasticsearch Service), use the OpenSearch data source instead. {{< /admonition >}}
Supported Elasticsearch versions
{{< admonition type="warning" >}} The Elasticsearch data source plugin currently does not support Elastic Cloud Serverless, or any other serverless variant of Elasticsearch. {{< /admonition >}}
This data source supports these versions of Elasticsearch:
- ≥ v7.17
- v8.x
- v9.x
The Grafana maintenance policy for the Elasticsearch data source aligns with Elastic Product End of Life Dates. Grafana ensures proper functionality for supported versions only. If you use an EOL version of Elasticsearch, you can still run queries, but the query builder displays a warning. Grafana doesn't guarantee functionality or provide fixes for EOL versions.
Additional resources
Once you have configured the Elasticsearch data source, you can:
- Use Explore to run ad-hoc queries against your Elasticsearch data.
- Configure and use template variables for dynamic dashboards.
- Add Transformations to process query results.
- Build dashboards to visualize your Elasticsearch data.
Related data sources
- OpenSearch - For Amazon OpenSearch Service.
- Loki - Grafana's log aggregation system.