You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: CHANGELOG.md
+46-27
Original file line number
Diff line number
Diff line change
@@ -10,6 +10,24 @@ This project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.htm
10
10
11
11
### Added
12
12
13
+
### Changed
14
+
15
+
### Deprecated
16
+
17
+
### Removed
18
+
19
+
### Fixed
20
+
21
+
### Security
22
+
23
+
## [1.0.0-RC1] / 0.21.0 - 2021-06-18
24
+
25
+
With this release we are introducing a split in module versions. The tracing API and SDK are entering the `v1.0.0` Release Candidate phase with `v1.0.0-RC1`
26
+
while the experimental metrics API and SDK continue with `v0.x` releases at `v0.21.0`. Modules at major version 1 or greater will not depend on modules
27
+
with major version 0.
28
+
29
+
### Added
30
+
13
31
- Adds `otlpgrpc.WithRetry`option for configuring the retry policy for transient errors on the otlp/gRPC exporter. (#1832)
14
32
- The following status codes are defined as transient errors:
15
33
| gRPC Status Code | Description |
@@ -21,23 +39,23 @@ This project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.htm
21
39
| 10 | Out of Range |
22
40
| 14 | Unavailable |
23
41
| 15 | Data Loss |
24
-
-The`Status` type was added to the `go.opentelemetry.io/otel/sdk/trace` package to represent the status of a span. (#1874)
25
-
-The`SpanStub` type and its associated functions were added to the `go.opentelemetry.io/otel/sdk/trace/tracetest` package.
42
+
-Added`Status` type to the `go.opentelemetry.io/otel/sdk/trace` package to represent the status of a span. (#1874)
43
+
-Added`SpanStub` type and its associated functions to the `go.opentelemetry.io/otel/sdk/trace/tracetest` package.
26
44
This type can be used as a testing replacement for the `SpanSnapshot` that was removed from the `go.opentelemetry.io/otel/sdk/trace` package. (#1873)
27
45
- Adds support for scheme in `OTEL_EXPORTER_OTLP_ENDPOINT` according to the spec. (#1886)
28
46
- Adds `trace.WithSchemaURL` option for configuring the tracer with a Schema URL. (#1889)
29
-
-An example of using OpenTelemetry Go as a trace context forwarder. (#1912)
47
+
-Added an example of using OpenTelemetry Go as a trace context forwarder. (#1912)
30
48
-`ParseTraceState` is added to the `go.opentelemetry.io/otel/trace` package.
31
49
It can be used to decode a `TraceState` from a `tracestate` header string value. (#1937)
32
-
-The`Len` method is added to the `TraceState` type in the `go.opentelemetry.io/otel/trace` package.
50
+
-Added`Len` method to the `TraceState` type in the `go.opentelemetry.io/otel/trace` package.
33
51
This method returns the number of list-members the `TraceState` holds. (#1937)
34
52
- Creates package `go.opentelemetry.io/otel/exporters/otlp/otlptrace` that defines a trace exporter that uses a `otlptrace.Client` to send data.
35
53
Creates package `go.opentelemetry.io/otel/exporters/otlp/otlptrace/otlptracegrpc` implementing a gRPC `otlptrace.Client` and offers convenience functions, `NewExportPipeline` and `InstallNewPipeline`, to setup and install a `otlptrace.Exporter` in tracing .(#1922)
36
-
-The`Baggage`, `Member`, and `Property` types are added to the `go.opentelemetry.io/otel/baggage` package along with their related functions. (#1967)
37
-
-The new `ContextWithBaggage`, `ContextWithoutBaggage`, and `FromContext` functions were added to the `go.opentelemetry.io/otel/baggage` package.
54
+
-Added`Baggage`, `Member`, and `Property` types to the `go.opentelemetry.io/otel/baggage` package along with their related functions. (#1967)
55
+
-Added `ContextWithBaggage`, `ContextWithoutBaggage`, and `FromContext` functions to the `go.opentelemetry.io/otel/baggage` package.
38
56
These functions replace the `Set`, `Value`, `ContextWithValue`, `ContextWithoutValue`, and `ContextWithEmpty` functions from that package and directly work with the new `Baggage` type. (#1967)
39
57
- The `OTEL_SERVICE_NAME` environment variable is the preferred source for `service.name`, used by the environment resource detector if a service name is present both there and in `OTEL_RESOURCE_ATTRIBUTES`. (#1969)
40
-
- Creates package `go.opentelemetry.io/otel/exporters/otlp/otlptrace/otlptracehttp` implementing a HTTP `otlptrace.Client` and offers convenience functions, `NewExportPipeline` and `InstallNewPipeline`, to setup and install a `otlptrace.Exporter` in tracing. (#1963)
58
+
- Creates package `go.opentelemetry.io/otel/exporters/otlp/otlptrace/otlptracehttp` implementing an HTTP `otlptrace.Client` and offers convenience functions, `NewExportPipeline` and `InstallNewPipeline`, to setup and install a `otlptrace.Exporter` in tracing. (#1963)
41
59
- Changes `go.opentelemetry.io/otel/sdk/resource.NewWithAttributes` to require a schema URL. The old function is still available as `resource.NewSchemaless`. This is a breaking change. (#1938)
42
60
- Several builtin resource detectors now correctly populate the schema URL. (#1938)
43
61
- Creates package `go.opentelemetry.io/otel/exporters/otlp/otlpmetric` that defines a metrics exporter that uses a `otlpmetric.Client` to send data.
@@ -58,33 +76,33 @@ This project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.htm
58
76
- Renamed `CloudZoneKey` to `CloudAvailabilityZoneKey` in Resource semantic conventions according to spec. (#1871)
59
77
- The `StatusCode` and `StatusMessage` methods of the `ReadOnlySpan` interface and the `Span` produced by the `go.opentelemetry.io/otel/sdk/trace` package have been replaced with a single `Status` method.
60
78
This method returns the status of a span using the new `Status` type. (#1874)
61
-
-The`ExportSpans` method of the`SpanExporter` interface type was updated to accept `ReadOnlySpan`s instead of the removed `SpanSnapshot`.
79
+
-Updated`ExportSpans` method of the`SpanExporter` interface type to accept `ReadOnlySpan`s instead of the removed `SpanSnapshot`.
62
80
This brings the export interface into compliance with the specification in that it now accepts an explicitly immutable type instead of just an implied one. (#1873)
63
81
- Unembed `SpanContext` in `Link`. (#1877)
64
-
- Semantic conventions are now generated from the specification YAML. (#1891)
82
+
-Generate Semantic conventions from the specification YAML. (#1891)
65
83
- Spans created by the global `Tracer` obtained from `go.opentelemetry.io/otel`, prior to a functioning `TracerProvider` being set, now propagate the span context from their parent if one exists. (#1901)
66
84
- The `"go.opentelemetry.io/otel".Tracer` function now accepts tracer options. (#1902)
67
85
- Move the `go.opentelemetry.io/otel/unit` package to `go.opentelemetry.io/otel/metric/unit`. (#1903)
68
86
- Changed `go.opentelemetry.io/otel/trace.TracerConfig` to conform to the [Contributing guidelines](CONTRIBUTING.md#config.) (#1921)
69
87
- Changed `go.opentelemetry.io/otel/trace.SpanConfig` to conform to the [Contributing guidelines](CONTRIBUTING.md#config). (#1921)
70
-
- Changed `span.End()` now only accepts Options that are allowed at `end()`. (#1921)
88
+
- Changed `span.End()` now only accepts Options that are allowed at `End()`. (#1921)
71
89
- Changed `go.opentelemetry.io/otel/metric.InstrumentConfig` to conform to the [Contributing guidelines](CONTRIBUTING.md#config). (#1921)
72
90
- Changed `go.opentelemetry.io/otel/metric.MeterConfig` to conform to the [Contributing guidelines](CONTRIBUTING.md#config). (#1921)
73
-
-Refactor option types according to the contribution style guide. (#1882)
91
+
-Refactored option types according to the contribution style guide. (#1882)
74
92
- Move the `go.opentelemetry.io/otel/trace.TraceStateFromKeyValues` function to the `go.opentelemetry.io/otel/oteltest` package.
75
93
This function is preserved for testing purposes where it may be useful to create a `TraceState` from `attribute.KeyValue`s, but it is not intended for production use.
76
94
The new `ParseTraceState` function should be used to create a `TraceState`. (#1931)
77
-
-The`MarshalJSON` method of the `go.opentelemetry.io/otel/trace.TraceState` type is updated to marshal the type in to the string representation of the `TraceState`. (#1931)
95
+
-Updated`MarshalJSON` method of the `go.opentelemetry.io/otel/trace.TraceState` type to marshal the type into the string representation of the `TraceState`. (#1931)
78
96
- The `TraceState.Delete` method from the `go.opentelemetry.io/otel/trace` package no longer returns an error in addition to a `TraceState`. (#1931)
79
-
-The`Get` method of the `TraceState` type from the `go.opentelemetry.io/otel/trace` package has been updated to accept a `string` instead of an `attribute.Key` type. (#1931)
80
-
-The`Insert` method of the `TraceState` type from the `go.opentelemetry.io/otel/trace` package has been updated to accept a pair of `string`s instead of an `attribute.KeyValue` type. (#1931)
81
-
-The`Delete` method of the `TraceState` type from the `go.opentelemetry.io/otel/trace` package has been updated to accept a `string` instead of an `attribute.Key` type. (#1931)
82
-
-Rename`NewExporter` to `New` in the `go.opentelemetry.io/otel/exporters/stdout` package. (#1985)
83
-
-Rename`NewExporter` to `New` in the `go.opentelemetry.io/otel/exporters/metric/prometheus` package. (#1985)
84
-
-Rename`NewExporter` to `New` in the `go.opentelemetry.io/otel/exporters/trace/jaeger` package. (#1985)
85
-
-Rename`NewExporter` to `New` in the `go.opentelemetry.io/otel/exporters/trace/zipkin` package. (#1985)
86
-
-Rename`NewExporter` to `New` in the `go.opentelemetry.io/otel/exporters/otlp` package. (#1985)
87
-
-Rename`NewUnstartedExporter` to `NewUnstarted` in the `go.opentelemetry.io/otel/exporters/otlp` package. (#1985)
97
+
-Updated`Get` method of the `TraceState` type from the `go.opentelemetry.io/otel/trace` package to accept a `string` instead of an `attribute.Key` type. (#1931)
98
+
-Updated`Insert` method of the `TraceState` type from the `go.opentelemetry.io/otel/trace` package to accept a pair of `string`s instead of an `attribute.KeyValue` type. (#1931)
99
+
-Updated`Delete` method of the `TraceState` type from the `go.opentelemetry.io/otel/trace` package to accept a `string` instead of an `attribute.Key` type. (#1931)
100
+
-Renamed`NewExporter` to `New` in the `go.opentelemetry.io/otel/exporters/stdout` package. (#1985)
101
+
-Renamed`NewExporter` to `New` in the `go.opentelemetry.io/otel/exporters/metric/prometheus` package. (#1985)
102
+
-Renamed`NewExporter` to `New` in the `go.opentelemetry.io/otel/exporters/trace/jaeger` package. (#1985)
103
+
-Renamed`NewExporter` to `New` in the `go.opentelemetry.io/otel/exporters/trace/zipkin` package. (#1985)
104
+
-Renamed`NewExporter` to `New` in the `go.opentelemetry.io/otel/exporters/otlp` package. (#1985)
105
+
-Renamed`NewUnstartedExporter` to `NewUnstarted` in the `go.opentelemetry.io/otel/exporters/otlp` package. (#1985)
88
106
- The `go.opentelemetry.io/otel/semconv` package has been moved to `go.opentelemetry.io/otel/semconv/v1.4.0` to allow for multiple [telemetry schema](https://github.com/open-telemetry/oteps/blob/main/text/0152-telemetry-schemas.md) versions to be used concurrently. (#1987)
89
107
- Metrics test helpers in `go.opentelemetry.io/otel/oteltest` have been moved to `go.opentelemetry.io/otel/metric/metrictest`. (#1988)
90
108
@@ -96,7 +114,7 @@ This project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.htm
96
114
97
115
### Removed
98
116
99
-
-Remove`resource.WithoutBuiltin()`. Use `resource.New()`. (#1810)
117
+
-Removed`resource.WithoutBuiltin()`. Use `resource.New()`. (#1810)
100
118
- Unexported types `resource.FromEnv`, `resource.Host`, and `resource.TelemetrySDK`, Use the corresponding `With*()` to use individually. (#1810)
101
119
- Removed the `Tracer` and `IsRecording` method from the `ReadOnlySpan` in the `go.opentelemetry.io/otel/sdk/trace`.
102
120
The `Tracer` method is not a required to be included in this interface and given the mutable nature of the tracer that is associated with a span, this method is not appropriate.
@@ -106,13 +124,13 @@ This project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.htm
106
124
- Removed the `SpanSnapshot` type from the `go.opentelemetry.io/otel/sdk/trace` package.
107
125
The use of this type has been replaced with the use of the explicitly immutable `ReadOnlySpan` type.
108
126
When a concrete representation of a read-only span is needed for testing, the newly added `SpanStub` in the `go.opentelemetry.io/otel/sdk/trace/tracetest` package should be used. (#1873)
109
-
-Remove the `Tracer` method from the `Span` interface in the `go.opentelemetry.io/otel/trace` package.
127
+
-Removed the `Tracer` method from the `Span` interface in the `go.opentelemetry.io/otel/trace` package.
110
128
Using the same tracer that created a span introduces the error where an instrumentation library's `Tracer` is used by other code instead of their own.
111
129
The `"go.opentelemetry.io/otel".Tracer` function or a `TracerProvider` should be used to acquire a library specific `Tracer` instead. (#1900)
112
130
- The `TracerProvider()` method on the `Span` interface may also be used to obtain a `TracerProvider` using the same trace processing pipeline. (#2009)
113
131
- The `http.url` attribute generated by `HTTPClientAttributesFromHTTPRequest` will no longer include username or password information. (#1919)
114
-
-The`IsEmpty` method of the `TraceState` type in the `go.opentelemetry.io/otel/trace` package is removed in favor of using the added `TraceState.Len` method. (#1931)
115
-
-The`Set`, `Value`, `ContextWithValue`, `ContextWithoutValue`, and `ContextWithEmpty` functions in the `go.opentelemetry.io/otel/baggage` package are removed.
132
+
-Removed`IsEmpty` method of the `TraceState` type in the `go.opentelemetry.io/otel/trace` package in favor of using the added `TraceState.Len` method. (#1931)
133
+
-Removed`Set`, `Value`, `ContextWithValue`, `ContextWithoutValue`, and `ContextWithEmpty` functions in the `go.opentelemetry.io/otel/baggage` package.
116
134
Handling of baggage is now done using the added `Baggage` type and related context functions (`ContextWithBaggage`, `ContextWithoutBaggage`, and `FromContext`) in that package. (#1967)
117
135
- The `InstallNewPipeline` and `NewExportPipeline` creation functions in all the exporters (prometheus, otlp, stdout, jaeger, and zipkin) have been removed.
118
136
These functions were deemed premature attempts to provide convenience that did not achieve this aim. (#1985)
@@ -127,7 +145,7 @@ This project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.htm
127
145
- Use `http://localhost:14268/api/traces` as default Jaeger collector endpoint instead of `http://localhost:14250`. (#1898)
128
146
- Allow trailing and leading whitespace in the parsing of a `tracestate` header. (#1931)
129
147
- Add logic to determine if the channel is closed to fix Jaeger exporter test panic with close closed channel. (#1870, #1973)
130
-
- Avoid transport security when otlp endpoint is a Unix socket. (#2001)
148
+
- Avoid transport security when OTLP endpoint is a Unix socket. (#2001)
131
149
132
150
### Security
133
151
@@ -1397,7 +1415,8 @@ It contains api and sdk for trace and meter.
1397
1415
- CircleCI build CI manifest files.
1398
1416
- CODEOWNERS file to track owners of this project.
0 commit comments