Release v0.20.0

[MrAlias]

Added

• The OTLP exporter now has two new convenience functions, NewExportPipeline and InstallNewPipeline, setup and install the exporter in tracing and metrics pipelines. (add NewExportPipeline and InstallNewPipeline for otlp #1373)
• Adds semantic conventions for exceptions. (Adds semantic conventions for exceptions #1492)
• Added Jaeger Environment variables: OTEL_EXPORTER_JAEGER_AGENT_HOST, OTEL_EXPORTER_JAEGER_AGENT_PORT
  These environment variables can be used to override Jaeger agent hostname and port (Update Jaeger environment variables #1752)
• Option ExportTimeout was added to batch span processor. (Add ExportTimeout option to batch span processor #1755)
• trace.TraceFlags is now a defined type over byte and WithSampled(bool) TraceFlags and IsSampled() bool methods have been added to it. (Make TraceFlags spec-compliant #1770)
• The Event and Link struct types from the go.opentelemetry.io/otel package now include a DroppedAttributeCount field to record the number of attributes that were not recorded due to configured limits being reached. (Record links/events attribute drops independently #1771)
• The Jaeger exporter now reports dropped attributes for a Span event in the exported log. (Record links/events attribute drops independently #1771)
• Adds test to check BatchSpanProcessor ignores OnEnd and ForceFlush post Shutdown. (Add test to check bsp ignores OnEnd and ForceFlush post Shutdown` #1772)
• Extract resource attributes from the OTEL_RESOURCE_ATTRIBUTES environment variable and merge them with the resource.Default resource as well as resources provided to the TracerProvider and metric Controller. (Fix default merging of resource attributes from environment variable #1785)
• Added WithOSType resource configuration option to set OS (Operating System) type resource attribute (os.type). (OS and Process resource detectors #1788)
• Added WithProcess* resource configuration options to set Process resource attributes. (OS and Process resource detectors #1788)
  • process.pid
  • process.executable.name
  • process.executable.path
  • process.command_args
  • process.owner
  • process.runtime.name
  • process.runtime.version
  • process.runtime.description
• Adds k8s.node.name and k8s.node.uid attribute keys to the semconv package. (Add k8s.node.name and k8s.node.uid to semconv #1789)
• Added support for configuring OTLP/HTTP and OTLP/gRPC Endpoints, TLS Certificates, Headers, Compression and Timeout via Environment Variables. (add partial support for env var config to otlp/HTTP #1758, add support for configuring tls certs via env var to otlp/HTTP #1769 and add support for env var configuration to otlp/gRPC #1811)
  • OTEL_EXPORTER_OTLP_ENDPOINT
  • OTEL_EXPORTER_OTLP_TRACES_ENDPOINT
  • OTEL_EXPORTER_OTLP_METRICS_ENDPOINT
  • OTEL_EXPORTER_OTLP_HEADERS
  • OTEL_EXPORTER_OTLP_TRACES_HEADERS
  • OTEL_EXPORTER_OTLP_METRICS_HEADERS
  • OTEL_EXPORTER_OTLP_COMPRESSION
  • OTEL_EXPORTER_OTLP_TRACES_COMPRESSION
  • OTEL_EXPORTER_OTLP_METRICS_COMPRESSION
  • OTEL_EXPORTER_OTLP_TIMEOUT
  • OTEL_EXPORTER_OTLP_TRACES_TIMEOUT
  • OTEL_EXPORTER_OTLP_METRICS_TIMEOUT
  • OTEL_EXPORTER_OTLP_CERTIFICATE
  • OTEL_EXPORTER_OTLP_TRACES_CERTIFICATE
  • OTEL_EXPORTER_OTLP_METRICS_CERTIFICATE
• Adds otlpgrpc.WithTimeout option for configuring timeout to the otlp/gRPC exporter. (Adds support for timeout on the otlp/gRPC exporter #1821)

Fixed

• The Span.IsRecording implementation from go.opentelemetry.io/otel/sdk/trace always returns false when not being sampled. (Fix span IsRecording when not sampling #1750)
• The Jaeger exporter now correctly sets tags for the Span status code and message.
  This means it uses the correct tag keys ("otel.status_code", "otel.status_description") and does not set the status message as a tag unless it is set on the span. (Fix Jaeger span status reporting and unify tag keys #1761)
• The Jaeger exporter now correctly records Span event's names using the "event" key for a tag.
  Additionally, this tag is overridden, as specified in the OTel specification, if the event contains an attribute with that key. (Update precedence of event name in Jaeger exporter #1768)
• Zipkin Exporter: Ensure mapping between OTel and Zipkin span data complies with the specification. (Zipkin Exporter: Adjust span transformation to comply with the spec #1688)
• Fixed typo for default service name in Jaeger Exporter. (Fixed typo for default service name in Jaeger Exporter #1797)
• Fix flaky OTLP for the reconnnection of the client connection. (Flaky test: TestNewExporter_collectorConnectionDiesThenReconnects #1527, Fix flaky OTLP exporter reconnect test #1814)

Changed

• Span RecordError now records an exception event to comply with the semantic convention specification. (Adds semantic conventions for exceptions #1492)
• Jaeger exporter was updated to use thrift v0.14.1. (upgrade thrift to v0.14.1 in jaeger exporter #1712)
• Migrate from using internally built and maintained version of the OTLP to the one hosted at go.opentelemetry.io/proto/otlp. (Migrate to using go.opentelemetry.io/proto/otlp #1713)
• Migrate from using github.com/gogo/protobuf to google.golang.org/protobuf to match go.opentelemetry.io/proto/otlp. (Migrate to using go.opentelemetry.io/proto/otlp #1713)
• The storage of a local or remote Span in a context.Context using its SpanContext is unified to store just the current Span.
  The Span's SpanContext can now self-identify as being remote or not.
  This means that "go.opentelemetry.io/otel/trace".ContextWithRemoteSpanContext will now overwrite any existing current Span, not just existing remote Spans, and make it the current Span in a context.Context. (Store current Span instead of local and remote SpanContext in context.Context #1731)
• Improve OTLP/gRPC exporter connection errors. (improve OTLP/gRPC connection errors #1737)
• Information about a parent span context in a "go.opentelemetry.io/otel/export/trace".SpanSnapshot is unified in a new Parent field.
  The existing ParentSpanID and HasRemoteParent fields are removed in favor of this. (Update SpanSnapshot to use parent SpanContext #1748)
• The ParentContext field of the "go.opentelemetry.io/otel/sdk/trace".SamplingParameters is updated to hold a context.Context containing the parent span.
  This changes it to make SamplingParameters conform with the OpenTelemetry specification. (Update SamplingParameters #1749)
• Updated Jaeger Environment Variables: JAEGER_ENDPOINT, JAEGER_USER, JAEGER_PASSWORD
  to OTEL_EXPORTER_JAEGER_ENDPOINT, OTEL_EXPORTER_JAEGER_USER, OTEL_EXPORTER_JAEGER_PASSWORD
  in compliance with OTel spec (Update Jaeger environment variables #1752)
• Modify BatchSpanProcessor.ForceFlush to abort after timeout/cancellation. (Modify ForceFlush to abort after timeout/cancellation #1757)
• The DroppedAttributeCount field of the Span in the go.opentelemetry.io/otel package now only represents the number of attributes dropped for the span itself.
  It no longer is a conglomerate of itself, events, and link attributes that have been dropped. (Record links/events attribute drops independently #1771)
• Make ExportSpans in Jaeger Exporter honor context deadline. (Make ExportSpans for Jaeger Exporter honor deadline #1773)
• Modify Zipkin Exporter default service name, use default resouce's serviceName instead of empty. (Zipkin exporter: default service name #1777)
• The go.opentelemetry.io/otel/sdk/export/trace package is merged into the go.opentelemetry.io/otel/sdk/trace package. (Merge sdk/export/trace into sdk/trace #1778)
• The prometheus.InstallNewPipeline example is moved from comment to example test (docs: use test example to document prometheus.InstallNewPipeline #1796)
• The convenience functions for the stdout exporter have been updated to return the TracerProvider implementation and enable the shutdown of the exporter. (Changes stdout to expose the *sdktrace.TracerProvider #1800)
• Replace the flush function returned from the Jaeger exporter's convenience creation functions (InstallNewPipeline and NewExportPipeline) with the TracerProvider implementation they create.
  This enables the caller to shutdown and flush using the related TracerProvider methods. (Update Jaeger exporter convenience functions #1822)
• Updated the Jaeger exporter to have a default enpoint, http://localhost:14250, for the collector. ( Update Default Value for Jaeger Exporter Endpoint  #1824)
• Changed the function WithCollectorEndpoint in the Jaeger exporter to no longer accept an endpoint as an argument.
  The endpoint can be passed with the CollectorEndpointOption using the WithEndpoint function or by setting the OTEL_EXPORTER_JAEGER_ENDPOINT environment variable value appropriately. ( Update Default Value for Jaeger Exporter Endpoint  #1824)
• The Jaeger exporter no longer batches exported spans itself, instead it relies on the SDK's BatchSpanProcessor for this functionality. (Remove bundler from Jaeger exporter #1830)
• The Jaeger exporter creation functions (NewRawExporter, NewExportPipeline, and InstallNewPipeline) no longer accept the removed Option type as a variadic argument. (Remove bundler from Jaeger exporter #1830)

Removed

• Removed Jaeger Environment variables: JAEGER_SERVICE_NAME, JAEGER_DISABLED, JAEGER_TAGS
  These environment variables will no longer be used to override values of the Jaeger exporter (Update Jaeger environment variables #1752)
• No longer set the links for a Span in go.opentelemetry.io/otel/sdk/trace that is configured to be a new root.
  This is unspecified behavior that the OpenTelemetry community plans to standardize in the future.
  To prevent backwards incompatible changes when it is specified, these links are removed. (Remove links on NewRoot spans #1726)
• Setting error status while recording error with Span from oteltest package. (Remove setting error status while recording error with Span from oteltest package #1729)
• The concept of a remote and local Span stored in a context is unified to just the current Span.
  Because of this "go.opentelemetry.io/otel/trace".RemoteSpanContextFromContext is removed as it is no longer needed.
  Instead, "go.opentelemetry.io/otel/trace".SpanContextFromContex can be used to return the current Span.
  If needed, that Span's SpanContext.IsRemote() can then be used to determine if it is remote or not. (Store current Span instead of local and remote SpanContext in context.Context #1731)
• The HasRemoteParent field of the "go.opentelemetry.io/otel/sdk/trace".SamplingParameters is removed.
  This field is redundant to the information returned from the Remote method of the SpanContext held in the ParentContext field. (Update SamplingParameters #1749)
• The trace.FlagsDebug and trace.FlagsDeferred constants have been removed and will be localized to the B3 propagator. (Make TraceFlags spec-compliant #1770)
• Remove Process configuration, WithProcessFromEnv and ProcessFromEnv, and type from the Jaeger exporter package.
  The information that could be configured in the Process struct should be configured in a Resource instead. (Remove process config for Jaeger exporter #1776, Remove the abandoned Process struct in Jaeger exporter #1804)
• Remove the WithDisabled option from the Jaeger exporter.
  To disable the exporter unregister it from the TracerProvider or use a no-operation TracerProvider. (Remove the WithDisabled option from Jaeger exporter #1806)
• Removed the functions CollectorEndpointFromEnv and WithCollectorEndpointOptionFromEnv from the Jaeger exporter.
  These functions for retrieving specific environment variable values are redundant of other internal functions and
  are not intended for end user use. ( Update Default Value for Jaeger Exporter Endpoint  #1824)
• Removed the Jaeger exporter WithSDKOptions Option.
  This option was used to set SDK options for the exporter creation convenience functions.
  These functions are provided as a way to easily setup or install the exporter with what are deemed reasonable SDK settings for common use cases.
  If the SDK needs to be configured differently, the NewRawExporter function and direct setup of the SDK with the desired settings should be used. (Remove the WithSDKOptions from the Jaeger exporter #1825)
• The WithBufferMaxCount and WithBatchMaxCount Options from the Jaeger exporter are removed.
  The exporter no longer batches exports, instead relying on the SDK's BatchSpanProcessor for this functionality. (Remove bundler from Jaeger exporter #1830)
• The Jaeger exporter Option type is removed.
  The type is no longer used by the exporter to configure anything.
  All of the previous configuration these options provided were duplicates of SDK configuration.
  They have all been removed in favor of using the SDK configuration and focuses the exporter configuration to be only about the endpoints it will send telemetry to. (Remove bundler from Jaeger exporter #1830)

[codecov]

Codecov Report

Merging #1837 (8bf28f3) into main (aa66fe7) will increase coverage by 0.0%.
The diff coverage is 100.0%.

@@          Coverage Diff          @@
##            main   #1837   +/-   ##
=====================================
  Coverage   78.5%   78.6%           
=====================================
  Files        137     137           
  Lines       7288    7288           
=====================================
+ Hits        5728    5729    +1     
+ Misses      1316    1315    -1     
  Partials     244     244           

Impacted Files	Coverage Δ
version.go	100.0% <100.0%> (+100.0%)	⬆️