Skip to content

Commit

Permalink
Add display name and regen tables
Browse files Browse the repository at this point in the history
  • Loading branch information
stevejgordon committed Aug 5, 2024
1 parent 8e90ea0 commit 8717a40
Show file tree
Hide file tree
Showing 3 changed files with 5 additions and 26 deletions.
4 changes: 2 additions & 2 deletions docs/attributes-registry/dotnet.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,9 +6,9 @@

# Dotnet

## Dotnet Attributes
## .NET Attributes

This document defines .NET Common Language Runtime (CLR) related attributes.
This document defines .NET related attributes.

| Attribute | Type | Description | Examples | Stability |
| --------------------------- | ------ | ------------------------------------------------------ | ---------------------- | ---------------------------------------------------------------- |
Expand Down
24 changes: 1 addition & 23 deletions docs/runtime/dotnet-metrics.md
Original file line number Diff line number Diff line change
Expand Up @@ -871,29 +871,7 @@ This metric reports the same values as calling [`AppDomain.CurrentDomain.FirstCh

| Attribute | Type | Description | Examples | [Requirement Level](https://opentelemetry.io/docs/specs/semconv/general/attribute-requirement-level/) | Stability |
|---|---|---|---|---|---|
| [`error.type`](/docs/attributes-registry/error.md) | string | Describes a class of error the operation ended with. [1] | `timeout`; `java.net.UnknownHostException`; `server_certificate_invalid`; `500` | `Required` | ![Stable](https://img.shields.io/badge/-stable-lightgreen) |

**[1]:** The `error.type` SHOULD be predictable, and SHOULD have low cardinality.

When `error.type` is set to a type (e.g., an exception type), its
canonical class name identifying the type within the artifact SHOULD be used.

Instrumentations SHOULD document the list of errors they report.

The cardinality of `error.type` within one instrumentation library SHOULD be low.
Telemetry consumers that aggregate data from multiple instrumentation libraries and applications
should be prepared for `error.type` to have high cardinality at query time when no
additional filters are applied.

If the operation has completed successfully, instrumentations SHOULD NOT set `error.type`.

If a specific domain defines its own set of error identifiers (such as HTTP or gRPC status codes),
it's RECOMMENDED to:

* Use a domain-specific attribute
* Set `error.type` to capture all errors, regardless of whether they are defined within the domain-specific set or not.


| [`error.type`](/docs/attributes-registry/error.md) | string | Describes a class of error the operation ended with. | `System.OperationCanceledException`; `Contoso.MyException` | `Required` | ![Stable](https://img.shields.io/badge/-stable-lightgreen) |

`error.type` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used.

Expand Down
3 changes: 2 additions & 1 deletion model/registry/dotnet.yaml
Original file line number Diff line number Diff line change
@@ -1,9 +1,10 @@
groups:
- id: registry.dotnet
type: attribute_group
display_name: .NET Attributes
prefix: dotnet
brief: >
This document defines .NET Common Language Runtime (CLR) related attributes.
This document defines .NET related attributes.
attributes:
- id: gc.heap.generation
stability: experimental
Expand Down

0 comments on commit 8717a40

Please sign in to comment.