Release v1.4.0

v1.4.0 (2021-06-07)

Context

• No changes.

Traces

• Add schema_url support to Tracer. (#1666)
• Add Dropped Links Count to non-otlp exporters section (#1697)
• Add note about reporting dropped counts for attributes, events, links. (#1699)

Metrics

• Add schema_url support to Meter. (#1666)
• Adds detail about when to use StartTimeUnixNano and handling of unknown start-time resets. (#1646)
• Expand Gauge metric description in the data model (#1661)
• Expand Histogram metric description in the data model (#1664)
• Added Experimental Metrics API specification.
  (#1401,
  #1557,
  #1578,
  #1590,
  #1594,
  #1617,
  #1645,
  #1657,
  #1665,
  #1672,
  #1674,
  #1675,
  #1703,
  #1704,
  #1731,
  #1733)
• Mark relevant portions of Metrics Data Model stable (#1728)

Logs

• No changes.

Resource

• Add schema_url support to Resource. (#1692)
• Clarify result of Resource merging and ResourceDetector aggregation in case of error. (#1726)

Semantic Conventions

• Add JSON RPC specific conventions (#1643).
• Add Memcached to Database specific conventions (#1689).
• Add semantic convention attributes for the host device and added OS name and version (#1596).
• Add CockroachDB to Database specific conventions (#1725).

Compatibility

• No changes.

OpenTelemetry Protocol

• No changes.

SDK Configuration

• Add OTEL_SERVICE_NAME environment variable. (#1677)

Release v1.3.0

v1.3.0 (2021-05-05)

Context

• No changes.

Traces

• Get Tracer should use an empty string if the specified name is null. (#1654)
• Clarify how to record dropped attribute count in non-OTLP formats. (#1662)

Metrics

• Expand description of Event Model and Instruments. (#1614)
• Flesh out metric identity and single-write principle. (#1574)
• Expand Sum metric description in the data model and delta-to-cumulative handling. (#1618)
• Remove the "Func" name, use "Asynchronous" and "Observable". (#1645)
• Add details to UpDownCounter API. (#1665)
• Add details to Histogram API. (#1657)

Logs

• Clarify "key/value pair list" vs "map" in Log Data Model. (#1604)

Semantic Conventions

• Fix the inconsistent formatting of semantic convention enums. (#1598)
• Add details for filling resource for AWS Lambda. (#1610)
• Add already specified messaging.rabbitmq.routing_key span attribute key to the respective YAML file. (#1651)
• Clarify usage of "otel." attribute namespace. (#1640)
• Add possibility to disable db.statement via instrumentation configuration. (#1659)

Compatibility

• No changes.

OpenTelemetry Protocol

• Fix incorrect table of transient errors. (#1642)
• Clarify that 64 bit integer numbers are decimal strings in OTLP/JSON. (#1637)

SDK Configuration

• Add OTEL_EXPORTER_JAEGER_TIMEOUT environment variable. (#1612)
• Add OTEL_EXPORTER_ZIPKIN_TIMEOUT environment variable. (#1636)

Release v1.2.0

v1.2.0 (2021-04-14)

Context

• Clarify composite TextMapPropagator method required and optional arguments. (#1541)
• Clarify B3 requirements and configuration. (#1570)

Traces

• Add ForceFlush to Span Exporter interface (#1467)
• Clarify the description for the TraceIdRatioBased sampler needs to include the sampler's sampling ratio. (#1536)
• Define the fallback tracer name for invalid values.
  (#1534)
• Clarify non-blocking requirement from span API End. (#1555)
• Remove the Included Propagators section from trace API specification that was a duplicate of the Propagators Distribution of the context specification. (#1556)
• Remove the Baggage API propagator notes that conflict with the API Propagators Operations section and fix #1526. (#1575)

Metrics

• Adds new metric data model specification (#1512)

Semantic Conventions

• Add semantic conventions for AWS SDK operations and DynamoDB (#1422)
• Add details for filling semantic conventions for AWS Lambda (#1442)
• Update semantic conventions to distinguish between int and double (#1550)
• Add semantic convention for AWS ECS task revision (#1581)

Compatibility

• Add initial OpenTracing compatibility section.
  (#1101)

Release v1.1.0

v1.1.0 (2021-03-11)

Traces

• Implementations can ignore links with invalid SpanContext(#1492)
• Add none as a possible value for OTEL_TRACES_EXPORTER to disable export
  (#1439)
• Add ForceFlush to SDK's TracerProvider (#1452)

Metrics

• Add none as a possible value for OTEL_METRICS_EXPORTER to disable export
  (#1439)

Logs

Semantic Conventions

• Add elasticsearch to db.system semantic conventions (#1463)
• Add arch to host semantic conventions (#1483)
• Add runtime to container semantic conventions (#1482)
• Rename gcp_gke to gcp_kubernetes_engine to have consistency with other
  Google products under cloud.infrastructure_service (#1496)
• http.url MUST NOT contain credentials (#1502)
• Add aws.eks.cluster.arn to EKS specific semantic conventions (#1484)
• Rename zone to availability_zone in cloud semantic conventions (#1495)

Release v1.0.1

New:

• Fix rebase issue for span limit default values (#1429)

See v1.0.0 for a list of substantial changes.

Release v1.0.0

v1.0.0

This version of the OpenTelemetry specification includes a stable release of the Tracing API and Tracing SDK components.

Every document in the specification is now marked as either stable or experimental. Please read the versioning and support document for details.

Caveats

• Missed #1429 we will do a patch release v1.0.1 asap.

As part of this release we are marking a large part of our specification stable:

• Trace (API/SDK)
• Context
• Baggage

New:

• Add cloud.infrastructure_service resource attribute
  (#1112)
• Add SpanLimits as a configuration for the TracerProvider(#1416)

Updates:

• Update default limit for span attributes, events, links to 128(#1419)
• Update OT Trace propagator environment variable to match latest name(#1406)
• Remove Metrics SDK specification to avoid confusion, clarify that Metrics API
  specification is not recommended for client implementation
  (#1401)
• Rename OTEL_TRACE_SAMPLER and OTEL_TRACE_SAMPLER_ARG env variables to OTEL_TRACES_SAMPLER and OTEL_TRACES_SAMPLER_ARG
  (#1382)
• Mark some entries in compliance matrix as optional(#1359)
  SDKs are free to provide support at their discretion.
• Rename signal-specific variables for OTLP_EXPORTER_* to OTLP_EXPORTER_TRACES_* and OTLP_EXPORTER_METRICS_*(#1362)
• Versioning and stability guarantees for OpenTelemetry clients(#1291)
• Additional Cassandra semantic attributes
  (#1217)
• OTEL_EXPORTER environment variable replaced with OTEL_TRACES_EXPORTER and
  OTEL_METRICS_EXPORTER which each accept only a single value, not a list.
  (#1318)
• process.runtime.description resource convention: Add java.vm.name
  (#1242)
• Refine span name guideline for SQL database spans
  (#1219)
• Add RPC semantic conventions for metrics
  (#1162)
• Clarify Description usage on Status API
  (#1257)
• Add/Update Status + error mapping for Jaeger & Zipkin Exporters
  (#1257)
• Resource's service.name MUST have a default value, service.instance.id is not
  required.
  (#1269)
  • Clarified in #1294
• Add requirement that the SDK allow custom generation of Trace IDs and Span IDs
  (#1006)
• Add default ratio when TraceIdRatioSampler is specified by environment variable but
  no ratio is.
  (#1322)
• Require schemed endpoints for OTLP exporters
  (1234)
• Resource SDK: Reverse (suggested) order of Resource.Merge parameters, remove
  special case for empty strings
  (#1345)
• Resource attributes: lowerecased the allowed values of the aws.ecs.launchtype
  attribute
  (#1339)
• Trace Exporters: Fix TODOs in Jaeger exporter spec
  (#1374)
• Clarify that Jaeger/Zipkin exporters must rely on the default Resource to
  get service.name if none was specified.
  (#1386)
• Modify OTLP/Zipkin Exporter format variables for 1.0 (allowing further specification post 1.0)
  (#1358)
• Add k8s.node semantic conventions (#1390)
• Clarify stability for both OTLP/HTTP and signals in OTLP.
  (#1400)

Release v0.7.0

v0.7.0 (11-18-2020)

Trace API was declared frozen 1121

New

• Document service name mapping for Jaeger exporters
  (1222)
• Change default OTLP port number
  (#1221)
• Add performance benchmark specification
  (#748)
• Enforce that the Baggage API must be fully functional, even without an installed SDK.
  (#1103)
• Rename "Canonical status code" to "Status code"
  (#1081)
• Add Metadata for Baggage entries, and clarify W3C Baggage Propagator implementation
  (#1066)
• Change Status to be consistent with Link and Event
  (#1067)
• Clarify env variables in otlp exporter
  (#975)
• Add Prometheus exporter environment variables
  (#1021)
• Default propagators in un-configured API must be no-op
  (#930)
• Define resource mapping for Jaeger exporters
  (#891)
• Add resource semantic conventions for operating systems
  (#693)
• Add semantic convention for source code attributes
  (#901)
• Add semantic conventions for outgoing Function as a Service (FaaS) invocations
  (#862)
• Add resource semantic convention for deployment environment
  (#606)
• Refine semantic conventions for messaging systems and add specific attributes for Kafka
  (#1027)
• Clarification of the behavior of the Trace API, re: context propagation, in
  the absence of an installed SDK
• Add API and semantic conventions for recording exceptions as Span Events
  (#697)
  • API was extended to allow adding arbitrary event attributes (#874)
  • exception.escaped semantic span event attribute was added
    (#784,
    #946)
• Allow samplers to modify tracestate
  (#988)
• Update the header name for otel baggage, and version date
  (#981)
• Define PropagationOnly Span to simplify active Span logic in Context
  (#994)
• Add limits to the number of attributes, events, and links in SDK Spans
  (#942)
• Add Metric SDK specification (partial): covering terminology and Accumulator component
  (#626)
• Clarify context interaction for trace module
  (#1063)
• Add Shutdown function to *Provider SDK
  (#1074)
• Add semantic conventions for system metrics
  (#937)
• Add db.sql.table to semantic conventions, allow db.operation for SQL
  (#1141)
• Add OTEL_TRACE_SAMPLER env variable definition
  (#1136)
• Add guidelines for OpenMetrics interoperability
  (#1154)
• Add OTEL_TRACE_SAMPLER_ARG env variable definition
  (#1202)

Updates

• Clarify null SHOULD NOT be allowed even in arrays
  (#1214)
• Remove ordering SHOULD-requirement for attributes
  (#1212)
• Make process.pid optional, split process.command_args from command_line
  (#1137)
• Renamed CorrelationContext to Baggage:
  (#857)
• Add semantic convention for NGINX custom HTTP 499 status code.
• Adapt semantic conventions for the span name of messaging systems
  (#690)
• Remove lazy Event and Link API from Span interface
  (#840)
  • SIGs are recommended to remove any existing implementation of the lazy APIs
    to avoid conflicts/breaking changes in case they will be reintroduced to the
    spec in future.
• Provide clear definitions for readable and read/write span interfaces in the
  SDK
  (#669)
  • SpanProcessors must provide read/write access at least in OnStart.
• Specify how Probability sampler is used with ParentOrElse sampler.
• Clarify event timestamp origin and range
  (#839)
• Clean up api-propagators.md, by extending documentation and removing redundant
  sections
  (#577)
• Rename HTTPText propagator to TextMap
  (#793)
• Rename ParentOrElse sampler to ParentBased and add multiple delegate samplers
  (#610)
• Rename ProbabilitySampler to TraceIdRatioBasedSampler and add requirements
  (#611)
• Version attributes no longer have a prefix such as semver:
  (#873)
• Add semantic conventions for process runtime
  (#882,
  #1137)
• Use hex encoding for trace id and span id fields in OTLP JSON encoding:
  (#911)
• Explicitly specify the SpanContext APIs IsValid and IsRemote as required
  (#914)
• A full Context is the only way to specify a parent of a Span.
  SpanContext or even Span are not allowed anymore.
  (#875)
• Remove obsolete http.status_text from semantic conventions
  (#972)
• Define null as an invalid value for attributes and declare attempts to set
  null as undefined behavior
  (#992)
• SDK: Rename the Decision values for SamplingResults to DROP, RECORD_ONLY
  and RECORD_AND_SAMPLE for consistency
  (#938,
  #956)
• Metrics API: Replace "Additive" with "Adding", "Non-Additive" with "Grouping"
  (#983
• Move active span interaction in the Trace API to a separate class
  (#923)
• Metrics SDK: Specify LastValue default aggregation for ValueObserver
  (#984
• Metrics SDK: Specify TBD default aggregation for ValueRecorder
  (#984
• Trace SDK: Sampler.ShouldSample gets parent Context instead of SpanContext
  (#881)
• SDK: Specify known values, as well as basic error handling for OTEL_PROPAGATORS.
  (#962)
  (#995)
• SDK: Specify when to generate new IDs with sampling
  (#1225)
• Remove custom header name for Baggage, use official header
  (#993)
• Trace API: Clarifications for Span.End, e.g. IsRecording becomes false after End...

Release v0.6.0

• Semantic convention additions & improvements.
• Clarifications for tracing components.
• Minor context propagation refinements.

Release v0.5.0

• Update api-metrics-user.md and api-metrics-meter.md with the latest metrics API.
• Define initial Log Data Model.
• More details about what is released can be found in this milestone.

Release v0.4.0

• Redesign the Metrics API.
• More details about what is released can be found in this milestone