Update attribute name in OpenTelemetry Spec

XMLWordPrintableJSON

    • Type: Task
    • Resolution: Unresolved
    • Priority: Unknown
    • None
    • Component/s: Logging
    • None
    • Needed
    • Hide

      Summary of necessary driver changes

      • Drivers that have already implemented OpenTelemetry should rename db.system attribute to db.system.name. Drivers MAY keep both attributes for some transition period to not break early adopters.

      Drivers that haven't implemented OpenTelemetry can just close the downstream ticket and follow the latest specification

      Commits for syncing spec/prose tests
      ce6bc33

      Show
      Summary of necessary driver changes Drivers that have already implemented OpenTelemetry should rename db.system attribute to db.system.name . Drivers MAY keep both attributes for some transition period to not break early adopters. Drivers that haven't implemented OpenTelemetry can just close the downstream ticket and follow the latest specification Commits for syncing spec/prose tests ce6bc33
    • $i18n.getText("admin.common.words.hide")
      Key Status/Resolution FixVersion
      CDRIVER-6234 Backlog
      CXX-3415 Backlog
      CSHARP-5870 Investigating
      GODRIVER-3811 Backlog
      JAVA-6094 Ready for Work
      NODE-7431 Backlog
      PYTHON-5718 Blocked
      PHPLIB-1784 Works as Designed
      RUBY-3771 Fixed 2.24.0
      RUST-2358 Needs Triage
      $i18n.getText("admin.common.words.show")
      #scriptField, #scriptField *{ border: 1px solid black; } #scriptField{ border-collapse: collapse; } #scriptField td { text-align: center; /* Center-align text in table cells */ } #scriptField td.key { text-align: left; /* Left-align text in the Key column */ } #scriptField a { text-decoration: none; /* Remove underlines from links */ border: none; /* Remove border from links */ } /* Add green background color to cells with FixVersion */ #scriptField td.hasFixVersion { background-color: #00FF00; /* Green color code */ } #scriptField td.willNotDo { background-color: #FF0000; /* Red color code */ } /* Center-align the first row headers */ #scriptField th { text-align: center; } Key Status/Resolution FixVersion CDRIVER-6234 Backlog CXX-3415 Backlog CSHARP-5870 Investigating GODRIVER-3811 Backlog JAVA-6094 Ready for Work NODE-7431 Backlog PYTHON-5718 Blocked PHPLIB-1784 Works as Designed RUBY-3771 Fixed 2.24.0 RUST-2358 Needs Triage

      Summary

      We need to update attribute names in the OpenTelemetry spec in compliance with the latest version of the Official OpenTelemetry semantic conventions for database client spans found here: https://opentelemetry.io/docs/specs/semconv/db/database-spans/

      The db.system attribute was renamed to db.system.name and we need to reflect that change and update our tests accordingly.

      Motivation

      Who is the affected end user?

      Users of drivers that have already implemented and released OpenTelemetry support

      How does this affect the end user?

      Users' telemetry data will use non-standard attribute names (db.system instead of db.system.name) that don't match the official OpenTelemetry semantic conventions. This means:
        - Dashboards and monitoring tools expecting standard OTel attribute names won't work correctly
        - Users must write queries/filters using non-standard attribute names
        - Breaks interoperability with OTel-compliant observability platforms and tooling

        This doesn't block users from using the driver, but it breaks compatibility with standard OpenTelemetry tooling and best practices

      How likely is it that this problem or use case will occur?

      Main path - every user who enables OpenTelemetry tracing in the driver will be affected. This is a guaranteed issue for anyone integrating with OTel-compliant monitoring systems.

      If the problem does occur, what are the consequences and how severe are they?

      Moderate severity:
        - Telemetry dashboards, queries, and alerting rules expecting standard OTel attribute names won't work
        - Impacts observability and monitoring effectiveness
        - Degrades the value of telemetry data

      Is this issue urgent?

      Yes - the C# driver OpenTelemetry implementation is currently in PR review and hasn't been released yet. This must be fixed before the first release to avoid introducing a breaking change later. Once released with incorrect attribute names, fixing them would be a breaking change for existing users.

      Is this ticket required by a downstream team?

      N/A

      Is this ticket only for tests?

      No - both the driver code and tests need updates

      Acceptance Criteria

       1. Attribute names updated in driver code:
          - db.system → db.system.name
          _- All other attribute names verified against latest OTel semantic conventions (https://opentelemetry.io/docs/specs/semconv/db/database-spans/)_
        2. OpenTelemetry spec tests updated:
          - All test assertions updated to expect db.system.name instead of db.system

            Assignee:
            Dmitry Rybakov
            Reporter:
            Adelin Mbida Owona
            Nabil Hachicha Nabil Hachicha
            Votes:
            0 Vote for this issue
            Watchers:
            1 Start watching this issue

              Created:
              Updated: