Skip to content

Commit

Permalink
lint
Browse files Browse the repository at this point in the history
  • Loading branch information
lmolkova committed Dec 20, 2024
1 parent a3017c2 commit 2afb348
Showing 1 changed file with 5 additions and 1 deletion.
6 changes: 5 additions & 1 deletion docs/general/how-to-define-semantic-conventions.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ for the new areas or make substantial changes to the existing ones.
#### Defining attributes

Reuse existing attributes when possible. Look through [existing conventions](/docs/attributes-registry/) for similar areas,
check out [common attributes](https://github.com/open-telemetry/semantic-conventions/blob/main/docs/general/attributes.md).
check out [common attributes](/docs/general/attributes.md).
Semantic conventions authors are encouraged to use attributes from different namespaces.

Introduce new attributes when there is a clear use-case for them. Consider adding
Expand Down Expand Up @@ -70,6 +70,7 @@ When defining a new attribute:
>
> This attribute contains sensitive (PII) information.
```
- Use the appropriate [attribute type](https://github.com/open-telemetry/weaver/blob/main/schemas/semconv-syntax.md#type)
- If the value has a reasonably short (open or closed) set of possible values, define it as an enum.
- If the value is a timestamp, record it as a string in ISO 8601 format.
Expand Down Expand Up @@ -139,9 +140,12 @@ TBD
- Conventions that are not used by instrumentations MUST NOT be declared stable

TODO:

- prototyping/implementation requirements
- migration plan

### Migration plan

TODO

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

0 comments on commit 2afb348

Please sign in to comment.