Skip to content

Commit bdf8eeb

Browse files
committed
docs: add an entry for troubleshooting python logging auto instrumentation
While at it improve a bit the configuration part for it.
1 parent c03d604 commit bdf8eeb

File tree

2 files changed

+14
-1
lines changed

2 files changed

+14
-1
lines changed

docs/configure.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -36,12 +36,15 @@ EDOT Python supports all configuration options listed in the [OpenTelemetry Gene
3636

3737
#### Logs
3838

39-
Exporting logs from the Python `logging` module is disabled by default and gated under a configuration environment variable:
39+
Instrument Python `logging` module to format and forward logs in OTLP format is disabled by default and gated under a configuration environment variable:
4040

4141
```sh
4242
export OTEL_PYTHON_LOGGING_AUTO_INSTRUMENTATION_ENABLED=true
4343
```
4444

45+
> [!NOTE]
46+
> Enabling this will make any call to [logging.basicConfig](https://docs.python.org/3/library/logging.html#logging.basicConfig) from your application a no-op.
47+
4548
#### Differences from OpenTelemetry Python
4649

4750
EDOT Python uses different defaults than OpenTelemetry Python for the following configuration options:

docs/troubleshooting.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -44,3 +44,13 @@ To disable the underlying OpenTelemetry SDK you set the following environment va
4444

4545
If only a subset of instrumentation are causing disruptions you can disable them with the `OTEL_PYTHON_DISABLED_INSTRUMENTATIONS`
4646
environment variable. It accepts a list of comma separated instrumentations to disable, see [OpenTelemetry zero code documentation](https://opentelemetry.io/docs/zero-code/python/configuration/#disabling-specific-instrumentations)
47+
48+
## Missing logs
49+
50+
Enabling the Python logging module auto-instrumentation with `OTEL_PYTHON_LOGGING_AUTO_INSTRUMENTATION_ENABLED=true` calls the
51+
[logging.basicConfig](https://docs.python.org/3/library/logging.html#logging.basicConfig) method that will make your own application calls
52+
to it a no-op. The side effect of this is that you won't see your application logs in the console anymore.
53+
54+
If you are already shipping logs by other means you don't need to enable this.
55+
56+
<!-- TODO: when available add link to to propose other option https://elastic.github.io/opentelemetry/use-cases/logs/ -->

0 commit comments

Comments
 (0)