- Fix regression in event attributes (#6865)
- Fix ConfigUtil#getString ConcurrentModificationException (#6841)
- Stabilize ExceptionEventData (#6795)
- Stabilize metric cardinality limits (#6794)
- Refactor metrics internals to remove MeterSharedState (#6845)
- Add memory mode option to stdout exporters (#6774)
- Log a warning if OTLP endpoint port is likely incorrect given the protocol (#6813)
- Fix OTLP gRPC retry mechanism for unsuccessful HTTP responses (#6829)
- Add ByteBuffer field type marshaling support (#6686)
- Fix stdout exporter format by adding newline after each export (#6848)
- Enable
reusuable_data
memory mode by default forOtlpGrpc{Signal}Exporter
,OtlpHttp{Signal}Exporter
,OtlpStdout{Signal}Exporter
, andPrometheusHttpServer
(#6799)
- Rebrand file configuration to declarative configuration in documentation (#6812)
- Fix declarative config
file_format
validation (#6786) - Fix declarative config env substitution by disallowing '}' in default value (#6793)
- Set declarative config default OTLP protocol to http/protobuf (#6800)
- Stabilize autoconfigure disabling of resource keys via
otel.resource.disabled.keys
(#6809)
- Run tests on Java 23 (#6825)
- Test Windows in CI (#6824)
- Add error prone checks for internal javadoc and private constructors (#6844)
- Add helper class to capture context using ScheduledExecutorService (#6712)
- Adds Baggage.getEntry(String key) (#6765)
- Fix ottracepropagation for short span ids (#6734)
- Optimize advice with FilteredAttributes (#6633)
- Add experimental stdout log, metric, trace exporters for printing records to stdout in standard OTLP JSON format. (#6675, #6750)
- Add Marshalers for profiling signal type (#6680)
- Add
*Model
suffix to declarative config generated classes. (#6721) - Use autoconfigured ClassLoader to load declarative config (#6725)
- Update declarative config to use opentelemetry-configuration v0.3.0 (#6733)
- Add
StructuredConfigProperties#getStructured
default method, addStructuredConfigProperties.empty()
(#6759)
- Add context info about wrong span or trace. (#6703)
- Revert
java-test-fixtures
plugin to remove test dependencies frompom.xml
. (#6695)
- BREAKING: Stabilize log support for AnyValue bodies. Rename
AnyValue
toValue
, promote fromopentelemetry-api-incubator
toopentelemetry-api
, change package fromio.opentelemetry.api.incubator.logs
toio.opentelemetry.api.common
. (#6591) - Noop implementations detect when
opentelemetry-api-incubator
is present and return extended noop implementations. (#6617)%
- Added experimental support for SpanProcessor OnEnding callback (#6367)
- Remove final modifier from SdkTracer.tracerEnabled (#6687)
- Suppress zipkin exporter instrumentation (#6552)
- OTLP exporters return status code exceptions via CompletableResultCode in GrpcExporter and HttpExporter. (#6645)
- Align GrpcSender contract with HttpSender (#6658)
- Add autoconfigure support for ns and us durations (#6654)
- Add declarative configuration ComponentProvider support for resources (#6625)
- Add declarative configuration ComponentProvider support for processors (#6623)
- Add declarative configuration ComponentProvider support for samplers (#6494)
- Add declarative configuration ComponentProvider support for propagators (#6624)
- Add declarative configuration missing pieces (#6677)
- Change jaeger remote sampler autoconfigure property from
pollingInterval
topollingIntervalMs
to match spec. (#6672)
- Add asserts for log record body fields (#6509)
- Move experimental suppress instrumentation context key to api internal package (#6546)
- Fix bug in
ExtendedContextPropagators
preventing context extraction when case is incorrect. (#6569)
- Extend
CompletableResultCode
withfailExceptionally(Throwable)
. (#6348)
- Avoid allocations when experimental advice doesn't remove any attributes. (#6629)
- Enable retry by default for OTLP exporters. (#6588)
- Retry ConnectException, add retry logging. (#6614)
- Extend
PrometheusHttpServer
with ability to configure default aggregation as function of instrument kind, including experimental env var support. (#6541) - Add exporter data model impl for profiling signal type. (#6498)
- Add Marshalers for profiling signal type. (#6565)
- Use generateCertificates() of CertificateFactory to process certificates. (#6579)
- Add file configuration ComponentProvider support for exporters. (#6493)
- Remove nullable from file config Factory contract. (#6612)
- Narrow ExtendedSpanBuilder return types for chaining (#6514)
- Add APIs to determine if tracer, logger, instruments are enabled (#6502)
- Move autoconfigure docs to opentelemetry.io (#6491)
- BREAKING: Refactor ExtendedTracer, ExtendedSpanBuilder to reflect incubating API conventions (#6497)
- BREAKING: Serve prometheus metrics only on
/metrics
by default. To restore the previous behavior and serve metrics on all paths, override the default handler as demonstrated here. (#6476) - Make OTLP exporter memory mode API public (#6469)
- Speed up OTLP string marshaling using sun.misc.Unsafe (#6433)
- Add exporter data classes for experimental profiling signal type. (#6374)
- Start prometheus http server with daemon thread (#6472)
- Update the Prometheus metrics library and improve how units are included in metric names. (#6473)
- Remove android animalsniffer check from prometheus exporter (#6478)
- Load file config YAML using core schema, ensure that env var substitution retains string types. (#6436)
- Define dedicated file configuration SPI ComponentProvider (#6457)
- Normalize timestamps and file ordering in jars, making the outputs reproducible (#6471)
- GHA for generating the post-release pull request (#6449)
- Stabilize synchronous gauge (#6419)
- Add put(AttributeKey, T) overload to EventBuilder (#6331)
- Baggage filters space-only keys (#6431)
- Add experimental scope config to enable / disable scopes (i.e. meter, logger, tracer) (#6375)
- Add ReadableSpan#getAttributes (#6382)
- Use standard ArrayList size rather than max number of links for initial span links allocation (#6252)
- Use low precision Clock#now when computing timestamp for exemplars (#6417)
- Update invalid instrument name log message now that forward slash
/
is valid (#6343)
- Introduce low allocation OTLP marshalers. If using autoconfigure, opt in
via
OTEL_JAVA_EXPERIMENTAL_EXPORTER_MEMORY_MODE=REUSABLE_DATA
. - Mark opentelemetry-exporter-sender-jdk stable (#6357)
- PrometheusHttpServer prevent concurrent reads when reusable memory mode (#6371)
- Ignore TLS components (SSLContext, TrustManager, KeyManager) if plain HTTP protocol is used for exporting (#6329)
- Add is_remote_parent span flags to OTLP exported Spans and SpanLinks (#6388)
- Add missing fields to OTLP metric exporters
toString()
(#6402)
- Rename otel.config.file to otel.experimental.config.file for autoconfigure (#6396)
- Fix opencensus shim spanBuilderWithRemoteParent behavior (#6415)
- Add additional API incubator docs (#6356)
- Run build on java 21 (#6370)
- Fix running tests with java 8 on macos (#6411)
- Move away from deprecated gradle enterprise APIs (#6363)
NOTICE: This release contains a significant restructuring of the experimental event API and the API incubator artifact. Please read the notes in the API -> Incubator
section carefully.
- Promote
Span#addLink
to stable API (#6317)
- BREAKING: Rename
opentelemetry-extension-incubator
toopentelemetry-api-incubator
, mergeopentelemetry-api-events
intoopentelemetry-api-incubator
. (#6289) - BREAKING: Remove domain from event api.
EventEmitterProvider#setEventDomain
has been removed. Theevent.name
field should now be namespaced to avoid collisions. See Semantic Conventions for Event Attributes for more details. (#6253) - BREAKING: Rename
EventEmitter
and related classes toEventLogger
. (#6316) - BREAKING: Refactor Event API to reflect spec changes. Restructure API to put fields in
the
AnyValue
log record body. Add setters for timestamp, context, and severity. Set default severity toINFO=9
. (#6318)
- Add
get{Signal}Exporter
methods toSimple{Signal}Processor
,Batch{Signal}Processor
. (#6078)
- Use synchronized instead of reentrant lock in explicit bucket histogram (#6309)
- Fix typo in OTLP javadoc (#6311)
- Add
PrometheusHttpServer#toBuilder()
(#6333) - Bugfix: Use
getPrometheusName
for Otel2PrometheusConverter map keys to avoid metric name conflicts (#6308)
- Add Metric exporter REUSABLE_DATA memory mode configuration options, including autoconfigure
support via env var
OTEL_JAVA_EXPERIMENTAL_EXPORTER_MEMORY_MODE=REUSABLE_DATA
. (#6304) - Add autoconfigure console alias for logging exporter (#6027)
- Update jaeger autoconfigure docs to point to OTLP (#6307)
- Add
ServiceInstanceIdResourceProvider
implementation for generatingservice.instance.id
UUID if not already provided by user. Included inopentelemetry-sdk-extension-incubator
. (#6226) - Add GCP resource detector to list of resource providers in autoconfigure docs (#6336)
- Check for Java 17 toolchain and fail if not found (#6303)
- Lazily initialize the container for events in the SDK Span implementation (#6244)
- Add basic proxy configuration to OtlpHttp{Signal}Exporters (#6270)
- Add connectTimeout configuration option OtlpGrpc{Signal}Exporters (#6079)
- Add ComponentLoader to autoconfigure support more scenarios (#6217)
- Added MetricReader customizer for AutoConfiguredOpenTelemetrySdkBuilder (#6231)
- Return AutoConfiguredOpenTelemetrySdkBuilder instead of the base type (#6248)
- Add note about draft PRs to CONTRIBUTING.md (#6247)
NOTE: The opentelemetry-exporter-jaeger
and opentelemetry-exporter-jaeger-thift
artifacts
have stopped being published. Jaeger
has native support for OTLP, and users
should export to jaeger
using OTLP
instead.
- Add Span#addLink, for adding a link after span start (#6084)
- Bugfix: Ensure span status cannot be updated after set to StatusCode.OK (#6209
- Reusable memory Mode: Adding support for exponential histogram aggregation (#6058, #6136)
- Reusable memory mode: Adding support for explicit histogram aggregation (#6153)
- Reusable memory mode: Adding support for sum aggregation (#6182)
- Reusable memory mode: Adding support for last value aggregation (#6196)
- Recreate / fix graal issue detecting RetryPolicy class (#6139, #6134)
- Restore prometheus metric name mapper tests, fix regressions (#6138)
- WARNING: Remove jaeger exporters (#6119)
- Update dependency
io.zipkin.reporter2:zipkin-reporter-bom
to 3.2.1. Note:ZipkinSpanExporterBuilder#setEncoder(zipkin2.codec.BytesEncoder)
has been deprecated in favor ofZipkinSpanExporterBuilder#setEncoder(zipkin2.reporter.BytesEncoder)
.ZipkinSpanExporterBuilder#setSender(zipkin2.reporter.Sender)
has been deprecated in favor ofZipkinSpanExporterBuilder#setSender(zipkin2.reporter.BytesMessageSender)
. (#6129, #6151) - Include trace flags in otlp marshaller (#6167)
- Add Compressor SPI support to OtlpGrpc{Signal}Exporters (#6103)
- Allow Prometheus exporter to add resource attributes to metric attributes (#6179)
- Autoconfigure accepts encoded header values for OTLP exporters (#6164)
- Return implementation type from
AutoConfiguredOpenTelemetrySdkBuilder.addLogRecordProcessorCustomizer
(#6248)
- Align file configuration with latest changes to spec (#6088)
NOTE: This is the LAST release for opentelemetry-exporter-jaeger
and opentelemetry-exporter-jaeger-thift
. Jaeger
has native support for OTLP, and users
should export to jaeger
using OTLP
instead.
- Ability to access version.properties API file with GraalVM native (#6095)
- Only call SpanProcessor onStart / onEnd if required (#6112)
- Add option to export unsampled spans from span processors (#6057)
- Memory Mode: Adding first part support for synchronous instruments - storage (#5998)
- Base2ExponentialHistogramAggregation maxBuckets must be >= 2 (#6093)
- Convert histogram measurements to double before passing recording exemplar reservoir (#6024)
- Add compressor SPI to support additional compression algos (#5990)
- Test OTLP exporters with different OkHttp versions (#6045)
- Refactor prometheus exporter to use
io.prometheus:prometheus-metrics-exporter-httpserver
, add exponential Histogram support (#6015) - UpstreamGrpcSenderProvider uses minimal fallback managed channel when none is specified (#6110)
- OTLP exporters propagate serialization IOException instead of rethrowing as runtime (#6082)
- Autoconfigure reads normalized otel.config.file property (#6105)
- Fix issue where wrapping "invalid" SpanContexts in Span does not preserve SpanContext (#6044)
- Refactor and add to ExtendedTracer, add ExtendedContextPropagators (#6017)
- Base64 encode AnyValue bytes in string representation (#6003)
- Add connectTimeout configuration option OtlpHttp{Signal}Exporters (#5941)
- Add ability for Otlp{Protocol}LogRecordExporter to serialize log body any value (#5938)
- Android environments can now handle base64 encoded PEM keys, remove exception handling in TlsUtil#decodePem (#6034)
- Add header supplier configuration option to OTLP exporters (#6004)
- Add autoconfigure option for customizing SpanProcessor, LogRecordProcessor (#5986)
- Incubator allows for simpler creation of start-only and end-only SpanProcessors. (#5923)
- Add hasAttributesSatisfying overload to AbstractPointAssert (#6048)
- Building animal sniffer signatures directly from android corelib (#5973)
- Target kotlin 1.6 in kotlin extension (#5910)
- Define language version compatibility requirements (#5983)
- Stabilize explicit bucket boundaries advice API (#5897)
- Allow events to be emitted with timestamp (#5928)
- Add null check to StrictContextStorage (#5954)
- Experimental support for Log AnyValue body (#5880)
- Dismantle AbstractInstrumentBuilder inheritance hierarchy (#5820)
- Fix delta metric storage concurrency bug that allows for lost writes when record operations occur during collection. The fix introduces additional work on record threads to ensure correctness. The additional overhead is non-blocking and should be small according to performance testing. Still, there may be an opportunity for further optimization. (#5932, #5976)
- Prometheus exporter: omit empty otel_scope_info and otel_target_info metrics (#5887)
- JdkHttpSender should retry on connect exceptions (#5867)
- Expand the set of retryable exceptions in JdkHttpSender (#5942)
- Identify OTLP export calls with context key used for instrumentation suppression (#5918)
- Add log support to junit extensions (#5966)
- Add file configuration to autoconfigure (#5831)
- Update to file configuration to use opentelemetry-configuration v0.1.0 (#5899)
- Add env var substitution support to file configuration (#5914)
- Stop setting Resource schemaUrl in autoconfigure (#5911)
- Add AutoConfigureListener to provide components with autoconfigured SDK (#5931)
- Clean up OpenCensus shim (#5858)
- Fix OpenTracing header name issue (#5840)
- Refactor advice API to simplify usage (#5848)
- BatchLogRecordProcessor and BatchSpanProcessor unify
queueSize
metric description and attribute name forprocessorType
(#5836)
- Allow instrument names to contain a forward slash (#5824)
- Memory Mode support: Adding memory mode, and implementing it for Asynchronous Instruments (#5709, #5855)
- Stabilize MetricProducer, allow custom MetricReaders (#5835)
- Drop NaN measurements to metric instruments (#5859)
- Fix flaky MetricExporterConfigurationTest (#5877)
- Add addAllAttributes() to ReadWriteLogRecord. (#5825)
- Prometheus exporter: handle colliding metric attribute keys (#5717)
- File configuration ConfigurationReader handles null values as empty (#5829)
- BREAKING: Stop publishing
io.opentelemetry:opentelemetry-semconv
. Please useio.opentelemetry.semconv:opentelemetry-semconv:1.21.0-alpha
instead, which is published from open-telemetry/semantic-conventions-java. The new repository is published in lockstep with open-telemetry/semantic-conventions. (#5807)
- Add Benchmark workflows (#5842, #5874)
- Add clearer docs around coroutine support with an example (#5799)
- Fix autoconfigure bug creating multiple
PrometheusHttpServer
instances with same port (#5811)
- Add experimental synchronous gauge (#5506)
- Add attributes advice API (#5677, #5722)
- Add AttributesProcessor toString, add attribute filter helper (#5765)
- Increase metric name maximum length from 63 to 255 characters (#5697)
- Prometheus exporter: remove non-ucum units from conversion (#5719)
- Prometheus exporter: add units to metric names in TYPE and HELP comments (#5718)
- Add support for file based configuration to incubator (#5687, #5751, #5758, #5757, #5755, #5763, #5766, #5773, #5771, #5779)
- Autoconfigure ConfigProperties#getMap filters entries with blank values instead of throwing (#5784)
- DEPRECATION:
io.opentelemetry:opentelemetry-semconv
is deprecated for removal. Please useio.opentelemetry.semconv:opentelemetry-semconv:1.21.0-alpha
instead, which is published from open-telemetry/semantic-conventions-java. The new repository is published in lockstep with open-telemetry/semantic-conventions. (#5786)
- Update Gradle Wrapper from 8.2.1 to 8.3 (#5728)
- Remove dependabot and
update-gradle-wrapper
task in favor of renovate (#5746)
- Update Span javadoc to allow null/empty attr values (#5616)
- Add Sdk{Signal}ProviderBuilder#addResource(Resource) method to merge Resource with current (#5619)
- Add LongHistogramAdviceConfigurer to improve api surface types (#5689)
- Instruments with names which are case-insensitive equal contribute to same metric, advice is not part of instrument identity. (#5701)
- Add OtlpHttp{Signal}Exporter#toBuilder() methods (#5652)
- Add OtlpGrpc{Signal}Exporter#toBuilder() methods (#5680)
- Add #toString to OTLP exporters (#5686)
- Break out GrpcSender, GrpcSenderProvider (#5617)
- BREAKING: Delete zpages (#5611)
- Initialize file configuration with generated model classes and parse method (#5399)
- Refactor SpiUtil to improve mocking (#5679)
- Switch from snakeyaml to snakeyaml engine (#5691)
- Add experimental autoconfigure support for customizing cardinality limit (#5659)
- Reorganize autoconfigure docs by signal (#5665)
- Add hasResourceSatisfying to LogRecordDataAssert (#5690)
- Change OpenCensus shim default sampling to defer to OpenTelemetry (#5604)
- Update Gradle Wrapper from 8.2 to 8.2.1 (#5618)
- Fix gradle java version requirement warning (#5624)
- Refer to Adoptium/Temurin instead of AdoptOpenJDK (#5636)
- Use OtelVersionClassPlugin instead of reading version from resource (#5622)
- Enforce build-graal success in required status check (#5696)
opentelemetry-sdk-extension-autoconfigure is now stable! See "SDK Extension" notes below for changes made prior to stabilization.
- Make Advice proper immutable class (#5532)
- Show attributes when async instruments record duplicate measurements (#5542)
- After cardinality limit exceeded record measurements to overflow series (#5560)
- Add HttpSender abstraction with OkHttp implementation (#5505)
- Add HttpSenderProvider SPI (#5533)
- Add JDK 11+ HttpClient HttpSender implementation (#5557)
- Remove unnecessary :exporter:otlp:common dependencies (#5535)
- Fix OTLP exporter artifact name in an error message (#5541)
- Stabilize RetryPolicy API for OTLP exporters (#5524)
- DEPRECATION:
opentelemetry-exporter-jaeger
andopentelemetry-exporter-jaeger-thrift
are now deprecated with the last release planned for 1.34.0 (January 2024) (#5190)
- Mark opentelemetry-sdk-extension-autoconfigure as stable (#5577)
- Refactor autoconfigure registerShutdownHook(boolean) to disableShutdownHook() (#5565)
- AutoConfiguredOpenTelemetrySdkBuilder does not set GlobalOpenTelemetry by default (#5564)
- Add public API to autoconfigure to access environment resource (#5554)
- Move autoconfigure getConfig to internal, remove getResource (#5467)
- Add autoconfigure support for low memory metric temporality setting (#5558)
- DEPRECATION: zpages extension from opentelemetry-sdk-extension-incubator is now deprecated (#5578)
- Publish build scans to ge.opentelemetry.io (#5510)
- Update Gradle Wrapper from 8.0.1 to 8.1.1 (#5531)
- Add action to auto update gradle wrapper (#5511)
The log bridge API / SDK are now stable! Some important notes:
- The contents of
opentelemetry-api-logs
have been merged intoopentelemetry-api
. - The contents of
opentelemetry-exporter-otlp-logs
have been merged intoopentelemetry-exporter-otlp
. - The contents of
opentelemetry-sdk-logs-testing
have been merged intoopentelemetry-sdk-testing
. - The
opentelemetry-sdk-logs
artifact has been marked stable. opentelemetry-sdk-extension-autoconfigure
has changed the default value ofotel.logs.exporter
fromnone
tootlp
.
NOTE: reminder that the Logs Bridge API is not meant for end users. Log appenders use the API to bridge logs from existing log frameworks (e.g. JUL, Log4j, SLf4J, Logback) into OpenTelemetry. Users configure the Log SDK to dictate how logs are processed and exported. See opentelemetry.io for documentation on usage.
- Ensure correct compiled output and sources are included in multi version jar (#5487)
- Fix broken link (#5451)
- Add meaningful
.toString
toNoopLogRecordProcessor
andDefaultOpenTelemetry
(#5493) - Promote log SDK to stable (#5341)
- Reset exponential aggregator scale after collection (#5496)
- Experimental metric reader and view cardinality limits (#5494)
- Merge sdk logs testing (#5431)
- Add a
hasBucketBoundaries()
variant that allows specifying precision (#5457)
- Enable otlp logs by default in autoconfigure (#5433)
- Update to semconv 1.20.0 (#5497)
This release represents the release candidate ("RC") release for the Logs Bridge API / SDK. In the
next release (1.27.0), opentelemetry-api-logs
will be merged into opentelemetry-api
,
opentelemetry-sdk-logs
will be marked as stable, opentelemetry-exporter-otlp-logs
will be
merged into opentelemetry-exporter-otlp
, opentelemetry-sdk-logs-testing
will be merged
into opentelemetry-sdk-testing
, opentelemetry-sdk-extension-autoconfigure
will enable otlp
log exporter by default (i.e. otel.logs.exporter=otlp
). For more details, see tracking
issue #5340. NOTE: reminder that
the Logs Bridge API
is not meant for end users. Log appenders use the API to bridge logs from existing log
frameworks (e.g. JUL, Log4j, SLf4J, Logback) into OpenTelemetry. Users configure the Log SDK to
dictate how logs are processed and exported.
opentelemetry-opentracing-shim
is now stable!
- Create OtelVersion class at build time which is used to resolve artifact version in
Resource
. (#5365)
- Add prototype histogram advice API (i.e. Hints). (#5217)
- Add LogRecord observed timestamp field. (#5370)
- Remove log record timestamp default. (#5374)
- Align BatchLogRecordProcessor defaults with specification. (#5364)
- Rename setEpoch to setTimestamp. (#5368)
- Log SDK cleanup. Move
InMemoryLogRecordExporter
toopentelemetry-sdk-logs-testing
. RenameInMemoryLogRecordExporter#getFinishedLogItems
togetFinishedLogRecordItems
. MoveSdkEventEmitterProvder
to internal package. (#5368)
- Add scaffolding for low level exporter TLS API. (#5362)
- Add new low level TLS APIs on OTLP and Jaeger gRPC exporter builders. (#5280, #5422)
- OTLP LogRecord exporters serialize observed timestamp. (#5382)
- Update prometheus test to reflect new collector behavior. (#5417)
- Prometheus exporter checks metrics name to prevent add duplicated _total suffix. (#5308)
- Add additional OTLP test for authenticator. (#5391)
- Mark opentracing-shim as stable. (#5371)
- Fixes jaeger remote sampler service strategies bug resolving service name. (#5418)
- Fix flaky JaegerRemoteSamplerGrpcNettyTest. (#5385)
- Add new log level TLS APIs on JaegerRemoteSamplerBuilder. (#5422)
- Fix a parameter name typo in autoconfigure-spi module. (#5409)
- Add missing links to deprecated constants in SemanticAttributes. (#5406)
- Update stale workflow. (#5381)
- Skip OWASP dependencyCheck on test modules. (#5383)
- Skip OWASP dependencyCheck on jmh tasks. (#5384)
- Drop create website pull request release step (#5361)
- Cache ImmutableKeyValuePairs#hashCode (#5307)
- Remove streams from B3Propagator (#5326)
- Stop validating instrument unit (#5279)
- Make the Executor for PrometheusHttpServer configurable (#5296)
- Fixing up javadoc to reflect how to create a junit4 OpenTelemetryRule (#5299)
- BREAKING: Autoconfigure drops support
for
otel.exporter.otlp.metrics.default.histogram.aggregation=EXPONENTIAL_BUCKET_HISTOGRAM
. UseBASE2_EXPONENTIAL_BUCKET_HISTOGRAM
instead. (#5290) - JaegerRemoteSampler use upstream grpc implementation if ManagedChannel is set (#5287)
- Adds version to otel tracer instrumentation scope (#5336)
- Adds version to otel tracer instrumentation scope (#5336)
- Update semconv to 1.19.0 and related build tool changes (#5311)
- Optimize DefaultSynchronousMetricStorage iteration to reduce allocations (#5183)
- Avoid exemplar allocations if there are no measurements (#5182)
- Remove boxed primitives from aggregations to reduce allocations (#5184)
- Stop ignoring long measurements in HistogramExemplarReservoir (#5216)
- Remove validations for noop instrument names and units (#5146)
- Allow views to select on instrument unit (#5255)
- Add (internal) TlsConfigHelper for additional TLS configurability (#5246)
- Introduce mTLS support for JaegerRemoteSamplerBuilder (#5209) (#5248)
-
OpenTracing Shim: Update Tracer.close() (#5151)
-
Update version to 1.24.0 (#5198)
-
Post release 1.23.0 (#5202)
- Addresses opencensus-shim trace issues under otel javaagent (#4900)
- Cleanup readmes (#5263)
- Upgrade to gradle 8.0.1 (#5256)
- Fixed example resource provider classname. (#5235)
- Fix case of bug label in open issue workflow (#5268)
- Update semconv to 1.19.0 (#5311)
- Fix bug that broke
AutoConfiguredOpenTelemetrySdk
's shutdown hook. (#5221)
This release is a notable release for metrics:
- The base2 exponential histogram aggregation has been marked as stable. To use, configure
your
MetricExporter
with a default aggregation ofAggregation.base2ExponentialBucketHistogram()
for histogram instruments. If using OTLP exporter with autoconfigure, setOTEL_EXPORTER_OTLP_METRICS_DEFAULT_HISTOGRAM_AGGREGATION=BASE2_EXPONENTIAL_BUCKET_HISTOGRAM
. If using configuring OTLP programatically, useOtlp*MetricExporterBuilder#setDefaultAggregationSelector(DefaultAggregationSelector)
. - The metrics SDK undergone significant internal refactoring which results in reduced complexity and significantly reduced memory allocation during metric collection / export.
- WARNING: Split out Event API from Log API. Event API is now published in
opentelemetry-api-events
. API / SDK usage has also changed - see PR for details. (#5049)
- Add shutdown / close to
OpenTelemetrySdk
(#5100)
- Base2 exponential histogram aggregations are now stable. Add
base2ExponentialBucketHistogram()
toAggregation
. (#5143) - Promote exponential histogram data interfaces to stable package (#5120)
- Add Base2 prefix to internal exponential histogram classes (#5179)
- Add MaxScale config parameter to
Base2ExponentialBucketHistogram
(#5044) - Add close method to
MetricReader
(#5109) - Reuse
AggregatorHandle
with cumulative temporality to reduce allocations (#5142) - Delete notion of accumulation to reduce allocations (#5154)
- Delete bound instruments (#5157)
- Reuse aggregation handles for delta temporality to reduce allocations (#5176)
- Add proper shutdown implementations for all exporters (#5113)
- WARNING: Remove deprecated autoconfigure exemplar filter names. Previous names
none
,all
,with_sampled_trace
have been removed. Usealways_off
,always_on
,trace_based
instead. (#5098) - Add autoconfigure support for "none" option for propagator value (#5121)
- Add autoconfigure support for
parentbased_jaeger_remote
sampler (#5123) - Autoconfigure closes up autoconfigured resources in case of exception (#5117)
- View file based config has switched from snakeyaml to snakeyaml-engine for YAML parsing. (#5138)
- Fix autoconfigure resource providers property docs (#5135)
- WARNING: Merge
opentelemetry-sdk-metrics-testing
intoopentelemetry-sdk-testing
. Stop publishingopentelemetry-sdk-metrics-testing
. (#5144) - Sort spans by start time (parents before children as tiebreaker) to avoid common causes for flaky tests (#5026)
- Add resource assertion methods to
SpanDataAssert
andMetricAssert
(#5160)
- Refactor to remove internal objects
BaseShimObject
andTelemetryInfo
(#5087) - WARNING: Minimize public surface area of OpenTracingShim. Remove
createTracerShim()
,createTracerShim(Tracer)
,createTracerShim(Tracer, OpenTracingPropagators)
. AddcreateTracerShim(TracerProvder,TextMapPropagator,TextMapPropagator)
. (#5110)
- Add OWASP dependency check (#5177)
- WARNING: GlobalOpenTelemetry trigger of autoconfiguration is now opt-in.
Previously,
GlobalOpenTelemetry.get
triggered autoconfiguration ifopentelemetry-sdk-extension-autoconfigure
was detected on the classpath. That behavior is now opt-in by setting environment variableOTEL_JAVA_GLOBAL_AUTOCONFIGURE_ENABLED=true
. (#5010) - Update LoggerBuilder, MeterBuilder, TracerBuilder javadoc (#5050)
- Make closing scope idempotent and non-operational when corresponding context is not current. (#5061)
- Standardize internal usage of
ConfigUtil
for reading environment variables and system properties (#5048)
- Lazily initialize exponential histogram buckets (#5023)
- Delete MapCounter alternative exponential histogram implementation (#5047)
- Add toString to SdkMeter, SdkObservableInstrument, AbstractInstrumentBuilder (#5072)
OtlpGrpcSpanExporter
,OtlpHttpSpanExporter
,OtlpGrpcLogRecordExporter
,OtlpHttpLogRecordExporter
,ZipkinSpanExporter
, andJaegerGrpcSpanExporter
are now instrumented withGlobalOpenTelemetry
by default. Instrumentation initializes lazily to prevent ordering issue of accessingGlobalOpenTelemetry.get
beforeGlobalOpenTelemetry.set
is called. (#4993)- Add
ConfigurableSpanExporterProvider
implementation forJaegerGrpcSpanExporter
(#5002) - Add
ConfigurableSpanExporterProvider
,ConfigurableMetricExporterProvider
,ConfigurableLogRecordExporterProvider
forOtlpGrpc{Signal}Exporter
s andOtlpHttp{SignalExporter
s (#5003) - Replace OTLP User-Agent spaces with dashes (#5080)
- Add
AutoConfigurationCustomizerProvider
implementation forPrometheusHttpServer
(#5053) - Add resource
target_info
and scopetarget_info
metrics toPrometheusHttpServer
in compliance with spec (#5039) - Drop delta metrics in
PrometheusHttpServer
(#5062) - PrometheusHttpServer drops metrics with same name and different type (#5078)
- DEPRECATION: Align autoconfigure exemplar filter names with spec. Previous names
none
,all
,with_sampled_trace
are deprecated. Usealways_off
,always_on
,trace_based
instead. (#5063)
- Add createTracerShim function (#4988)
- WARNING:
opentelemetry-extension-aws
has been removed following its relocation to opentelemetry-java-contrib/aws-xray-propagator, which is published under coordinatesio.opentelemetry.contrib:opentelemetry-aws-xray-propagator:{version}
. We will push security patches to1.20.x
as needed. The latestopentelemetry-bom
will point to the latest published version, currently1.20.1
. (#4945) - Add toString implementation to various propagator components (#4996)
- Add toString implementation to various log SDK components (#4979)
- Add histogram collection benchmark (#4912)
- Add ExponentialHistogramIndexerBenchmark (#4989)
- Stop extra copy of exponential histogram buckets (#5020)
- Zipkin exporter serializes EventData attributes as JSON (#4934)
- Add support for EC mTLS keys (applies to
OtlpHttp{Signal}Exporter
,OtlpGrpc{Signal}Exporter
,JaegerGrpcSpanExporter
,JaegerRemoteSampler
) (#4920) - Add
Configurable{Signal}ExporterProvider
implementations forLogging{Signal}Exporter
s (#4950) - Add
ConfigurableSpanExporterProvider
implementation forZipkinSpanExporter
(#4991) - Add
Configurable{Signal}ExporterProvider
implementations forOtlpJsonLogging{Signal}Exporter
s (#4992) ZipkinSpanExporter
populates remoteEndpoint (#4933)
- BREAKING: Remove support for otel.experimental.sdk.enabled from autoconfigure (#4973)
- De-singleton ZPageServer implementation (#4935)
- Add auto-configure support for logging-otlp exporters (#4879)
- Move DefaultConfigProperties to internal package in
opentelemetry-sdk-extension-autoconfigure-spi
(#5001)
- Make APIs for asserting attributes consistent (#4882)
- Attribute assertions error messages always contain the attr key (#5027)
- Handle unsupported types when setting Attributes (#4939)
- Properly set the status based on the error tag (#4962)
- Handle
io.opentracing.noop.NoopSpan
correctly (#4968) - Log invalid arguments rather than throwing exceptions. (#5012)
- Stop mapping semconv values from OpenTracing to OTel. (#5016)
- Fix bug in
ComponentRegistry
that producesConcurrentModificationException
when reading metrics at the same time as obtaining a meter. (#4951)
- Fix bug in
W3CBaggagePropagator
that caused+
characters to be decoded as whitespace
- DEPRECATION: the
opentelemetry-extension-aws
module containing variousAwsXrayPropagator
implementations has been deprecated for removal in next minor version. A copy of the code will instead be maintained in opentelemetry-java-contrib/aws-xray-propagator and published under coordinatesio.opentelemetry.contrib:opentelemetry-aws-xray-propagator:{version}
. (#4862)
- Add graal hints for shaded dependencies, allowing
JcTools
queue to be used in graal environment. (#4832) Sampler#getDescription()
implementations are now locale independent. (#4877)- Allow SDK to run in environments prohibiting use of
sun.misc.Unsafe
. (#4902)
- Add
toString
toAbstractInstrument
. (#4833) - Add zero bucket boundary to default explicit bucket histogram aggregation. (#4819)
- Optimize log hot path, reducing allocations significantly. (#4913)
- BREAKING: Add
Context
argument toLogRecordProcessor#onEmit
. (#4889)
OtlpLogging{Signal}Exporter
s encode enums as numbers. (#4783)- Add
User-Agent
header ofOTel OTLP Exporter Java/{version}
to OTLP export requests. (#4784)
- WARNING:
opentelemetry-sdk-extension-aws
has been removed following its relocation to opentelemetry-java-contrib/instrumentation-aws-xray, which is published under coordinatesio.opentelemetry.contrib:opentelemetry-aws-resources:{version}
. We will push security patches to1.19.x
as needed. The latestopentelemetry-bom
will point to the latest published version, currently1.19.0
. (#4830) - WARNING:
opentelemetry-sdk-extension-resources
has been removed following its relocation to opentelemetry-java-instrumentation/instrumentation/resources/library, which is published under coordinatesio.opentelemetry.instrumentation:opentelemetry-resources:{version}
. We will push security patches to1.19.x
as needed. The latestopentelemetry-bom
will point to the latest published version, currently1.19.0
. (#4828) - Add autoconfigure support for
BatchLogRecordProcessor
. (#4811) - Autoconfigure performs percent decoding on
otel.resource.attributes
values. (#4653) - Unify compression configuration for exporters including
(#4775):
- Fix handling of
none
in OTLP exporters. - Add
JaegerGrpcSpanExporterBuilder#setCompression(String)
. - Add
ZipkinSpanExporterBuilder#setCompression(String)
.
- Fix handling of
- Add migration notes to deprecated attributes (#4840)
- Use
opentracing-shim
as instrumentation scope name. (#4890) - Add full support for multiple parents. (#4916)
This release contains a large number of changes to the log signal following a series of significant
changes to
the log specification.
The changes include renaming key classes like LogExporter
to LogRecordExporter
,
and LogProcessor
to LogRecordProcessor
, and LogEmitter
to Logger
, and more. Additionally, a
log API component has been added for emitting events and for writing log appenders. Note, the log
API is not a substitute for traditional log frameworks like Log4j, JUL, SLF4J, or Logback. While the
event portion of the API is intended for instrumentation authors and end users, the API for emitting
LogRecords is not.
See LoggerProvider
and Logger javadoc for more
details.
- Add
opentelemetry-bom
as a dependency toopentelemetry-bom-alpha
, ensuring synchronization between alpha and stable artifact versions.
- WARNING:
opentelemetry-extension-annotations
has been removed following its relocation to opentelemetry-java-instrumentation/instrumentation-annotations, which is published under coordinatesio.opentelemetry.instrumentation:opentelemetry-instrumentation-annotations:{version}
. We will push security patches to1.18.x
as needed. The latestopentelemetry-bom
will point to the latest published version, currently1.18.0
.
- Introduce log API for emitting events and writing log appenders. The artifact is available at
coordinates
io.opentelemetry:opentelemetry-api-logs:1.19.0-alpha
.
- Change exponential histogram bucket boundaries to be lower exclusive / upper inclusive, instead of lower inclusive / upper exclusive.
- BREAKING: Rename
SdkLogEmitterProvider
toSdkLoggerProvider
.OpenTelemetrySdkBuilder#setLogEmitterProvider
has changed toOpenTelemetrySdkBuilder#setLoggerProvider
.OpenTelemetrySdk#getSdkLogEmitterProvider
has changed toOpenTelemetrySdk#getSdkLoggerProvider
.AutoConfigurationCustomizer#addLogEmitterProviderCustomizer
has changed toAutoConfigurationCustomizer#addLoggerProviderCustomizer
. - BREAKING: Rename
LogEmitter
toLogger
. - BREAKING: Rename
LogExporter
toLogRecordExporter
.SystemOutLogExporter
has changed toSystemOutLogRecordExporter
.OtlpJsonLoggingLogExporter
has changed toOtlpJsonLoggingLogRecordExporter
.OtlpHttpLogExporter
has changed toOtlpHttpLogRecordExporter
.OtlpGrpcLogExporter
has changed toOtlpGrpcLogRecordExporter
.InMemoryLogExporter
has changed toInMemoryLogRecordExporter
. ConfigurableLogExporterProviderhas changed to
ConfigurableLogRecordExporterProvider`. - BREAKING: Rename
LogData
toLogRecordData
.TestLogData
has changed toTestLogRecordData
. - BREAKING: Rename
LogProcessor
toLogRecordProcessor
.BatchLogProcessor
has changed toBatchLogRecordProcessor
.SimpleLogProcessor
has changed toSimpleLogRecordProcessor
.
- OTLP log record exporters now include dropped_attributes_count.
- Autoconfigure now supports an option to disable the SDK. If
otel.sdk.disabled=true
,AutoConfiguredOpenTelemetrySdk#getOpenTelemetrySdk()
returns a minimal (but not noop)OpenTelemetrySdk
with noop tracing, metric and logging providers. The same minimal instance is set toGlobalOpenTelemetry
. The now deprecated propertyotel.experimental.sdk.enabled
will continue to work in the same way during a transition period. - Fix
ProcessResource
directory separator to use/
or\
instead of:
or;
. - DEPRECATION: the
opentelemetry-sdk-extension-resource
module containing variousResourceProvider
implementations has been deprecated for removal in next major version. A copy of the code will instead be maintained in opentelemetry-java-instrumentation/instrumentation/resources/library and published under coordinatesio.opentelemetry.instrumentation:opentelemetry-resources:{version}
. - DEPRECATION: the
opentelemetry-sdk-extension-aws
module containing AWSResourceProvider
implementations has been deprecated for removal in next major version. A copy of the code will instead be maintained in opentelemetry-java-contrib/aws-resources and published under coordinatesio.opentelemetry.contrib:opentelemetry-aws-resources:{version}
.
- Fully support Baggage-only propagation.
- The semantic conventions have been updated to 1.13.0.
- Added scope attributes to
InstrumentationScopeInfo
accessible viaInstrumentationScopeInfo#getAttributes()
. Will add the ability to specify scope attributes in Meter, Tracer, and Logger in a future version. - DEPRECATION: The
InstrumentationScopeInfo#create(String, String, String)
method has been deprecated in favor ofInstrumentationScopeInfo#builer(String).setVersion(String).setSchemaUrl(String).build()
. - Optimize
Resource#merge(Resource)
by returning early if the other resource is empty.
- Fix module name of
opentelemetry-sdk-logs
by changing fromio.opentelemetry.sdk.extension.logging
toio.opentelemetry.sdk.logs
.
- Add methods to assert attributes do not contain keys via
AttributeAssert#doesNotContainKey()
.
- Added ability to specify local IP address in
ZipkinSpanExporter
viaZipkinSpanExporterBuilder#setLocalIpAddressSupplier(Supplier<InetAddress>)
. - Upgrade to OTLP protobuf version 0.19.0.
- OTLP exporters now serialize
InstrumentationScopeInfo#getAttributes()
. - Stop publishing
opentelemetry-exporter-jaeger-proto
. Theopentelemetry-bom
will include a constraint on the last published version1.17.0
. If security issues are discovered, patches will be published to1.17.x
.
- BREAKING:
opentelemetry-sdk-extension-metric-incubator
,opentelemetry-sdk-extension-tracing-incubator
, andopentelemetry-sdk-extension-zpages
merged intoopentelemetry-sdk-extension-incubator
. - BREAKING: Move
opentelemetry-sdk-extension-jfr-events
to opentelemetry-java-contrib/jfr-events. It will now be published under the coordinatesio.opentelemetry.contrib:opentelemetry-jfr-events:{version}
. - BREAKING: Move
opentelemetry-extension-noop-api
to opentelemetry-java-contrib/noop-api. It will now be published under the coordinatesio.opentelemetry.contrib:opentelemetry-noop-api:{version}
. - Improve ECS resource detection to include
aws.ecs.container.arn
,container.image.name
,container.image.tag
,aws.ecs.container.image.id
,aws.log.group.arns
,aws.log.group.names
,aws.log.steam.names
,aws.ecs.task.arn
,aws.ecs.task.family
, andaws.ecs.task.revision
. - Fix resource
container.id
detection when using k8s with containerd v1.5.0+. - Add experimental
ConditionalResourceProvider
SPI, for conditionally applying resource providers based on current config and resource.
- BREAKING: Move
opentelemetry-micrometer1-shim
to opentelemetry-java-instrumentation/instrumentation/micrometer/micrometer-1.5/library. It will now be published under the coordinatesio.opentelemetry.instrumentation:opentelemetry-micrometer-1.5:{version}
.
- DEPRECATION: the
opentelemetry-extension-annotations
module containing@WithSpan
and@SpanAttribute
annotations has been deprecated for removal in next major version. A copy of the code will instead be maintained in opentelemetry-java-instrumentation/instrumentation-annotations and published under coordinatesio.opentelemetry.instrumentation:opentelemetry-instrumentation-annotations:{version}
.
- Add default implementation for
SpanData#getInstrumentationScopeInfo()
andReadableSpan#getInstrumentationScopeInfo()
. This fixes a previous mistake where those interfaces were extended without default implementation, a breaking change for source compatibility. Stricter checks have been added to ensure this mistake is not repeated.
- BREAKING: delete
LogDataBuilder
. A similar implementation ofLogData
calledTestLogData
has been added toopentelemetry-sdk-logs-testing
. - BREAKING: rename
LogProcessor#emit(LogData)
toLogProcessor#onEmit(ReadWriteLogRecord)
. The argument change fromLogData
toReadWriteLogRecord
allows implementations to mutate logs. To obtainLogData
, callReadWriteLogRecord#toLogData()
. - Optimize
SdkLogEmitterProvider
to return noopLogEmitter
when noLogProcessor
s are registered.
- Split out shared and internal exporter classes from
opentelemetry-exporter-otlp-common
toopentelemetry-exporter-common
. - Add experimental support for OTLP header based authentication. To use, add a dependency
on
opentelemetry-exporter-common
and callio.opentelemetry.exporter.internal.auth.Authenticator#setAuthenticatorOnDelegate(OtlpHttp{Signal}Builder, Authenticator)
. - Add ability to collect export metrics on
ZipkinSpanExporter
viaZipkinSpanExporter#setMeterProvider(MeterProvider)
. - Minor optimization to OkHttp based exporters to cache endpoint URLs. Applies
to
OtlpHttp{Signal}Exporter
,OtlpGrpc{Signal}Exporter
, and more. - Fix diagnostic log message in
OtlpGrpc{Signal}Exporter
to include correct environment variables.
- Extend View file based configuration with support for specifying explicit bucket histogram bucket boundaries and exponential bucket counts.
- Extend autoconfigure SPI
AutoConfigurationCustomizerProvider
andResourceProvider
with option to specify ordering. - Add autoconfigure SPI with
ConfigurableLogExporterProvider
, allowing custom named log exporters to be provided and selected via autoconfigure. - Extend autoconfigure SPI with
AutoConfigurationCustomizer#addPropertiesCustomizer
, providing the ability examine current configuration properties and add / overwrite properties.
- Fix bug
ImmutableKeyValuePairs
implementation that causesArrayIndexOutOfBoundsException
to be thrown under certain conditions.
- Optimize
BatchSpanProcessor
using JcTools.
- Tighten up exponential histogram implementation for alignment with specification: Default to 160 positive and negative buckets. Remove ability to configure starting scale. Minimum number of buckets is one instead of zero.
- Allow
MetricExporter
andMetricReader
to influence default aggregation. The default aggregation is used when no registered views match an instrument.
- Fix handling of client keys in PEM format.
- For OTLP exporters, change behavior to use
OkHttpGrpcExporter
(OkHttp implementation that doesn't use any gRPC dependencies) unlessOtlpGrpc{Signal}Builder#setChannel(ManagedChannel)
is called by user. Previously,OkHttpGrpcExporter
was used if no gRPC implementation was found on classpath. - Add support to configure default aggregation on OTLP metric exporters
via
Otlp{Protocol}MetricExporterBuilder#setDefaultAggregationSelector(DefaultAggregationSelector)
.
- Add span status assertions.
- Autoconfigure properly handles non-string system properties.
- Autoconfigure normalizes hyphens
-
to periods.
when accessingConfigProperties
.
- Add support for span wrappers.
- Store OpenTracing
SpanContext
in OpenTracingSpan
wrapper. - Use
Baggage
of active span.
- Add batch callback API, allowing a single callback to record measurements to multiple metric instruments.
SdkMeterProvider#toString()
now returns a useful string describing configuration.- Fix bug preventing proper function of Metrics SDK when multiple readers are present (#4436).
- Fix reporting intervals for metrics for delta readers (#4400).
- BREAKING: merge all stable OTLP exporters into
opentelemetry-exporter-otlp
.opentelemetry-exporter-otlp-trace
,opentelemetry-exporter-otlp-metrics
,opentelemetry-exporter-otlp-http-trace
, andopentelemetry-exporter-otlp-http-metrics
are no longer published and their contents have been merged into a single artifact. - BREAKING: merge log OTLP exporters into
opentelemetry-exporter-otlp-logs
.opentelemetry-exporter-otlp-http-logs
is no longer published and its contents have been merged into a single artifact. - Upgrade to OTLP protobuf version 0.18.0.
- RetryInterceptor retries on
SocketTimeoutException
with no message. - Added
JaegerGrpcSpanExporterBuilder#setMeterProvider()
, enabling support of experimental jaeger span export metrics. - DEPRECATION: the
opentelemetry-exporter-jaeger-proto
module containing jaeger proto definitions and corresponding generated classes is deprecated for removal in next major version. - OTLP gRPC exporters support overriding
:authority
viaOtlpGrpc*ExporterBuilder#addHeader("host", "my-authority-override")
.
- BREAKING: Move
ConfigureableMetricExporterProvider
fromopentelemetry-sdk-extension-autoconfigure
to stableopentelemetry-sdk-extension-autoconfigure-spi
. - Autoconfigure now supports multiple values for
otel.metrics.exporter
. - Autoconfigure now supports general attribute limits, applicable to span attributes, span event attributes, span link attributes, and log attributes.
- Autoconfigure now supports an experimental option to disable the SDK.
If
otel.experimental.sdk.enabled=true
,AutoConfiguredOpenTelemetrySdk#getOpenTelemetrySdk()
returns a minimal (but not noop)OpenTelemetrySdk
. The same minimal instance is set toGlobalOpenTelemetry
. - New "get or default" methods have been added to
ConfigProperties
. E.g.ConfigProperties#getString("otel.metrics.exporter", "otlp")
fetches the value for the propertyotel.metrics.exporter
and returnsotlp
if it is not set. - Fix bug in
ContainerResource
provider that caused it to throw an exception in some instances when containerd is used.
- Cache descriptions such that metrics with the same name use the first seen description.
The metrics SDK is stable! New stable artifacts include:
io.opentelemetry:opentelemetry-sdk-metrics
(also now included inio.opentelemetry:opentelemetry-sdk
)io.opentelemetry:opentelemetry-exporter-otlp-metrics
(also now included inio.opentelemetry:opentelemetry-exporter-otlp
)io.opentelemetry:opentelemetry-exporter-otlp-http-metrics
- Metrics testing components have been moved
from
io.opentelemetry:opentelemetry-sdk-metrics-testing
to the stableio.opentelemetry:opentelemetry-sdk-testing
.
While the API of the metrics SDK is now stable, there are a couple of known issues that will be addressed in the next release:
- The start time is incorrect for delta metrics when the first recording for a set of attributes occurs after the first collections (#4400).
- Registering multiple readers results in incorrect metrics (#4436).
- Fix bug where non-runtime exception breaks
BatchSpanProcessor
. - Fix bug preventing attribute limits from applying to exception events.
- BREAKING: Drop deprecated methods referencing
InstrumentationLibraryInfo
from Log SDK.
- Instrument name is validated. If invalid, a warning is logged and a noop instrument is returned.
- Default unit is empty instead of
1
. If an invalid unit is set, a warning is logged and empty is used. - Ensure symmetry between type of
PointData
and their type of exemplars (double or long). - BREAKING: Rename
MetricReader#flush()
toMetricReader#forceFlush()
. - Introduce
AggregationTemporalitySelector
interface for selecting aggregation temporality based on instrument.MetricReader
andMetricExporter
extendAggregationTemporalitySelector
.
- BREAKING: Remove deprecated option to specify temporality
with
otel.exporter.otlp.metrics.temporality
. Useotel.exporter.otlp.metrics.temporality.preference
instead. - Log warning when
AwsXrayPropagator
can't identify parent span id. - Fix jaeger remote sampling bug preventing correct parsing of 0-probability sampling strategies.
- Fix prometheus exporter formatting bug when there are no attributes.
- Ensure prometheus metrics with the same name are serialized as a group.
- BREAKING:
OtlpHttpMetricExporterBuilder
andOtlpGrpcMetricExporterBuilder
configure aggregation temporality via#setAggregationTemporalitySelector(AggregationTemporalitySelector)
.
- BREAKING: Metrics testing components added to stable
io.opentelemetry:opentelemetry-sdk-testing
module, includingInMemoryMetricReader
,InMemoryMetricExporter
, andMetricAssertions.assertThat(MetricData)
has been moved toOpenTelemetryAssertions.assertThat(MetricData)
. - BREAKING: The patterns for metrics assertions have been adjusted to better align with assertj conventions. See #4444 for examples demonstrating the change in assertion patterns.
- BREAKING: Metric assertion class names have been simplified.
- Add
TraceAssert.hasSpansSatisfyingExactlyInAnyOrder(..)
methods.
- Instrumentation scope name changed to
io.opentelemetry.micrometer1shim
.
- Many improvements to the build and release workflows. Big thanks to @trask for driving
standardization across
opentelemetry-java
,opentelemetry-java-instrumentation
, andopentelemetry-java-contrib
!
Although we originally intended 1.13.0 to be the first stable release of the metrics SDK, we've
postponed it out of caution due to a large number of changes in both the metrics SDK specification
and the java implementation. This release should be considered a release candidate for the metrics
SDK. There are several notable changes mentioned in the Metrics section. Additionally, please note
that the Auto-configuration module now enables metric export by default via OTLP, i.e. by
default otel.metrics.exporter
is set to otlp
instead of none
.
- Fix
TraceStateBuilder
reuse bug.
InstrumentationScopeInfo
replacesInstrumentationLibraryInfo
. Methods returningInstrumentationLibraryInfo
are deprecated.- Add
ResourceBuilder#removeIf(Predicate)
method for symmetry withAttributesBuilder
.
- Span events that record exceptions are instances of
ExceptionEventData
.
- BREAKING: Remove
MetricReader
factory pattern:MetricReader
instances, rather thanMetricReaderFacotry
, are registered withSdkMeterProviderBuilder
. For example:SdkMeterProvider.builder().registerMetricReader(PeriodicMetricReader.builder(exporter).build())
.MetricReader
does not support custom implementations. Built-in readers include:PeriodicMetricReader
,PrometheusHttpServer
, and for testing,InMemoryMetricReader
.
- BREAKING: Several breaking changes metrics to the
Data
classes:MetriaData
returnsInstrumentationScopeInfo
instead ofInstrumentationLibraryInfo
.MetricData
factories classes have been moved internal.- Exemplar data classes have been migrated to interfaces, and deprecated methods have been removed.
- PointData classes have been migrated to interfaces.
ValueAtPercentile
has been converted toValueAtQuantile
to reflect specification.- Drop
HistogramPointData
utility methods for finding bucket bounds.
- BREAKING: Move
InstrumentType
andInstrumentValueType
toio.opentelemetry.sdk.metrics
package. - BREAKING: Several breaking changes to the
InstrumentSelector
/View
APIs:InstrumentSelector
/View
and corresponding builders have been moved toio.opentelemetry.sdk.metrics
package.InstrumentSelector
meter selection criteria has been inlined andMeterSelector
has been removed.InstrumentSelector
criteria has been reduced to reflect specification. All fields are exact match, except instrument name which accepts wildcard*
and?
matches.- If
InstrumentSelectorBuilder#build()
is called without any selection criteria, an exception will be thrown. View
baggage appending attribute processor has been removed. Available for experimental use viaSdkMeterProviderUtil#appendFilteredBaggageAttributes
.- Concept of
AttributeProcessor
has been moved internal. - If a View configures an aggregation that is not compatible with the instrument type of a selected instrument, a warning is logged and the View is ignored.
- BREAKING: Remove deprecated
Aggregation#histogram()
. UseAggregation#explicitBucketHistogram()
instead. - Relax behavior around conflicting instruments. If you register two instruments with the same name but conflicting description, unit, type, or value type, both will be exported and a warning will be logged indicating the metric identity conflict. Previously, the second registered would have produced a noop instrument. Likewise, if two views are registered that produce instruments with conflicting names, or if an instrument conflicts with a registered view's name, both will be exported and a warning will be logged indicating the view conflict.
- BREAKING: Exemplars have been moved to internal. By default, exemplars are enabled
with
with_sampled_trace
filter. This can be adjusted via experimental APIs viaSdkMeterProviderUtil#setExemplarFilter
. - BREAKING:
MetricExporter#getPreferredTemporality()
has been removed and replaced withgetAggregationTemporality(InstrumentType)
, which allows exporters to dictate the aggregation temporality on a per-instrument basis.MetricExporter#alwaysCumulative(InstrumentType)
andMetricExporter#deltaPreferred(Instrument)
are provided as utilities representing common configurations. - Callbacks associated with asynchronous instruments with multiple matching views will only be called once per collection, instead of once per view per collection.
PeriodicMetricReader
will no longer callMetricExporter#export
if no metrics are available.- BREAKING:
SdkMeterProviderBuilder#setMinimumCollectionInterval
has been removed. Available for experimental use viaSdkMeterProviderUtil#setMinimumCollectionInterval
. - Introduce lock ensuring that metric collections occur sequentially.
- Add min and max to
HistogramDataPoint
.
- BREAKING: Deprecated name field has been removed.
- Upgrade to OTLP protobuf version 0.16.0.
- Jaeger and Zipkin exporters export
otel.scope.name
andotel.scope.version
, in addition tootel.library.name
andotel.library.version
which are retained for backwards compatibility. - BREAKING: Remove deprecated
PrometheusCollector
. UsePrometheusHttpServer
instead. - Add support for mTLS authentication to OTLP and jaeger exporters.
- Only log once if OTLP gRPC export receives
UNIMPLEMENTED
. - Jaeger remote sampler sets appropriate sampling strategy type if not provided in response.
- BREAKING: The
setPreferredTemporality
method has been removed fromOtlpGrpcMetricExporterBuilder
andOtlpHttpMetricExporterBuilder
. UsesetAggregationTemporality(Function<InstrumentType, AggregationTemporality>)
instead.
- IMPORTANT: Auto-configuration sets
otel.metrics.exporter
tootlp
instead ofnone
, enabling metric export by default. - Auto-configuration added
otel.java.enabled.resource-providers
property for opting into specific resource providers.
- Bring micrometer shim over from
opentelemetry-java-instrumentation
. Artifact is available at maven coordinatesio.opentelemetry:opentelemetry-micrometer1-shim:1.13.0-alpha
. - Add support for "prometheus mode", enabling better naming when exporting micrometer metrics via prometheus.
- Add int overload for equalTo attribute assertion.
- Add
SpanDataAssert.hasAttribute
methods.
This release includes many breaking changes to the metrics SDK as we move towards marking its first stable release.
Notably, if you configure metric View
s or have written a custom metric exporter, many of the classes and methods will
have been moved or renamed. There are still a few remaining cleanups targeted for the next release after which there
should not be many. Thanks for bearing with us on this.
- New methods have been added to
Context
to propagate context for common Java 8 callback types AttributesBuilder.put
now supports vararg versions for lists withAttributeKey
- Multiple metric async callbacks can be registered for the same instrument, and callbacks can be removed
- An issue with Android desugaring of the SDK has been worked around
- EXPERIMENTAL: Support for disabling resource keys with
OTEL_EXPERIMENTAL_RESOURCE_DISABLED_KEYS
- Fixed handling of
schemaUrl
inResource.toBuilder()
- BREAKING: Many changes to
Data
classes used during export - BREAKING: Many view configuration methods have been removed
- APIs deprecated in the previous release have been removed
- DEPRECATION:
PrometheusCollector
for exporting OpenTelemetry metrics with the prometheus client library has been deprecated - EXPERIMENTAL: File-based configuration of views
- Prometheus exporter now supports JPMS modules
- DEPRECATION:
LogData.getName
has been deprecated for removal
- Examples moved to opentelemetry-java-examples
- Switch Jaeger remote sampler to use grpc lite
- Deprecate
.setChannel(ManagedChannel)
methods on OTLP gRPC exporters - Deprecate
.setChannel(ManagedChannel)
methods on Jaeger gRPC exporter - Experimental OTLP retry support now retries on connection timeouts
- BREAKING Change: Deprecated
InMemoryMetricExporter
andInMemoryMetricReader
have been removed. Use versions inopentelemetry-sdk-metrics-testing
instead - Deprecate
InstrumentType
valuesOBSERVABLE_SUM
andOBSERVABLE_UP_DOWN_SUM
in favor ofOBSERVABLE_COUNTER
andOBSERVABLE_UP_DOWN_COUNTER
- Add ability to configure log attribute limits via
SdkLogEmitterProviderBuilder#setLogLimits(..)
- Auto-configuration added options to
AutoConfigurationCustomizer
for customizingSdkTracerProviderBuilder
,SdkMeterProviderBuilder
,MetricExporter
,SdkLogEmitterProviderBuilder
, andLogExporter
- Auto-configuration added option to skip shutdown hooks
- Auto-configuration adjusted the execution order of tracer and meter provider customization to happen after autoconfiguration
- Auto-configuration adjusted SPI factories to evaluate lazily
- Auto-configuration now uses sets configured
SdkMeterProvider
onBatchLogProcessor
andBatchSpanProcessor
- Auto-configuration deprecated
SdkTracerProviderConfigurer
in favor ofAutoConfigurationCustomizer#addTracerProviderCustomizer(..)
- Fix issue preventing registration of PrometheusCollector with SDK
- Allow retry policy to be set for OkHttpGrpcExporter
- Performance of
GlobalOpenTelemetry.get
improved buildWithCallback
for asynchronous metrics now return interfaces instead of void. The interfaces are empty but will allow adding functionality in the future- BREAKING CHANGE:
Double/LongMeasurement.observe
have been removed - BREAKING CHANGE:
GlobalMeterProvider
has been removed - BREAKING CHANGE:
ObservableMeasurement
, an empty interface, has been removed. This type was not previously deprecated but is expected to have no use in apps due to the lack of functionality - The Metrics API has been merged into the
opentelemetry-api
artifact.OpenTelemetry.getMeterProvider()
is the new entrypoint - BREAKING CHANGE: Bound metrics instruments have been removed for now to allow more time to bake while still providing a stable metrics API
Double/LongMeasurement.observe
has been renamed torecord
.observe
is deprecated in this releaseGlobalMeterProvider
has been deprecated.GlobalOpenTelemetry.getMeterProvider
should be used instead- A warning is logged now when registering async instruments with the same name. Previously subsequent invocations were just ignored.
GlobalOpenTelemetry
extended with helpers for meter creation
- The semantic conventions have been updated to 1.8.0
- Deprecated methods have been removed from the
opentelemetry-sdk-autoconfigure
artifact.
- The OkHttp gRPC exporters now support experimental retry
- OkHttp dispatcher threads are now spawned as daemon threads
- The JPMS module name for the logs exporter has been fixed
- Metrics exporters can have temporality configured
- HTTP exporters now support experimental retry
- Jaeger exporter allows setting trusted certificates
- gRPC exporter metric typos corected
InMemoryMetricExporter
has been moved to theopentelemetry-sdk-metrics-testing
artifact. The current class has been deprecated in this release- Metric instrument usage violations consistently report issues as debug logs
- Some user callbacks have been wrapped to catch exceptions instead of throwing
- MinMaxSumCount/Count aggregation has been removed
- Empty aggregator is renamed to
drop
- Cumulative aggregations will not be aggressively dropped every collection cycle
- A
opentelemetry-sdk-logs-testing
module has been added SdkLogEmitterProvider
is now available throughOpenTelemetrySdk
- LogDataBuilder can now take a SpanContext directly
- SdkLogEmitterProvider.get convenience method added
- HTTP requests now use OkHttp instead of the JDK
- Shim span attributes are set before the span is created instead of after
- Exceptions are not thrown when activating a null span
- BREAKING CHANGE: Deprecated trace incubator types (DelegatingSpanData, SpanDataBuidler) have been removed
- BREAKING CHANGE: Deprecated
ExecutorServiceSpanProcessor
has been removed cloud.platform
is now populated in AWSResource
- Auto-configuration correctly uses configured class loader for configuring Resource
- Auto-configuration prints a debug log with the resolved tracer configuration
- Auto-configuration supports the logs signal
- In Prometheus exporter, only populate exemplars for Prometheus types that support them
- Fix proto encoding of oneof values in metrics
- Correctly cleanup OkHttp client resources when shutting down exporters
- IMPORTANT: The deprecated
io.opentelemetry:opentelemetry-proto
module was removed. Java bindings for OTLP protobufs are now published via opentelemetry-proto-java, and available at maven coordinatesio.opentelemetry.proto:opentelemetry-proto
.
- New
AttributesBuilder#remove(String)
andAttributeBuilder#removeIf(Predicate<AttributeKey<?>>)
methods improve ergonomics of modifying attributes. W3CBaggagePropagator
now encodes baggage values in URL encoded UTF-8 format, per the W3C Baggage Specification.
DelegatingSpanData
has been promoted from incubation and is now available in the Trace SDK. TheDelegatingSpanData
class in theio.opentelemetry:opentelemetry-sdk-extension-tracing-incubator
module is now deprecated.
- The prometheus metric exporter now includes the
time_unix_nano
representing the epoch timestamp when collection occurred. - The OTLP
grpc
exporters (OtlpGrpcSpanExporter
,OtlpGrpcLogExporter
, andOtlpGrpcMetricExporter
) now include a default client implementation (okhttp
). If agrpc
implementation is detected on the classpath it will be used, but the exporters now work "out of the box" with no additional dependencies.
- IMPORTANT: The deprecated
io.opentelemetry:opentelemetry-sdk-extension-async-processor
module was removed. This module is now published via opentelemetry-java-contrib, and available at maven coordinatesio.opentelemetry.contrib:opentelemetry-disruptor-processor
. - The
ExecutorServiceSpanProcessor
from theio.opentelemetry:opentelemetry-sdk-extension-tracing-incubator
module is now deprecated.
- This release includes a rework of the Log SDK to
implement OTEP-0150
and to have more symmetry to the Trace SDK.
LogSink
is nowLogEmitter
.LogEmitter
instances are obtained fromSdkLogEmitterProvider
. Other additions includeMultiLogProcessor
(accessed viaLogProcessor#composite(...)
),SimpleLogProcessor
,InMemoryLogExporter
,OtlpJsonLoggingLogExporter
, andSystemOutLogExporter
. - The Log SDK maven coordinates have changed
from
io.opentelemetry:opentelemetry-sdk-extension-logging
toio.opentelemetry:opentelemetry-sdk-logs
.
- The
new InMemoryMetricReader()
constructor has been deprecated. UseInMemoryMetricReader.create()
instead. - A typo in
Aggregation.explictBucketHistogram()
has been fixed, and is now accessible atAggregation.explicitBucketHistogram()
. - The
PeriodicMetricReader#builder(MetricExporter)
builder replacesPeriodicMetricReader#newMetricReaderFactory(MetricExporter, Duration)
. - Aggregation temporality is now influenced by metric exporters, and the ability to configure
aggregation temporality via the view API has been removed. For example, the OTLP metric exporters
support both
DELTA
andCUMULATIVE
temporality.CUMULATIVE
is the default preferred, but this can be changed either via programmatic configuration or viaOTEL_EXPORTER_OTLP_METRICS_TEMPORALITY
if using autoconfigure. - The
MeterProvider#get(String instrumentationName, String instrumentationVersion, String schemaUrl)
method is deprecated. UseMeterProvider#meterBuilder(String instrumentationName)
with corresponding builder setters instead. - Metric cardinality defenses have been added. Each instrument view now can have at most 2000 distinct metric streams per collection cycle. Recordings for additional streams are dropped with a diagnostic log message. Additionally, cumulative metric streams (both for synchronous and asynchronous instruments) are aggressively forgotten each time a metric export occurs that does not include recordings for a particular stream. The net effect is that there is now a cap on metric memory consumption.
- BREAKING CHANGE: Remove deprecated
otel.experimental.exporter.otlp.protocol
,otel.experimental.exporter.otlp.{signal}.protocol
properties. Please useotel.exporter.otlp.protocol
,otel.exporter.otlp.{signal}.protocol
instead. - The autoconfigure module has introduced a powerful new
AutoConfiguredOpenTelemetrySdkBuilder
, and SPI for programmatically configuring the builder withAutoConfigurationCustomizerProvider
. This provides improved ergonomics and control around autoconfigure customization. - Added experimental support for enabling OTLP retry support for the
grpc
exporters. If enabled viaotel.experimental.exporter.otlp.retry.enabled
, a default retry policy will be used. - The metric export interval of
PeriodicMetricReader
is now configured viaotel.metric.export.interval
. The existingotel.imr.export.interval
property has been deprecated. - The SPI classloader can now be specified when using the autoconfigure module programmatically.
- BUGFIX: In 1.7.0, the
okhttp-based exporters (
OtlpHttpSpanExporter
,OtlpHttpMetricExporter
,OtlpHttpLogExporter
) did not properly close the okhttp response and hence would leak connections. This has been fixed in 1.7.1.
- IMPORTANT: The
io.opentelemetry:opentelemetry-proto
module should now be considered deprecated. It will be removed from publications in a future release. If you need Java bindings for the OTLP protobufs, they are now being published via the new opentelemetry-proto-java repository. They are at new maven coordinates:io.opentelemetry.proto:opentelemetry-proto
and versioning is aligned with the released version of the protobuf definitions themselves.
- BREAKING CHANGE: The Jaeger gRPC exporter does not directly use the
protobuf-java
library for marshaling trace data. Along with this, theopentelemetry-exporter-jaeger
artifact does not contain generated protobuf classes for the Jaeger API. If you were using these in your application, you must update your build configuration to also include the newjaeger-proto
artifact. This artifact will not be included in a future 2.0 release of the SDK so it is recommended to instead generated the protobuf classes in your own build. - BREAKING CHANGE: The
opentelemetry-exporter-otlp-http-*
exporter default endpoint ports have changed from4317
to4318
, in line with recent changes to the spec. - The OTLP gRPC exporters will now function without the
grpc-java
dependency, ifokhttp
is present on the classpath. - The (alpha) metrics that are generated by the gRPC exporters have changed slightly. They now have
a slightly different instrumentation library name,
"io.opentelemetry.exporters.otlp-grpc"
and the names of the metrics have also changed. Now emitted are metrics with namesotlp.exporter.seen
andotlp.exported.exported
. Note that it is likely this will change in the future as the metrics semantic conventions are more defined.
- BREAKING CHANGE: The behavior of
otel.exporter.otlp.endpoint
has changed when the protocol ishttp/protobuf
. The new behavior is in line with recent changes to the specification, which states that the signal path (e.g.v1/traces
orv1/metrics
) is appended to the configured endpoint. Values for signal specific endpoint configuration ( e.g.otel.exporter.otlp.traces.endpoint
andotel.exporter.otlp.metrics.endpoint
) override the generic endpoint configuration and are used as-is without modification. - The
compression
option for exporters now explicitly supports thenone
value, in addition to the existinggzip
value.
- BREAKING CHANGE: The
IntervalMetricReader
has been removed, and replaced with aPeriodicMetricReader
that provides an implementation of the newMetricReader
interface. - This release includes initial support for multiple exporters to be configured for a single SDK
instance. See the
SdkMeterProviderBuilder.registerMetricReader
method for more details. - This release includes initial support for the SDK recording of Metric Exemplars for sampled Spans.
See
SdkMeterProviderBuilder.setExemplarFilter
and theExemplarFilter
interface for more details.
- This release includes SDK extension interfaces for
LogProcessor
s andLogExporter
s, and has implementations for batch log processing and export via OTLP. These classes are intended for usage in implementations of log appenders that emit OTLP log entries.
- Various performance optimizations
- 1 and 2 element Attributes instances now bypass some logic to reduce object allocations.
- The result of
hashCode()
ofAttributeKey
is now cached. - Checks for base-16 validity of TraceId and SpanId have been optimized.
- Internally created
SpanContext
instances now bypass unneeded validation.
- The
SemanticAttributes
andResourceAttributes
classes have been updated to match the semantic conventions as of specification release1.6.1
.
- The
io.opentelemetry.sdk.trace.ReadableSpan
interface has been expanded to include agetAttribute(AttributeKey)
method. - The
io.opentelemetry.sdk.trace.SpanLimits
class now supports enforcing a maximum Span attribute length (measured in characters) on String and String-array values.
- The OTLP exporters have been undergone a significant internal rework. Various performance optimizations have been done on process of converting to the OTLP formats.
- The OTLP metric exporter no longer exports the deprecated metric
Labels
, onlyAttributes
. This means that your collector MUST support at least OTLP version0.9.0
to properly ingest metric data. - BREAKING CHANGE: The
OtlpHttpMetricExporter
class has been moved into theio.opentelemetry.exporter.otlp.http.metrics
package. - BUGFIX: The
OtlpGrpcSpanExporter
andOtlpGrpcMetricExporter
will now wait for the underlying grpc channel to be terminated when shutting down. - The OTLP exporters now optionally support
gzip
compression. It is not enabled by default.
- The
AwsXrayIdGenerator
in theopentelemetry-sdk-extension-aws
module has been deprecated. This implementation has been superseded by the one in the opentelemetry-java-contrib project and will not be maintained here going forward.
- The
otel.traces.exporter
/OTEL_TRACES_EXPORTER
option now supports a comma-separated list of exporters. - The Metrics SDK will no longer be configured by default. You must explicitly request an exporter configuration in order to have a Metrics SDK configured.
- BREAKING CHANGE: All SPI interfaces are now in a separate module from the autoconfiguration
module:
opentelemetry-sdk-extension-autoconfigure-spi
. - BREAKING CHANGE:
ConfigProperties
andConfigurationException
have been moved to a new package (io.opentelemetry.sdk.autoconfigure.spi
) and module (opentelemetry-sdk-extension-autoconfigure-spi
). - BREAKING CHANGE: All SPI interfaces now take a
ConfigProperties
instance on their methods. - BUGFIX: Exceptions thrown during the loading of an SPI implementation class are now handled more gracefully and will not bubble up unless you have explicitly requested the bad implementation as the one to use.
- You can now specify
gzip
compress for the OTLP exporters via theotel.exporter.otlp.compression
/OTEL_EXPORTER_OTLP_COMPRESSION
configuration option. - You can now specify maximum Span attribute length via the
otel.span.attribute.value.length.limit
/OTEL_SPAN_ATTRIBUTE_VALUE_LENGTH_LIMIT
configuration option.
- BREAKING CHANGES: The metrics SDK has numerous breaking changes, both behavioral and in the SDK's
configuration APIs.
- The default aggregation for a
Histogram
instrument has been changed to be a Histogram, rather than a Summary. - Registration of Views has undergone significant rework to match the current state of the SDK specification. Please reach out on CNCF slack in the #otel-java channel, or in a github discussion if you need assistance with converting to the new Views API.
- The OTLP exporter no longer exports the deprecated metric
Labels
, onlyAttributes
. This means that your collector MUST support at least OTLP version0.9.0
to properly ingest metric data. - It is no longer possible to provide custom aggregations via a View. This feature will return in the future.
- The default aggregation for a
- The
io.opentelemetry.context.ContextStorage
interface now allows providing a rootContext
.
- The
io.opentelemetry.sdk.trace.samplers.SamplingResult
class has been enhanced with new factory methods for the static result values. - The
io.opentelemetry.exporter.otlp.trace.OtlpGrpcSpanExporter
now supports setting custom TLS certificates. - The
io.opentelemetry.sdk.trace.ReadableSpan
interface now exposes the parent SpanContext directly. - The
io.opentelemetry.sdk.resources.Resource
now exposes agetAttribute(AttributeKey)
method to directly retrieve attributes. - A new
opentelemetry-exporter-otlp-http-trace
module is now available to support OTLP over HTTP exports.
- The
opentelemetry-sdk-extension-resources
module now provides a newContainerResource
that auto-detects docker container Resource attributes. - The Jaeger Remote Sampler in the
opentelemetry-sdk-extension-jaeger-remote-sampler
module is nowjava.io.Closeable
.
- The SDK testing module (
opentelemetry-sdk-testing
) has been enhanced with additional assertions for Spans and Attributes.
- BREAKING CHANGE:
io.opentelemetry.sdk.autoconfigure.ConfigProperties
in theopentelemetry-sdk-extension-autoconfigure
is now an interface andio.opentelemetry.sdk.autoconfigure.OpenTelemetrySdkAutoConfiguration.initiatize()
now accepts an optionalConfigProperties
instance to add properties to the standard auto-detected ones. - BREAKING CHANGE:
OpenTelemetrySdkAutoConfiguration.getResource()
has been removed in favor of using the newOpenTelemetryResourceAutoConfiguration
class. - The
opentelemetry-sdk-extension-autoconfigure
module now exposes a newOpenTelemetryResourceAutoConfiguration
class specifically for acquiring autoconfiguredResource
instances. - The
opentelemetry-sdk-extension-autoconfigure
module now provides an option to not set the GlobalOpenTelemetry instance when auto-configuring. - The
opentelemetry-sdk-extension-autoconfigure
module now has support for signal-specific timeout, header and TLS certificate configuration. - A new SPI option is available for configuring a metrics exporter. See
io.opentelemetry.sdk.autoconfigure.spi.ConfigurableMetricExporterProvider
for details. - A new
OTEL_TRACES_SAMPLER
/otel.traces.sampler
option is available:jaeger_remote
.- It can be configured using the
OTEL_TRACES_SAMPLER_ARG
/otel.traces.sampler.arg
, which is parsed as a comma-separated map.- For example
-Dotel.traces.sampler=jaeger_remote -Dotel.traces.sampler.arg=endpoint=192.168.1.5:14250,pollingInterval=5000,initialSamplingRate=0.01
- For example
- It can be configured using the
- The
SemanticAttributes
andResourceAttributes
classes have been updated to match the semantic conventions as of specification release1.5.0
.
- BREAKING CHANGE: The Metrics API has been completely re-written to match the newly specified API. Please reach out on CNCF slack in the #otel-java channel, or in a github discussion if you need assistance with converting to the new API.
- A new
opentelemetry-exporter-otlp-http-metrics
module is now available to support OTLP over HTTP exports.
- Fill labels in addition to attributes during OTLP metrics export to support versions of the OpenTelemetry Collector which do not support the new protocol yet.
- You can now assign an OpenTelemetry schema URL to a
Tracer
via the newTracerBuilder
class that is accessed via theTracerProvider
or any of the global instances that delegate to one.
- A new
@SpanAttribute
annotation has been added for adding method parameters to spans automatically. This has no implementation in this release, but should be supported by the auto-instrumentation agent soon.
- Calling
shutdown()
multiple times on the OTLP and Jaeger GRPC-based exporters will now work correctly and return a proper implementation ofCompletableResultCode
for the calls beyond the first.
- If the
jdk.unsupported
package is not available, theBatchSpanProcessor
will now fall back to a supported, standardQueue
implementation.
- A
Resource
can now be assigned an OpenTelemetry schema URL via theResourceBuilder
or thecreate(Attributes, String)
method on theResource
itself. - You can now obtain a default
Clock
based on system time viaClock.getDefault
. The sdk-testing artifact also provides aTestClock
for unit testing.
- The
SemanticAttributes
andResourceAttributes
classes have been updated to match the semantic conventions as of specification release1.4.0
. These classes also now expose aSCHEMA_URL
field which points at the version of the OpenTelemetry schema the files were generated from. There are no breaking changes in this update, only additions.
- You can now assign an OpenTelemetry schema URL to a
Meter
via the newMeterBuilder
class that is accessed via theMeterProvider
or any global instances that delegate to one. - The metrics SDK now utilizes
Attributes
rather thanLabels
internally. - You can now register an
IntervalMetricReader
as global andforceFlush
the global reader.
- Parsing of the W3C Baggage header has been optimized.
- The implementation of SpanBuilder will no longer throw exceptions when null parameters are passed in. Instead, it will treat these calls as no-ops.
- Memory usage of the Tracing SDK has been greatly reduced when exporting via the OTLP or Jaeger exporters.
- The OTLP protobuf version has been updated to v0.9.0
- A new experimental extension module has been added to provide a truly no-op implementation of the API. This
is published under the
io.opentelemetry.extension.noopapi
name. - The
io.opentelemetry.sdk.autoconfigure
module now supports theOTEL_SERVICE_NAME
/otel.service.name
environment variable/system property for configuring the SDK'sResource
implementation.
- The autoconfiguration code for metrics now supports durations to be provided with units attached to them (eg. "
100ms
"). This includes the following environment variables/system properties:OTEL_EXPORTER_OTLP_TIMEOUT
/otel.exporter.otlp.timeout
OTEL_IMR_EXPORT_INTERVAL
/otel.imr.export.interval
- The
"Implementation-Version"
attribute has been added to the jar manifests for all published jar artifacts.
- A new method has been added to the Span and the SpanBuilder to enable adding a set of Attributes in one call, rather than
having to iterate over the contents and add them individually. See
Span.setAllAttributes(Attributes)
andSpanBuilder.setAllAttributes(Attributes)
- Previously, an AttributeKey with a null underlying key would preserve the null. Now, this will be converted to an empty String.
- The
IdGenerator.random()
method will now attempt to detect if it is being used in an Android environment, and use a more Android-friendlyIdGenerator
instance in that case. This will affect any usage of the SDK that does not explicitly specify a customIdGenerator
instance when running on Android.
- The name used for Tracer instances that do not have a name has been changed to be an empty String, rather than the
previously used
"unknown"
value. This change is based on a specification clarification.
- The B3 Propagator injectors now only include the relevant fields for the specific injection format.
- The
W3CBaggagePropagator
will no longer explicitly populate an emptyBaggage
instance into the context when the header is unparsable. It will now return the provided Context instance unaltered, as is required by the specification. - The
AwsXrayPropagator
will no longer explicitly populate an invalidSpan
instance into the context when the headers are unparsable. It will now return the provided Context instance unaltered, as is required by the specification.
- The
jaeger-thrift
exporter has had its dependency on thejaeger-client
library updated to version1.6.0
. - The
zipkin
exporter now has an option to specific a custom timeout. - The
zipkin
,jaeger
andjaeger-thrift
exporters will now report theotel.dropped_attributes_count
andotel.dropped_events_count
tags if the numbers are greater than zero.
- The SemanticAttributes and ResourceAttributes have both been updated to match the OpenTelemetry Specification v1.3.0 release, which includes several breaking changes.
- Values that were previously defined as
enum
s are now defined as staticpublic static final
constants of the appropriate type.
- Error logging support in the shim is now implemented according to the v1.2.0 specification.
- A new
HostResource
Resource and the correspondingResourceProvider
has been added. It will populate thehost.name
andhost.arch
Resource Attributes. - A new
ExecutorServiceSpanProcessor
has been added to theopentelemetry-sdk-extension-tracing-incubator
module. This implementation of a batch SpanProcessor allows you to provide your own ExecutorService to do the background export work. - The
autoconfigure
module now supports providing the timeout setting for the Jaeger GRPC exporter via a system property (otel.exporter.jaeger.timeout
) or environment variable (OTEL_EXPORTER_JAEGER_TIMEOUT
). - The
autoconfigure
module now supports providing the timeout setting for the Zipkin exporter via a system property (otel.exporter.zipkin.timeout
) or environment variable (OTEL_EXPORTER_ZIPKIN_TIMEOUT
). - The
autoconfigure
module now exposes theEnvironmentResource
class to provide programmatic access to aResource
built from parsing theotel.resource.attributes
configuration property.
- The deprecated
SdkMeterProvider.registerView()
method has been removed. The ViewRegistry is now immutable and cannot be changed once theSdkMeterProvider
has been built.
- OTLP summaries now have the proper percentile value of
1.0
to represent the maximum; previously it was wrongly set to100.0
.
- There is now full support for delta-aggregations with the
LongSumAggregator
andDoubleSumAggregator
. SeeAggregatorFactory.sum(AggregationTemporality)
. The previousAggregatorFactory.sum(boolean)
has been deprecated and will be removed in the next release.
- We now use our own internal
@GuardedBy
annotation for errorprone so there won't be an accidental transitive dependency on a 3rd-party jar. - The
TraceStateBuilder
now will not crash when an empty value is provided.
- The
Context
class now provides methods to wrapjava.util.concurrent.Executor
andjava.util.concurrent.ExecutorService
instances to do context propagation using the current context. Seeio.opentelemetry.context.Context.taskWrapping(...)
for more details.
- The shim now supports methods that take a timestamp as a parameter.
- You can now specify both the
TEXT_MAP
and theHTTP_HEADER
type propagators for the shim. Seeio.opentelemetry.opentracingshim.OpenTracingPropagators
for details.
- The AWS X-Ray propagator is now able to extract 64-bit trace ids.
- The
CompletableResultCode.join(long timeout, TimeUnit unit)
method will no longerfail
the result when the timeout happens. Nor willwhenComplete
actions be executed in that case. - The
SimpleSpanProcessor
now keeps track of pending export calls and will wait for them to complete via a CompletableResultCode whenforceFlush()
is called. Similarly, this is also done onshutdown()
. - The Jaeger Thrift exporter now correctly populates the parent span id into the exporter span.
- The SpanBuilder provided by the SDK will now ignore
Link
entries that are reference an invalid SpanContext. This is an update from the OpenTelemetry Specification v1.1.0 release. - The OTLP Exporters will now log more helpful messages when the collector is unavailable or misconfigured.
- The internals of the
BatchSpanProcessor
have had some optimization done on them, to reduce CPU usage under load. - The
Resource
class now hasbuilder()
andtoBuilder()
methods and a correspondingResourceBuilder
class has been introduced for more fluent creation and modification ofResource
instances. - The standard exporters will now throttle error logging when export errors are too frequent. If more than 5 error messages are logged in a single minute by an exporter, logging will be throttled down to only a single log message per minute.
- Removed a stacktrace on startup when using the
autoconfigure
module without a metrics SDK on the classpath.
- The
autoconfigure
module now supportsOTEL_EXPORTER_OTLP_METRICS_ENDPOINT
andOTEL_EXPORTER_OTLP_TRACES_ENDPOINT
settings, in addition to the combinedOTEL_EXPORTER_OTLP_ENDPOINT
environment variable. Corresponding system properties are also supported (-Dotel.exporter.otlp.metrics.endpoint
and-Dotel.exporter.otlp.traces.endpoint
). - An
SdkMeterProviderConfigurer
SPI is now available in theautoconfigure
module.
- The SemanticAttributes and ResourceAttributes have both been updated to match the OpenTelemetry Specification v1.1.0 release.
This includes a breaking changes to the constants defined in the
ResourceAttributes
class:ResourceAttributes.CLOUD_ZONE
has been replaced withResourceAttributes.CLOUD_AVAILABILITY_ZONE
.
- The
ViewRegistry
now lets you registerView
objects, rather thanAggregatorFactory
instances. GlobalMetricsProvider
has been renamed toGlobalMeterProvider
.View
registration has been moved to theSdkMeterProviderBuilder
and the methods on theSdkMeterProvider
to add views have been deprecated. They will be removed in the next release.
- A new option for aggregation as Histograms is now available.
- AWS resource extensions have been fixed to not throw NullPointerException in actual AWS environment
This releases marks the first stable release for the tracing, baggage and context APIs and the SDK. Please see the Versioning document for stability guarantees.
The best source of lsit of the now stable packages can be found in the opentelemetry-bom artifact in maven central.
Javadoc is available at javadoc.io. For example, javadoc.io for the API module.
- The
opentelemetry-proto
module is now versioned as analpha
module, as it contains non-stable metrics and logs signals. It has hence been removed from the main BOM. - The
opentelemetry-sdk-extension-otproto
module has been removed. The classes in it have been moved to a newopentelemetry-exporter-otlp-common
module but have been repackaged into an unsupported, internal package.
PrometheusCollector.Builder
inner class has been moved to the top level asPrometheusCollectorBuilder
.
- Removed the unused
ResourceProvider
interface from the SDK. This interface is still available in theopentelemetry-sdk-extension-autoconfigure
module, where it is actually used.
Note: In an effort to accelerate our work toward a 1.0.0 release, we have skipped the deprecation phase on a number of breaking changes. We apologize for the inconvenience this may have caused. We are very aware that these changes will impact users. If you need assistance in migrating from previous releases, please open a discussion topic at https://github.com/open-telemetry/opentelemetry-java/discussions.
Many classes have been made final that previously were not. Please reach out if you have a need to provide extended functionality, and we can figure out how best to solve your use-case.
TraceStateBuilder.set(String, String)
has been renamed toTraceStateBuilder.put(String, String)
.BaggageBuilder.setParent()
andBaggageBuilder.setNoParent()
have been removed from the Baggage APIs. In addition, Baggage will no longer be implicitly generated from Baggage that is in the current context. You now must explicitly get theBaggage
instance from theContext
and calltoBuilder()
on it in order to get the entries pre-populated in your builder.TextMapPropagator.Setter
andTextMapPropagator.Getter
have been moved to the top level and renamed toTextMapSetter
andTextMapGetter
respectively.OpenTelemetry.getDefault()
has been renamed toOpenTelemetry.noop()
.OpenTelemetry.getPropagating()
has been renamed toOpenTelemetry.propagating()
.TracerProvider.getDefault()
has been renamed toTracerProvider.noop()
Tracer.getDefault()
has been removed.TraceId.getTraceIdRandomPart(CharSequence)
has been removed.- The
B3Propagator.getInstance()
has been renamed toB3Propagator.injectingSingleHeader()
. - The
B3Propagator.builder()
method has been removed. As a replacement, you can useB3Propagator.injectingMultiHeaders()
directly.
- The SPI for configuring Resource auto-populators has been removed from the SDK and moved to the
opentelemetry-sdk-extension-autoconfigure
module. This means thatResource.getDefault()
will no longer be populated via SPI, but only include the bare minimum values from the SDK itself. In order to get the auto-configured Resource attributes, you will need to use theopentelemetry-sdk-extension-autoconfigure
module directly. InstrumentationLibraryInfo.getEmpty()
has been renamed toInstrumentationLibraryInfo.empty()
.Resource.getEmpty()
has been renamed toResource.empty()
.- When specifying the endpoints for grpc-based exporters, you now are required to specify the protocol. Hence, you must include
the
http://
orhttps://
in front of your endpoint. - The option on
SpanLimits
to truncate String-valued Span attributes has been removed (this is still pending in the specification). - The
InMemoryMetricsExporter
has been removed from theopentelemetry-sdk-testing
module.
- The default values for SpanLimits have been changed to 128, from 1000, to match the spec.
- In the
opentelemetry-sdk-extension-autoconfigure
module, we have changed the system property used to exclude some Resource auto-populators to beotel.java.disabled.resource-providers
instead ofotel.java.disabled.resource_providers
. - In the
opentelemetry-sdk-extension-autoconfigure
module, you now specify theOtTracePropagator
with the"ottrace"
option, rather than"ottracer"
. - In the
opentelemetry-sdk-extension-autoconfigure
module, the default exporters are now set to be"otlp"
, as required by the 1.0.0 specification. - In the
opentelemetry-sdk-extension-autoconfigure
module, the default propagators are now set to be"tracecontext,baggage"
, as required by the 1.0.0 specification. - The
CommonProperties
class has been removed from theopentelemetry-sdk-extension-otproto
module.
Meter.getDefault()
has been removed.MeterProvider.getDefault()
has been renamed toMeterProvider.noop()
.
Note: In an effort to accelerate our work toward a 1.0.0 release, we have skipped the deprecation phase on a number of breaking changes. We apologize for the inconvenience this may have caused. We are very aware that these changes will impact users. If you need assistance in migrating from previous releases, please open a discussion topic at https://github.com/open-telemetry/opentelemetry-java/discussions.
- Methods and classes deprecated in 0.15.0 have been removed.
- The
Span.Kind
enum has been moved to the top level, and namedSpanKind
. DefaultOpenTelemetry
is no longer a public class. If you need the functionality previously provided by this implementation, it can be accessed via new static methods on theOpenTelemetry
interface itself.- The
TraceFlags
interface has been re-introduced. This is now used, rather than a barebyte
wherever trace flags is used. In particular,SpanContext.create()
,SpanContext.createFromRemoteParent()
now require aTraceFlags
instance, andSpanContext.getTraceFlags()
returns aTraceFlags
instance. - The names of static methods on
TraceFlags
have been normalized to match other similar classes, and now returnTraceFlags
instead ofbyte
where appropriate. - The
Labels
interface and related classes have been moved into the alpha metrics modules and repackaged. TraceId.copyHexInto(byte[] traceId, char[] dest, int destOffset)
has been removed.SpanContext.getTraceIdAsHexString()
has been renamed toSpanContext.getTraceId()
SpanContext.getSpanIdAsHexString()
has been renamed toSpanContext.getSpanId()
BaggageEntry.getEntryMetadata()
has been renamed toBaggageEntry.getMetadata()
BaggageConsumer
has been removed in favor of a standardjava.util.function.BiConsumer<String, BaggageEntry>
TraceFlags.isSampledFromHex(CharSequence src, int srcOffset)
has been removed.SpanId
andTraceId
methods that had aString
parameter now acceptCharSequence
and assume the id starts at the beginning.SpanId.getSize()
andTraceId.getSize()
have been removed.SpanId.bytesFromHex()
has been removed.SpanId.asLong(CharSequence)
has been removed.SpanId.asBytes(CharSequence)
has been removed.SpanId.getHexLength()
has been renamed toSpanId.getLength()
SpanId.bytesToHex()
has been renamed toSpanId.fromBytes()
TraceId.bytesFromHex()
has been removed.TraceId.traceIdLowBytesAsLong(CharSequence)
has been removed.TraceId.traceIdHighBytesAsLong(CharSequence)
has been removed.TraceId.asBytes(CharSequence)
has been removed.TraceId.getHexLength()
has been renamed toTraceId.getLength()
TraceId.bytesToHex()
has been renamed toTraceId.fromBytes()
StrictContextStorage
has been made private. Use -Dio.opentelemetry.context.enableStrictContext=true` to enable itAwsXrayPropagator
has been moved to theopentelemetry-extension-aws
artifact
- The
W3CTraceContextPropagator
class now directly implements theTextMapPropagator
interface. - The
OpenTelemetry
interface now has agetDefault()
method which will return a completely no-op implementation. - The
OpenTelmmetry
interface now has agetPropagating(ContextPropagators propagators)
method which will return an implementation that contains propagators, but is otherwise no-op.
- The internal
StringUtils
class has had metrics-related methods removed from it. But, you weren't using internal classes, were you? - The internal
AbstractWeakConcurrentMap
class has been made non-public. See the line above about internal classes.
- The
OtTracerPropagator
has been renamed toOtTracePropagator
in the trace-propagators extension module.
TraceConfig
has been renamed toSpanLimits
and relocated to theio.opentelemetry.sdk.tracing
package. All related method names have been renamed to match.SpanData.getTraceState()
has been removed. The TraceState is still available via the SpanContext accessor.SpanData.isSampled()
has been removed. The isSampled property is still available via the SpanContext accessor.
SpanData
now directly exposes the underlyingSpanContext
instance.
- In the
opentelemetry-autoconfigure
module, three environment variables/system properties have been renamed to match the spec:OTEL_TRACE_EXPORTER
/otel.trace.exporter
has been replaced withOTEL_TRACES_EXPORTER
/otel.traces.exporter
OTEL_TRACE_SAMPLER
/otel.trace.sampler
has been replaced withOTEL_TRACES_SAMPLER
/otel_traces_sampler
OTEL_TRACE_SAMPLER_ARG
/otel.trace.sampler.arg
has been replaced withOTEL_TRACES_SAMPLER_ARG
/otel.traces.sampler.arg
- The
opentelemetry-autoconfigure
module now supports using non-millisecond values for duration & interval configuration options. See the javadoc on theio.opentelemetry.sdk.autoconfigure.ConfigProperties.getDuration(String)
method for details on supported formats. - The
opentelemetry-autoconfigure
module now provides automatic SPI-based parsing of theOTEL_RESOURCE_ATTRIBUTES
env var (and the correspondingotel.resource.attributes
system property). If you include this module on your classpath, it will automatically update theResource.getDefault()
instance with that configuration.
- The
Labels
interface has been moved into the metrics API module and repackaged into theio.opentelemetry.api.metrics.common
package.
- Methods and classes deprecated in 0.14.x have been removed.
The opentelemetry-semconv
module has been marked as -alpha
and removed from the bom. This was done because the OpenTelemetry
project has not decided on a specification for stability of semantic conventions or the specific telemetry produced by
instrumentation.
- The items in the
io.opentelemetry.semconv.trace.attributes.SemanticAttributes
which were previously generated form the Resource semantic conventions have been deprecated. Please use the ones in the newio.opentelemetry.semconv.resource.attributes.ResourceAttributes
class.
- A new
io.opentelemetry.semconv.resource.attributes.ResourceAttributes
has been introduced to hold the generated semantic attributes to be used in creatingResource
s.
SamplingResult.Decision
has been removed in favor of theio.opentelemetry.sdk.trace.samplers.SamplingDecision
top-level class.Resource.merge(Resource)
now will resolve conflicts by preferring theResource
passed in, rather than the original.- The default Resource (accessible via
Resource.getDefault()
) now includes a fallbackservice.name
attribute. The implication of this is that exporters that have configured fallback service names will only use them if the SDK is intentionally configured with a Resource that does not utilize the default Resource for its underlying Resource data. - The
Sampler
is now specified when building the SdkTracerProvider directly, rather than being a part of the TraceConfig.
- The Jaeger exporters will now properly populate the process service name from the Resource service.name attribute.
- Going forward, OTLP exporter endpoint specifications must include a scheme, either
http://
orhttps://
. We will support endpoints without schemes until the next release, at which point not providing a scheme will generate an error when trying to use them. This applies to the use of system properties, environment variables, or programmatic specifications of the endpoints. - The
exportOnlySampled
configuration of theBatchSpanProcessor
has been deprecated and will be removed in the next release. - The
io.opentelemetry.sdk.resources.ResourceAttributes
has been deprecated and will be removed in the next release. Please use the newio.opentelemetry.semconv.resource.attributes.ResourceAttributes
class in theopentelemetry-semconv
module. - The serviceName configuration option for the Jaeger and Zipkin exporters has been deprecated. In the next release, those
configuration options will be removed, and the fallback
service.name
will always be pulled from the default Resource.
Resource.getDefault()
now includes a fallbackservice.name
attribute. Exporters that require aservice.name
should acquire the fallback from the default resource, rather than having it configured in.
- The
otel.bsp.schedule.delay.millis
env var/system property configuration option for the batch span processor has been renamed tootel.bsp.schedule.delay
to match the specification. - The
otel.bsp.export.timeout.millis
env var/system property configuration option for the batch span processor has been renamed tootel.bsp.export.timeout
to match the specification.
- The
opentelemetry-sdk-extension-autoconfigure
module will now additionally register the auto-configured SDK as the instance ofGlobalOpenTelemetry
when used. - The
opentelemetry-sdk-extension-autoconfigure
module now supports theotel.exporter.otlp.certificate
configuration property for specifying a path to a trusted certificate for the OTLP exporters.
- Several more modules have been updated to have
-alpha
appended on their versions:opentelemetry-sdk-extension-jfr-events
opentelemetry-sdk-extension-async-processor
opentelemetry-sdk-extension-logging
opentelemetry-sdk-extension-zpages
opentelemetry-sdk-exporter-prometheus
opentelemetry-sdk-exporter-tracing-incubator
opentelemetry-opentracing-shim
opentelemetry-opencensus-shim
- Code that was deprecated in
0.13.0
has been removed from the project.- Metrics interfaces are no longer available as a part of the
opentelemetry-pom
or from theopentelemetry-api
modules. To access the alpha metrics APIs, you will need to explicitly add them as a dependency. OpenTelemetry.setPropagators()
has been removed. You should instead create yourOpenTelemetry
implementations with the Propagators preset, via the various builder options. For example, useDefaultOpenTelemetry.builder().setPropagators(propagators).build()
to configure your no-sdk implementation.- The
OpenTelemetry.builder()
and theOpenTelemetryBuilder
interface have been removed. The builder functionality is now only present on individual implementations of OpenTelemetry. For instance, theDefaultOpenTelemetry
class has a builder available.
- Metrics interfaces are no longer available as a part of the
- The SemanticAttributes class has been moved to a new module:
opentelemetry-semconv
and repackaged into a new package:io.opentelemetry.semconv.trace.attributes
. The oldSemanticAttributes
class will be removed in the next release. - The SPI interfaces for OpenTelemetry have been deprecated. We are moving to a new auto-configuration approach with the
new SDK auto-configuration module:
io.opentelemetry.sdk.autoconfigure
. This module should be considered the officially supported auto-configuration library moving forward.
- The SemanticAttributes have been updated to the latest version of the specification, as of January 7th, 2021.
- Environment variables/system properties that are used to set extra headers for the OTLP exporters have been fixed to now
split on commas, rather than semicolons. This has been brought in line with the specification for these environment
variables. This includes
otel.exporter.otlp.span.headers
,otel.exporter.otlp.metric.headers
, andotel.exporter.otlp.headers
. - Passing a null span name when creating a span will no longer cause a NullPointerException. Instead, a default span name will be provided in place of the missing name.
- The deprecated
SpanData.Link.getContext()
method has been removed in favor ofSpanData.Link.getSpanContext()
. - The
TracerProviderFactorySdk
SPI class has been renamed toSdkTracerProviderFactory
. - The
OpenTelemetrySdkBuilder.build()
method has been renamed toOpenTelemetrySdkBuilder.buildAndRegisterGlobal()
. Thebuild()
method still exists, but no longer sets the instance on theGlobalOpenTelemetry
when invoked. - The
SdkTracerManagement.shutdown()
method now returnsCompletableResultCode
which can be used to wait asynchronously for shutdown to complete. - The
sampling.probability
sampling attribute previously generated by theTraceIdRatioBasedSampler
is no longer generated, as it was not conformant with the specifications. - The
SpanData
inner classes have been moved to the top level, soSpanData.Link
->LinkData
,SpanData.Event
->EventData
andSpanData.Status
->StatusData
.
SdkTracerProvider.updateActiveTraceConfig()
andSdkTracerProvider.addSpanProcessor()
have been deprecated. The methods will be removed in the next release.- All existing auto-configuration mechanisms have been deprecated in favor of using the new
io.opentelemetry.sdk.autoconfigure
module. The existing ones will be removed in the next release. - The methods with the term "deadline" has been deprecated in the configuration of the grpc-based exporters (OTLP and Jaeger) in favor of the word "timeout". The deadline-named methods will be removed in the next release.
- The
StringUtils
class in theopentelemetry-extension-trace-propagators
extension module has been deprecated and will be made non-public in the next release. - The
StatusData.isUnset()
andStatusData.isOk()
methods have been deprecated. They will be removed in the next release.
- The
OtlpGrpcSpanExporter
now supports setting trusted TLS certificates for secure communication with the collector. - A new module for supporting auto-configuration of the SDK has been added. The new module,
io.opentelemetry.sdk.autoconfigure
will be the new path for auto-configuration of the SDK, including via SPI, environment variables and system properties. - The
TraceConfig
class now exposes abuilder()
method directly, so you don't need to get the default then calltoBuilder()
on it. - The OTLP protobuf definitions were updated to the latest released version:
0.7.0
. Both theSpan
and (alpha)Metric
exporters were updated to match. - Timeouts in the exporters can now be specified with
java.util.concurrent.TimeUnit
andjava.time.Duration
based configurations, rather than requiring milliseconds.
- The ZPages extension now exposes its SpanProcessor implementation. To use it, you will need to add it to your SDK implementation directly, rather than it adding itself to the global SDK instance.
- The JaegerRemoteSampler builder patterns have been changed and updated to more closely match the rest of the builders in the project.
- The
AwsXrayIdGenerator
constructor has been deprecated in favor of using a simplegetInstance()
singleton, since it has no state. - The
TraceProtoUtils
class in theopentelemetry-sdk-extension-otproto
module has been deprecated and will be removed in the next release.
- The JaegerRemoteSampler now uses the ParentBased sampler as the basis for any sampling that is done.
- The
InstrumentSelector.newBuilder()
method has been renamed toInstrumentSelector.builder()
and the methods on the Builder have changed to use the same naming patterns as the rest of the project. - The
MeterProviderFactorySdk
class has been renamed toSdkMeterProviderFactory
. - The
SdkMeterProvicer.Builder
has been moved to the top levelSdkMeterProviderBuilder
. - The
InstrumentSelector
now requires an instrument type to be provided, and defaults the name regex to.*
.
- Starting with 0.13.0, all unstable modules (the 2 metrics modules for now) will have a
-alpha
appended to their base version numbers to make it clear they are not production ready, and will not be when we get to releasing 1.0. See our Rationale document for details.
- The
Labels.ArrayBackedLabelsBuilder
class has been made non-public. You can still access theLabelsBuilder
functionality via theLabels.builder()
method. - Methods deprecated in the 0.12.0 release have been removed or made non-public:
- The
HttpTraceContext
class has been removed. - The
toBuilder()
method on the OpenTelemetry interface has been removed. - The
Attributes.builder(Attributes)
method has been removed in favor ofAttributes.toBuilder(Attributes)
. - The
DefaultContextPropagators
class has made non-public. - The
TraceMultiPropagator
builder has been removed in favor of a simple factory method. - The
value()
method on theStatusCode
enum has been removed. - The Baggage
EntryMetadata
class has been removed in favor of theBaggageEntryMetadata
interface. - The
setCallback()
method on the asynchronous metric instruments has been removed.
- The
- Several public classes have been made
final
.
- An
asMap
method has been added to theLabels
interface, to expose them as ajava.util.Map
. - You can now enable strict Context verification via a system property (
-Dio.opentelemetry.context.enableStrictContext=true
) Enabling this mode will make sure that allScope
s that are created are closed, and generate log messages if they are not closed before being garbage collected. This mode of operation is CPU intensive, so be careful before enabling it in high-throughput environments that do not need this strict verification. See the javadoc on theio.opentelemetry.context.Context
interface for details. - Several of the methods on the
Span
interface have been given default implementations. - The Semantic Attributes constants have been updated to the version in the yaml spec as of Dec 14, 2020.
- The Metrics API has been deprecated in the
opentelemetry-api
module, in preparation for releasing a fully-stable 1.0 version of that module. The Metrics API will be removed from the module in the next release. - The API has been broken into separate modules, in preparation for the 1.0 release of the tracing API.
If you depend on the
opentelemetry-api
module, you should get the rest of the API modules as transitive dependencies. - The
OpenTelemetry.builder()
and theOpenTelemetryBuilder
interface have been deprecated and will be removed in the next release. The builder functionality is now only present on individual implementations of OpenTelemetry. For instance, theDefaultOpenTelemetry
class has a builder available. - The
OpenTelemetry.setPropagators()
has been deprecated and will be removed in the next release. You should instead create yourOpenTelemetry
implementations with the Propagators preset, via the various builder options. For example, useDefaultOpenTelemetry.builder().setPropagators(propagators).build()
to configure your no-sdk implementation.
- The
SpanData.Link.getContext()
method has been deprecated in favor of a newSpanData.Link.getSpanContext()
. The deprecated method will be removed in the next release of the SDK. - The internals of the (alpha) Metrics SDK have been significantly updated.
- OTLP adapter classes have been moved into the
opentelemetry-sdk-extension-otproto
module so they can be shared across OTLP usages. - The zipkin exporter has been updated to have its error code handling match the spec.
- The logging exporter's format has changed to something slightly more human-readable.
- Many SDK classes have been renamed to be prefixed with
Sdk
rather than havingSdk
being embedded in the middle of the name. For example,TracerSdk
has been renamed toSdkTracer
andTracerSdkManagement
has been renamed toSdkTracerManagement
. - The
ResourcesConfig.builder()
method has been made non-public. - The
TraceConfig.Builder
class has been moved to the top-levelTraceConfigBuilder
class. - The built-in exporter
Builder
classes have been moved to the top level, rather than inner classes. Access to the builders is still available viabuilder()
methods on the exporter classes. - The built-in SpanProcessor
Builder
classes have been moved to the top level, rather than inner classes. Access to the builders is still available viabuilder()
methods on the SpanProcessor implementation classes. - The built-in ParentBasedSampler
Builder
class has been moved to the top level, rather than inner classes. Access to the builder is still available via methods on the Sampler interface. - The
DaemonThreadFactory
class has been moved to an internal module and should not be used outside of this repository. - The builder class for the
OpenTelemetrySdk
class has been slimmed down. The configurable details have been moved into the specific provider builders, where they apply more specifically and obviously. - Many public classes have been made
final
. - The MetricExporter interface's
shutdown()
method now returnsCompletableResultCode
rather than void. - The
OpenTelemetrySdk
's builder class has been moved to the top level, rather than being an inner class. It has been renamed toOpenTelemetrySdkBuilder
as a part of that change. - The OTLP exporters have been split into two separate modules, and the metrics exporter has been tagged with the
-alpha
version. If you continue to depend on theopentelemetry-exporters-otlp
module, you will only get the trace exporter as a transitive dependency.
- The
opentelemetry-extension-annotations
module now includes the api module as anapi
dependency, rather than justimplementation
.
- The deprecated
opentelemetry-extension-runtime-metrics
module has been removed. The functionality is available in the opentelemetry-java-instrumentation project under a different module name. - The deprecated
trace-utils
module has been removed. - Several public classes have been made
final
.
- Some common OTLP adapter utilities have been moved into the
opentelemetry-sdk-extension-otproto
module so they can be shared across OTLP exporters.
- Usages of tracers and meters on all
OpenTelemetry
instances were being delegated to the global Meter and Tracer. This has been corrected, and all instances should have independent Tracer and Meter instances.
- The
AttributesBuilder
no long accepts null values for array-valued attributes with numeric or boolean types. - The
TextMapPropagator.fields()
method now returns aCollection
rather than aList
. Labels
has been converted to an interface, from an abstract class. Its API has otherwise remained the same.TraceState
has been converted to an interface, from an abstract class. Its API has otherwise remained the same.Attributes
has been converted to an interface, from an abstract class. Its API has otherwise remained the same.- The
ReadableAttributes
interface has been removed, as it was redundant with theAttributes
interface. All APIs that used or returnedReadableAttributes
should accept or return standardAttributes
implementations. SpanContext
has been converted to an interface, from an abstract class. Its API has otherwise remained the same.- The functional
AttributeConsumer
interface has been removed and replaced with a standardjava.util.function.BiConsumer
. - The signature of the
BaggageBuilder.put(String, String, EntryMetadata entryMetadata)
method has been changed toput(String, String, BaggageEntryMetadata)
- A
builder()
method has been added to the OpenTelemetry interface to facilitate constructing implementations. - An
asMap()
method has been added to theAttributes
interface to enable conversion to a standardjava.util.Map
. - An
asMap()
method has been added to theBaggage
interface to enable conversion to a standardjava.util.Map
. - An
asMap()
method has been added to theTraceState
interface to enable conversion to a standardjava.util.Map
. - The Semantic Attributes constants have been updated to the version in the yaml spec as of Dec 1, 2020.
- The
HttpTraceContext
class has been deprecated in favor ofW3CTraceContextPropagator
.HttpTraceContext
will be removed in 0.13.0. - The
toBuilder()
method on the OpenTelemetry interface has been deprecated and will be removed in 0.13.0. - The
DefaultContextPropagators
class has been deprecated. Access to it will be removed in 0.13.0. - The
TraceMultiPropagator
builder has been deprecated in favor of a simple factory method. The builder will be removed in 0.13.0. You can access the same functionality via static methods on theContextPropagators
interface. - The
setCallback()
method on the asynchronous metric instruments has been deprecated and will be removed in 0.13.0. Instead, use thesetCallback()
method on the builder for the instruments. - The
value()
method on theStatusCode
enum has been deprecated and will be removed in 0.13.0. - The Baggage
EntryMetadata
class has been deprecated in favor of theBaggageEntryMetadata
interface. The class will be made non-public in 0.13.0.
- The
opentelemetry-extension-runtime-metrics
module has been deprecated. The functionality is available in the opentelemetry-java-instrumentation project under a different module name. The module here will be removed in 0.13.0. - The
trace-utils
module has been deprecated. If you need this module, please let us know! The module will be removed in 0.13.0.
- The
opentelemetry-sdk-tracing
module has been renamed toopentelemetry-sdk-trace
. - The default port the OTLP exporters use has been changed to
4317
. - The deprecated
SpanData.getCanonicalCode()
method has been removed, along with the implementations.
- The OpenTelemetrySdk builder now supports the addition of
SpanProcessor
s to the resulting SDK. - The OpenTelemetrySdk builder now supports the assignment of an
IdGenerator
to the resulting SDK. - The
ReadableSpan
interface now exposes theSpan.Kind
of the span. - The SDK no longer depends on the guava library.
- The parent SpanContext is now exposed on the
SpanData
interface.
- The
toBuilder()
method on the OpenTelemetrySdk class has been deprecated and will be removed in 0.13.0. - The MultiSpanProcessor and MultiSpanExporter have been deprecated. You can access the same functionality via
the
SpanProcessor.composite
andSpanExporter.composite
methods. The classes will be made non-public in 0.13.0. - The
SpanData.hasRemoteParent()
method has been deprecated and will be removed in 0.13.0. If you need this information, you can now callSpanData.getParentSpanContext().isRemote()
. - The default timeouts for the 2 OTLP exporters and the Jaeger exporter have been changed to 10s from 1s.
- The
opentelemetry-sdk-extension-aws-v1-support
module has been renamed toopentelemetry-sdk-extension-aws
and the classes in it have been repackaged into theio.opentelemetry.sdk.extension.aws.*
packages.
- The OpenTracing
TracerShim
now properly handles keys for context extraction in a case-insensitive manner.
- The
opentelemetry-sdk-extension-resources
now includes resource attributes for the process runtime via theProcessRuntimeResource
class. This is included in the Resource SPI implementation that the module provides. - The
opentelemetry-sdk-extension-aws
extension now will auto-detect AWS Lambda resource attributes.
- The SPI interfaces have moved to a package (not a module) separate from the API packages, and now live in
io.opentelemetry.spi.*
package namespace. - Builder classes have been moved to the top level, rather than being inner classes.
For example, rather than
io.opentelemetry.api.trace.Span.Builder
, the builder is now in its own top-level class:io.opentelemetry.api.trace.SpanBuilder
. Methods to create the builders remain in the same place as they were before. - SpanBuilder.setStartTimestamp, Span.end, and Span.addEvent methods which accept a timestamp now accept a timestamp with a TimeUnit instead of requiring a nanos timestamp.
- Versions of SpanBuilder.setStartTimestamp, Span.end, and Span.addEvent added which accept Instant timestamps
- Setting the value of the
io.opentelemetry.context.contextStorageProvider
System property todefault
will enforce that the default (thread local) ContextStorage will be used for the Context implementation, regardless of what SPI implementations are available.
- Invalid W3C
TraceState
entries will now be silently dropped, rather than causing the invalidation of the entireTraceState
.
- The builder class for the
OpenTelemetrySdk
now strictly requires its components to be SDK implementations. You can only build anOpenTelemetrySdk
withTracerSdkProvider
andMeterSdkProvider
instances.
- An API has been added to the SDK's MeterProvider implementation (
MeterSdkProvider
) that allows the end-user to configure how various metrics will be aggregated. This API should be considered a precursor to a full "Views" API, and will most likely evolve over the coming months before the metrics implementation is complete. See the javadoc forMeterSdkProvider.registerView()
for details.
- The
SpanProcessor
interface now includes default method implementations for theshutdown()
andforceFlush()
methods. - The BatchRecorder implementation has been updated to actually batch the recordings, rather than simply passing them through.
- The
@WithSpan
annotation has been moved to theio.opentelemetry.extension.annotations
package in theopentelemetry-extension-annotations
module
- The memory pool metrics provided by the MemoryPools class in the
opentelemetry-extension-runtime-metrics
module have been fixed to properly report the committed memory values.
- A new module has been added to assist with propagating the OTel context in kotlin co-routines.
See the
opentelemetry-extension-kotlin
module for details.
- The W3C Baggage Propagator is now available.
- The B3 Propagator now handles both single and multi-header formats.
- The B3 Propagator defaults to injecting the single B3 header, rather than the multi-header format.
- Mutating a method on
Span
now returns theSpan
to enable call-chaining.
- The
package-info
file was removed from theio.otel.context
package because it made the project incompatible with JPMS.
- There have been many updates to the semantic conventions constants. The constants are now auto-generated from the YAML specification files, so the names will now be consistent across languages. For more information, see the YAML Model for Semantic Conventions.
- All API classes have been moved into the
io.opentelemetry.api.
prefix to support JPMS users. - The API no longer uses the
grpc-context
as the context implementation. It now usesio.opentelemetry.context.Context
. This is published in theopentelemetry-context
artifact. Interactions with the context were mostly moved to static methods in theSpan
andBaggage
interfaces. - The Baggage API has been reworked to more closely match the specification. This includes the removal of the
BaggageManager
. Baggage is fully functional within the API, without needing to install an SDK. TracingContextUtils
andBaggageUtils
were removed from the public API. Instead, use the appropriate static methods on theSpan
andBaggage
classes, or use methods on theContext
itself.- The context propagation APIs have moved into the new
opentelemetry-context
context module. DefaultSpan
was removed from the public API. Instead, useSpan.wrap(spanContext)
if you need a non-functional span that propagates the trace context.DefaultMeter
,DefaultMeterProvider
,DefaultTracer
andDefaultTracerProvider
were removed from the public API. You can access the same functionality withgetDefault()
methods on theMeter
,MeterProvider,
Tracer, and
TracerProvider` classes, respectively.- Some functionality from the
Tracer
interface is now available either on theSpan
interface orContext
interface. - The
OpenTelemetry
class is now an interface, with implementations. Methods on this interface have changed their names to reflect this change. For more information, see OpenTelemetry.java. - All builder-creation methods have been renamed to
.builder()
. StatusCanonicalCode
has been renamed toStatusCode
.Span.getContext()
has been renamed toSpan.getSpanContext()
.AttributesBuilder
now usesput
instead ofadd
as the method name for adding attributes.- All parameters are now marked as non-nullable by default.
TextMapPropagators
could receive a null carrier passed to the extract method.- The
TextMapPropagator.Getter
interface has added a method to return the keys that the propagator uses.
- A new
MetricData
gauge metric type is now available. - A new
opentelemetry-sdk-testing
module with a JUnit 5 extension to assist with testing is now available. - The Prometheus metric exporter now consumes
gauge
metrics. - The Jaeger gRPC exporter now maps
Resource
entries to process tags. - The OTLP protobuf definitions were updated to the latest released version: 0.6.0. Both the
Span
andMetric
exporters were updated to match. - The
Sampler
interface now allows aSampler
implementation to update theTraceState
that is applied to theSpanContext
for the resulting span.
TraceConfig
configuration option names (environment variables and system properties) were renamed to match the OpenTelemetery Specification. For more information, see TraceConfig.- The Jaeger gRPC exporter was updated to match the OpenTelemetry Specification. The
message
log entry attribute has been renamed toevent
and a newdropped attributes count
attribute was added. For more information, see the Overview. - The
SpanData.getHasRemoteParent()
andSpanData.getHasEnded()
methods were renamed tohasRemoteParent()
andhasEnded()
, respectively. - The
IdsGenerator
interface has been renamed toIdGenerator
, and all implementations and relevant factory methods were similarly renamed. - The
RandomIdGenerator
is now accessible via a factory method on theIdGenerator
class, rather than being exposed itself. UseIdGenerator.random()
to acquire an instance. - The OTLP metric exporter now emits
gauge
metrics where appropriate. ValueObserver
instruments now generate gauge metrics, rather than non-monotonic counter-style metrics.ValueObserver
instruments now use theLastValue
aggregation instead ofMinMaxSumCount
.- The
SpanData.*
implementation classes were removed from the public SDK, but the interfaces are still available. SpanProcessor.onStart
now takes aContext
as its first parameter.- The
Sampler
interface now takes a parentContext
rather than aSpanContext
. - Each
Sampler
has been reorganized into their own classes and moved into theio.opentelemetry.sdk.trace.samplers
package. Factory methods that used to be on theSamplers
class were moved to theSampler
interface.
- A new JUnit5 extension was added for writing tests. For more information, see OpenTelemetryExtension.java.
- A Jaeger
SpanExporter
which exports via thethrift-over-http protocol
is now available. - A Jaeger Propagator is now available.
- The in-memory exporter(s) have been moved to the
opentelemetry-sdk-testing
artifact. - The OpenTracing shim factory class has been renamed from
TraceShim
toOpenTracingShim
. The factory methods have changed becauseBaggageManager
was removed and non-globalOpenTelemetry
instances are now available. - The 's' was removed from the word "exporters" for every exporter artifact. For example,
opentelemetry-exporters-logging
was renamed toopentelemetry-exporter-logging
. - The 's' was removed from the word "extensions" for the package for every SDK extension. For example,
io.opentelemetry.sdk.extensions.otproto.TraceProtoUtils
was renamed toio.opentelemetry.sdk.extension.otproto.TraceProtoUtils
.
Many thanks to everyone who made this release possible!
@anuraaga @bogdandrutu @Oberon00 @thisthat @HaloFour @jkwatson @kenfinnigan @MariusVolkhart @malafeev @trask @tylerbenson @XiXiaPdx @dengliming @hengyunabc @jarebudev @brianashby-sfx
-
API
- BREAKING CHANGE: SpanId, TraceId and TraceFlags are no longer used as instances, but only contain helper methods for managing conversion between Strings, bytes and other formats. SpanId and TraceId are now natively String-typed, and the TraceFlags is a single byte.
- BREAKING CHANGE: Propagators now only expose a singleton instance.
- BREAKING CHANGE: The LabelConsumer and AttributeConsumer are now first-class interfaces, and the underlying consumer interface has had the key made additionally generic. Please prefer using the specific interfaces, rather than the underlying
ReadableKeyValuePairs.KeyValueConsumer
. - BREAKING CHANGE: Minimum JDK version has been updated to 8, with Android API level 24.
- BREAKING CHANGE: Metric Instrument names are now case-insensitive.
- BREAKING CHANGE: The type-safety on Attributes has been moved to a new AttributeKey, and the AttributeValue wrappers have been removed. This impacts all the semantic attribute definitions, and the various APIs that use Attributes.
- BREAKING CHANGE: The obsolete HTTP_STATUS_TEXT semantic attribute has been removed.
- BREAKING CHANGE: The type of the REDIS_DATABASE_INDEX semantic attribute has been changed to be numeric.
- BREAKING CHANGE: Constant Labels have been removed from metric Instrument definitions.
- BREAKING CHANGE: The number of available Span Status options has been greatly reduced (from 16 to 3).
- BREAKING CHANGE: Constant labels have been removed from metric Instrument definitions.
- BREAKING CHANGE: The only way to specify span parenting is via a parent Context
- BREAKING CHANGE: The default TextMapPropagator is now a no-op in the API
- BREAKING CHANGE: CorrelationContext has been renamed to Baggage
- BREAKING CHANGE: Null-valued span attribute behavior has been changed to being "unspecified".
- BREAKING CHANGE: Link and Event interfaces have been removed from the API
- BREAKING CHANGE: The Status object has been removed from the API, in favor of StatusCanonicalCode
- BUGFIX: the
noParent
option on a Span was being ignored if it was set after setting an explicit parent. - BUGFIX: Attributes and Labels now preserve the latest added entry when an existing key has been used.
- BUGFIX: Updated some of the W3C traceparent validation logic to better match the spec.
- FaaS semantic attributes have been added
- Semantic attribute for "exception.escaped" added
-
SDK
- BREAKING CHANGE: The names of the Sampler.Decision enum values, returned by the Sampler interface, have changed.
OpenTelemetrySdk.forceFlush()
now returns a CompletableResultCode- BREAKING CHANGE: The
ProbabilitySampler
has been renamed toTraceIdRatioBased
- BREAKING CHANGE: The environment variables/system properties for specifying exporter and span processor configuration have been updated to match the specification.
- BREAKING CHANGE: Exported zipkin attributes have been changed to match the specification.
- BREAKING CHANGE: Metric Descriptor attributes have been flattened into the MetricData for export.
- BREAKING CHANGE: The OpenTelemetrySdk class now returns a TraceSdkManagement interface, rather than the concrete TracerSdkProvider.
- BUGFIX: Zipkin span durations are now rounded up to 1 microsecond, if less than 1.
- BUGFIX: The insecure option for OTLP export now does the correct thing.
- Added a configuration option for disabling SPI-provided ResourceProviders
- New incubator module with helper classes for working with SpanData
- AWS resources now include the
cloud.provider
attribute.
-
Extensions
- BREAKING CHANGE: Propagators now only expose a singleton instance.
- The auto-config extension has been moved to the instrumentation project.
- New incubator module with some utilities for mutating SpanData instances.
- The AWS Resource extension will now pull in EKS Resource attributes.
- New pre-release extension for handling logging natively.
Many thanks to all who made this release possible:
@bogdandrutu @Oberon00 @jkwatson @thisthat @anuraaga @jarebudev @malafeev @quijote @JasonXZLiu @zoercai @eunice98k @dengliming @breedx-nr @iNikem @wangzlei @imavroukakis
-
Extensions:
- Updated metrics generated by the runtime_metrics module to match the proposed semantic conventions.
-
API:
- BREAKING CHANGE: Renamed HttpTextFormat to TextMapPropagator
- Added a toBuilder method to the Attributes class
- Added method to create an Attributes Builder from ReadableAttributes
- Updates to the Attributes' null-handling to conform to the specification
- TraceState validations were updated to match the W3C specification
- recordException Span API now has an additional overload to support additional attributes
-
SDK:
- BUGFIX: Bound instruments with no recordings no longer generate data points.
- BREAKING CHANGE: The Exporter interfaces have changed to be async-friendly.
- BREAKING CHANGE: The parent context passed to the Sampler will no longer be nullable, but instead an invalid context will be passed.
- BREAKING CHANGE: The SpanProcessor now takes a ReadWriteSpan for the onStart method
- BREAKING CHANGE: ResourceConstants changed to ResourceAttributes
- BREAKING CHANGE: ParentOrElse Sampler changed to be called ParentBased
- Default Resource include the SDK attributes
- ResourceProvider SPI to enable custom Resource providers
- The individual pieces of the SDK are not published as individual components, in addition to the whole SDK artifact.
- Zipkin and Jaeger exporters now include the InstrumentationLibraryInfo attributes.
- The OTLP protobufs were updated to version 0.5.0 and the OTLP exporters were updated accordingly.
-
Many thanks for contributions from @anuraaga, @dengliming, @iNikem, @huntc, @jarebudev, @MitchellDumovic, @wtyanan, @williamhu99, @Oberon00, @thisthat, @malafeev, @mateuszrzeszutek, @kenfinnigan
- BUGFIX: OTLP Span Exporter: fix splitting metadata key-value substring with more than one '=' sign
NOTE: This release contains non-backward-compatible breaking SDK changes
- Added an InMemoryMetricExporter
- Added a toBuilder method to Labels
- Added some semantic attribute constants
- New ZPages extension module with TraceZ and TraceConfigZ pages implemented
- Some overloads added for setting the parent Context
- Some performance improvements in HttpTraceContext implementation
- Removed null checks from the Trace APIs
- The bare API will no longer generate Trace and Span IDs when there is no parent trace context.
- Null Strings are no longer valid keys for Attributes
- BREAKING CHANGE: The Sampler API was changed
- Default endpoint is now set for the OTLP exporters
- BREAKING CHANGE: Jaeger exporter env vars/system properties were updated
- Resource attributes may now be set with a System Property as well as the environment variable.
- Added a propagator for Lightstep OpenTracing propagator
- The ZipkinSpanExporter now defaults to using the OkHttpSender
- The default Sampler in the SDK is now the ParentOrElse sampler
- BUGFIX: SpanWrapper SpanData implementation is now truly Immutable
- Added some simple logging for failed export calls
- Quieted the noisy B3 propagator
- Public constants were added for exporter configuration options
- Added a new configuration option to limit the size of Span attributes
- Many thanks for contributions from @anuraaga, @dengliming, @iNikem, @wtyanan, @williamhu99, @trask, @Oberon00, @MitchellDumovic, @FrankSpitulski, @heyams, @ptravers, @thisthat, @albertteoh, @evantorrie, @neeraj97,
NOTE: This release contains non-backward-compatible breaking API and SDK changes
- Introduction of immutable Attributes for SpansEvents, Links and Resources
- Introduction of immutable Labels for Metric Instruments and Recordings
- BUGFIX: make sure null Points are not propagated to metric exporters
- Added a propagator for AWS X-Ray
- BUGFIX: IntervalMetricReader now handles exceptions thrown by metric exporters
- Renamed contrib modules to "extensions" (Note: this changes the published artifact names, as well)
- Converted CorrelationContext entry keys and values to simple Strings
- Enhanced OTLP exporter configuration options
- Added new SDK Telemetry Resource populator
- Introduced an new MultiTracePropagator to handle multiple propagation formats
- Added new AWS Resource populators
- Added an extension to populate span data into log4j2 log formats.
- Changed the MinMaxSumCount aggregations for ValueRecorders to always aggregate deltas, rather than cumulative
- Updated the OTLP protobuf and exporter to version 0.4.0 of the OTLP protobufs.
TODO: fill this out
- Add helper API to get Tracer/Meter
- Initial implementation of the Zipkin exporter.
- Breaking change: Move B3 propagator to a contrib package
- Add support for Jaeger propagator
- Start implementing support for configuring exporters using Config pattern with support to load from environment variables and system properties.
- Add support to flush the entire SDK processors and exporter pipelines.
- Mark all threads/pools as daemon.
- Add support for Jaeger remote sampler.
- Initial Java API and SDK for context, trace, metrics, resource.
- Initial implementation of the Jaeger exporter.
- Initial implementation of the OTLP exporters for trace and metrics.