docs(dart, flutter): Add Attributes page - #18779
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
1 Skipped Deployment
|
| description: "Attributes automatically enrich your telemetry with typed key-value data. Use them to add business context that you can filter and search in Sentry." | ||
| --- | ||
|
|
||
| <AvailableSince version="9.23.0" /> |
There was a problem hiding this comment.
I added this version number from the streamed spans docs, but attributes were available for metrics and logs before that? Please let me know @buenaflor
Updated the version number - hope this is correct!
|
|
||
| Each attribute value is created with a typed `SentryAttribute` factory: | ||
|
|
||
| | Factory | Dart Type | |
There was a problem hiding this comment.
I'm considering removing this and instead add a link to the Streamed Spans page (or API docs if it's in there) - wdyt?
![sentry[bot]](https://avatars.githubusercontent.com/in/12637?s=60&v=4){kind=small}
buenaflor
left a comment
buenaflor
left a comment
There was a problem hiding this comment.
nice! just one comment
| When using the `fmt` function, you must use the `%s` placeholder for each | ||
| value you want to insert. |
There was a problem hiding this comment.
I think this is an accidental line break
| <Alert level="warning"> | ||
| Tags are **not** applied to logs or metrics. If you're using SDK version | ||
| `9.23.0` or above and want to attach context to logs or metrics, use{" "} | ||
| <PlatformLink to="/enriching-events/attributes/">Attributes</PlatformLink>{" "} | ||
| instead. | ||
| </Alert> |
There was a problem hiding this comment.
Bug: The documentation incorrectly states SDK version 9.23.0 is required for log/metric attributes, when the feature is available from version 9.9.0.
Severity: LOW
Suggested Fix
Update the warning in tags/index.mdx to reflect the correct minimum SDK version for using Attributes with logs and metrics, which is 9.9.0. Clarify that the 9.23.0 version requirement is specific to span attributes.
Prompt for AI Agent
Review the code at the location below. A potential bug has been identified by an AI
agent. Verify if this is a real issue. If it is, propose a fix; if not, explain why it's
not valid.
Location: docs/platforms/dart/common/enriching-events/tags/index.mdx#L10-L15
Potential issue: The warning added to
`docs/platforms/dart/common/enriching-events/tags/index.mdx` incorrectly states that SDK
version `9.23.0` or higher is required to use Attributes for attaching context to logs
or metrics. The correct minimum version for this feature is `9.9.0`. The `9.23.0`
version requirement is specific to span attributes in stream mode. This misinformation
will prevent users on SDK versions between `9.9.0` and `9.22.x` from realizing the
Attributes feature is available to them for logs and metrics.
Co-authored-by: Alex Krawiec <alex.krawiec@sentry.io>
880b1ca to
9f90674
Compare
3 participants
DESCRIBE YOUR PR
This branch adds a new page, "Attributes," under "Enriching Events" (similar to the JS SDK; see #18729).
Closes: #18778
IS YOUR CHANGE URGENT?
Help us prioritize incoming PRs by letting us know when the change needs to go live.
SLA
Thanks in advance for your help!
PRE-MERGE CHECKLIST
Make sure you've checked the following before merging your changes:
EXTRA RESOURCES