-
messaging
: Support generic operations in messaging and rename metrics:- Make
messaging.operation.name
required andmessaging.operation.type
conditionally required when type is applicable. - Rename
messaging.publish.messages
metric tomessaging.client.published.messages
- Unify
messaging.publish.duration
andmessaging.receive.duration
metrics intomessaging.client.operation.duration
- Unify
messaging.receive.messages
andmessaging.process.messages
metrics intomessaging.client.consumed.messages
(#1006, #947, #937)
- Make
-
db
: Clean updb.system
enum members:- remove
firstsql
,mssqlcompact
, andcloudscape
as the corresponding databases are discontinued. - rename
cache
tointersystems_cache
- remove
coldfusion
as it is not a database. (#1110)
- remove
-
db
: Renamedb.client.connections.*
attributes todb.client.connection.*
(#1125) -
messaging
: Renamemessaging.kafka.message.offset
tomessaging.kafka.offset
(#1156) -
db
: Sampling relevant attributes defined for database client spans (#1019) -
tls
: Deprecatetls.client.server_name attribute
in favor of commonserver.address
. (#1211, #1216) -
messaging
: Deprecate `messaging.destination_publish.*`` namespace and remove all usages. (#1178, #1241) -
messaging
: Introduce common attributes for consumer group and subscription name instead of per-system ones: -messaging.consumer.group.name
instead ofmessaging.kafka.consumer.group
,messaging.rocketmq.client_group
, andmessaging.eventhubs.consumer.group
. -messaging.destination.subscription.name
instead ofmessaging.servicebus.destination.subscription_name
. Use it in the Google Pub/Sub conventions. (#815) -
db
: Align Elasticsearch span name to the general database span name guidelines. Deprecatesdb.elasticsearch.cluster.name
in favor ofdb.namespace
. (#1002) -
cicd, deployment, artifact, test, vcs
: Adds CICD common attributes to the registry. (#915, #832, #833)- CICD common attributes have been added to the registry.
deployment.environment
has been deprecated and moved todeployment.environment.name
.
-
jvm
: Rename JVM metricjvm.buffer.memory.usage
tojvm.buffer.memory.used
(#288) -
system
: Renameprocess.cpu.state
,container.cpu.state
, andsystem.cpu.state
attributes into a commoncpu.mode
attribute (#840)
azure
: Add Azure SDK attributes & Logs event semantic conventions (#1027)go
: Add new go namespace for Go runtime metrics (#535)nodejs
: Introducing semantic conventions for Node.js runtime metrics. (#990)user
: BREAKING - deprecateenduser
in favor of a newuser
namespace. Add moreuser
attributes. (#731)v8js
: Introducing semantic conventions for V8 JS Engine runtime metrics. (#990)
db
: List SQL database systems on the SQL semantic conventions. (#1024)db
: Update database span name: clarify that target depends on the operation and should not be set when corresponding data is not available. (#1045)db
: Mention how to capture collection and operation names from query text in the registry (#1070)docs
: Don't render deprecated enum members in semconv tables. (#1110)gen-ai
: Use GenAI instead of LLM on GenAI trace semantic conventions and minor cleanups. (#1087)gen-ai
: Add GenAI model server metrics for measuring LLM serving latency (#1102)db
: Clarify thatdb.query.parameter.<key>
is string representation of the parameter value (#1165)messaging
: Clarify how per-message attributes should be recorded for batch operations. (#1168)messaging
: Define sampling relevant attributes for messaging client spans (#432, #1169)gen_ai
: Renamegen_ai.usage.prompt_tokens
togen_ai.usage.input_tokens
andgen_ai.usage.completion_tokens
togen_ai.usage.output_tokens
to align terminology between spans and metrics. (#1200)gen_ai
: Convertgen_ai.operation.name
to enum and use it on spans (#1202)network
: Add QUIC to the list of well known network transports (#1237, #1239)db
:db.query.text
IN-clauses MAY be collapsed during the sanitization process (#1053)db
,messaging
: Clarify that DB and messaging system-specific conventions override common ones (#1235, #1244)db
: Add better example of how to make the pool name unique (#1289)docs
: Update semantic conventions code generation documentation to use weaver instead of build-tools. (#1296)gen_ai
: Addserver.address
,server.port
, anderror.type
to GenAI spans. (#1297)gen-ai
: Adding metrics for GenAI clients. (#811)gen-ai
: Addinggen_ai.request.top_k
,gen_ai.request.presence_penalty
,gen_ai.request.frequency_penalty
andgen_ai.request.stop_sequences
attributes. (#839)messaging
: Documentmessaging.operation.name
for Azure messaging systems. (#942)all
: Define name abbreviations guidelines in attribute and metric names. (#1121)messaging
: Add pulsar message system (#1099)linux
: Add thesystem.linux.memory.slab.usage
metric and thelinux.memory.slab.state
attributes. (#531)cloudevents
: CloudEvents conventions to follow HTTP/Messaging Span conventions (#654)db
: Add support for database batch operations (#712)db
: Specify sanitization fordb.query.text
. (#717)gen-ai
: Add 3 well-known gen-ai systems as reference values of the gen-ai system attribute (#1020)gcp
: Introducesgcp.client.service
scope attribute. (#1047)db
: Add semantic convention of InfluxDB (#949)log
: Add 'log.record.original' attribute. (#1137)session
: Add new experimentalsession.start
andsession.end
events (#1091)
messaging
: Update Kafka Spring example to align with the messaging spec (#1155)http
: Relax requirement on when to set HTTP span status to Error fromMUST
toSHOULD
. (#1167, #1003)
-
db
: Renamedb.statement
todb.query.text
and introducedb.query.parameter.<key>
(#716) -
db
: Renamesdb.sql.table
,db.cassandra.table
,db.mongodb.collection
, anddb.cosmosdb.container
attributes todb.collection.name
(#870) -
db
: Renamedb.operation
todb.operation.name
. (#884) -
messaging
: Renamemessaging.operation
tomessaging.operation.type
, addmessaging.operation.name
. (#890) -
db
: Deprecate thedb.user
attribute. (#885) -
db
: Renamedb.name
anddb.redis.database_index
todb.namespace
, deprecatedb.mssql.instance_name
. (#885) -
db
: Removedb.instance.id
. For Elasticsearch, replace withdb.elasticsearch.node.name
. (#972) -
db
: Clarify database span name format and fallback values. (#974, #704) -
db
: Renamedb.client.connections.*
metric namespace todb.client.connection.*
and renamedb.client.connection.usage
todb.client.connection.count
. (#201, #967) -
db
: Renamepool.name
todb.client.connections.pool.name
andstate
todb.client.connections.state
. (#909) -
system
: Deprecateshared
fromsystem.memory.state
values and make it a standalone metric (#522) -
device.app.lifecycle
: Reformat and update thedevice.app.lifecycle
event description adds constraints for the possible values of theandroid.state
andios.state
. (#794) Removes theios.lifecycle.events
andandroid.lifecycle.events
attributes from the global registry and adds constraints for the possible values of theandroid.state
andios.state
attributes. -
messaging
: Renamemessaging.client_id
tomessaging.client.id
(#935) -
rpc
: Renamemessage.*
attributes underrpc
torpc.message.*
. Deprecate oldmessage.*
attributes. (#854)
gen-ai
: Introducing semantic conventions for GenAI clients. (#327)
-
all
: Markdown snippets are now generated by jinja templates in thetemplates
directory. (#1000) -
db, messaging, gen_ai
: Clarify thatdb.system
,messaging.system
,gen_ai.system
attributes capture the client perception and may differ from the actual product name. (#813, #1016) -
messaging
: Show all applicable attributes in individual messaging semantic conventions. (#869, #1018) -
process
: Add additional attributes to process attribute registry (#564) -
messaging
: Add a GCP Pub/Sub unary pull example and the new GCP messaging attributes: -messaging.gcp_pubsub.message.ack_deadline
, -messaging.gcp_pubsub.message.ack_id
, -messaging.gcp_pubsub.message.delivery_attempt
(#527) -
db
: Adddb.client.operation.duration
metric (#512) -
messaging
: Adds `messaging.destination.partition.id`` to the messaging attributes (#814) -
exception
: Replace constraints with requirement levels on exceptions. (#862) -
process
: Replace constraints with requirement_level in process attributes. (#863) -
db
: Reorganize DB conventions to be shared across span and metric conventions. (#910) -
all
: Migrate Attribute Registry to be completely autogenerated. (#197) Migrate to using weaver for markdown generation (snippet + registry). The entirety of the registry now is generated using weaver with templates under thetemplates/
directory. Snippets still require a hardcoded command. -
http
: List all HTTP client and server attributes in the corresponding table, remove common attributes from yaml and markdown. (#928) -
other
: Document patterns and suggestions for semconv code generation. (#551, #953) -
db
: Show applicable common attributes in individual database semantic conventions. (#973) -
db
: Adderror.type
attribute to the database span and operation duration metric. (#975) -
db
: Parameterized query text does not need to be sanitized by default (#976) -
http
: List experimental HTTP attributes applicable to HTTP client and server spans. (#989) -
db
: Finalizes the migration requirement for instrumentations to follow when updating to stable database semconv. (#719) -
http
: Newurl.template
attribute added to URL, HTTP client attributes are extended with optional low-cardinalityurl.template
(#675) -
db
: Add note todb.collection.name
,db.namespace
, anddb.operation.name
about capturing those without attempting to do any case normalization. (#886) -
events
: Provides additional definitions of log events and their structure. (#755) -
k8s
: add container.status.last_terminated_reason resource attribute (#922)
http
: Add previously deprecated http attributes to registry (#1025) These attributes were deprecated in 1.13net
: Add previously deprecated net attributes to registry (#1029) These attributes were deprecated in 1.13
messaging
: Removenetwork.transport
andnetwork.type
attributes from messaging semantic conventions, clarify whennetwork.peer.address|port
should be populated. (#690, #698)db
: Removenetwork.transport
andnetwork.type
attributes from database semantic conventions, clarify whennetwork.peer.address|port
should be populated. (#690, #768)messaging
: Introduce commonmessaging.destination.partition.id
instead ofmessaging.kafka.destination.partition
(#798)host
: [resource/host] Change type of host.cpu.stepping to string (#664, #665)system
: Renamesystem.processes.*
namespace tosystem.process.*
(#484)k8s
,container
: Depluralize labels for pod (k8s.pod.labels.*
) and container (container.labels.*
) resources (#625)process
: Generate process metrics from YAML (#330):- Rename
process.threads
toprocess.thread.count
- Rename
process.open_file_descriptors
toprocess.open_file_descriptor.count
- Rename attributes for
process.cpu.*
state
toprocess.cpu.state
- Change attributes for
process.disk.io
- Instead of
direction
usedisk.io.direction
from global registry
- Instead of
- Change attributes for
process.network.io
- Instead of
direction
usenetwork.io.direction
from global registry
- Instead of
- Rename attributes for
process.context_switches
type
toprocess.context_switch_type
- Rename attributes for
process.paging.faults
type
toprocess.paging.fault_type
- Rename
db
: Deprecatedb.connection_string
attribute in favor ofserver.address
andserver.port
(#724, #769)db
: Deprecatedb.jdbc.driver_classname
attribute (#796)
file
: Add new file namespace (#732)
messaging
: Add `messaging.rabbitmq.message.delivery_tag`` to the list of RabbitMQ specific tags (#433)messaging
: Clarify producer span relationships for messaging semantic conventions (#509)rpc
: Add link to specification for metrics defined by gRPC community. (#627)messaging
: Add messaging semantic conventions for settlement spans (#621)messaging
: Clarifies span names for Azure messaging systems and addsmessaging.servicebus.disposition_status attribute
. (#697)messaging
: Add a "Process" spans and metrics for messaging (#657)db
: Update Elasticsearch attributes to use db.instance.id instead of db.elasticsearch.node.name (#725)db
: Merge DB connection-level and call-level attributes tables (#780)dns
: Introduces common DNS lookup duration metric and attributes. (#404)other
: Update build-tools version to 0.24.0 and make semantic conventions compatible with this version (add stability on enum members and deprecated attributes). (#807)system
: Alignsystem.cpu.state
's definition with this ofprocess.cpu.state
. (#563)container
: Add new container metrics forcpu
,memory
,disk
andnetwork
(#282, #72)url
: Sensitive content provided inurl.full
,url.path
, andurl.query
SHOULD be scrubbed when instrumentations can identify it. (#676)metrics
: Clarify metric attributes should be namespaced. (#394)events
: Add clarification that the body of an Event will live in the LogRecord body field. (#566)http
: Addhttp.request.size
andhttp.response.size
attributes for the total number of bytes in http messages (#38, #84)http
: Extracts common HTTP client metrics from .NET conventions. (#800)resource
: Define a common algorithm forservice.instance.id
. (#312)user-agent
: Update user_agent subfields wording to support it's usage for non-browser products with multiple names/versions (#680)url
: Add remaining ECS fields to the url namespace (#496)messaging
: Makenetwork.protocol.name
conditionally required for messaging (#644)cloud
: Addazure_container_apps
tocloud.platform
semantic conventions (#615)user_agent
: Adduser_agent.name
anduser_agent.version
attributes (#452)messaging
: Add an example for gcp_pubsub asynchronous batch publish (#545)aws
: Addaws.ecs.task.id
attribute, corrected description foraws.ecs.task.arn
(#597)messaging
: Add Azure Service Bus and Event Hubs messaging attributes (#572)
aws-lambda
: Fix problem inxray-lambda
propagator definition (#778)http
: Two fixes to the HTTP semconv migration guide (#802)network
: Clarifies that network.protocol.version represents negotiated version (#686)jvm
: Fix JVM buffer metric schema translations (#683)
- Update
jvm.gc.duration
histogram buckets to[ 0.01, 0.1, 1, 10 ]
(#317) - BREAKING: Change type of
host.cpu.model.id
andhost.cpu.model.family
to string. (#499) - Changed
messaging.system
attribute type to an open enum (#517) - Rename metrics
jvm.memory.usage
tojvm.memory.used
andjvm.memory.usage_after_last_gc
tojvm.memory.used_after_last_gc
(#536) - BREAKING: Change
event.name
definition to includenamespace
and removeevent.domain
from log event attributes. (#473) - BREAKING: Change
system.disk.io.direction
andsystem.network.io.direction
to global attributesdisk.io.direction
andnetwork.io.direction
(#530) - BREAKING: Change
messaging.kafka.partition
tomessaging.kafka.destination.partition
(#547)
- Adds
labels
attribute tok8s.pod
resource (#494) - Change Erlang managed thread attribute to be the Erlang process (#491)
- Add gcp_pubsub as a messaging system (#490)
- Adds
annotation
attribute tok8s.pod
resource (#494) - Add
code.stacktrace
attribute (#435) - Add
http.flavor
andhttp.user_agent
to list of deprecated attributes (#503) - Add Semantic conventions for TLS/SSL encrypted communication. (#21)
- Add
messaging.gcp_pubsub.message.ordering_key
attribute. (#528) - Define how to set
process.runtime.name
,process.runtime.version
,process.runtime.description
for .NET runtime. (#561) - Add
db.instance.id
attribute. (#345) - Add messaging metrics (#163)
- Add .NET 8.0 metrics for HTTP client, ASP.NET Core, SignalR server and Kestrel. (#283)
- Add system shared IO direction attributes (#530)
- JVM metrics marked stable (#569)
- Add attribute for k8s pod annotations (#573)
- Replace AWS X-Ray Environment Span Link section with AWS X-Ray Active Tracing Considerations (#354)
- Remove misleading pluralization wording related to count metrics (#488)
- Remove no longer relevant Oct 1 mention from
OTEL_SEMCONV_STABILITY_OPT_IN
(#541) - Update stability definitions of HTTP client and server duration metrics to be consistent with markdown. (#587)
- Use
deprecated
property to mark attributes as deprecated instead ofstability
(#588)
This release marks the first where the core of HTTP semantic conventions have stabilized.
- BREAKING: Rename http.resend_count to http.request.resend_count. (#374)
- BREAKING: Change
network.protocol.name
from recommended to opt-in in HTTP semconv. (#398) - BREAKING: Define url.scheme in terms of logical operation in HTTP server semconv. (#376)
- BREAKING: Change
network.transport
from recommended to opt-in in HTTP semconv. (#402) - BREAKING: Change
network.type
from recommended to opt-in in HTTP semconv. (#410) - BREAKING: Factor in
X-Forwarded-Host
/Forwarded
when capturingserver.address
andserver.port
. (#411) - Remove
thread.daemon
, and introducejvm.thread.daemon
instead. Introducejvm.thread.state
attribute and add it tojvm.thread.count
metric. (#297) - Fix
server.port
to be not required whenserver.address
is not set. (#429) - Use seconds as default duration for FaaS duration histograms (#384)
- BREAKING: Remove
total
from list of well-known values ofsystem.memory.state
attribute. (#409) - Remove
url.path
default value. (#462) - Remove conditional requirement on
network.peer.address
andnetwork.peer.port
(#449) - Change
user_agent.original
from recommended to opt-in on HTTP client spans. (#468) - Change
http.request.body.size
andhttp.response.body.size
from recommended to opt-in. (#460) - Clarify that
client.port
is the port of whichever client was captured inclient.address
. (#471) - Change
client.port
from recommended to opt-in on HTTP server spans (#472) - BREAKING: Make
url.scheme
opt_in for HTTP client and remove default value forserver.port
making it required on the client. (#459) - Make
client.address
sampling relevant on HTTP server spans. (#469) - Change
network.protocol.name
from opt-in to conditionally required. (#478) - Remove outdated
http.request.header.host
guidance (#479) - Change sampling relevant from
MUST
toSHOULD
(#486) - Make
user_agent.original
andhttp.request.header.*
sampling relevant on HTTP server spans. (#467)
- Adds
session.previous_id
to session.md (#348) - Metric namespaces SHOULD NOT be pluralized. (#267)
- Add opt-in
system.memory.limit
metric. (#409) - Add
host.mac
resource attribute convention. (#340) - Mark HTTP semantic conventions as stable. (#377)
- Clarify that
error.type
should be the fully-qualified exception class name when it represents an exception type. (#387) - Add cardinality warning about two opt-in HTTP metric attributes (#401)
- Change
server.port
from recommended to conditionally required on HTTP server semconv. (#399) - Add cardinality warning about two opt-in HTTP metric attributes to all HTTP metrics. (#412)
- Remove outdated note about not recording HTTP
server.address
when only IP address available. (#413) - Clarify HTTP server definitions and
server.address|port
notes. (#423) - Change the precedence between
:authority
andHost
headers when populatingserver.address
andserver.port
attributes. (#455) - Explain
deployment.environment
impact on service identity. (#481)
- 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
andnode.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. Makecontainer.image.tag
array and in plural form. (#159) - BREAKING: Rename
http.client.duration
andhttp.server.duration
metrics tohttp.client.request.duration
andhttp.server.request.duration
respectively. (#224) - 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.
- BREAKING: Rename all JVM metrics from
process.runtime.jvm.*
tojvm.*
(#241) - BREAKING: Add namespaces to JVM metric attributes (#20).
- Rename attributes
type
tojvm.memory.type
,pool
tojvm.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
tojvm.gc.name
,action
tojvm.gc.action
- Applies to metrics:
jvm.gc.duration
- Rename attribute
daemon
tothread.daemon
- Applies to metrics:
jvm.threads.count
- Rename attribute
pool
tojvm.buffer.pool.name
- Applies to metrics:
jvm.buffer.usage
jvm.buffer.limit
jvm.buffer.count
- Rename attributes
- Clarify that
http/dup
has higher precedence thanhttp
in case both values are present inOTEL_SEMCONV_STABILITY_OPT_IN
(#249) - Add
jvm.cpu.count
metric. (#52) - BREAKING: Rename metrics
jvm.buffer.usage
tojvm.buffer.memory.usage
andjvm.buffer.limit
tojvm.buffer.memory.limit
. (#253) - BREAKING: Rename
jvm.classes.current_loaded
metrics tojvm.classes.count
(#60) - BREAKING: Remove pluralization from JVM metric namespaces. (#252)
- Simplify HTTP metric briefs. (#276)
- Add host cpu resource attributes. (#209)
- Introduce
error.type
attribute and use it in HTTP conventions (#205) - BREAKING: Change HTTP span name when method is unknown (use
HTTP
instead of_OTHER
) (#270) - Moved RPC streaming notes from metric brief section to notes section. (#275)
- Updates
client.address
to allow domain names for consistency withserver.address
. (#302) - BREAKING: Generate System metrics semconv from YAML.
(#89)
- Rename attributes for
system.cpu.*
metrics:state
tosystem.cpu.state
cpu
tosystem.cpu.logical_number
- Rename attributes for
system.memory.*
metrics:state
tosystem.memory.state
- Rename attributes for
system.paging.*
metrics:state
tosystem.paging.state
type
tosystem.paging.type
direction
tosystem.paging.direction
- Rename attributes for
system.disk.*
metrics:device
tosystem.device
direction
tosystem.disk.direction
- Rename attributes for
system.filesystem.*
metrics:device
tosystem.device
state
tosystem.filesystem.state
type
tosystem.filesystem.type
mode
tosystem.filesystem.mode
mountpoint
tosystem.filesystem.mountpoint
- Rename attributes for
system.network.*
metrics:device
tosystem.device
direction
tosystem.network.direction
protocol
tonetwork.protocol
state
tosystem.network.state
- Rename attributes for
system.processes.*
metrics:status
tosystem.processes.status
- Rename attributes for
- BREAKING: Rename
messaging.message.payload_size_bytes
tomessaging.message.body.size
, removemessaging.message.payload_compressed_size_bytes
. (#229) - Add
system.linux.memory.available
metric. (#323) - BREAKING: Rename
http.server.request.size
metric tohttp.server.request.body.size
andhttp.server.response.size
metric tohttp.server.response.body.size
(#247) - 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) - BREAKING: Remove the zero bucket boundary from
http.server.request.duration
andhttp.client.request.duration
. (#318) - Encourage setting
network.transport
when reporting port numbers (#289) - BREAKING: Add
url.scheme
tohttp.client.*
metrics (#357) - BREAKING: Remove
server.socket.address
from HTTP and RPC client metrics. (#350) - Improve network attribute briefs. (#352)
- Document the difference between host and system metrics (#324)
- BREAKING: Rename
telemetry.auto.version
resource attribute totelemetry.distro.version
and addtelemetry.distro.name
resource attribute (#178) - Add
system.cpu.frequency
metric. (#337) - Improve HTTP metric briefs. (#366)
- Add
host.ip
resource attribute convention. (#203) - BREAKING: remove
-
to_
normalization from http header and rpc metadata attribute keys. (#369) - BREAKING: Rename/replace
(client|server).socket.(address|port)
attributes withnetwork.(peer|local).(address|port)
. (#342) - Make
network.protocol.name|version
description consistent between HTTP spans and metrics. (#367)
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
, makemessaging.client_id
generic (#3336) - Add transition plan for upcoming breaking changes to the unstable HTTP semantic conventions. (#3443)
- Rename
net.peer.*
,net.host.*
, andnet.sock.*
attributes to align with ECS (#3402) BREAKING: renamenet.peer.name
toserver.address
on client side and toclient.address
on server side,net.peer.port
toserver.port
on client side and toclient.port
on server side,net.host.name
andnet.host.port
toserver.address
andserver.port
(sincenet.host.*
attributes only applied to server instrumentation),net.sock.peer.addr
toserver.socket.address
on client side and toclient.socket.address
on server side,net.sock.peer.port
toserver.socket.port
on client side and toclient.socket.port
on server side,net.sock.peer.name
toserver.socket.domain
(sincenet.sock.peer.name
only applied to client instrumentation),net.sock.host.addr
toserver.socket.address
(sincenet.sock.host.*
only applied to server instrumentation),net.sock.host.port
toserver.socket.port
(similarly sincenet.sock.host.*
only applied to server instrumentation),http.client_ip
toclient.address
- BREAKING: Introduce
network.transport
defined as OSI Transport Layer or Inter-process Communication method. Introducenetwork.type
defined as OSI Network Layer or non-OSI equivalent. Removenet.transport
andnet.sock.family
. Renamenet.protocol.*
tonetwork.protocol.*
,net.host.connection.*
tonetwork.connection.*
, andnet.host.carrier.*
tonetwork.carrier.*
. (#3426) - BREAKING: Adopt ECS attributes in HTTP semantic conventions.
Renames:
http.method
tohttp.request.method
,http.status_code
tohttp.response.status_code
,http.request_content_length
tohttp.request.body.size
,http.response_content_length
tohttp.response.body.size
,http.url
tourl.full
,http.scheme
tourl.scheme
, and removeshttp.target
breaking it down tohttp.target
tourl.path
,url.query
, andurl.fragment
. (#3355) - Add
gcp.cloud_run.job.execution
andgcp.cloud_run.job.task_id
resource attributes for GCP Cloud Run Jobs (#3378) - Specify second unit (
s
) and advice bucket boundaries of[]
forprocess.runtime.jvm.gc.duration
. (#3458) - Specify the value range for JVM CPU metrics. (#13)
- Rename
process.runtime.jvm.cpu.utilization
toprocess.runtime.jvm.cpu.recent_utilization
. (#53) - Clarify
process.runtime.jvm.threads.count
refers to platform threads. (#54) - Add
gcp.gce.instance.name
andgcp.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
andserver.port
requirement levels on HTTP server metrics fromrequired
toopt_in
. (#109) - Updated AWS Java Lambda guidance - using system properties. (#27)
- Limit
http.request.method
values to a closed set of known values, introducehttp.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 usemessaging.destination.*
attributes on producer and consumer to describe messaging queue or topic. (#100) - Mark
process.runtime.jvm.system.cpu.load_1m
andprocess.runtime.jvm.system.cpu.utilization
metrics as opt-in. (#57) - Add container
image.id
,command
,command_line
andcommand_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)
- Add
system.cpu.physical.count
andsystem.cpu.logical.count
metrics. (#99)
This and earlier versions were released as part of the Specification. See the specification changelog if you'd like to git blame
a changelog entry.
- Clarify that attribute requirement levels apply to the instrumentation library (#3289)
- Fix grammatical number of metric units. (#3298)
- Rename
net.app.protocol.(name|version)
tonet.protocol.(name|version)
(#3272) - Replace
http.flavor
withnet.protocol.(name|version)
(#3272) - Metric requirement levels are now stable (#3271)
- BREAKING: remove
messaging.destination.kind
andmessaging.source.kind
. (#3214, #3348) - Define attributes collected for
cosmosdb
by Cosmos DB SDK (#3097) - Clarify stability requirements of semantic conventions (#3225)
- BREAKING: Change span statuses for gRPC server spans. (#3333)
- Stabilize key components of
service.*
andtelemetry.sdk.*
resource semantic conventions. (#3202) - Fixed attributes requirement level in semantic conventions for hardware metrics (#3258)
- Added AWS S3 semantic conventions. (#3251)
- Fix units in the Kafka metric semantic conventions. (#3300)
- Add Trino to Database specific conventions (#3347)
- Change
db.statement
to only be collected if there is sanitization. (#3127) - BREAKING: Remove
http.status_code
attribute from thehttp.server.active_requests
metric. (#3366) - Mark attribute requirement levels as stable (#3368)
- Move X-Ray Env Variable propagation to span link instead of parent for AWS Lambda. (#3166)
- Add heroku resource semantic conventions. #3075
- BREAKING: Rename faas.execution to faas.invocation_id (#3209)
- BREAKING: Change faas.max_memory units to Bytes instead of MB (#3209)
- BREAKING: Expand scope of faas.id to cloud.resource_id (#3188)
- Add Connect RPC specific conventions (#3116)
- Rename JVM metric attribute value from
nonheap
tonon_heap
(#3250) - Mark the attribute naming guidelines in the specification as stable. (#3220)
- Mark telemetry schema readme stable. (#3221)
- Remove mention of
net.transport
from HTTP semantic conventions (#3244) - Clarifies that if an HTTP client request is explicitly made to an IP address,
e.g.
http://x.x.x.x:8080
, thennet.peer.name
SHOULD be the IP addressx.x.x.x
(#3276) - Mark
net.sock.host.port
as conditionally required. (#3246) - Rename Optional attribute requirement level to Opt-In. (#3228)
- Rename
http.user_agent
touser_agent.original
. (#3190) - Expand the declaration of
pool.name
. (#3050)
- Add Cloud Spanner and Microsoft SQL Server Compact to db.system semantic conventions (#3105).
- Enable semantic convention tooling for metrics in spec (#3119)
- Rename google openshift platform attribute from
google_cloud_openshift
togcp_openshift
to match the existingcloud.provider
prefix. (#3095) - Changes http server span names from
{http.route}
to{http.method} {http.route}
(when route is available), and fromHTTP {http.method}
to{http.method}
(when route is not available). Changes http client span names fromHTTP {http.method}
to{http.method}
. (#3165) - Mark
http.server.duration
andhttp.client.duration
metrics as required, and mark all other HTTP metrics as optional. #3158 - Add
net.host.port
tohttp.server.active_requests
metrics attributes. #3158 http.route
SHOULD contain the "application root" if there is one. (#3164)
- Clarify common HTTP attributes apply to both clients and servers (#3044)
- Add
code.lineno
source code attribute (#3029) - Add ClickHouse to db.system semantic conventions (#3011)
- Refactor messaging attributes and per-message attributes in batching scenarios.
(#2957).
BREAKING: rename
messaging.consumer_id
tomessaging.consumer.id
,messaging.destination
tomessaging.destination.name
,messaging.temp_destination
tomessaging.destination.temporary
,messaging.destination_kind
tomessaging.destination.kind
,messaging.message_id
tomessaging.message.id
,messaging.protocol
tonet.app.protocol.name
,messaging.protocol_version
,net.app.protocol.version
,messaging.conversation_id
tomessaging.message.conversation_id
,messaging.message_payload_size_bytes
tomessaging.message.payload_size_bytes
,messaging.message_payload_compressed_size_bytes
tomessaging.message.payload_compressed_size_bytes
,messaging.rabbitmq.routing_key
:messaging.rabbitmq.destination.routing_key
,messaging.kafka.message_key
tomessaging.kafka.message.key
,messaging.kafka.consumer_group
tomessaging.kafka.consumer.group
,messaging.kafka.partition
tomessaging.kafka.destination.partition
,messaging.kafka.tombstone
tomessaging.kafka.message.tombstone
,messaging.rocketmq.message_type
tomessaging.rocketmq.message.type
,messaging.rocketmq.message_tag
tomessaging.rocketmq.message.tag
,messaging.rocketmq.message_keys
tomessaging.rocketmq.message.keys
; Removedmessaging.url
; Renamedsend
operation topublish
; Splitdestination
andsource
namespaces and clarify per-message attributes in batching scenarios.
- Add
process.runtime.jvm.gc.duration
metric to semantic conventions. (#2903) - Make http.status_code metric attribute an int. (#2943)
- Add IBM Cloud as a cloud provider. (#2965)
- Add semantic conventions for Feature Flags (#2529)
- Rename
rpc.request.metadata.<key>
andrpc.response.metadata.<key>
torpc.grpc.request.metadata.<key>
andrpc.grpc.response.metadata.<key>
(#2981) - List the machine-id as potential source for a unique host.id (#2978)
- Add
messaging.kafka.message.offset
attribute. (#2982) - Update hardware metrics to use
direction
as per general semantic conventions (#2942)
- Change to messaging.kafka.max.lag from UpDownCounter to Gauge (and rename it) (#2837)
- Add daemon attribute to jvm threads metric (#2828)
- Add gRPC request and response metadata semantic conventions (#2874)
- Add
process.paging.faults
metric to semantic conventions (#2827) - Define semantic conventions yaml for non-otlp conventions (#2850)
- Add more semantic convention attributes of Apache RocketMQ (#2881)
- Add
process.runtime.jvm.memory.usage_after_last_gc
metric to semantic conventions. (#2901)
- Add
process.context_switches
, andprocess.open_file_descriptors
, to the metrics semantic conventions (#2706) - Add exceptions to the logs semantic conventions (#2819)
- Make context propagation requirements explicit for messaging semantic conventions (#2750).
- Update http metrics to use
http.route
instead ofhttp.target
for servers, drophttp.url
for clients (#2818).
- Add
net.app.protocol.*
attributes (#2602) - Add network metrics to process semantic conventions (#2556)
- Adopt attribute requirement levels in semantic conventions (#2594)
- Add semantic conventions for GraphQL (#2456)
- Change
cloudevents.event_spec_version
andcloudevents.event_type
level fromrequired
torecommended
(#2618) - Change
faas.document.time
andfaas.time
level fromrequired
torecommended
(#2627) - Add
rpc.grpc.status_code
to RPC metric semantic conventions (#2604) - Add
http.*.*.size
metric semantic conventions for tracking size of requests / responses for http servers / clients (#2588) - BREAKING: rename
net.peer.ip
tonet.sock.peer.addr
,net.host.ip
tonet.sock.host.addr
,net.peer.name
tonet.sock.peer.name
for socket-level instrumentation. Define socket-level attributes and clarify logical peer and host attributes meaning (#2594) - Add semantic conventions for JVM buffer pool usage (#2650)
- Improve the definition of
state
attribute for metricsystem.network.connections
(#2663) - Add
process.parent_pid
attribute for use in reporting parent process id (PID) (#2691) - Add OpenSearch to db.system semantic conventions (#2718)
- Clarify when "count" is used instead of pluralization (#2613)
- Add the convention 'type' to the YAML definitions for all existing semantic conventions (#2693)
- Remove alternative attribute sets from HTTP semantic conventions (#2469)
- Add semantic conventions for JVM CPU metrics (#2292)
- Add details for FaaS conventions for Azure Functions and allow FaaS/Cloud resources as span attributes on incoming FaaS spans (#2502)
- Define attribute requirement levels (#2522)
- Initial addition of Kafka metrics (#2485).
- Add semantic conventions for Kafka consumer metrics (#2536)
- Add database connection pool metrics semantic conventions (#2273).
- Specify how to obtain a Ruby thread's id (#2508).
- Refactor jvm classes semantic conventions (#2550).
- Add browser.* attributes (#2353).
- Change JVM runtime metric
process.runtime.jvm.memory.max
toprocess.runtime.jvm.memory.limit
(#2605). - Add semantic conventions for hardware metrics (#2518).
- Note added that
net.peer.name
SHOULD NOT be set if capturing it would require an extra reverse DNS lookup. And movednet.peer.name
from common http attributes to just client http attributes. (#2446) - Add
net.host.name
andnet.host.ip
conventions for rpc server spans. (#2447) - Allow all metric conventions to be either synchronous or asynchronous. (#2458
- Update JVM metrics with JMX Gatherer values (#2478)
- Add HTTP/3 (#2507)
- Map SunOS to solaris for os.type resource attribute (#2509)
- Define span structure for HTTP retries and redirects. (#2078)
- Changed
rpc.system
to an enum (allowing custom values), and changed therpc.system
value for .NET WCF fromwcf
todotnet_wcf
. (#2377) - Define JavaScript runtime semantic conventions. (#2290)
- Add semantic conventions for CloudEvents. (#1978)
- Add
process.cpu.utilization
metric. (#2436) - Add
rpc.system
value for Apache Dubbo. (#2453)
- Align runtime metric and resource namespaces (#2112)
- Prohibit usage of retired names in semantic conventions. (#2191)
- Add
device.manufacturer
to describe mobile device manufacturers. (2100) - Change golang namespace to 'go', rather than 'gc' (#2262)
- Add JVM memory runtime semantic conventions. (#2272)
- Add opentracing.ref_type semantic convention. (#2297)
- Add
k8s.container.restart_count
Resource attribute. (#1945) - Add "IBM z/Architecture" (
s390x
) tohost.arch
(#2055) - BREAKING: Remove db.cassandra.keyspace and db.hbase.namespace, and clarify db.name (#1973)
- Add AWS App Runner as a cloud platform (#2004)
- Add Tencent Cloud as a cloud provider. (#2006)
- Don't set Span.Status for 4xx http status codes for SERVER spans. (#1998)
- Add attributes for Apache RocketMQ. (#1904)
- Define http tracing attributes provided at span creation time (#1916)
- Change meaning and discourage use of
faas.trigger
for FaaS clients (outgoing). (#1921) - Clarify difference between container.name and k8s.container.name (#1980)
- BREAKING: Change enum member IDs to lowercase without spaces, not starting with numbers.
Change values of
net.host.connection.subtype
to match. (#1863) - Lambda instrumentations should check if X-Ray parent context is valid (#1867)
- Update YAML definitions for events
(#1843):
- Mark exception as semconv type "event".
- Add YAML definitions for grpc events.
- Add
messaging.consumer_id
to differentiate between message consumers. (#1810) - Clarifications for
http.client_ip
andhttp.host
. (#1890) - Add HTTP request and response headers semantic conventions. (#1898)
- Add mobile-related network state:
net.host.connection.type
,net.host.connection.subtype
&net.host.carrier.*
#1647 - Adding alibaba cloud as a cloud provider. (#1831)
- Clean up FaaS semantic conventions, add
aws.lambda.invoked_arn
. (#1781) - Remove
rpc.jsonrpc.method
, clarify thatrpc.method
should be used instead. (#1748)
- 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).
- 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)
- 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)
- Add
elasticsearch
todb.system
semantic conventions (#1463) - Add
arch
tohost
semantic conventions (#1483) - Add
runtime
tocontainer
semantic conventions (#1482) - Rename
gcp_gke
togcp_kubernetes_engine
to have consistency with other Google products undercloud.infrastructure_service
(#1496) http.url
MUST NOT contain credentials (#1502)- Add
aws.eks.cluster.arn
to EKS specific semantic conventions (#1484) - Rename
zone
toavailability_zone
incloud
semantic conventions (#1495) - Rename
cloud.infrastructure_service
tocloud.platform
(#1530) - Add section describing that libraries and the collector should autogenerate the semantic convention keys. (#1515)
N/A
First release of OpenTelemetry Specification. Semantic conventions were not explicitly tracked in changelog up to this point.