Skip to content

Commit d77482e

Browse files
authored
README: move configuration content to docs/configure.md (#251)
* README: move configuration content to docs/configure.md So we don't duplicate information. * Update docs/configure.md
1 parent 58d5ba6 commit d77482e

File tree

2 files changed

+8
-20
lines changed

2 files changed

+8
-20
lines changed

README.md

Lines changed: 1 addition & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -73,24 +73,7 @@ opentelemetry-instrument gunicorn main:app
7373

7474
The distribution supports all the configuration variables from OpenTelemetry Python project version 1.30.0.
7575

76-
### Default configuration variables
77-
78-
This distribution sets the following defaults:
79-
80-
- `OTEL_TRACES_EXPORTER`: `otlp`
81-
- `OTEL_METRICS_EXPORTER`: `otlp`
82-
- `OTEL_LOGS_EXPORTER`: `otlp`
83-
- `OTEL_EXPORTER_OTLP_PROTOCOL`: `grpc`
84-
- `OTEL_EXPERIMENTAL_RESOURCE_DETECTORS`: `process_runtime,os,otel,telemetry_distro,_gcp,aws_ec2,aws_ecs,aws_elastic_beanstalk,azure_app_service,azure_vm`
85-
- `OTEL_METRICS_EXEMPLAR_FILTER`: `always_off`
86-
- `OTEL_EXPORTER_OTLP_METRICS_TEMPORALITY_PREFERENCE`: `DELTA`
87-
88-
> [!NOTE]
89-
> `OTEL_EXPERIMENTAL_RESOURCE_DETECTORS` cloud resource detectors are dynamically set. When running in a Kubernetes Pod it will be set to `process_runtime,os,otel,telemetry_distro,_gcp,aws_eks`.
90-
91-
### Distribution specific configuration variables
92-
93-
- `ELASTIC_OTEL_SYSTEM_METRICS_ENABLED` (default: `false`): when sets to `true` sends *system namespace* metrics.
76+
See [Configuration](./docs/configure.md) for more details.
9477

9578
## License
9679

docs/configure.md

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -48,8 +48,13 @@ EDOT Python uses different defaults than OpenTelemetry Python for the following
4848

4949
| Option | EDOT Python default | OpenTelemetry Python default |
5050
|---|---|---|
51-
| `OTEL_EXPERIMENTAL_RESOURCE_DETECTORS` | `process_runtime,os,otel,telemetry_distro` | `otel` |
52-
| `OTEL_LOGS_EXPORTER` | `otlp` | _no default_ |
51+
| `OTEL_EXPERIMENTAL_RESOURCE_DETECTORS` | `process_runtime,os,otel,telemetry_distro,_gcp,aws_ec2,aws_ecs,aws_elastic_beanstalk,azure_app_service,azure_vm` | `otel` |
52+
| `OTEL_METRICS_EXEMPLAR_FILTER` | `always_off` | `trace_based` |
53+
| `OTEL_EXPORTER_OTLP_METRICS_TEMPORALITY_PREFERENCE` | `DELTA` | `CUMULATIVE` |
54+
55+
> [!NOTE]
56+
> `OTEL_EXPERIMENTAL_RESOURCE_DETECTORS` cloud resource detectors are dynamically set. When running in a Kubernetes Pod it will be set to `process_runtime,os,otel,telemetry_distro,_gcp,aws_eks`.
57+
5358

5459
### Configuration options that are _only_ available in EDOT Python
5560

0 commit comments

Comments
 (0)