Skip to content

Commit 12d024f

Browse files
committed
Update config file docs to add information about Temporality
1 parent 677da55 commit 12d024f

File tree

1 file changed

+27
-10
lines changed

1 file changed

+27
-10
lines changed

docs/source/config-file.mdx

Lines changed: 27 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -244,20 +244,37 @@ transport:
244244

245245
#### Metrics
246246

247-
| Option | Type | Default | Description |
248-
| :-------------------- | :--------------- | :-------------------------- | :--------------------------------------------- |
249-
| `otlp` | `OTLP Exporter` | `null` (Exporting disabled) | Configuration for exporting metrics via OTLP. |
250-
| `omitted_attributes` | `List<String>` | | List of attributes to be omitted from metrics. |
247+
| Option | Type | Default | Description |
248+
| :-------------------- | :---------------------- | :-------------------------- | :--------------------------------------------- |
249+
| `otlp` | `OTLP Metric Exporter` | `null` (Exporting disabled) | Configuration for exporting metrics via OTLP. |
250+
| `omitted_attributes` | `List<String>` | | List of attributes to be omitted from metrics. |
251+
252+
253+
#### OTLP Metrics Exporter
254+
255+
| Option | Type | Default | Description |
256+
| :--------- | :------------ | :-------------------------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
257+
| `endpoint` | `URL` | `http://localhost:4137` | URL to export data to. Requires full path. |
258+
| `protocol` | `string` | `grpc` | Protocol for export. Only `grpc` and `http/protobuf` are supported. |
259+
| `temporality` | `Temporality` | `Cumulative` | OTel property that refers to the way additive quantities are expressed, in relation to time, indicating whether reported values incorporate previous measurements or not. |
260+
261+
##### Temporality
262+
263+
| Option | Type | Description |
264+
| :----------- | :------ | :------------------------------------------------------------------------------------------------ |
265+
| `Cumulative` | `enum` | The metric value will be the overall value since the start of the measurement. (default behavior) |
266+
| `Delta` | `enum` | The metric will be the difference in the measurement since the last time it was reported. |
267+
251268

252269
#### Traces
253270

254-
| Option | Type | Default | Description |
255-
| :-------------------- | :--------------- | :-------------------------- | :--------------------------------------------- |
256-
| `otlp` | `OTLP Exporter` | `null` (Exporting disabled) | Configuration for exporting traces via OTLP. |
257-
| `sampler` | `SamplerOption` | `ALWAYS_ON` | Configuration to control sampling of traces. |
258-
| `omitted_attributes` | `List<String>` | | List of attributes to be omitted from traces. |
271+
| Option | Type | Default | Description |
272+
| :-------------------- | :--------------------- | :-------------------------- | :--------------------------------------------- |
273+
| `otlp` | `OTLP Trace Exporter` | `null` (Exporting disabled) | Configuration for exporting traces via OTLP. |
274+
| `sampler` | `SamplerOption` | `ALWAYS_ON` | Configuration to control sampling of traces. |
275+
| `omitted_attributes` | `List<String>` | | List of attributes to be omitted from traces. |
259276

260-
#### OTLP Exporter
277+
#### OTLP Trace Exporter
261278

262279
| Option | Type | Default | Description |
263280
| :--------- | :-------- | :-------------------------- | :--------------------------------------------------------------- |

0 commit comments

Comments
 (0)