Skip to content

Commit 0717871

Browse files
mtopo27claude
andauthored
docs(snapshots): Document tags metadata field for snapshots (#17968)
## DESCRIBE YOUR PR Documents the `tags` metadata field for snapshots, which lets users attach key-value string labels to snapshots and filter or group them in the viewer (for example by theme, viewport, or component variant). - Add the `tags` field to the snapshot metadata reference table in the uploading-snapshots guide - Add an example image showing how metadata appears in the Sentry UI ## IS YOUR CHANGE URGENT? Help us prioritize incoming PRs by letting us know when the change needs to go live. - [ ] Urgent deadline (GA date, etc.): <!-- ENTER DATE HERE --> - [ ] Other deadline: <!-- ENTER DATE HERE --> - [x] None: Not urgent, can wait up to 1 week+ ## SLA - Teamwork makes the dream work, so please add a reviewer to your PRs. - Please give the docs team up to 1 week to review your PR unless you've added an urgent due date to it. Thanks in advance for your help! ## PRE-MERGE CHECKLIST *Make sure you've checked the following before merging your changes:* - [ ] Checked Vercel preview for correctness, including links - [ ] PR was reviewed and approved by any necessary SMEs (subject matter experts) - [ ] PR was reviewed and approved by a member of the [Sentry docs team](https://github.com/orgs/getsentry/teams/docs) Co-authored-by: Claude <noreply@anthropic.com>
1 parent f44db0a commit 0717871

2 files changed

Lines changed: 3 additions & 0 deletions

File tree

130 KB
Loading

docs/product/snapshots/uploading-snapshots/index.mdx

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -57,6 +57,9 @@ You can include an optional JSON file to add metadata to each image:
5757
| `display_name` | string | Human-readable label shown in the comparison. viewer. |
5858
| `group` | string | Groups related snapshots in the UI. sidebar. |
5959
| `diff_threshold` | number | Value from `0.0` to `1.0`. Sentry reports the image as changed only when the share of changed pixels is greater than this value. `0.01` ignores changes of 1% or less. |
60+
| `tags` | object | Key-value string labels attached to the snapshot. Use them to filter and group snapshots in the viewer, for example by theme, viewport, or component variant. |
61+
62+
![Example of how metadata impacts the Sentry UI](../img/sentry_ui_metadata.png)
6063

6164
### Supported Formats
6265

0 commit comments

Comments
 (0)