Skip to content

Commit d21167f

Browse files
mariomacmariomac
committed
Update documentation about deprecated metric features
1 parent b30640b commit d21167f

File tree

2 files changed

+48
-53
lines changed

2 files changed

+48
-53
lines changed

‎content/en/docs/zero-code/obi/configure/export-data.md‎

Lines changed: 43 additions & 48 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,49 @@ weight: 10
99

1010
OBI can export OpenTelemetry metrics and traces to a OTLP endpoint.
1111

12+
## Common metrics configuration
13+
14+
YAML section: `metrics`.
15+
16+
The `metrics` section contains the common configuration for the OpenTelemetry
17+
metrics and traces exporters.
18+
19+
It currently supports selecting the different sets of metrics to export.
20+
21+
Example:
22+
23+
```yaml
24+
metrics:
25+
features: ['network', 'network_inter_zone']
26+
```
27+
28+
| YAML<br>environment variable | Description | Type | Default |
29+
|------------------------------------------------------------------------------------------| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | --------------- | --------------------------- |
30+
| `features`<br>`OTEL_EBPF_METRICS_FEATURES` | The list of metric groups OBI exports data for, refer to [metrics export features](#metrics-export-features). Accepted values `application`, `application_span`, `application_host`, `application_service_graph`, `network` and `network_inter_zone`. | list of strings | `["application"]` |
31+
32+
### Metrics export features
33+
34+
The OBI metrics exporter can export the following metrics data groups for
35+
processes matching entries in the [metrics discovery](./) configuration.
36+
37+
- `application`: Application-level metrics
38+
- `application_host`: Application-level host metrics for host-based pricing.
39+
- `application_span`: Application-level trace span metrics in legacy format
40+
(like `traces_spanmetrics_latency`, `spanmetrics` is not separate).
41+
- `application_span_otel`: Application-level trace span metrics in OpenTelemetry
42+
format (like `traces_span_metrics_calls_total`), `span_metrics` is separate.
43+
- `application_span_sizes`: Application-level trace span metrics reporting information
44+
about request and response sizes.
45+
- `application_service_graph`: Application-level service graph metrics. It's
46+
recommended to use a DNS for service discovery and to ensure the DNS names
47+
match the OpenTelemetry service names OBI uses. In Kubernetes environments,
48+
the OpenTelemetry service name set by the service name discovery is the best
49+
choice for service graph metrics.
50+
- `network`: Network-level metrics, refer to the
51+
[network metrics](../../network) configuration documentation to learn more
52+
- `network_inter_zone`: Network inter-zone metrics, refer to the
53+
[network metrics](../../network/) configuration documentation to learn more
54+
1255
## OpenTelemetry metrics exporter component
1356

1457
YAML section: `otel_metrics_export`
@@ -31,7 +74,6 @@ otel_metrics_export:
3174
ttl: 5m
3275
endpoint: http://otelcol:4318
3376
protocol: grpc
34-
features: ['network', 'network_inter_zone']
3577
buckets:
3678
duration_histogram: [0, 1, 2]
3779
histogram_aggregation: base2_exponential_bucket_histogram
@@ -45,7 +87,6 @@ otel_metrics_export:
4587
| `OTEL_EXPORTER_OTLP_PROTOCOL` | Similar to the shared endpoint, the protocol for metrics and traces. | string | Inferred from port usage |
4688
| `insecure_skip_verify`<br>`OTEL_EBPF_INSECURE_SKIP_VERIFY` | If `true`, OBI skips verifying and accepts any server certificate. Only override this setting for non-production environments. | boolean | `false` |
4789
| `interval`<br>`OTEL_EBPF_METRICS_INTERVAL` | The duration between exports. | Duration | `60s` |
48-
| `features`<br>`OTEL_EBPF_METRICS_FEATURES` | The list of metric groups OBI exports data for, refer to [metrics export features](#metrics-export-features). Accepted values `application`, `application_span`, `application_host`, `application_service_graph`, `application_process`, `network` and `network_inter_zone`. | list of strings | `["application"]` |
4990
| `allow_service_graph_self_references`<br>`OTEL_EBPF_ALLOW_SERVICE_GRAPH_SELF_REFERENCES` | Controls if OBI includes self-referencing services in service graph generation, for example a service that calls itself. Self referencing reduces service graph usefulness and increases data cardinality. | boolean | `false` |
5091
| `instrumentations`<br>`OTEL_EBPF_METRICS_INSTRUMENTATIONS` | The list of metrics instrumentation OBI collects data for, refer to [metrics instrumentation](#metrics-instrumentation) section. | list of strings | `["*"]` |
5192
| `buckets` | Sets how you can override bucket boundaries of diverse histograms, refer to [override histogram buckets](../metrics-histograms/). | (n/a) | Object |
@@ -59,26 +100,6 @@ If you don't set a protocol OBI sets the protocol as follows:
59100
- `http/protobuf`: if the port ends in `4318`, for example `4318`, `14318`, or
60101
`24318`.
61102

62-
### Metrics export features
63-
64-
The OBI metrics exporter can export the following metrics data groups for
65-
processes matching entries in the [metrics discovery](./) configuration.
66-
67-
- `application`: Application-level metrics
68-
- `application_span` Application-level trace span metrics
69-
- `application_host` Application-level host metrics for host based pricing
70-
- `application_service_graph`: Application-level service graph metrics. It's
71-
recommended to use a DNS for service discovery and to ensure the DNS names
72-
match the OpenTelemetry service names OBI uses. In Kubernetes environments,
73-
the OpenTelemetry service name set by the service name discovery is the best
74-
choice for service graph metrics.
75-
- `application_process`: Metrics about the processes that runs the instrumented
76-
application
77-
- `network`: Network-level metrics, refer to the
78-
[network metrics](../../network) configuration documentation to learn more
79-
- `network_inter_zone`: Network inter-zone metrics, refer to the
80-
[network metrics](../../network/) configuration documentation to learn more
81-
82103
### Metrics instrumentation
83104

84105
The list of instrumentation areas OBI can collection data from:
@@ -160,12 +181,6 @@ prometheus_export:
160181
buckets:
161182
request_size_histogram: [0, 10, 20, 22]
162183
response_size_histogram: [0, 10, 20, 22]
163-
features:
164-
- application
165-
- network
166-
- application_process
167-
- application_span
168-
- application_service_graph
169184
instrumentations: ["http, "sql"]
170185
```
171186

@@ -176,7 +191,6 @@ prometheus_export:
176191
| `extra_resource_attributes`<br>`OTEL_EBPF_PROMETHEUS_EXTRA_RESOURCE_ATTRIBUTES` | A list of additional resource attributes to be added to the reported `target_info` metric. Refer to [extra resource attributes](#prometheus-extra-resource-attributes) for important details about runtime discovered attributes. | list of strings | |
177192
| `ttl`<br>`OTEL_EBPF_PROMETHEUS_TTL` | The duration after which metric instances are not reported if they haven't been updated. Used to avoid reporting indefinitely finished application instances. | Duration | `5m` |
178193
| `buckets` | Sets how you can override bucket boundaries of diverse histograms, refer to [override histogram buckets](../metrics-histograms/). | Object | |
179-
| `features`<br>`OTEL_EBPF_PROMETHEUS_FEATURES` | The list of metric groups OBI exports data for, refer to [Prometheus export features](#prometheus-export-features). | list of strings | `["application"]` |
180194
| `allow_service_graph_self_references`<br>`OTEL_EBPF_PROMETHEUS_ALLOW_SERVICE_GRAPH_SELF_REFERENCES` | Does OBI include self-referencing service in service graph generation. Self referencing isn't useful for service graphs and increases data cardinality. | boolean | `false` |
181195
| `instrumentations`<br>`OTEL_EBPF_PROMETHEUS_INSTRUMENTATIONS` | The list of instrumentation OBI collects data for, refer to [Prometheus instrumentation](#prometheus-instrumentation) section. | list of strings | `["*"]` |
182196

@@ -198,25 +212,6 @@ they are exported via Prometheus.
198212
To make `deployment_environment` visible in Prometheus, you need to add it to
199213
the `extra_resource_attributes` list.
200214

201-
### Prometheus export features
202-
203-
The Prometheus metrics exporter can export the following metrics data groups:
204-
205-
- `application`: Application-level metrics
206-
- `application_span`: Application-level trace span metrics
207-
- `application_host` Application-level host metrics for host based pricing
208-
- `application_service_graph`: Application-level service graph metrics. It's
209-
recommended to use a DNS for service discovery and to ensure the DNS names
210-
match the OpenTelemetry service names OBI uses. In Kubernetes environments,
211-
the OpenTelemetry service name set by the service name discovery is the best
212-
choice for service graph metrics.
213-
- `application_process`: Metrics about the processes that runs the instrumented
214-
application
215-
- `network`: Network-level metrics, refer to the
216-
[network metrics](../../network/) configuration documentation to learn more
217-
- `network_inter_zone`: Network inter-zone metrics, refer to the
218-
[network metrics](../../network/) configuration documentation to learn more
219-
220215
### Prometheus instrumentation
221216

222217
The list of instrumentation areas OBI can collection data from:

‎content/en/docs/zero-code/obi/network/inter-az.md‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -53,14 +53,14 @@ Using a separate metric for inter-zone traffic reduces the metric cardinality
5353
impact of collecting this data, because the `src.zone` and `dst.zone` attributes
5454
are not added to the regular network metrics.
5555

56-
To enable the `obi.network.inter.zone` metric, add the `network_inter_zone`
57-
option to the
58-
[OTEL_EBPF_METRICS_FEATURES or OTEL_EBPF_PROMETHEUS_FEATURES](../../configure/export-data/)
59-
configuration option, or its equivalent YAML options. For example, if OBI is
56+
To enable the `obi.network.inter.zone` metric, add the
57+
`network_inter_zone` option to the
58+
[OTEL_EBPF_METRICS_FEATURES](../../configure/export-data/)
59+
configuration option, or its equivalent YAML option. For example, if OBI is
6060
configured to export metrics via OpenTelemetry:
6161

6262
```yaml
63-
otel_metrics_export:
63+
metrics:
6464
features:
6565
- network
6666
- network_inter_zone

0 commit comments

Comments
 (0)