Skip to content

Releases: open-telemetry/semantic-conventions

v1.22.0

12 Oct 14:09
cadfe53
Compare
Choose a tag to compare

Breaking

  • BREAKING: Rename all JVM metrics from process.runtime.jvm.* to jvm.*
    (#241)
  • BREAKING: Add namespaces to JVM metric attributes (#20).
    • Rename attributes type to jvm.memory.type, pool to jvm.memory.pool.name
    • Applies to metrics:
      • jvm.memory.usage
      • jvm.memory.init
      • jvm.memory.committed
      • jvm.memory.limit
      • jvm.memory.usage_after_last_gc
    • Rename attributes gc to jvm.gc.name, action to jvm.gc.action
    • Applies to metrics:
      • jvm.gc.duration
    • Rename attribute daemon to thread.daemon
    • Applies to metrics:
      • jvm.threads.count
    • Rename attribute pool to jvm.buffer.pool.name
    • Applies to metrics:
      • jvm.buffer.usage
      • jvm.buffer.limit
      • jvm.buffer.count
  • BREAKING: Rename http.client.duration and http.server.duration metrics to
    http.client.request.duration and http.server.request.duration respectively.
    (#224)
  • BREAKING: Rename jvm.classes.current_loaded metrics to jvm.classes.count
    (#60)
  • BREAKING: Remove pluralization from JVM metric namespaces.
    (#252)
  • BREAKING: Rename metrics jvm.buffer.usage to jvm.buffer.memory.usage
    and jvm.buffer.limit to jvm.buffer.memory.limit.
    (#253)
  • BREAKING: Change HTTP span name when method is unknown (use HTTP instead of _OTHER)
    (#270)
  • BREAKING: Generate System metrics semconv from YAML.
    (#89)
    • Rename attributes for system.cpu.* metrics:
      • state to system.cpu.state
      • cpu to system.cpu.logical_number
    • Rename attributes for system.memory.* metrics:
      • state to system.memory.state
    • Rename attributes for system.paging.* metrics:
      • state to system.paging.state
      • type to system.paging.type
      • direction to system.paging.direction
    • Rename attributes for system.disk.* metrics:
      • device to system.device
      • direction to system.disk.direction
    • Rename attributes for system.filesystem.* metrics:
      • device to system.device
      • state to system.filesystem.state
      • type to system.filesystem.type
      • mode to system.filesystem.mode
      • mountpoint to system.filesystem.mountpoint
    • Rename attributes for system.network.* metrics:
      • device to system.device
      • direction to system.network.direction
      • protocol to network.protocol
      • state to system.network.state
    • Rename attributes for system.processes.* metrics:
      • status to system.processes.status
  • BREAKING: Rename messaging.message.payload_size_bytes to messaging.message.body.size,
    remove messaging.message.payload_compressed_size_bytes.
    (#229)
  • BREAKING: Rename http.server.request.size metric to http.server.request.body.size
    and http.server.response.size metric to http.server.response.body.size
    (#247)
  • BREAKING: Remove the zero bucket boundary from http.server.request.duration
    and http.client.request.duration.
    (#318)
  • BREAKING: Rename telemetry.auto.version resource attribute to telemetry.distro.version
    and add telemetry.distro.name resource attribute
    (#178)
  • BREAKING: Add url.scheme to http.client.* metrics
    (#357)
  • BREAKING: Remove server.socket.address from HTTP and RPC client metrics.
    (#350)
  • BREAKING: Rename/replace (client|server).socket.(address|port) attributes
    with network.(peer|local).(address|port).
    (#342)

Non-Breaking

  • Remove experimental Kafka metrics (#338)
  • Adds session.id and session.md to general docs and model
    (#215)
  • Add container.labels.<key> attributes.
    (#125)
  • Add cluster.name and node.name attributes to Elasticsearch semantic conventions.
    (#285)
  • Fix the unit of metric.process.runtime.jvm.system.cpu.load_1m to be {run_queue_item}
    (#95)
  • Update .count metric naming convention so that it only applies to UpDownCounters,
    and add that .total should not be used by either Counters or UpDownCounters
    (#107)
  • Add oci.manifest.digest, container.image.repo_digests attributes. Make container.image.tag array and in plural form.
    (#159)
  • Update HTTP network.protocol.version examples to match HTTP RFCs.
    (#228)
  • Re-introduce namespace and attributes to describe the original destination messages were
    published to (messaging.destination_publish.*).
    (#156)
  • Generate FaaS metric semantic conventions from YAML.
    (#88)
    The conventions cover metrics that are recorded by the FaaS itself and not by
    clients invoking them.
  • Clarify that http/dup has higher precedence than http in case both values are present
    in OTEL_SEMCONV_STABILITY_OPT_IN
    (#249)
  • Add jvm.cpu.count metric.
    (#52)
  • Simplify HTTP metric briefs.
    (#276)
  • Add host cpu resource attributes.
    (#209)
  • Introduce error.type attribute and use it in HTTP conventions
    (#205)
  • Moved RPC streaming notes from metric brief section to notes section.
    (#275)
  • Updates client.address to allow domain names for consistency with server.address.
    (#302)
  • Add system.linux.memory.available metric.
    (#323)
  • Move non-network.* attributes out of network.yaml.
    (#296)
  • Introducing Android android.os.api_level resource attribute.
    (#328)
  • Added os.build_id resource attribute.
    (#293)
  • Encourage setting network.transport when reporting port numbers
    (#289)
  • Improve network attribute briefs.
    (#352)
  • Document the difference between host and system metrics
    (#324)
  • Improve HTTP metric briefs.
    (#366)
  • Add host.ip resource attribute convention.
    (#203)
  • Make network.protocol.name|version description consistent between HTTP
    spans and metrics.
    (#367)

v1.21.0

13 Jul 18:49
e531541
Compare
Choose a tag to compare

Note: This is the first release of Semantic Conventions separate from the Specification.

  • Add GCP Bare Metal Solution as a cloud platform
    (#64)
  • Clarify the scope of the HTTP client span.
    (#3290)
  • Add moratorium on relying on schema transformations for telemetry stability
    (#3380)
  • Mark "Instrumentation Units" and "Instrumentation Types" sections of the general
    metric semantic conventions as stable
    (#3294)
  • Add clarification that UCUM c/s variant applies to all units other than 1 and
    those using annotations.
    (#3393)
  • Specify that seconds should be used for measuring durations.
    (#3388)
  • Change http.server.duration and http.client.duration units to seconds
    (#3390)
  • BREAKING: Remove messaging.consumer.id, make messaging.client_id generic
    (#3336)
  • Add transition plan for upcoming breaking changes to the unstable HTTP semantic
    conventions.
    (#3443)
  • Rename net.peer.*, net.host.*, and net.sock.* attributes to align with ECS
    (#3402)
    BREAKING: rename net.peer.name to server.address on client side and to client.address on server side,
    net.peer.port to server.port on client side and to client.port on server side,
    net.host.name and net.host.port to server.address and server.port (since net.host.* attributes only applied to server instrumentation),
    net.sock.peer.addr to server.socket.address on client side and to client.socket.address on server side,
    net.sock.peer.port to server.socket.port on client side and to client.socket.port on server side,
    net.sock.peer.name to server.socket.domain (since net.sock.peer.name only applied to client instrumentation),
    net.sock.host.addr to server.socket.address (since net.sock.host.* only applied to server instrumentation),
    net.sock.host.port to server.socket.port (similarly since net.sock.host.* only applied to server instrumentation),
    http.client_ip to client.address
  • BREAKING: Introduce network.transport defined as
    OSI Transport Layer or
    Inter-process Communication method.
    Introduce network.type defined as OSI Network Layer
    or non-OSI equivalent. Remove net.transport and net.sock.family.
    Rename net.protocol.* to network.protocol.*,
    net.host.connection.* to network.connection.*, and
    net.host.carrier.* to network.carrier.*.
    (#3426)
  • BREAKING: Adopt ECS attributes in HTTP semantic conventions.
    Renames: http.method to http.request.method,
    http.status_code to http.response.status_code,
    http.request_content_length to http.request.body.size,
    http.response_content_length to http.response.body.size,
    http.url to url.full,
    http.scheme to url.scheme,
    and removes http.target breaking it down to http.target to url.path, url.query, and url.fragment.
    (#3355)
  • Add gcp.cloud_run.job.execution and gcp.cloud_run.job.task_id resource
    attributes for GCP Cloud Run Jobs (#3378)
  • Specify second unit (s) and advice bucket boundaries of []
    for process.runtime.jvm.gc.duration.
    (#3458)
  • Specify the value range for JVM CPU metrics.
    (#13)
  • Rename process.runtime.jvm.cpu.utilization to process.runtime.jvm.cpu.recent_utilization.
    (#53)
  • Clarify process.runtime.jvm.threads.count refers to platform threads.
    (#54)
  • Add gcp.gce.instance.name and gcp.gce.instance.hostname resource
    attributes for GCP Compute Engine VMs. (#15)
  • Add note that HTTP duration metrics should match HTTP span duration.
    (#69)
  • Clarify when HTTP client spans should end.
    (#70)
  • Clarify that OTEL_SEMCONV_STABILITY_OPT_IN is a comma-separated list of values
    (#104)
  • Add process.runtime.jvm.cpu.time metric.
    (#55)
  • Split out sections for proposed stable JVM metrics and experimental JVM metrics.
    (#56)
  • Make url.query conditionally required for HTTP spans.
    (#118)
  • Change server.address and server.port requirement levels on HTTP server metrics
    from required to opt_in.
    (#109)
  • Updated AWS Java Lambda guidance - using system properties.
    (#27)
  • Limit http.request.method values to a closed set of known values,
    introduce http.request.method_original for the original value.
    (#17)
  • Mark service.version as stable.
    (#106)
  • Mark initial set of HTTP semantic conventions as frozen
    (#105)
  • BREAKING: Remove messaging.source.* attributes and use messaging.destination.*
    attributes on producer and consumer to describe messaging queue or topic.
    (#100)
  • Mark process.runtime.jvm.system.cpu.load_1m and process.runtime.jvm.system.cpu.utilization metrics as opt-in.
    (#57)
  • Add container image.id, command, command_line and command_args resource attributes.
    (#39)
  • Add Elasticsearch client semantic conventions.
    (#23)
  • Add YAML definitions for log semantic conventions and define requirement levels
    (#133)
  • Add markdown file for url semantic conventions
    (#174)