Skip to content

Releases: open-telemetry/semantic-conventions

v1.36.0

05 Jul 16:55
4b2c0e6
Compare
Choose a tag to compare

🚩 Deprecations 🚩

  • os: Adds the 'deprecated:' tag/attribute to the z_os enum value of os.type. This value was recently deprecated in v1.35.0. (#2479)

💡 Enhancements 💡

  • otel: Replaces otel.sdk.span.ended with otel.sdk.span.started and allow differentiation based on the parent span origin (#2431)
  • db: Add database context propagation via SET CONTEXT_INFO for SQL Server (#2162)
  • entities: Adds support for Entity registry and Entity stabilization policies. (#2246)

🧰 Bug fixes 🧰

  • cloud: Exclude deprecated Azure members from code generation on the cloud.platform attribute (#2477, #2455)

Full Changelog: v1.35.0...v1.36.0

v1.35.0

30 Jun 20:02
a497728
Compare
Choose a tag to compare

🛑 Breaking changes 🛑

  • azure: Align azure events, attributes, and enum members with general naming guidelines. (#608, #1708, #1698)

    • Renamed attributes:
      • az.service_request_id to azure.service.request.id
      • az.namespace to azure.resource_provider.namespace
    • Renamed events:
      • az.resource.log to azure.resource.log
    • Renamed enum members:
      • az.ai.inference to azure.ai.inference (on gen_ai.system)
      • az.ai.openai to azure.ai.openai (on gen_ai.system)
      • azure_aks to azure.aks (on cloud.platform)
      • azure_app_service to azure.app_service (on cloud.platform)
      • azure_container_apps to azure.container_apps (on cloud.platform)
      • azure_container_instances to azure.container_instances (on cloud.platform)
      • azure_functions to azure.functions (on cloud.platform)
      • azure_openshift to azure.open_shift (on cloud.platform)
      • azure_vm to azure.vm (on cloud.platform)
  • system: Revert the change that moved system.cpu.* to cpu.*. The 3 affected metrics are back in system.cpu.*. (#1873)

  • system: Changes system.network.connections to system.network.connection.count (#1800)

  • k8s: Change instrument type for .limit/.request container metrics from gauge to updowncounter (#2354)

🚩 Deprecations 🚩

  • os: Deprecate os.type='z_os' and replace with os.type='zos' (#1687)

🚀 New components 🚀

  • mainframe, zos: Add initial semantic conventions for mainframes (#1687)

💡 Enhancements 💡

  • dotnet: Define .NET-specific network spans for DNS resolution, TLS handshake, and socket connections, along with HTTP-level spans to (optionally) record relationships between HTTP requests and connections.
    (#1192)

  • k8s: Add k8s.node.allocatable.cpu, k8s.node.allocatable.ephemeral_storage, k8s.node.allocatable.memory, k8s.node.allocatable.pods metrics (#2243)

  • k8s: Add k8s.container.restart.count metric (#2191)

  • k8s: Add K8s container resource related metrics (#2074)

  • k8s: Add k8s.container.ready metric (#2074)

  • k8s: Add k8s.node.condition metric (#2077)

  • k8s: Add k8s resource quota metrics (#2076)

  • events: Update general event guidance to allow complex attributes on events and use them instead of the body fields.
    (#1651, #1669)

  • k8s: Add k8s.container.status.state and k8s.container.status.reason metrics (#1672)

  • feature_flags: Mark feature flag semantic convention as release candidate. (#2277)

  • k8s: Add new resource attributes for k8s.hpa to capture the scaleTargetRef fields (#2008)
    Adds below attributes to the k8s.hpa resource:

    • k8s.hpa.scaletargetref.kind
    • k8s.hpa.scaletargetref.name
    • k8s.hpa.scaletargetref.api_version
  • k8s: Adds metrics and attributes to track k8s HPA's metric target values for CPU resources. (#2182)
    Below metrics are introduced to provide insight into HPA scaling configuration for CPU.

    • k8s.hpa.metric.target.cpu.value
    • k8s.hpa.metric.target.cpu.average_value
    • k8s.hpa.metric.target.cpu.average_utilization
  • k8s: Explains the rationale behind the Kubernetes resource naming convention. (#2245)

  • all: Adds modelling guide for resource and entity. (#2246)

  • service: Adds stability policies for Entity groups. (#2378)
    Entity groups now require role to be filled for attributes.

  • otel: Specifies component.type values for Zipkin and Prometheus exporters (#2229)

🧰 Bug fixes 🧰

  • otel: Removes otel.scope entity. (#2310)

New Contributors

Full Changelog: v1.34.0...v1.35.0

v1.34.0

19 May 19:48
e96d8de
Compare
Choose a tag to compare

🛑 Breaking changes 🛑

  • all: Convert deprecated text to structured format. (#2047)
    This is a breaking change from the schema perspective, but does not change anything for instrumentations or the end users. It breaks compatibility with the (old) code generation tooling. Please use weaver to generate Semantic Conventions markdown or code.

  • feature_flag: Move the evaluated value from the event body to attributes (#1990)

  • process: Require sensitive data sanitization for process.command_args and process.command_line (#626)

💡 Enhancements 💡

  • docs: Document system-specific naming conventions (#608, #1494, #1708)
  • gen-ai: Add gen_ai.conversation.id attribute (#2024)
  • all: Renames all resource.* groups to be entity.* (#2244)
    Part of open-telemetry/opentelemetry-specification#4436
  • aws: Added new AWS attributes for various services including SQS, SNS, Bedrock, Step Functions, Secrets Manager and Kineses (#1794)
  • cloud: Broaden cloud.region definition to explicitly cover both resource location and targeted destination. (#2142)
  • network: Stabilize network.transport enum value quic. (#2275)

🧰 Bug fixes 🧰

  • db: Fix the db.system.name attribute value for MySQL which was incorrectly pointing to microsoft.sql_server. (#2276)

New Contributors

Full Changelog: v1.33.0...v1.34.0

v1.33.0

02 May 19:48
9e993af
Compare
Choose a tag to compare

This release marks the first where the core of database semantic conventions have stabilized.

🛑 Breaking changes 🛑

  • db: Add db.query.parameter, replace relevant usages of db.operation.parameter (#2093)
  • db: Make db.response.returned_rows opt-in on release_candidate spans (#2211)
  • db: Use | as the separator when db.namespace is a concatenation of multiple components. (#2067)
  • feature_flag: Rename feature_flag.provider_name to feature_flag.provider.name (#1982)
  • feature_flag: Use generic error.message in feature flag evaluation event (#1994)
  • gen-ai: Refine the values for gen_ai.system related to Google's AI endpoints. (#1950)
    Enable sharing of attributes between Vertex AI and Gemini through a common prefix.
  • k8s: Make k8s Node and Pod labels optional (#2079)
  • otel: Rename span health metrics to remove the .count suffixes (#1979)

🚀 New components 🚀

  • db: Adding semantic conventions for oracledb instrumentations. (#1911)
    Oracle Database semantic conventions.
  • browser: Add browser web vitals event. (#1940)

💡 Enhancements 💡

  • cicd: Add resource conventions for CICD systems and define spans for CICD pipeline runs. (#1713)
    Define spans cicd.pipeline.run.server and cicd.pipeline.task.internal.
    Add cicd.pipeline.action.name, cicd.worker.id, cicd.worker.name, cicd.worker.url.full andcicd.pipeline.task.run.result to attribute registry.
    Define resources cicd.pipeline, cicd.pipeline.run and cicd.worker.
    Add entity associations in cicd metrics for these new cicd resources.
  • vcs: Add resource conventions for VCS systems and VCS references. (#1713)
    Define resources vcs.repo and vcs.ref.
    Add entity associations in vcs metrics for these new vcs resources.
  • gen-ai: Adding span for invoke agent (#1842)
  • gen-ai: Adding gen_ai.tool.description to the span attributes (#2087)
  • gen-ai: Separate inference and embeddings span definitions, remove irrelevant attributes from the create agent span. (#1924, #2122)
  • general: Provide guidance on modeling lat/lon, x/y, etc (#2145)
  • db: Move db.query.parameter.<key> from release_candidate back to development. (#2194)
  • db: Mark database semantic conventions as stable for MariaDB, Microsoft SQL Server, MySQL, and PostgreSQL. (#2199)
  • db: Make db.operation.name required where it's available, add recommendation for instrumentation point. (#2200, #2098)
  • db: Add db.stored_procedure.name to the general span conventions (#2205)
  • db: Add an option to generate db.query.summary from operation name and target, remove it from CosmosDB. (#2206)
  • db: Add db.operation.name and db.collection.name to SQL for higher-level APIs (#2207)
  • jvm: Add jvm.file_descriptor.count as an in-development metric to track the number of open file descriptors as reported by the JVM. (#1838)
  • jvm: Add jvm.gc.cause to metric jvm.gc.duration as an opt-in attribute to track gc cause. (#2065)
  • process: Add process.environment_variable. (#672)
  • app: Defines two new click events for the app domain (#2070)
  • code: Mark code.* semantic conventions as stable (#1377)
  • k8s: Introduce semantic conventions for k8s CronJob labels and annotations (#2138)
  • k8s: Introduce semantic conventions for k8s DaemonSet labels and annotations (#2136)
  • k8s: Introduce semantic conventions for k8s Deployment labels and annotations (#2134)
  • system: Added entity association template rendering and policies. (#1276)
  • gen_ai: Document generate_content as a permissible value of gen_ai.operation.name. (#2048)
  • k8s: Introduce semantic conventions for k8s Job labels and annotations (#2137)
  • otel: Adds SDK self-monitoring metrics for metric processing (#2016)
  • k8s: Introduce semantic conventions for k8s Namespace labels and annotations (#2131)
  • k8s: Introduce semantic conventions for k8s Node labels and annotations (#2079)
  • k8s: Introduce semantic conventions for k8s ReplicaSet labels and annotations (#2132)
  • otel: Adds SDK self-monitoring metric for exporter call duration (#1906)
  • k8s: Introduce semantic conventions for k8s StatefulSet labels and annotations (#2135)

🧰 Bug fixes 🧰

  • gen-ai: Removed irrelevant response attributes on GenAI create agent span. (#1924, #2116)
  • vcs: Fix typo in gitea name (#2057)
  • gen-ai: Add invoke_agent as a member of gen_ai.operation.name (#2160)
  • db: Clarify db.query.summary for stored procedures (#2218)

New Contributors

Full Changelog: v1.32.0...v1.33.0

v1.32.0

31 Mar 16:00
6814d83
Compare
Choose a tag to compare

📣 This release is the second release candidate for the Database Semantic Conventions, with db conventions stability planned to be declared in the subsequent release.

🛑 Breaking changes 🛑

  • device: Change the definition of device.id and make it opt-in. (#1874, #1951)
  • feature_flag: Rename evaluation to result for feature flag evaluation result attributes (#1989)

🚀 New components 🚀

  • app: Create app.installation.id attribute (#1874, #1897)
  • cpython: Add CPython runtime garbage collector metrics (#1930)

💡 Enhancements 💡

  • vcs: Add owner and provider name to VCS attribute registry (#1452)
  • vcs: Remove fallback value for VCS provider name attribute (#2020)
  • db: Truncate db.query.summary to 255 characters if parsed from the query (#1978)
  • db: Normalize spaces in db.operation.name (if any) (#2028)
  • db: db.operation.parameter.<key> should not be captured for batch operations (#2026)
  • db: Add db.stored_procedure.name (#1491)
  • gcp: Adds GCP AppHub labels for resource. (#2006)
  • error: Add error.message property for human-readable error message on events. (#1992)
  • profile: Extend the list of known frame types with a value for Go and Rust (#2003)
  • otel: Adds SDK self-monitoring metrics for log processing (#1921)

New Contributors

Full Changelog: v1.31.0...v1.32.0

v1.31.0

11 Mar 00:53
c01aa89
Compare
Choose a tag to compare

🛑 Breaking changes 🛑

  • code: code.function.name value should contain the fully qualified function name, code.namespace is now deprecated (#1677)

  • gen-ai: Introduce gen_ai.output.typeand deprecate gen_ai.openai.request.response_format (#1757)

  • mobile: Rework device.app.lifecycle mobile event. (#1880)
    The device.app.lifecycle event has been reworked to use attributes instead
    of event body fields. The ios.app.state and android.app.state attributes
    have been reintroduced to the attribute registry.

  • system: Move CPU-related system.cpu.* metrics to CPU namespace (#1873)

  • k8s: Change k8s.replication_controller metrics to k8s.replicationcontroller (#1848)

  • db: Rename db.system to db.system.name in database metrics, and update the values to be consistent with database spans. (#1581)

  • session: Move session.id and session.previous_id from body fields to event attributes, and yamlize session.start and session.end events. (#1845)
    As part of the ongoing migration of event fields from LogRecord body to extended/complex attributes, the session.start and session.end events have been redefined.

💡 Enhancements 💡

  • code: Mark code.* semantic conventions as release candidate (#1377)

  • gen-ai: Added AI Agent Semantic Convention (#1732, #1739)

  • db: Add database-specific notes on db.operation.name and db.collection.name for Cassandra, Cosmos DB, HBase, MongoDB, and Redis, covering their batch/bulk terms and lack of cross-table queries. (#1863, #1573)

  • gen-ai: Adds gen_ai.request.choice.count span attribute (#1888)
    Enables recording target number of completions to generate

  • enduser: Undeprecate 'enduser.id' and introduce new attribute enduser.pseudo.id (#1104)
    The new attribute enduser.pseudo.id is intended to provide a unique identifier of a pseudonymous enduser.

  • k8s: Add k8s.hpa, k8s.resourcequota and k8s.replicationcontroller attributes and resources (#1656)

  • k8s: How to populate resource attributes based on attributes, labels and transformation (#236)

  • process: Adjust the semantic expectations for process.executable.name (#1736)

  • otel: Adds SDK self-monitoring metrics for span processing (#1631)

  • cicd: Adds a new attribute cicd.pipeline.run.url.full and corrects the attribute description of cicd.pipeline.task.run.url.full (#1796)

  • user-agent: Add user_agent.os.name and user_agent.os.version attributes (#1433)

🧰 Bug fixes 🧰

  • process: Fix units of process.open_file_descriptor.count and process.context_switches (#1662)

New Contributors

Special thanks to @chalin with all the link-checking fixes ❤️

Full Changelog: v1.30.0...v1.31.0

v1.30.0

24 Jan 19:11
ac424df
Compare
Choose a tag to compare

🛑 Breaking changes 🛑

  • event: Deprecate event.name attribute in favor of the top level event name property on the log record (#1646)

  • gen_ai: Rename gen_ai.openai.request.seed to gen_ai.request.seed and use it on general GenAI conventions. (#1715)

  • db: Rename db.system to db.system.name and clean up its values.
    Rename db.elasticsearch.*, db.cassandra.*, db.cosmosdb.* attributes to elasticsearch.*, cassandra.*, and azure.cosmosdb.* respectively.
    Rename db.client.cosmosdb.* metrics to azure.cosmosdb.client.*.
    (#1581, #608)

  • code: rename code.function, code.lineno, code.column and code.filepath (#1377, #1599)
    code.function renamed to code.function.name
    code.lineno renamed to code.line.number
    code.column renamed to code.column.number
    code.filepath renamed to code.file.path

  • system: Replace system.network.state with network.connection.state (#308)

  • messaging: RabbitMQ: Specify how to populate messaging.destination.name (#1529)

🚀 New components 🚀

  • security-rule: Introducing a new security rule namespace (#903)

💡 Enhancements 💡

  • cloud: Add Oracle Cloud Infrastructure to Semantic Conventions (#1658)

  • gen_ai: Yamlify gen_ai events and clean up examples. (#1469)

  • cicd: Add CICD metrics (#1600)
    Makes the following changes:

    • Add metrics cicd.pipeline.run.duration, cicd.pipeline.run.active, cicd.worker.count,
      cicd.pipeline.run.errors and cicd.system.errors.
    • The CICD attributes cicd.pipeline.run.state, cicd.pipeline.result, cicd.system.component, cicd.worker.state have been added to the registry.
  • gen-ai: Adds OpenAI API compatible gen_ai.system attribute values: az.ai.openai, deepseek, gemini, groq,
    perplexity and xai. Elaborates that openai can be ambiguous due to API emulation.
    (#1655)

  • docs: Update attribute, events, and metrics naming guidance to include new best practices. (#1694)

    • Use namespaces (with . delimiter) whenever possible.
    • Use precise, descriptive, unambiguous names that leave room for expansion.
  • docs, db: Add common guidance for recording errors on spans and metrics, clarify DB conventions. (#1516, #1536, #1716)

  • gen-ai: Adds mistral_ai as a gen_ai.system attribute value. (#1719)

  • process: Update process.runtime example for the Python language. (#1772)

  • db: Add metrics section to each of the database system-specific conventions. (#1447, #1779)

  • k8s: Add metrics for k8s deployment, replicaset, replication_controller, statefulset and hpa. (#1636, #1637, #1644)
    This addition focused on providing consistency between these metrics, while
    also ensuring alignment with recommendations from Kubernetes.
    More details in #1637

  • k8s: Add k8s deamonset related metrics (#1649)

  • k8s: Add k8s metrics for job and cronjob (#1660)

  • k8s: Add k8s.namespace.phase metric along with the respective attribute (#1668)

  • aws: Add extended request ID to general AWS attributes as aws.extended_request_id (#1670)

  • messaging: Further clarify {destination} value on span names (#1635)

  • gen_ai: Introduce gen_ai.request.seed and deprecated gen_ai.openai.request.seed (#1710)

  • system: Adds note about how system.cpu.physical.count and system.cpu.logical.count are calculated (#1780)

  • k8s: Add migration guide for K8s semantic conventions (#1597)

  • profile: Extend the list of known frame types with a value for Erlang (#1735)

  • dotnet: Mark .NET runtime metrics as stable (#1602)

  • vcs: Adds vcs.repository.name attribute to registry and update
    vcs.repository.url.full description for consistent representation. Updates
    the VCS metrics to include vcs.repository.name as a recommended attribute.
    (#1254, #1453)

  • vcs: Add vcs.change.time_to_merge metric. (#1685)

New Contributors

Full Changelog: v1.29.0...v1.30.0

v1.29.0

28 Nov 18:25
0edb9e2
Compare
Choose a tag to compare

🛑 Breaking changes 🛑

  • vcs: Add the VCS metrics inspired by the GitHub Receiver (#1372)
    Makes the following changes:

    • Add metrics vcs.change.count, vcs.change.duration, vcs.change.time_to_approval, vcs.repository.count, vcs.ref.count,
      vcs.ref.lines_delta, vcs.ref.revisions_delta, vcs.ref.time, vcs.contributor.count
    • The VCS attributes vcs.change.state, vcs.revision_delta.direction and vcs.line_change.type have been added to the registry.
    • The VCS ref attributes have been duplicated to vcs.ref.base.* to allow for ref comparisons.
    • The VCS attribute vcs.ref.type has been added for simplicity when neither a full head or base ref is necessary.
    • vcs.repository.change.* attributes have been deprecated and moved to vcs.change.*.
    • vcs.repository.ref.* attributes have been deprecated and moved to vcs.ref.head.*.
  • feature_flag: Rename feature_flag event to feature_flag.evaluation event, define new feature flag attributes and provide body definition. Remove feature_flag span event definition in favor of log-based event.
    (#1440)

  • db: Generalize db.query.parameter.<key> to db.operation.parameter.<key> (#1559)

  • db: Remove redis database index from the redis span name. (#1449)

  • db: Don't capture db.operation.name and db.collection.name from query formats that support multiples. (#1566)

  • system: Introduce network.interface.name and use that instead of system.device for system and container network metrics (#1492)

  • system: Add system.device attribute to system paging metrics (#1408)

  • process: Change process.uptime instrument to a gauge. (#1518)

  • process.executable.build_id: Rename process.executable.build_id.profiling to process.executable.build_id.htlhash. (#1520)
    With #4197 it was decided to rename the attribute profiling in process.executable.build_id to htlhash.

  • graphql: Update the GraphQL Span name convention (#1361)

🚀 New components 🚀

  • cli: Define span describing CLI application execution (#1577)
  • geo: Add geo fields to attribute registry. (#1033)

💡 Enhancements 💡

  • gen_ai: Add system-specific conventions for Azure AI Inference. (#1393)
  • http: Define how to handle experimental attributes in stable groups, add policies and move experimental HTTP attributes into stable HTTP groups (as opt_in). (#906, #1472)
  • db, gen-ai, faas: Relax wording for span kind - use SHOULD instead of MUST for logical operations. (#1315, #1506)
  • kestrel: Add .NET 9 error reasons to Kestrel connection metric. (#1582)
  • db: Specify how to set span status for database operations. (#1536, #1560)
  • gen-ai: Add 2 well-known gen-ai systems as reference values of the gen-ai system attribute including AWS Bedrock and IBM Watsonx AI (#1574)
  • http: Relax server.port requirement level on HTTP server spans (#1387)
  • gen-ai: Add conventions for GenAI Embeddings operations (#1174, #1603)
  • feature_flag: Rename feature_flag.system back to feature_flag.provider_name (#1614)
  • user_agent: Add the user_agent.synthetic.type attribute to specify the category of synthetic traffic, such as tests or bots. (#1127)
  • system: Add system uptime metric (#648)
  • gen-ai: Add gen_ai.openai.response.system_fingerprint attribute (#1355)
  • k8s: Add k8s.{node,pod}.network.{io,errors} metrics (#1427)
  • k8s: Add uptime metrics for container, K8s Pod and K8s Node (#1486)
  • linux: Add linux.process.cgroup attribute (#1357)
  • docs: Improve separation between attribute table footnotes and enum values (#1569)
  • messaging: Specify which span kind to use for messaging settle operations (#1478)
  • db: Added db.cosmosdb.regions_contacted attribute to Cosmos DB metrics and traces. (#1525)
  • db: Added new common db.client.response.returned_rows database metric and several operation level metrics for Azure Cosmos DB. (#1438)

🧰 Bug fixes 🧰

  • service: Merge resource experimental and stable groups for service and telemetry.sdk (#1423)
    Discovered when fixing weaver#306

  • db: Fix telemetry for complex queries:

  • introduce the db.query.summary attribute to provide a concise, low-cardinality
    representation of the query text.

  • use db.query.summary as the span name and as a recommended attribute on metrics.

  • avoid capturing db.operation.name and db.collection.name when the query
    involves multiple operations or collections, to prevent ambiguity.
    (#521, #805, #1159)

  • url: Specific URL query string values should now be redacted by default due to concerns around leaking credentials. (#971)

  • messaging: Fix typo in schemas for messaging attribute changes (#1595)

New Contributors

Full Changelog: v1.28.0...v1.29.0

v1.28.0

08 Oct 00:05
96f8bda
Compare
Choose a tag to compare

🛑 Breaking changes 🛑

  • database: Add new db.response.status_code attribute, deprecate db.cosmos.status_code. (#1424)
  • gen_ai: Deprecate gen_ai.prompt and gen_ai.completion attributes, introduce log-based events for GenAI inputs and outputs. (#834, #980)
  • system: Make system.cpu.utilization and process.cpu.utilization opt-in (#1130)
  • messaging: Mark *.size messaging attributes as opt-in (#474)

🚩 Deprecations 🚩

  • event: Remove support for the event fields supporting referencing / inheriting fields from global attributes. (#1341)

🚀 New components 🚀

  • cloudfoundry: Adds a resource convention for Cloud Foundry applications and system components. (#622, #624)
    Introduces a description for CloudFoundry resources. These can either be
    applications deployed on the runtime or system components of Cloud Foundry
    itself. It also extends to the runtime logs and metrics, e.g. Gorouter access
    logs and container metrics.

  • dotnet: Adds experimental metrics for the .NET Common Language Runtime (CLR). (#956)

  • profile: Introduce semantic convention for OTel Profiles. (#1188)

💡 Enhancements 💡

  • db: Mark database semantic conventions as release candidate (#1101)

  • messaging: Define span kind for unspecified cases of messaging publish and process spans. (#1112)

  • db: Change description of db.client.connection.pending_requests from cumulative to current value (#1290)

  • docs: Add note on tooling limitations for attribute names and enforce name format. (#1124)

  • az, db: Define db.operation.name values for Cosmos DB, declare az.namespace attribute and add proper reference to it. (#1330)

  • db: Recommend to capture db.namespace from initial connection over not capturing any, also specify db.namespace value for PostgreSQL, MySQL and MariaDB (#1437)

  • messaging: Add recommendation to report "Create" spans for batch send calls only and to allow to disable "Create" spans.
    (#1273)

  • other: Update resource to include stability in the YAML file (#1399)
    Makes the following changes:

    • Require name on resource groups.
    • Enforce backwards compatibility stability requirements on resource groups.
    • Rename telemetry to telemetry.sdk, attributes are unchanged.
    • Mark telemetry.sdk and resource as stable in YAML model.
    • Markdown templates for resource groups NOW includes header describing
      the resource type, stability and description.
  • process: Add additional process fields from ECS (#993)

  • container: Add container.cpu.usage metric (#1128)

  • container: Add CSI (Container Storage Interface) attributes: container.csi.plugin.name and container.csi.volume.id. (#1119)

  • system: Add the system.filesystem.limit metric (#127)

  • k8s: Add k8s.pod.cpu.time, k8s.pod.cpu.usage, k8s.node.cpu.time, k8s.node.cpu.usage metrics (#1320)

  • k8s: Add k8s.pod.memory usage and k8s.node.memory.usage metrics (#1406)

  • k8s: Adds k8s.volume.name and k8s.volume.type attributes to the registry (#1164)

  • os: add lookup for os.build_id (#1318)

  • gen_ai: Add system specific conventions for OpenAI. (#1370)

  • system: Add the system.disk.limit metric (#127)

  • file: Add additional attributes from ECS to the file namespace. (#914)

  • messaging: Clarify the possibility to have a parent-child trace structure in messaging conventions (#1282)

  • nodejs: Adding nodejs.eventloop.time metric to Node.js runtime metrics. (#1259)

  • process: Extend process.executable with build_id attributes. (#1329)
    For correct symbolization it is important to uniquely identify executables.

  • messaging: Change messaging.operation.type = publish to messaging.operation.type = send (#1285)

  • host: update lookup for os.build_id (#1396)

🧰 Bug fixes 🧰

  • messaging: Fix deprecated note for service bus attributes (#1418)
  • container: Fixes broken link (#1332)

New Contributors

Full Changelog: v1.27.0...v1.28.0

v1.27.0

02 Aug 16:10
01c542c
Compare
Choose a tag to compare

🛑 Breaking changes 🛑

  • messaging: Support generic operations in messaging and rename metrics:

    • Make messaging.operation.name required and messaging.operation.type conditionally required when type is applicable.
    • Rename messaging.publish.messages metric to messaging.client.published.messages
    • Unify messaging.publish.duration and messaging.receive.duration metrics into messaging.client.operation.duration
    • Unify messaging.receive.messages and messaging.process.messages metrics into messaging.client.consumed.messages
      (#1006, #947, #937)
  • db: Clean up db.system enum members:

    • remove firstsql, mssqlcompact, and cloudscape as the corresponding databases are discontinued.
    • rename cache to intersystems_cache
    • remove coldfusion as it is not a database.
      (#1110)
  • db: Rename db.client.connections.* attributes to db.client.connection.* (#1125)

  • messaging: Rename messaging.kafka.message.offset to messaging.kafka.offset (#1156)

  • db: Sampling relevant attributes defined for database client spans (#1019)

  • tls: Deprecate tls.client.server_name attribute in favor of common server.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 of messaging.kafka.consumer.group, messaging.rocketmq.client_group, and messaging.eventhubs.consumer.group. - messaging.destination.subscription.name instead of messaging.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. Deprecates db.elasticsearch.cluster.name in favor of db.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 to deployment.environment.name.
  • jvm: Rename JVM metric jvm.buffer.memory.usage to jvm.buffer.memory.used (#288)

  • system: Rename process.cpu.state, container.cpu.state, and system.cpu.state attributes into a common cpu.mode attribute (#840)

🚀 New components 🚀

  • 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 - deprecate enduser in favor of a new user namespace. Add more user attributes. (#731)
  • v8js: Introducing semantic conventions for V8 JS Engine runtime metrics. (#990)

💡 Enhancements 💡

  • 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 that db.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: Rename gen_ai.usage.prompt_tokens to gen_ai.usage.input_tokens and gen_ai.usage.completion_tokens to gen_ai.usage.output_tokens to align terminology between spans and metrics.
    (#1200)
  • gen_ai: Convert gen_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: Add server.address, server.port, and error.type to GenAI spans. (#1297)
  • gen-ai: Adding metrics for GenAI clients. (#811)
  • gen-ai: Adding gen_ai.request.top_k, gen_ai.request.presence_penalty, gen_ai.request.frequency_penalty and gen_ai.request.stop_sequences attributes. (#839)
  • messaging: Document messaging.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 the system.linux.memory.slab.usage metric and the linux.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 for db.query.text. (#717)
  • gen-ai: Add 3 well-known gen-ai systems as reference values of the gen-ai system attribute (#1020)
  • gcp: Introduces gcp.client.service scope attribute. (#1047)
  • db: Add semantic convention of InfluxDB (#949)
  • log: Add 'log.record.original' attribute. (#1137)
  • session: Add new experimental session.start and session.end events (#1091)

🧰 Bug fixes 🧰

  • messaging: Update Kafka Spring example to align with the messaging spec (#1155)
  • http: Relax requirement on when to set HTTP span status to Error from MUST to SHOULD. (#1167, #1003)

New Contributors

Full Changelog: v1.26.0...v1.27.0