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

lmolkova · 2025-01-10T01:02:13Z

Fix #1581

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 Demo - remove root namespace from system-specific attributes and metrics #1711:
- some systems (e.g. redis are cache and database and also a messaging system)
- not all operations that are done on the database are related to DB (control plane, auth, etc)
- 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.

…e constants, remove db prefix from system-specific attributes

lmolkova · 2025-01-10T01:12:08Z

docs/database/database-spans.md


 | Value  | Description | Stability |
 |---|---|---|
+| `actian.ingres` | [Actian Ingres](https://www.actian.com/databases/ingres/) | ![Experimental](https://img.shields.io/badge/-experimental-blue) |


ingres seems to be too generic - easy to mix with a word "ingress", but it's a trademark. I'm totally open to change it back to ingres

lmolkova · 2025-01-10T01:17:58Z

docs/database/database-spans.md

-| `intersystems_cache` | InterSystems Caché | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
-| `mariadb` | MariaDB (This value has stability level RELEASE CANDIDATE) | ![Release Candidate](https://img.shields.io/badge/-rc-mediumorchid) |
-| `maxdb` | SAP MaxDB | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
+| `aws.dynamodb` | [Amazon DynamoDB](https://aws.amazon.com/pm/dynamodb/) | ![Experimental](https://img.shields.io/badge/-experimental-blue) |


Dynamodb is a trademark, but also "amazon redshift" is a trademark.

Also, s3 is a trademark, but we use aws.s3 in other places.

I'm suggesting to keep all things AWS consistent and use aws prefix regardless of what trademark is registered for

docs/database/database-spans.md

lmolkova · 2025-01-10T01:36:18Z

docs/database/database-spans.md

+| `hbase` | [Apache HBase](https://hbase.apache.org/) | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
+| `hive` | [Apache Hive](https://hive.apache.org/) | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
+| `hsqldb` | [HyperSQL Database](https://hsqldb.org/) | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
+| `ibm.db2` | [IBM Db2](https://www.ibm.com/db2) | ![Experimental](https://img.shields.io/badge/-experimental-blue) |


All IBM databases have independent trademarks. E.g. db2

Still, given that other cloud services come with provider as a namespace, I'm suggesting ibm.*.

Maybe @gyliu513 or @mamwl1 would have some input from the IBM side? (it aligns with ibm.watsonx.ai) and we'd use ibm.mq as a messaging system name.

lmolkova · 2025-01-10T01:38:09Z

docs/database/database-spans.md

 | `memcached` | Memcached | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
 | `mongodb` | MongoDB | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
-| `mssql` | Microsoft SQL Server (This value has stability level RELEASE CANDIDATE) | ![Release Candidate](https://img.shields.io/badge/-rc-mediumorchid) |
-| `mysql` | MySQL (This value has stability level RELEASE CANDIDATE) | ![Release Candidate](https://img.shields.io/badge/-rc-mediumorchid) |
+| `mssql` | Microsoft SQL Server | ![Release Candidate](https://img.shields.io/badge/-rc-mediumorchid) |


should we rename it to ms.sql or ms.sql.server ? wdyt @trask @jcocchi ?

microsoft.sql_server?

docs/database/database-spans.md

model/database/registry.yaml

docs/database/database-spans.md

trask · 2025-01-10T04:08:56Z

model/database/registry.yaml

-              stability: experimental
+              value: "opensearch"  # trademark on 'opensearch'
+              brief: "[OpenSearch](https://opensearch.org/)"
+              stability: development
            - id: oracle
              value: "oracle"


does this work now that we are sort of considering this to point to a top-level namespace?

or maybe a better question, if we add oracle (database) specific attributes what namespace would they be under? (now that we also have oracle cloud related namespaces I think)

renamed to oracle.db, but it looks funky along with couchdb, mariadb, cosmosdb, dynamodb... Need to sleep on this.

It's the case where we have one company and may offerings oracle.db, oracle.nosql_db?, oracle.web_logic, oracle.jvm 😅, oracle cloud is being added as oracle_cloud

model/database/registry.yaml

trask · 2025-01-11T01:34:32Z

docs/database/database-spans.md

+| `firebirdsql` | [Firebird](https://www.firebirdsql.org/) | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
+| `gcp.spanner` | [Google Cloud Spanner](https://cloud.google.com/spanner) | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
+| `geode` | [Apache Geode](https://geode.apache.org/) | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
+| `h2` | [H2 Database](https://h2database.com/) | ![Experimental](https://img.shields.io/badge/-experimental-blue) |


maybe should be h2database when considered as a top-level namespace

trask

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

trask · 2025-01-12T03:41:52Z

model/database/registry.yaml

            - id: adabas
-              value: "adabas"
+              value: "adabas"  # trademark on 'adabas'


Suggested change

value: "adabas" # trademark on 'adabas'

value: "software_ag.adabas" # trademark on 'adabas'

trask · 2025-01-12T03:47:16Z

model/database/registry.yaml

-              brief: "InterBase"
-              stability: experimental
+              value: "instantdb"  # no trademark
+              brief: "[InstantDB](https://www.instantdb.com/)"


from their website, looks like they're calling it just "Instant" (but we could still use instantdb as the value based on their domain name

Suggested change

brief: "[InstantDB](https://www.instantdb.com/)"

brief: "[Instant](https://www.instantdb.com/)"

model/database/registry.yaml

lmolkova added 3 commits January 9, 2025 16:47

Align with naming guidance: rename db.system to db.system.name, renam…

8db64ac

…e constants, remove db prefix from system-specific attributes

up

3977146

up

f5a7855

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 Jan 10, 2025

lint

d8ff697

lmolkova commented Jan 10, 2025

View reviewed changes

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

lmolkova commented Jan 10, 2025

View reviewed changes

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

a few more renames

c21f5ce

lmolkova commented Jan 10, 2025

View reviewed changes

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

lmolkova commented Jan 10, 2025

View reviewed changes

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

lmolkova commented Jan 10, 2025

View reviewed changes

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

remove constants

59c865a

lmolkova commented Jan 10, 2025

View reviewed changes

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

lmolkova commented Jan 10, 2025

View reviewed changes

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

lmolkova added 2 commits January 9, 2025 18:32

lint

c424f76

changelog

f008481

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 Jan 10, 2025

View reviewed changes

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

up

1042c6e

trask reviewed Jan 10, 2025

View reviewed changes

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

trask reviewed Jan 10, 2025

View reviewed changes

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

trask reviewed Jan 10, 2025

View reviewed changes

model/database/registry.yaml Show resolved Hide resolved

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

bdcb0a2

lmolkova mentioned this pull request Jan 10, 2025

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

Open

trask reviewed Jan 11, 2025

View reviewed changes

trask reviewed Jan 12, 2025

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

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

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

lmolkova commented Jan 10, 2025 •

edited

Loading

lmolkova Jan 10, 2025

lmolkova Jan 10, 2025 •

edited

Loading

lmolkova Jan 10, 2025 •

edited

Loading

lmolkova Jan 10, 2025 •

edited

Loading

trask Jan 12, 2025

trask Jan 10, 2025

lmolkova Jan 10, 2025 •

edited

Loading

trask Jan 11, 2025

trask left a comment

trask Jan 12, 2025

trask Jan 12, 2025

	value: "adabas" # trademark on 'adabas'
	value: "software_ag.adabas" # trademark on 'adabas'

	brief: "[InstantDB](https://www.instantdb.com/)"
	brief: "[Instant](https://www.instantdb.com/)"

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

Are you sure you want to change the base?

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

Conversation

lmolkova commented Jan 10, 2025 • edited Loading

Merge requirement checklist

lmolkova Jan 10, 2025

Choose a reason for hiding this comment

lmolkova Jan 10, 2025 • edited Loading

Choose a reason for hiding this comment

lmolkova Jan 10, 2025 • edited Loading

Choose a reason for hiding this comment

lmolkova Jan 10, 2025 • edited Loading

Choose a reason for hiding this comment

trask Jan 12, 2025

Choose a reason for hiding this comment

trask Jan 10, 2025

Choose a reason for hiding this comment

lmolkova Jan 10, 2025 • edited Loading

Choose a reason for hiding this comment

trask Jan 11, 2025

Choose a reason for hiding this comment

trask left a comment

Choose a reason for hiding this comment

trask Jan 12, 2025

Choose a reason for hiding this comment

trask Jan 12, 2025

Choose a reason for hiding this comment

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

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

lmolkova commented Jan 10, 2025 •

edited

Loading

lmolkova Jan 10, 2025 •

edited

Loading

lmolkova Jan 10, 2025 •

edited

Loading

lmolkova Jan 10, 2025 •

edited

Loading

lmolkova Jan 10, 2025 •

edited

Loading