Skip to content

Commit 079166c

Browse files
committed
Otel config reference
1 parent 7736adb commit 079166c

File tree

5 files changed

+39
-3
lines changed

5 files changed

+39
-3
lines changed

docs/how-to-guides/observability/auto-instrumentation.md

+4
Original file line numberDiff line numberDiff line change
@@ -57,3 +57,7 @@ spec:
5757
enabled: true
5858
runtime: sdk
5959
```
60+
61+
## Resources
62+
63+
[:bulb: OpenTelemetry Auto-Instrumentation Configuration Reference](../../reference/observability/auto-config.md)

docs/how-to-guides/observability/tracing/context-propagation.md

+4
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,7 @@
1+
---
2+
description: Learn how to propagate trace context across process boundaries in a few common scenarios.
3+
tags: [guide, tracing]
4+
---
15
# Trace context propagation
26

37
Each Span carries a Context that includes metadata about the trace (like a unique trace identifier and span identifier) and any other data you choose to include. This context is propagated across process boundaries, allowing all the work that's part of a single trace to be linked together, even if it spans multiple services.
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
# OpenTelemetry Auto-Instrumentation Configuration
2+
3+
When you enable [auto-instrumentation](../../how-to-guides/observability/auto-instrumentation.md) in your application the following OpenTelemetry configuration will become available to your application as environment variables:
4+
5+
| Variable | Example Value |
6+
| ------------------------------------ | --------------------------------------------------------------------------------------------- |
7+
| `OTEL_SERVICE_NAME` | `my-application` |
8+
| `OTEL_EXPORTER_OTLP_ENDPOINT` | `http://opentelemetry-collector.nais-system:4317` |
9+
| `OTEL_EXPORTER_OTLP_PROTOCOL` | `grpc` |
10+
| `OTEL_EXPORTER_OTLP_INSECURE` | `true` |
11+
| `OTEL_PROPAGATORS` | `tracecontext,baggage` |
12+
| `OTEL_TRACES_SAMPLER` | `parentbased_always_on` |
13+
| `OTEL_RESOURCE_ATTRIBUTES_POD_NAME` | `my-application-777787df6d-pw9mq` |
14+
| `OTEL_RESOURCE_ATTRIBUTES_NODE_NAME` | `gke-node-abc123` |
15+
| `OTEL_RESOURCE_ATTRIBUTES` | `service.name=my-application,service.namespace=my-team,k8s.container.name=my-application,...` |
16+
17+
!!! tip
18+
Do not hardcode these values in your application. OpenTelemetry SDKs and auto-instrumentation libraries will automatically pick up these environment variables and use them to configure the SDK.
19+
20+
## More OpenTelemetry Configuration
21+
22+
A full list of environment variables that can be used to configure the OpenTelemetry SDK can be found here:
23+
24+
* [:simple-opentelemetry: General SDK Configuration](https://opentelemetry.io/docs/specs/otel/configuration/sdk-environment-variables/#general-sdk-configuration)
25+
* [:simple-opentelemetry: OTLP Exporter Configuration](https://opentelemetry.io/docs/languages/sdk-configuration/otlp-exporter/)
26+
27+
[OTLP is the OpenTelemetry Protocol](https://opentelemetry.io/docs/specs/otel/protocol/exporter/), and is the protocol used to send telemetry data to Prometheus, Grafana Tempo, and Grafana Loki.

docs/reference/observability/tracing/traceql.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@ Similar to PromQL, TraceQL supports a set of operators for comparing span attrib
4343

4444
Since a trace can be composed of multiple spans, multiple selectors can be used together to filter spans based on different attributes.
4545

46-
TraceQL supports two types of combining spansets: logical (`&&` and `||`) and structural relations (`>`, `>>`, `<<` `<`, and `~`).
46+
TraceQL supports two types of combining spansets: logical (`&&` and `||`) and structural relations (`>`, `>\>`, `<\<` `<`, and `~`).
4747

4848
##### Logical
4949

@@ -60,8 +60,8 @@ The above query will return traces where a span with the service name `server` a
6060
Structural relations are used to filter spans based on their structural relationships. The structural relations are:
6161

6262
- `>` - Direct parent of
63-
- `>>` - Ancestor of
64-
- `<<` - Descendant of
63+
- `>\>` - Ancestor of
64+
- `<\<` - Descendant of
6565
- `<` - Direct child of
6666
- `~` - Sibling of
6767

mkdocs.yml

+1
Original file line numberDiff line numberDiff line change
@@ -93,6 +93,7 @@ plugins:
9393
'addons/wonderwall.md': 'security/auth/wonderwall.md'
9494
'device/update.md': 'how-to-guides/naisdevice/update.md'
9595
'how-to-guides/observability/tracing/otel-tracing.md': 'how-to-guides/observability/auto-instrumentation.md'
96+
'reference/observability/otel/tracing.md': 'reference/observability/auto-config.md'
9697
markdown_extensions:
9798
- toc:
9899
permalink: True

0 commit comments

Comments
 (0)