Skip to content

Commit

Permalink
Apply suggestions from code review
Browse files Browse the repository at this point in the history
Co-authored-by: Trask Stalnaker <[email protected]>
  • Loading branch information
lmolkova and trask authored Jan 11, 2025
1 parent abecb36 commit 9b2b07c
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 4 deletions.
4 changes: 2 additions & 2 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -83,9 +83,9 @@ and helps to keep conventions consistent and backward compatible.
Want to define your own conventions outside this repo while building on OTel’s?
Come help us [decentralize semantic conventions](https://github.com/open-telemetry/weaver/issues/215).

### Suggesting conventions for a new areas
### Suggesting conventions for a new area

Defining semantic conventions involves a group of people who are familiar with the domain,
Defining semantic conventions requires a group of people who are familiar with the domain,
are involved with instrumentation efforts, and are committed to be the point of contact for
pull requests, issues, and questions in this area.

Expand Down
4 changes: 2 additions & 2 deletions docs/general/how-to-define-semantic-conventions.md
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@ When defining a new attribute:
- Follow the [naming guidance](/docs/general/naming.md)
- Provide descriptive `brief` and `note` sections to clearly explain what the attribute represents.
- If the attribute represents a common concept documented externally, include relevant links.
For example, always link to attributes related to concepts defined in RFCs or other standards.
For example, always link to concepts defined in RFCs or other standards.
- If the attribute's value might contain PII or other sensitive information, explicitly call this out in
the `note`.

Expand All @@ -75,7 +75,7 @@ When defining a new attribute:
- 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.
- For arrays of primitives, use the array type. Avoid recording arrays as a single string.
- Use the template type to define attributes with variable names (only the last segment of the name should be dynamic).
- Use the template type to define attributes with dynamic names (only the last segment of the name should be dynamic).
This is useful for capturing user-defined key-value pairs, such as HTTP headers.
- Represent complex values as a set of flat attributes. <!-- This may change, check out https://github.com/open-telemetry/semantic-conventions/issues/1669 to monitor the progress -->
- Define new attributes with `development` stability.
Expand Down

0 comments on commit 9b2b07c

Please sign in to comment.