From 46b73548b3a3aabb895044dd7be5e2634264cdc1 Mon Sep 17 00:00:00 2001 From: Gareth Dawson Date: Wed, 19 Apr 2023 14:13:53 +0100 Subject: [PATCH] Elasticsearch: Deprecate the usage of the database field in provisioning (#66828) * update docs and gdev provisioning * update docs --- devenv/datasources.yaml | 6 +++--- devenv/datasources_docker.yaml | 6 +++--- docs/sources/datasources/elasticsearch/_index.md | 8 ++++++-- 3 files changed, 12 insertions(+), 8 deletions(-) diff --git a/devenv/datasources.yaml b/devenv/datasources.yaml index 9f2fad5e059..be050bbe382 100644 --- a/devenv/datasources.yaml +++ b/devenv/datasources.yaml @@ -126,9 +126,9 @@ datasources: type: elasticsearch uid: gdev-elasticsearch access: proxy - database: "[logs-]YYYY.MM.DD" url: http://localhost:9200 jsonData: + index: "[logs-]YYYY.MM.DD" interval: Daily timeField: "@timestamp" logLevelField: level @@ -137,9 +137,9 @@ datasources: - name: gdev-elasticsearch-filebeat type: elasticsearch access: proxy - database: "[filebeat-]YYYY.MM.DD" url: http://localhost:9200 jsonData: + index: "[filebeat-]YYYY.MM.DD" interval: Daily timeField: "@timestamp" timeInterval: "10s" @@ -149,9 +149,9 @@ datasources: - name: gdev-elasticsearch-metricbeat type: elasticsearch access: proxy - database: "[metricbeat-]YYYY.MM.DD" url: http://localhost:9200 jsonData: + index: "[metricbeat-]YYYY.MM.DD" interval: Daily timeField: "@timestamp" timeInterval: "10s" diff --git a/devenv/datasources_docker.yaml b/devenv/datasources_docker.yaml index 53c710e1054..61c0b3c7ecd 100644 --- a/devenv/datasources_docker.yaml +++ b/devenv/datasources_docker.yaml @@ -71,18 +71,18 @@ datasources: - name: gdev-elasticsearch type: elasticsearch access: proxy - database: "[logs-]YYYY.MM.DD" url: http://elasticsearch:9200 jsonData: + index: "[logs-]YYYY.MM.DD" interval: Daily timeField: "@timestamp" - name: gdev-elasticsearch-filebeat type: elasticsearch access: proxy - database: "[filebeat-]YYYY.MM.DD" url: http://elasticsearch:9200 jsonData: + index: "[filebeat-]YYYY.MM.DD" interval: Daily timeField: "@timestamp" timeInterval: "10s" @@ -92,9 +92,9 @@ datasources: - name: gdev-elasticsearch-metricbeat type: elasticsearch access: proxy - database: "[metricbeat-]YYYY.MM.DD" url: http://elasticsearch:9200 jsonData: + index: "[metricbeat-]YYYY.MM.DD" interval: Daily timeField: "@timestamp" timeInterval: "10s" diff --git a/docs/sources/datasources/elasticsearch/_index.md b/docs/sources/datasources/elasticsearch/_index.md index 37218e297e0..f4ea2a05b62 100644 --- a/docs/sources/datasources/elasticsearch/_index.md +++ b/docs/sources/datasources/elasticsearch/_index.md @@ -140,6 +140,10 @@ For more information about AWS authentication options, refer to [AWS authenticat You can define and configure the data source in YAML files as part of Grafana's provisioning system. For more information about provisioning, and for available configuration options, refer to [Provisioning Grafana]({{< relref "../../administration/provisioning/#data-sources" >}}). +> **Note:** The previously used `database` field has now been [deprecated](https://github.com/grafana/grafana/pull/58647). +> You should now use the `index` field in `jsonData` to store the index name. +> Please see the examples below. + #### Provisioning examples **Basic provisioning:** @@ -151,9 +155,9 @@ datasources: - name: Elastic type: elasticsearch access: proxy - database: '[metrics-]YYYY.MM.DD' url: http://localhost:9200 jsonData: + index: '[metrics-]YYYY.MM.DD' interval: Daily timeField: '@timestamp' ``` @@ -167,9 +171,9 @@ datasources: - name: elasticsearch-v7-filebeat type: elasticsearch access: proxy - database: '[filebeat-]YYYY.MM.DD' url: http://localhost:9200 jsonData: + index: '[filebeat-]YYYY.MM.DD' interval: Daily timeField: '@timestamp' logMessageField: message