Consistent naming: `db.system` to `db.system.name`, namespace constants, remove `db` from system-specific names #1734

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Merged

lmolkova merged 27 commits into open-telemetry:main from lmolkova:db-rename-system-and-attributes

Jan 24, 2025

Member

lmolkova commented Jan 10, 2025 •

edited

Loading

Addresses DB-related portion of #608, replaces db-related things from #1711 and #1613.

Rename db.system to db.system.name. It gives us a good opportunity to clean up constants, batching multiple breaking changes together (see below)
Removes deprecated constants from new enum and updates existing constants to follow consistent naming
Removes db prefix from system-specific attributes following Add system-specific naming guidance #1708:
- some systems don't fit into one domain (e.g. redis is a cache and database and also a messaging system)
- not all operations that are done on the database are related to DB (control plane, auth, scaling, node communication)
- we're quite inconsistent in naming
Adjusts _ -> . where it makes sense

Merge requirement checklist

CONTRIBUTING.md guidelines followed.
Change log entry added, according to the guidelines in When to add a changelog entry.
- If your PR does not need a change log, start the PR title with [chore]
schema-next.yaml updated with changes to existing conventions.

lmolkova changed the title ~~Align with naming guidance: db.system to db.system.name, namespace constants, remove db from system-specific names~~ Consistent naming: db.system to db.system.name, namespace constants, remove db from system-specific names

lmolkova commented

View reviewed changes

docs/database/database-spans.md Show resolved Hide resolved

lmolkova commented

View reviewed changes

docs/database/database-spans.md Show resolved Hide resolved

lmolkova commented

View reviewed changes

docs/database/database-spans.md Show resolved Hide resolved

lmolkova commented

View reviewed changes

docs/database/database-spans.md Show resolved Hide resolved

lmolkova commented

View reviewed changes

docs/database/database-spans.md Outdated Show resolved Hide resolved

lmolkova commented

View reviewed changes

docs/database/database-spans.md Outdated Show resolved Hide resolved

lmolkova commented

View reviewed changes

docs/database/database-spans.md Show resolved Hide resolved

lmolkova commented

View reviewed changes

docs/database/database-spans.md Show resolved Hide resolved

lmolkova commented

View reviewed changes

docs/database/database-spans.md Show resolved Hide resolved

lmolkova commented

View reviewed changes

docs/database/database-spans.md Show resolved Hide resolved

lmolkova commented

View reviewed changes

docs/database/database-spans.md Show resolved Hide resolved

lmolkova marked this pull request as ready for review

January 10, 2025 02:52

lmolkova requested review from a team as code owners

January 10, 2025 02:52

trask reviewed

View reviewed changes

model/database/registry.yaml Outdated Show resolved Hide resolved

trask reviewed

View reviewed changes

model/database/registry.yaml Outdated Show resolved Hide resolved

trask reviewed

View reviewed changes

docs/database/database-spans.md Show resolved Hide resolved

trask reviewed

View reviewed changes

model/database/registry.yaml Outdated Show resolved Hide resolved

trask reviewed

View reviewed changes

model/database/registry.yaml Show resolved Hide resolved

lmolkova mentioned this pull request

Guidance on product/project name inside attribute/metric name #608

Open

trask reviewed

View reviewed changes

docs/database/database-spans.md Outdated Show resolved Hide resolved

trask reviewed

View reviewed changes

Member

trask left a comment

I think I'm coming around to your proposal in #608 (comment)

model/database/registry.yaml Outdated Show resolved Hide resolved

model/database/registry.yaml Outdated Show resolved Hide resolved

model/database/registry.yaml Show resolved Hide resolved

lmolkova force-pushed the db-rename-system-and-attributes branch from bdcb0a2 to 6f9d66a Compare

January 12, 2025 18:58

maryliag reviewed

View reviewed changes

docs/database/elasticsearch.md Outdated Show resolved Hide resolved

maryliag reviewed

View reviewed changes

model/database/registry.yaml Show resolved Hide resolved

model/database/spans.yaml Show resolved Hide resolved

schema-next.yaml Outdated Show resolved Hide resolved

lmolkova added the area:db label

trask reviewed

View reviewed changes

model/cassandra/registry.yaml Outdated Show resolved Hide resolved

model/database/registry.yaml Outdated Show resolved Hide resolved

model/database/registry.yaml Outdated Show resolved Hide resolved

model/database/registry.yaml Outdated Show resolved Hide resolved

model/database/registry.yaml Outdated Show resolved Hide resolved

lmolkova force-pushed the db-rename-system-and-attributes branch from 7574011 to 4509a9f Compare

January 17, 2025 00:16

Liudmila Molkova added 18 commits

January 23, 2025 22:47


          changelog

3d34aa8

up

e12aa3f


          remove edb, firebird -> firebirdsql, oracle -> oracle.db

9387ae2


          h2database

cb34f41


          more renames

dd41255


          mssql -> microsoft.sql_server

faf5361


          az.cosmos -> azure.cosmos

735e394


          add links, remove trandemark comments, speculative_execution_count ->…

b150c8d

… speculative_execution.count


          software_ag -> softwareag

87a31d1


          lint

458b5bb


          lint

dea0f99


          feedback


          db.elasticsearch.path_parts -> db.operation.parameter

5c3c7aa


          lint

ee3a4b3


          is_idempotent -> idempotent

ffc4c5a


          update system constants

aa32bd7


          a few more cleanups: examples and cosmos attributes

961d87c

up

ab5268f

lmolkova force-pushed the db-rename-system-and-attributes branch from 28b213b to ab5268f Compare

January 24, 2025 06:51

up

2668c31

lmolkova commented

View reviewed changes

docs/database/elasticsearch.md Outdated Show resolved Hide resolved


          Update docs/database/elasticsearch.md

lmolkova merged commit 62d5a7c into open-telemetry:main

14 of 15 checks passed

codefromthecrypt mentioned this pull request

Handle remote services in topology view ymtdzzz/otel-tui#200

Open

lmolkova mentioned this pull request

Messaging: adopt system-specific naming practices similar to DB #1892

Open

3 tasks

sincejune mentioned this pull request

[db] rename db.system to db.system.name for metrics and update values #1917

Merged

3 tasks

trask mentioned this pull request

Database semantic conventions may violate namespacing guidelines #713

Closed

martincostello mentioned this pull request

[feature request] Have db systems match sem conv open-telemetry/opentelemetry-dotnet-contrib#2973

Closed

lmolkova mentioned this pull request

RPC: adopt system-specific naming practices #2703

Open

3 tasks

chalin reviewed

View reviewed changes

model/azure/registry.yaml

    
                        it indicates that the operation was performed on multiple regions i.e. cross-regional call.

                      note: >

                        Region name matches the format of `displayName`

                        in [Azure Location API](https://learn.microsoft.com/rest/api/subscription/subscriptions/list-locations?view=rest-subscription-2021-10-01&tabs=HTTP#location)

Contributor

chalin Oct 1, 2025 •

edited

Loading

The following link in model/azure/registry.yaml for id: azure.cosmosdb.operation.contacted_regions is invalid (404):

in Azure Location API

Screenshot:

Contributor

chalin Oct 1, 2025

Let's track this via:

[editorial] Invalid URL in azure.cosmosdb.operation.contacted_regions note #2844

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

area:db breaking