Skip to content

Commit 11b2173

Browse files
lmolkovaShipraJain01
authored andcommitted
Remove outdated section from naming doc (open-telemetry#2644)
1 parent d0a8e43 commit 11b2173

File tree

1 file changed

+4
-31
lines changed

1 file changed

+4
-31
lines changed

docs/general/naming.md

Lines changed: 4 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,6 @@ aliases: [attribute-naming]
2020
- [otel.\* namespace](#otel-namespace)
2121
- [Attribute name pluralization guidelines](#attribute-name-pluralization-guidelines)
2222
- [Signal-specific attributes](#signal-specific-attributes)
23-
- [System-specific attributes](#system-specific-attributes)
2423
- [Metrics](#metrics)
2524
- [Naming rules for counters and UpDownCounters](#naming-rules-for-counters-and-updowncounters)
2625
- [Pluralization](#pluralization)
@@ -31,7 +30,7 @@ aliases: [attribute-naming]
3130
- [System-specific naming](#system-specific-naming)
3231
- [System (project/product/provider) name attribute](#system-projectproductprovider-name-attribute)
3332
- [Choosing a system name](#choosing-a-system-name)
34-
- [System-specific attributes](#system-specific-attributes-1)
33+
- [System-specific attributes](#system-specific-attributes)
3534
- [System-specific metrics](#system-specific-metrics)
3635
- [Known exceptions](#known-exceptions)
3736

@@ -239,32 +238,6 @@ Examples:
239238
Metric `http.server.request.duration` uses attributes from the registry such as
240239
`server.port`, `error.type`.
241240

242-
### System-specific attributes
243-
244-
**Status**: [Development][DocumentStatus]
245-
246-
When an attribute is specific to a particular system (e.g., project, provider, product),
247-
the system name should be used in the attribute name, following the pattern:
248-
`{optional domain}.{system}.*.{property}` pattern.
249-
250-
Examples:
251-
252-
- `db.cassandra.consistency_level` - Describes the consistency level property
253-
specific to the Cassandra database.
254-
- `aws.s3.key` - Refers to the `key` property of the AWS S3 product.
255-
- `signalr.connection.status` – Indicates the connection status of the SignalR
256-
network protocol. In this case, no domain is included.
257-
258-
Semantic conventions for a specific domain are generally applicable to multiple systems.
259-
These conventions should define an attribute to represent the name of the system.
260-
For example, database conventions include the `db.system.name` attribute.
261-
262-
The name of the system used in the corresponding attribute should match the name
263-
used inside system-specific attributes.
264-
265-
For example, if the database name specified in `db.system.name` is `foo.bar`, system-specific
266-
attributes for this database should follow the `db.foo.bar.*` pattern.
267-
268241
## Metrics
269242

270243
**Status**: [Development][DocumentStatus]
@@ -458,8 +431,8 @@ attribute use the same system name (`azure.cosmosdb`).
458431
pattern](/docs/system/system-metrics.md#systemos---os-specific-system-metrics)
459432
of `system.{os}` and `process.{os}`. <!-- TODO: document why-->
460433

461-
- [RPC](/docs/rpc/README.md), [messaging](/docs/messaging/README.md), and
462-
[GenAI](/docs/gen-ai/README.md) semantic conventions don't follow the
463-
system-specific naming guidance yet, and will be updated one-by-one.
434+
- [RPC](/docs/rpc/README.md) and [messaging](/docs/messaging/README.md) semantic
435+
conventions don't follow the system-specific naming guidance yet, and will be
436+
updated one-by-one.
464437

465438
[DocumentStatus]: https://opentelemetry.io/docs/specs/otel/document-status

0 commit comments

Comments
 (0)