Audit for 1.13.0 spec compliance

[ahayworth]

Spec release 1.13.0 is available:

• Release notes
• Diff v1.12.0...v1.13.0

The release should be audited for issues pertinent to opentelemetry-ruby, and issues created for any outstanding spec compliance work. Make sure to tag those issues with the spec-compliance and spec-compliance/v1.13.0 labels, and add them to the Spec Compliance project.

[ahayworth]

Traces

• Clarify the return of Export(batch) in the Batch Span Processor and exporter concurrency (span exporter concurrency: expand on Export() requirements opentelemetry-specification#2452)
  • ✅ The clarified requirements state that calls to export must not happen concurrently, but that the export itself can be done concurrently within the exporter. As far as I can tell, we simply have no concurrency in any of our exporters, so we're okay here.
• Clarify that Context should not be mutable when setting a span (Make clear that context is not mutable when setting a span opentelemetry-specification#2637)
  • ✅ Our contexts are immutable, as far as I can tell. Granted, is anything in ruby every truly immutable? Of course not, but our Context code treats things as if they are. 😄
• Clarify that ForceFlush is a required method on SpanExporter interface (Clarify SpanExporter#ForceFlush is required opentelemetry-specification#2654)
  • ✅ We're good here, all exporters (even the in-memory and console exporters) implement this interface.

Metrics

• Add experimental OTEL_EXPORTER_OTLP_DEFAULT_HISTOGRAM_AGGREGATION variable for configuring default histogram aggregation of OTLP metric exporter (Config option enabling exponential histogram as default histogram aggregation opentelemetry-specification#2619)
• Clarify async instrument callback identity (Clarify async instrument callback identity opentelemetry-specification#2538)
• Prometheus export: Only monotonic sum are counters (with _total) (Only monotonic sum are counters (with _total) opentelemetry-specification#2644)
• [OM/OTLP] Use _created for StartTimeUnixNano and vice-versa ([OM/OTLP] Use _created for StartTimeUnixNano and vice-versa opentelemetry-specification#2645)
• Prometheus compatibility: use target_info metric instead of "target" info MF (Prometheus compatibility: use target_info metric instead of "target" info MF opentelemetry-specification#2701)
• Add optional Zero Threshold for Exponential Histograms to the metrics data model (Add optional Zero Threshold for Exponential Histograms to the metrics data model opentelemetry-specification#2665)
• Change the inclusivity of exponential histogram bounds (Change the inclusivity of exponential histogram bounds opentelemetry-specification#2633)
• Add process.threads host metric semantic convention. (Add process.threads opentelemetry-specification#2705).

Logs

Logs? What logs? 🙃

Resource

• Update the version of the W3C Baggage specification used for OTEL_RESOURCE_ATTRIBUTES (Update SDK spec to the latest W3C Baggage spec version opentelemetry-specification#2670)
  • Tracked in Handle partial success responses from OTLP export services #1361

Semantic Conventions

• We need to update the version of the semconv gem to pull all of these in:
  • Add net.app.protocol.* attributes (Add semantic convention attributes for capturing the application layer protocol opentelemetry-specification#2602)
  • Add network metrics to process semantic conventions (Add network metrics to process semantic conventions opentelemetry-specification#2556)
  • Add semantic conventions for GraphQL (Add semantic conventions for GraphQL opentelemetry-specification#2456)
  • Add rpc.grpc.status_code to RPC metric semantic conventions (Add rpc.grpc.status_code attribute to rpc metric semantic conventions opentelemetry-specification#2604)
  • Add http...size metric semantic conventions for tracking size of requests
    / responses for http servers / clients (Add metrics for http request and response size opentelemetry-specification#2588)
  • Define socket-level attributes and clarify logical peer and host attributes meaning (Adopt attribute requirement levels in semantic conventions opentelemetry-specification#2594)
  • Add semantic conventions for JVM buffer pool usage (Add JVM buffer pool semantic conventions opentelemetry-specification#2650)
  • Improve the definition of state attribute for metric system.network.connections (add definition for state attribute of system.network.connections opentelemetry-specification#2663)
  • Add OpenSearch to db.system semantic conventions (Add OpenSearch in the database group opentelemetry-specification#2718)
  • Remove alternative attribute sets from HTTP semantic conventions (Remove alternative attribute sets from HTTP semantic conventions opentelemetry-specification#2469)
  • Add the convention 'type' to the YAML definitions for all existing semantic conventions (Add 'type' to all groups opentelemetry-specification#2693)
• Add process.parent_pid attribute for use in reporting parent process id (PID) (add process.parent_pid attribute opentelemetry-specification#2691)
• Clarify when "count" is used instead of pluralization (Clarify when "count" is used instead of pluralization opentelemetry-specification#2613)
• Adopt attribute requirement levels in semantic conventions (Adopt attribute requirement levels in semantic conventions opentelemetry-specification#2594)
  • Since attribute requirement levels were just adopted, these should come along "for free" and don't need separate auditing (I think).
    • Change cloudevents.event_spec_version and cloudevents.event_type level from required to recommended (cloudevents: relax requirement level for type and version opentelemetry-specification#2618)
    • Change faas.document.time and faas.time level from required to recommended (FaaS conventions: make faas.document.time and faas.time attributes recommended opentelemetry-specification#2627)
• BREAKING: rename net.peer.ip to net.sock.peer.addr, net.host.ip to net.sock.host.addr,
  net.peer.name to net.sock.peer.name for socket-level instrumentation.
  • This change should get pulled in with the update to semconv, but we should audit to ensure that we update any calling code which might be referencing it.
  • I believe we have references to it manually, without using the semconv gem: zipkin exporter

OpenTelemetry Protocol

• Add support for partial success in an OTLP export response (Add support for partial success in an OTLP export response [2] opentelemetry-specification#2696)
  • Tracked in Handle partial success responses from OTLP export services #1361

SDK Configuration

• Mark OTEL_METRIC_EXPORT_INTERVAL, OTEL_METRIC_EXPORT_TIMEOUT
  environment variables as Stable (Make periodic exporting MetricReader env vars stable opentelemetry-specification#2658)

Telemetry Schemas

• Introduce "split" metric schema transformation (Introduce "split" metric schema transformation opentelemetry-specification#2653)

Common

• Introduce Instrumentation Scope Attributes (Introduce Instrumentation Scope Attributes opentelemetry-specification#2579)
  • Define Instrumentation Scope Attributes as non identifiers (Remove scope attributes form the Scope identity opentelemetry-specification#2789)

[github-actions]

👋 This issue has been marked as stale because it has been open with no activity. You can: comment on the issue or remove the stale label to hold stale off for a while, add the keep label to hold stale off permanently, or do nothing. If you do nothing this issue will be closed eventually by the stale bot.