Skip to content

Commit 0a08fcc

Browse files
authored
Merge pull request #10513 from martialblog/docs/elastic-perfdata
docs: Mention field mapping issue with ElasticsearchWriter
2 parents 1a94c2c + 5605316 commit 0a08fcc

File tree

2 files changed

+12
-6
lines changed

2 files changed

+12
-6
lines changed

doc/09-object-types.md

Lines changed: 10 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1229,6 +1229,11 @@ Configuration Attributes:
12291229
Note: If `flush_threshold` is set too low, this will force the feature to flush all data to Elasticsearch too often.
12301230
Experiment with the setting, if you are processing more than 1024 metrics per second or similar.
12311231

1232+
> **Note**
1233+
>
1234+
> Be aware that `enable_send_perfdata` will create a new field mapping in the index for each performance data metric in a check plugin.
1235+
> Elasticsearch/OpenSearch have a maximum number of fields in an index. The default value is usually 1000 fields. See [mapping settings limit](https://www.elastic.co/guide/en/elasticsearch/reference/8.18/mapping-settings-limit.html)
1236+
12321237
Basic auth is supported with the `username` and `password` attributes. This requires an
12331238
HTTP proxy (Nginx, etc.) in front of the Elasticsearch instance. Check [this blogpost](https://blog.netways.de/2017/09/14/secure-elasticsearch-and-kibana-with-an-nginx-http-proxy/)
12341239
for an example.
@@ -1680,11 +1685,11 @@ Configuration Attributes:
16801685
flush\_threshold | Number | **Optional.** How many data points to buffer before forcing a transfer to InfluxDB. Defaults to `1024`.
16811686
enable\_ha | Boolean | **Optional.** Enable the high availability functionality. Only valid in a [cluster setup](06-distributed-monitoring.md#distributed-monitoring-high-availability-features). Defaults to `false`.
16821687

1683-
Note: If `flush_threshold` is set too low, this will always force the feature to flush all data
1684-
to InfluxDB. Experiment with the setting, if you are processing more than 1024 metrics per second
1685-
or similar.
1686-
1687-
1688+
> **Note**
1689+
>
1690+
> If `flush_threshold` is set too low, this will always force the feature to flush all data
1691+
> to InfluxDB. Experiment with the setting, if you are processing more than 1024 metrics per second
1692+
> or similar.
16881693
16891694
### Influxdb2Writer <a id="objecttype-influxdb2writer"></a>
16901695

doc/14-features.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -364,7 +364,8 @@ The following event types are written to Elasticsearch:
364364
* icinga2.event.notification
365365

366366
Performance data metrics must be explicitly enabled with the `enable_send_perfdata`
367-
attribute.
367+
attribute. Be aware that this will create a new field mapping in the index for each performance data metric in a check plugin.
368+
See: [ElasticsearchWriter](09-object-types.md#objecttype-elasticsearchwriter)
368369

369370
Metric values are stored like this:
370371

0 commit comments

Comments
 (0)