Regenerate integrations docs (#21899)
Co-authored-by: vkalintiris <25480816+vkalintiris@users.noreply.github.com>
Netdata bot committed
Mar 6, 2026 at 08:08 UTC
fed0d409582a58db30b516a042819fe9845f34f6
1 file changed
+49
-2
src/crates/netdata-otel/otel-plugin/integrations/opentelemetry.md
+49
-2
@@ -103,6 +103,12 @@ to the Netdata agent's gRPC endpoint.
103
#### Options
104
105
The plugin is configured via `otel.yaml` in the Netdata configuration directory.
106
+Only the fields you want to change need to be specified.
107
+
108
+Any option can also be overridden via environment variables with the `NETDATA_OTEL_`
109
+prefix (highest priority). The variable name is the config option in all caps with
110
+dots replaced by underscores — e.g. `endpoint.tls_cert_path` becomes
111
+`NETDATA_OTEL_ENDPOINT_TLS_CERT_PATH`.
112
113
114
<details open><summary>Config options</summary>
@@ -115,11 +121,11 @@ The plugin is configured via `otel.yaml` in the Netdata configuration directory.
121
| endpoint.tls_cert_path | Path to TLS certificate file. Enables TLS when provided. | | no |
122
| endpoint.tls_key_path | Path to TLS private key file. Required when TLS certificate is provided. | | no |
123
| endpoint.tls_ca_cert_path | Path to TLS CA certificate file for client authentication. | | no |
118
-| metrics.chart_configs_dir | Directory containing YAML files that define how OTLP metrics are mapped to Netdata charts. Each file can match metrics by instrumentation scope and name, set the dimension attribute key, and override timing parameters. The plugin ships stock mappings; user files in this directory take priority. | /etc/netdata/otel.d/v1/metrics/ | no |
124
+| [metrics.chart_configs_dir](#option-metrics-chart-configs-dir) | Directory containing metric mapping YAML files. | /etc/netdata/otel.d/v1/metrics/ | no |
125
| metrics.interval_secs | Collection interval in seconds (1–3600). Defines the Netdata chart update frequency. | 10 | no |
126
| metrics.grace_period_secs | Grace period in seconds. After the last data point, the plugin waits this long before gap-filling. | 60 | no |
127
| metrics.expiry_duration_secs | Expiry duration in seconds. Charts with no data for this long are removed. | 900 | no |
122
-| metrics.max_new_charts_per_request | Maximum number of new charts that can be created per gRPC request. Limits cardinality explosion from high-cardinality label combinations. | 100 | no |
128
+| [metrics.max_new_charts_per_request](#option-metrics-max-new-charts-per-request) | Maximum new charts created per gRPC request. | 100 | no |
129
| logs.journal_dir | Directory to store journal files for ingested logs. | | yes |
130
| logs.size_of_journal_file | Maximum file size before rotating to a new journal file. | 100MB | no |
131
| logs.entries_of_journal_file | Maximum log entries per journal file. | 50000 | no |
@@ -127,6 +133,28 @@ The plugin is configured via `otel.yaml` in the Netdata configuration directory.
133
| logs.number_of_journal_files | Maximum number of journal files to keep. | 10 | no |
134
| logs.size_of_journal_files | Maximum total size of all journal files. | 1GB | no |
135
| logs.duration_of_journal_files | Maximum age of journal files. | 7 days | no |
136
+| [logs.store_otlp_json](#option-logs-store-otlp-json) | Store the complete OTLP JSON in each log entry. | no | no |
137
+
138
+<a id="option-metrics-chart-configs-dir"></a>
139
+##### metrics.chart_configs_dir
140
+
141
+Each file defines how OTLP metrics are mapped to Netdata charts.
142
+Files can match metrics by instrumentation scope and name, set the
143
+dimension attribute key, and override timing parameters. The plugin
144
+ships stock mappings; user files in this directory take priority.
145
+
146
+
147
+<a id="option-metrics-max-new-charts-per-request"></a>
148
+##### metrics.max_new_charts_per_request
149
+
150
+Limits cardinality explosion from high-cardinality label combinations.
151
+
152
+
153
+<a id="option-logs-store-otlp-json"></a>
154
+##### logs.store_otlp_json
155
+
156
+Useful for debugging and reprocessing, but increases storage usage.
157
+
158
159
160
</details>
@@ -165,6 +193,25 @@ logs:
193
journal_dir: /var/log/netdata/otel-journals
194
195
```
196
+###### Partial user override
197
+
198
+Override only specific fields in the user config. All other settings
199
+are inherited from the stock config. Unknown fields are ignored for
200
+forward compatibility.
201
+
202
+
203
+<details open><summary>Config</summary>
204
+
205
+```yaml
206
+endpoint:
207
+ path: "0.0.0.0:4317"
208
+logs:
209
+ number_of_journal_files: 20
210
+ duration_of_journal_files: "14 days"
211
+
212
+```
213
+</details>
214
+
215
###### Metric mapping file
216
217
Place YAML files like this in `/etc/netdata/otel.d/v1/metrics/` to control how