Skip to content

Commit b59bdaf

Browse files
pmcollinspmcollins
authored
Change release notes filename and add changelog entry (#591)
1 parent 56229a1 commit b59bdaf

File tree

2 files changed

+33
-21
lines changed

2 files changed

+33
-21
lines changed

‎CHANGELOG.md‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,9 @@
22

33
## Unreleased
44

5+
## 2.0.0 - 2025-01-28
6+
- See VERSION_2_RELEASE_NOTES.md
7+
58
## 1.20.0 - 2024-08-08
69
- Upgrade Otel dependencies to 1.26.0 / 0.47b0
710

RELEASE_NOTES.md renamed to VERSION_2_RELEASE_NOTES.md

Lines changed: 30 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,14 @@
22

33
Summary of changes between Splunk OTel Python major versions 1 and 2.
44

5+
## Overview
6+
7+
Version 2 of the Splunk Distribution of Opentelemetry Python represents a significant rewrite of the distribution,
8+
including a new build system using Hatch, matching the upstream Opentelemetry Python repository. As the upstream
9+
repository has become more mature since Splunk OTel Python 1.0 was released, version 2 has adopted
10+
a smaller footprint, deferring logic and spec compliance to the upstream project, while making vendor-specific features
11+
available for your convenience to send telemetry to Splunk Observability Cloud.
12+
513
## API
614

715
### Version 1
@@ -19,27 +27,27 @@ Summary of changes between Splunk OTel Python major versions 1 and 2.
1927

2028
## Environment Variables
2129

22-
| Variable | Default | Description |
23-
|--------------------------------------------------|-----------|-------------------------------------------------------------------------------------------------------|
24-
| SPLUNK_ACCESS_TOKEN | | Adds token to requests to enable direct ingest (for skipping the collector) |
25-
| SPLUNK_PROFILER_ENABLED | false | Configures the Splunk profiler to start polling at startup |
26-
| SPLUNK_TRACE_RESPONSE_HEADER_ENABLED | true | Configures a ServerTimingReponsePropagator if true (injects tracecontext headers into HTTP responses) |
27-
| SPLUNK_PROFILER_CALL_STACK_INTERVAL | 1000 | Profiling poll interval, in milliseconds |
28-
| SPLUNK_PROFILER_LOGS_ENDPOINT | | OTel logging endpoint, only if profiling is enabled |
29-
| SPLUNK_REALM | | Sets the metrics and traces endpoints by realm (e.g. `us1`) and sets the protocol to `http/protobuf` |
30-
| OTEL_METRICS_EXPORTER | otlp | Sets the metrics exporter |
31-
| OTEL_TRACES_EXPORTER | otlp | Sets the traces exporter |
32-
| OTEL_LOGS_EXPORTER | otlp | Sets the logs exporter |
33-
| OTEL_EXPERIMENTAL_RESOURCE_DETECTORS | host | Configures a host resource detector to set telemetry attributes |
34-
| OTEL_TRACES_SAMPLER | always_on | Configures the sampler to export all traces |
35-
| OTEL_PYTHON_LOGGING_AUTO_INSTRUMENTATION_ENABLED | true | Exports all logs |
36-
| OTEL_SPAN_LINK_COUNT_LIMIT | 1000 | Sets the maximum allowed span link count |
37-
| OTEL_ATTRIBUTE_VALUE_LENGTH_LIMIT | 12000 | Sets the maximum allowed attribute value size |
38-
| OTEL_ATTRIBUTE_COUNT_LIMIT | _empty_ | |
39-
| OTEL_SPAN_ATTRIBUTE_COUNT_LIMIT | _empty_ | |
40-
| OTEL_SPAN_EVENT_COUNT_LIMIT | _empty_ | |
41-
| OTEL_EVENT_ATTRIBUTE_COUNT_LIMIT | _empty_ | |
42-
| OTEL_LINK_ATTRIBUTE_COUNT_LIMIT | _empty_ | |
30+
| Variable | Default | Description |
31+
|--------------------------------------------------|-----------|------------------------------------------------------------------------------------------------------|
32+
| SPLUNK_ACCESS_TOKEN | | Adds token to requests to enable direct ingest (for skipping the Collector) |
33+
| SPLUNK_REALM | | Sets the metrics and traces endpoints by realm (e.g. `us1`) and sets the protocol to `http/protobuf` |
34+
| SPLUNK_PROFILER_ENABLED | false | Configures the Splunk profiler to start polling at startup |
35+
| SPLUNK_TRACE_RESPONSE_HEADER_ENABLED | true | Configures injection of tracecontext headers into HTTP responses if true |
36+
| SPLUNK_PROFILER_CALL_STACK_INTERVAL | 1000 | Sets the profiler poll interval, in milliseconds |
37+
| SPLUNK_PROFILER_LOGS_ENDPOINT | | Sets the OTel logging endpoint, only if profiler is enabled |
38+
| OTEL_METRICS_EXPORTER | otlp | Sets the metrics exporter |
39+
| OTEL_TRACES_EXPORTER | otlp | Sets the traces exporter |
40+
| OTEL_LOGS_EXPORTER | otlp | Sets the logs exporter |
41+
| OTEL_EXPERIMENTAL_RESOURCE_DETECTORS | host | Configures a host resource detector to set telemetry attributes |
42+
| OTEL_TRACES_SAMPLER | always_on | Configures the sampler to export all traces |
43+
| OTEL_PYTHON_LOGGING_AUTO_INSTRUMENTATION_ENABLED | true | Exports all logs |
44+
| OTEL_SPAN_LINK_COUNT_LIMIT | 1000 | Sets the maximum allowed span link count |
45+
| OTEL_ATTRIBUTE_VALUE_LENGTH_LIMIT | 12000 | Sets the maximum allowed attribute value size |
46+
| OTEL_ATTRIBUTE_COUNT_LIMIT | _empty_ | |
47+
| OTEL_SPAN_ATTRIBUTE_COUNT_LIMIT | _empty_ | |
48+
| OTEL_SPAN_EVENT_COUNT_LIMIT | _empty_ | |
49+
| OTEL_EVENT_ATTRIBUTE_COUNT_LIMIT | _empty_ | |
50+
| OTEL_LINK_ATTRIBUTE_COUNT_LIMIT | _empty_ | |
4351

4452
## Environment Variable Changes Between 1.x and 2.x
4553

@@ -48,6 +56,7 @@ Summary of changes between Splunk OTel Python major versions 1 and 2.
4856
| OTEL_METRICS_ENABLED | Removed (set `OTEL_PYTHON_DISABLED_INSTRUMENTATIONS=system_metrics` to disable) |
4957
| OTEL_METRICS_EXPORTER | Overridden in 1.x, configurable in 2.x |
5058
| OTEL_TRACE_ENABLED | Removed (defaulted to `true`) |
59+
| OTEL_PYTHON_LOG_CORRELATION | No longer set (previously reformatted logs, adding trace IDs) |
5160
| OTEL_METRICS_EXPORTER | Added |
5261
| OTEL_LOGS_EXPORTER | Added |
5362
| OTEL_EXPERIMENTAL_RESOURCE_DETECTORS | Added |

0 commit comments

Comments
 (0)