-
-
Notifications
You must be signed in to change notification settings - Fork 1.6k
feat(python): Illustrate types of metrics #15556
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 5 commits
Commits
Show all changes
6 commits
Select commit
Hold shift + click to select a range
9e2cb1b
feat(python): Illustrate types of metrics
alexander-alderman-webb 528fbbb
.
alexander-alderman-webb eed0809
.
alexander-alderman-webb a2d4b46
.
alexander-alderman-webb f0f2e30
merge before send metric paragraphs
alexander-alderman-webb 3e181d2
argument style
alexander-alderman-webb 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
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
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 | ||||||||
|---|---|---|---|---|---|---|---|---|---|---|
|
|
@@ -2,26 +2,62 @@ Once the feature is enabled on the SDK and the SDK is initialized, you can send | |||||||||
|
|
||||||||||
| The `metrics` namespace exposes three methods that you can use to capture different types of metric information: `count`, `gauge`, and `distribution`. | ||||||||||
|
|
||||||||||
| ## Emit a Counter | ||||||||||
|
|
||||||||||
| Counters are one of the more basic types of metrics and can be used to count certain event occurrences. | ||||||||||
|
|
||||||||||
| To emit a counter, do the following: | ||||||||||
|
|
||||||||||
| ```python | ||||||||||
| from sentry_sdk import metrics | ||||||||||
| import sentry_sdk | ||||||||||
|
|
||||||||||
| metrics.count("checkout.failed", 1) | ||||||||||
| metrics.gauge("queue.depth", 42) | ||||||||||
| metrics.distribution("cart.amount_usd", 187.5) | ||||||||||
| # Record five total button clicks | ||||||||||
| sentry_sdk.metrics.count( | ||||||||||
| name="button_click", | ||||||||||
| value=5, | ||||||||||
| attributes={ | ||||||||||
| "browser": "Firefox", | ||||||||||
| "app_version": "1.0.0" | ||||||||||
| }, | ||||||||||
| ) | ||||||||||
| ``` | ||||||||||
|
|
||||||||||
| You can also pass additional attributes directly to `count`, `gauge`, and `distribution` via the `attributes` kwarg. | ||||||||||
| ## Emit a Distribution | ||||||||||
|
|
||||||||||
| Distributions help you get the most insights from your data by allowing you to obtain aggregations such as `p90`, `min`, `max`, and `avg`. | ||||||||||
|
|
||||||||||
| To emit a distribution, do the following: | ||||||||||
|
|
||||||||||
| ```python | ||||||||||
| from sentry_sdk import metrics | ||||||||||
|
|
||||||||||
| metrics.count( | ||||||||||
| "checkout.failed", | ||||||||||
| 1, | ||||||||||
| attributes={ | ||||||||||
| "route": "/checkout", | ||||||||||
| "tenant": "acme", | ||||||||||
| "provider": "stripe", | ||||||||||
| }, | ||||||||||
| import sentry_sdk | ||||||||||
|
|
||||||||||
| # Add '15.0' to a distribution used for tracking the loading times per page. | ||||||||||
| sentry_sdk.metrics.distribution( | ||||||||||
| name="page_load", | ||||||||||
| value=15.0, | ||||||||||
|
||||||||||
| name="page_load", | |
| value=15.0, | |
| "page_load", | |
| 15.0, |
Outdated
Contributor
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Suggested change
| name="page_load", | |
| value=15.0, | |
| "page_load", | |
| 15.0, |
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Just passing
nameandvaluein as simple args makes this a bit more straightforward to read IMO, and it also communicates right away which args are required and which are optional:There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
agreed and changed, these were artifacts of the old metrics docs I copied the examples from.