-
Notifications
You must be signed in to change notification settings - Fork 255
Attempt a write-up about t-shaped-signals. #2232
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
Show all changes
17 commits
Select commit
Hold shift + click to select a range
44840f7
Attempt a write-up about t-shaped-signals.
jsuereth 6f4621d
Merge remote-tracking branch 'origin/main' into wip-t-shaped-signals
jsuereth c5f0cb7
Move guidance into how-to-write section.
jsuereth b30e68e
Add changelog.
jsuereth ea421cf
Add recommendations.
jsuereth 9d0e1e4
Add link to t-shaped signals from how to write conventions.
jsuereth 09f64ef
Update docs/non-normative/how-to-write-conventions/t-shaped-signals.md
jsuereth 2ac7185
Update .chloggen/wip-t-shaped-signals.yaml
jsuereth f3fafd7
Update docs/general/how-to-define-semantic-conventions.md
jsuereth fce8a44
Update docs/non-normative/how-to-write-conventions/t-shaped-signals.md
jsuereth f93fcd8
Fixes from review.
jsuereth 62edaaa
Fix lint.
jsuereth b644391
Update docs/non-normative/how-to-write-conventions/t-shaped-signals.md
jsuereth 17d71b8
Update docs/non-normative/how-to-write-conventions/t-shaped-signals.md
jsuereth fc3eaf3
Update docs/general/how-to-define-semantic-conventions.md
jsuereth e51b706
Update docs/non-normative/how-to-write-conventions/t-shaped-signals.md
jsuereth 4329935
Fix merge conflicts.
jsuereth File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,22 @@ | ||
# Use this changelog template to create an entry for release notes. | ||
# | ||
# If your change doesn't affect end users you should instead start | ||
# your pull request title with [chore] or use the "Skip Changelog" label. | ||
|
||
# One of 'breaking', 'deprecation', 'new_component', 'enhancement', 'bug_fix' | ||
change_type: enhancement | ||
|
||
# The name of the area of concern in the attributes-registry, (e.g. http, cloud, db) | ||
component: docs | ||
|
||
# A brief description of the change. Surround your text with quotes ("") if it needs to start with a backtick (`). | ||
note: Document the "T-Shaped" notion for defining semantic conventions. | ||
|
||
# Mandatory: One or more tracking issues related to the change. You can use the PR number here if no issue exists. | ||
# The values here must be integers. | ||
issues: [2232] | ||
|
||
# (Optional) One or more lines of additional information to render under the primary note. | ||
# These lines will be padded with 2 spaces and then inserted directly into the document. | ||
# Use pipe (|) for multiline entries. | ||
subtext: |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
58 changes: 58 additions & 0 deletions
58
docs/non-normative/how-to-write-conventions/t-shaped-signals.md
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,58 @@ | ||
# T-shaped Signals | ||
|
||
Semantic Conventions approaches observability with a T-shaped mindset. This | ||
splits signals into two types of a "T" shape: | ||
|
||
```mermaid | ||
block-beta | ||
columns 3 | ||
Broad["Broadly Applicable Signals"]:3 | ||
columns 3 | ||
space:1 | ||
Deep("Rich,\nDeep\nSignals") | ||
space:1 | ||
``` | ||
|
||
This matches an 80-20 rule, where 80% of users (or use-cases) can leverage the | ||
broadly applicable signals and 20% of users (or use-cases) will dive deeply into | ||
a problem with deep signals. | ||
|
||
## Broadly Applicable Signals | ||
|
||
These are conventions meant to provide a baseline observability experience | ||
across a domain. An example includes HTTP semantic conventions that allow | ||
general-purpose dashboarding, alerting, and diagnostics for HTTP | ||
(micro-)services. These signals should provide "horizontal" coverage for | ||
observability. | ||
|
||
Examples include: | ||
|
||
- Golden Signals / RED metrics (Saturation, Rate, Error, Duration) | ||
- High Level Spans | ||
- Error logs, Crash reports | ||
- Request/Response logs | ||
|
||
## Rich, Deep Signals | ||
|
||
These are conventions meant to provide deep understanding of a specific | ||
kamphaus marked this conversation as resolved.
Show resolved
Hide resolved
|
||
system, library, module, application or service. These are used to diagnose | ||
issues specific to that system. | ||
|
||
Examples include: | ||
|
||
- Linux slab memory usage | ||
- Specific database signals, e.g MySQL index usage | ||
- Language-specific Garbage Collection metrics (JVM, Go, .NET, etc.) | ||
|
||
## Recommendations | ||
|
||
Defining semantic conventions is a balance between generating | ||
broadly applicable signals and ensuring rich observability for a specific | ||
technology. It is recommended to start with the *broad* use cases and signals | ||
for a particular domain first. After providing a baseline set of signals for | ||
that domain, then explore deeper integrations that may be vendor or | ||
implementation specific. | ||
|
||
For example, see [Database semantic conventions](/docs/database/README.md) where | ||
there is general guidance for spans about communicating with a database, and | ||
additionally there is database-specific guidance as an extension of the general. |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.