docs(dashboards): Releases in Dashboards #5083

shruthilayaj · 2022-05-27T15:29:41Z

Documentation for the Releases widget in Dashboard

vercel · 2022-05-27T15:29:44Z

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name	Status	Preview	Updated
sentry-docs	✅ Ready (Inspect)	Visit Preview	Jun 8, 2022 at 3:32PM (UTC)

shruthilayaj · 2022-05-30T11:37:48Z

src/docs/product/dashboards/widget-library/index.mdx

+- **Crash Rates for Recent Releases**: Percentage of crashed sessions for your recent releases
+- **Session Health**: The total number of abnormal, crashed, errored and healthy sessions


these two widget are only available for EA, should there be an indication of that?

Yeah, let's add a note after the list: "The Crash Rates for Recent Releases and Session Health widgets are only available..."

Addressed in this commit 9f2e2ce#diff-124b2f7356d01f77a1ac84d799606e8247298ade1ab46fdae30038d4afbef784R28-R33

imatwawana

This looks good! However the Custom Dashboards page is being updated pretty dramatically and a new page for the widget builder is being added on PR 5065. That PR has significantly more files/changes/commits, so let's hold off on merging this until that PR gets merged and then go from there.

imatwawana · 2022-05-30T13:54:10Z

src/docs/product/dashboards/widget-library/index.mdx

+- **Crash Rates for Recent Releases**: Percentage of crashed sessions for your recent releases
+- **Session Health**: The total number of abnormal, crashed, errored and healthy sessions


Yeah, let's add a note after the list: "The Crash Rates for Recent Releases and Session Health widgets are only available..."

imatwawana · 2022-05-30T13:59:27Z

src/docs/product/dashboards/custom-dashboards/index.mdx

 Choosing "Issues" allows you to query issue properties, such as `is:unresolved` or event properties such as `error.handled:0`, and to sort by issue fields such as `First Seen`. When searching on event properties, the search will return any issue that has one or more events matching the supplied event filters. Choose this data set if you want to customize a list of issues on your dashboard. Some widget examples include:
 - Issues assigned to your team
 - Most frequently occurring issues

 The "Issues" data set is only available in [table](#table-results) visualization widgets.
+
+### Releases


Suggested change

### Releases

### Releases

Addressed in this commit 5bc332a#diff-483fd5b737378ca17b303465d6a2c5e14eb79f0d6c0456458a5ad2465b6eb710R79-R80

imatwawana · 2022-05-30T14:02:30Z

src/docs/product/dashboards/custom-dashboards/index.mdx

+
+</Note>
+
+Choosing "Releases" allows you to query properites specific to a release of your application, primarily session data. Choose this data set if you want to display healthy, errored and crashed sessions and crash rates for your releases or projects on your dashboard. Doesn't apply to World Map. Some widget examples include:


I've made the wording edits here, but this will end up living on a new page entirely

Suggested change

Choosing "Releases" allows you to query properites specific to a release of your application, primarily session data. Choose this data set if you want to display healthy, errored and crashed sessions and crash rates for your releases or projects on your dashboard. Doesn't apply to World Map. Some widget examples include:

Choosing "Releases" allows you to query properties specific to a release of your application, primarily session data. Choose this dataset if you want to display healthy, errored, and crashed sessions and crash rates for your releases or projects on your dashboard. This dataset isn't available in for [world map](#world-map) visualizations. Some example widgets using this dataset include:

Addressed in this commit 9f2e2ce#diff-483fd5b737378ca17b303465d6a2c5e14eb79f0d6c0456458a5ad2465b6eb710R88

imatwawana · 2022-05-30T14:04:35Z

src/docs/product/dashboards/widget-library/index.mdx

@@ -90,3 +92,25 @@ Update "Columns" to add `links` so you can see seen any external links related t

 - Columns: `issue, assignee, events, title, links`
 - Sort by: `Priority`
+
+
+### Release Health


We've done sentence case on all the other ones so let's keep it consistent

Suggested change

### Release Health

### Release health

Addressed in this commit 9f2e2ce#diff-124b2f7356d01f77a1ac84d799606e8247298ade1ab46fdae30038d4afbef784R104

imatwawana · 2022-05-30T14:05:49Z

src/docs/product/dashboards/widget-library/index.mdx

+
+- Search condition 1: `release:{version}`
+
+To monitor the health of your latest releases, update the Search condition to use the `latest` keyword:


Suggested change

To monitor the health of your latest releases, update the Search condition to use the `latest` keyword:

To monitor the health of your latest releases, update the search condition to use the `latest` keyword:

Addressed in this commit 9f2e2ce#diff-124b2f7356d01f77a1ac84d799606e8247298ade1ab46fdae30038d4afbef784R121

imatwawana · 2022-05-30T14:18:40Z

src/docs/product/dashboards/custom-dashboards/index.mdx

@@ -89,15 +89,29 @@ transactions'.

 ## Data Set Selection


I've made the wording edits that will apply on this page, but most of this content is being moved to a new page in PR 5065.

shruthilayaj · 2022-05-30T14:38:11Z

I'll wait till the other PR gets merged before addressing these comments 👍

shruthilayaj · 2022-05-31T14:40:08Z

src/docs/product/dashboards/widget-builder/index.mdx

-Choosing "Errors and Transactions" allows you to query and aggregate error and transaction events in the same way you would for a [Discover Query](/product/discover-queries/). Some widget examples include: 
+Choosing "Errors and Transactions" allows you to query and aggregate error and transaction events in the same way you would for a [Discover Query](/product/discover-queries/). Some widget examples include:

- Tracking performance of an endpoint 
- Throughput by country 
+- Tracking performance of an endpoint
+- Throughput by country
 - Users most affected by errors

 ### Issues
-Choosing "Issues (States, Assignment, Time, etc.)" allows you to query issue properties, such as `is:unresolved` or event properties such as `error.handled:0`, and to sort by issue fields such as `First Seen`. When searching on event properties, the search will return any issue that has one or more events matching the supplied event filters. 
+Choosing "Issues (States, Assignment, Time, etc.)" allows you to query issue properties, such as `is:unresolved` or event properties such as `error.handled:0`, and to sort by issue fields such as `First Seen`. When searching on event properties, the search will return any issue that has one or more events matching the supplied event filters.
 Choose this dataset if you want to customize a list of issues on your dashboard. Some widget examples include:

- Issues assigned to your team 


I think these changes are because of my linter?

imatwawana

Just a few small changes, but otherwise, looks good!

src/docs/product/dashboards/widget-library/index.mdx

Co-authored-by: Isabel <76437239+imatwawana@users.noreply.github.com>

Documentation for the Releases widget in Dashboard

* Update docs to use Hint object * Revert migration guide changes * Change import for Hint * Document how to manipulate attachments via hints (#5070) * Document how to manipulate attachments via hints * Apply suggestions from code review Co-authored-by: Isabel <76437239+imatwawana@users.noreply.github.com> * Update src/includes/enriching-events/add-attachment/java.mdx Co-authored-by: Isabel <76437239+imatwawana@users.noreply.github.com> * Apply suggestions from code review Co-authored-by: Isabel <76437239+imatwawana@users.noreply.github.com> * ref(frontend): Bump JS SDK to 7.0 beta 2 (#5064) * bump to 7.0 beta 2 * update yarn.lock * Fix manifest code snippet tag (#5069) * fix: typos in Unity troubleshooting (#5060) * Typo fix (#5059) * fix references to source maps and time range change example (#5051) * Fix typo in query builder docs (#5072) * updated banner (#5067) * docs(js): Add sourcemaps explain to source maps troubleshooting guide (#5076) * feat(discover): extend list of stacking functions (#5074) - This list is a bit outdated, and there are many more functions that discover supports. Updating this to include all of them, but longterm probably worth revisiting this section of docs - This is so the API docs can link here * chore: bump Sentry SDK to 7.0.0-rc.0 (#5077) * chore(billing): GA on-demand budget for all performance plans (#5075) * fix(alerts): Remove duplicate alert rules section (#5080) * feat(visibility): Add a note about apdex score (#5081) - This is cause I've heard folks confused whether a higher apdex score is better or not, and personally forget sometimes. * feat(unity): Added Screenshot to Verify (#5031) * added sample screenshot * Update src/includes/getting-started-verify/unity.mdx Co-authored-by: Isabel <76437239+imatwawana@users.noreply.github.com> * jpg -> png Co-authored-by: Bruno Garcia <bruno@brunogarcia.com> Co-authored-by: Isabel <76437239+imatwawana@users.noreply.github.com> * Add instructions to tree shake tracing code in JS SDK (#5086) * Add docs for new attachments API (#5073) Co-authored-by: Isabel <76437239+imatwawana@users.noreply.github.com> * Add React Router v6 instrumentation docs. (#5037) Co-authored-by: Isabel <76437239+imatwawana@users.noreply.github.com> * Remove `ignoreSentryErrors` section in JS docs (#5036) * Update ExtraErrorData depth description (#5021) JavaScript SDK: Updates `ExtraErrorData` `depth` option description to not mention a workaround for the global `normalizeDepth` option. * feat(angular): Update Angular docs for v7 release (#4963) This PR updates our Angular SDK docs for the v7 release. It adds information about compatibility of our SDK with different Angular versions and updates information on `TraceDirective` compatibility. * Adjust JS CDN bundle page to reflect ES5/ES6 naming changes (#4962) Co-authored-by: Isabel <76437239+imatwawana@users.noreply.github.com> * ref(js): change migration guide URLs from v7 branch to master (#5087) This small PR changes the URLs of two links to the JS SDK migration guide which previously linked to the 7.x branch version of the migration guide. It now links to master since we merged the 7.x branch * Adust docs for dealing with baggage headers (CORS and meta tags) (#5061) Adjust the JS SDK Performance Monitoring -> "Connect Services" page by adding information about the newly introduced baggage header and its propagation. It adds instructions on setting up CORS rules to accept the new header as well as how to add the baggage information to meta tags for server-originating traces. * Add tree shaking guide for default integrations (#4996) Co-authored-by: Isabel <76437239+imatwawana@users.noreply.github.com> * Replace deprecated severity enums with string literals (#4940) Co-authored-by: Lukas Stracke <lukas@stracke.co.at> * getsentry/relay@8fcff0b * Adust docs after renaming `UserAgent` integration to `HttpContext` (#4997) This PR adjusts docs after renaming the UserAgent integration in the Sentry JS SDK to HttpContext * Add Prisma ORM Integration Docs. (#4961) Co-authored-by: Isabel <76437239+imatwawana@users.noreply.github.com> * chore: bump Sentry SDK to 7.0.0 (#5088) * ref(native): capture-error using high-level API. (#5085) * feat(widget-builder): Add GA documentation - (#5065) * Add SampleRate code sample for go (#5090) * fix(android): Typo for UI transactions (#5096) * ref(js): Add note about old name of HttpContext integration (#5099) Adds a note to the HttpContext integration of the JS SDK explaining that it was called UserAgent before v7. This ensures that pre-v7 users can find correct information about their default integrations. * ref(js): Add baggage intormation to automatic instrumentation page (#5095) Add instructions on how to deal with the new baggage header in CORS settings. The baggage header was introduced in v7 of the JS SDK. * feat(apple): User interaction instrumentation (#5098) Add docs similar to user interaction instrumentation on Android. As the implementations don't match exactly we can't create reusable docs. Co-authored-by: Isabel <76437239+imatwawana@users.noreply.github.com> Co-authored-by: Roman Zavarnitsyn <rom4ek93@gmail.com> * dotnet performance clarify GetSpan (#5078) Co-authored-by: Isabel <76437239+imatwawana@users.noreply.github.com> Co-authored-by: Matt Johnson-Pint <mattjohnsonpint@gmail.com> Co-authored-by: Bruno Garcia <bruno@brunogarcia.com> * chore(unity): Fixed typo (#5050) Co-authored-by: Bruno Garcia <bruno@brunogarcia.com> * docs: add explanation regarding appcenter token (#5063) * ref(integration-platform): Add URI formatting guidelines to docs (#5103) This PR adds a blurb explaining the URI formatting guidelines for the schema they provide when specifying UI Components. Each instance of a URI attribute links back to these guidelines. * improve enable suspect commits content (#5094) * restructured page * restructured page * restructured enable suspect commits page * fixes to improve flow * fixing typo and clarifying language * wording fixes * feat(alerts): Restore duplciate alert rule docs (#5111) * feat(integrations): Direct users to the reference implementation (#5053) * getsentry/relay@acb94fa * ref(android): Simplify UI transaction code sample (#5097) Reduce the complexity of the code sample for manually adding spans to user interaction transacrtions. Co-authored-by: Roman Zavarnitsyn <rom4ek93@gmail.com> * feat(unity): Added additional platforms to native support (#5109) * improved native support docs * Update src/includes/getting-started-primer/unity.mdx Co-authored-by: Isabel <76437239+imatwawana@users.noreply.github.com> * Update src/platforms/unity/native-support/index.mdx Co-authored-by: Isabel <76437239+imatwawana@users.noreply.github.com> * Update src/platforms/unity/native-support/index.mdx Co-authored-by: Isabel <76437239+imatwawana@users.noreply.github.com> * Update src/platforms/unity/native-support/index.mdx Co-authored-by: Isabel <76437239+imatwawana@users.noreply.github.com> * Update src/platforms/unity/native-support/index.mdx Co-authored-by: Isabel <76437239+imatwawana@users.noreply.github.com> * Update src/platforms/unity/native-support/index.mdx Co-authored-by: Isabel <76437239+imatwawana@users.noreply.github.com> Co-authored-by: Isabel <76437239+imatwawana@users.noreply.github.com> * feat(apple): Add UI instrumentation to wizard (#5100) * Refactor Ionic/Capacitor/Cordova Wizards (#5093) Co-authored-by: Isabel <76437239+imatwawana@users.noreply.github.com> * fix(quotas): Clarify filters application scope (#5102) Inbound data filters are applied to all events, including transactions. See [envelope filtering](https://github.com/getsentry/relay/blob/7c6b308bbf04e63e8e0b456489da1ddc320e2e6a/relay-server/src/actors/envelopes.rs#L1603) and the [should_filter check](https://github.com/getsentry/relay/blob/7c6b308bbf04e63e8e0b456489da1ddc320e2e6a/relay-filter/src/lib.rs#L38-L60) in relay. * feat(api): Update the bump script since CI doesn't run it (#5115) - this is so the script can be run on MacOS where the date function is slightly different * chore(api): bump api sha with events doc (#5116) Bump the SENTRY_API_SCHEMA_SHA with latest changes * Add metric alert slack example with new chart (#5113) Co-authored-by: Isabel <76437239+imatwawana@users.noreply.github.com> * Change migration guide for hints (#5068) * Add discontinuation of AngularJS 1.x (#5123) * feat(docs): Document flutter autoInitializeNativeSdk (#5029) * chore(unity): Updated troubleshooting for 2022 (#5122) * ref(native): Clarify before_send with Crashpad (#5092) Co-authored-by: Isabel <76437239+imatwawana@users.noreply.github.com> * getsentry/relay@d8f887a * docs(dashboards): Releases in Dashboards (#5083) Documentation for the Releases widget in Dashboard * fix transaction quota management content (#5114) * added inbound filters to transaction quota mgmt, removed beforeSend, and fixed inbound filter reference on quotas index page * fixed typo * feat(alerts): Alert wizard v3 alert config docs (#5107) * feat(alerts): Alert wizard v3 alert config docs * addressing comments updating screenshots * update screenshot * review 2 * reverting an accidental change Co-authored-by: Isabel <76437239+imatwawana@users.noreply.github.com> * hid banner (#5127) * feat(android): App permissions in App Context (#5038) Co-authored-by: Isabel <76437239+imatwawana@users.noreply.github.com> Co-authored-by: Katie Byers <katie.byers@sentry.io> Co-authored-by: Manoel Aranda Neto <5731772+marandaneto@users.noreply.github.com> Co-authored-by: Ivan Dlugos <6349682+vaind@users.noreply.github.com> Co-authored-by: Asko Kauppi <akauppi@gmail.com> Co-authored-by: Aru Sahni <aru@arusahni.net> Co-authored-by: dorothymlee <89860861+dorothymlee@users.noreply.github.com> Co-authored-by: Kamil Ogórek <kamil.ogorek@gmail.com> Co-authored-by: William Mak <william@wmak.io> Co-authored-by: Vladan Paunovic <vladan.paunovic.bg@gmail.com> Co-authored-by: Alberto Leal <mail4alberto@gmail.com> Co-authored-by: Taylan Gocmen <taylangocmen@users.noreply.github.com> Co-authored-by: Stefan Jandl <stefan.jandl@sentry.io> Co-authored-by: Bruno Garcia <bruno@brunogarcia.com> Co-authored-by: Luca Forstner <luca.forstner@gmail.com> Co-authored-by: Tim Fish <tim@timfish.uk> Co-authored-by: Onur Temizkan <onur@narval.co.uk> Co-authored-by: Lukas Stracke <lukas@stracke.co.at> Co-authored-by: Joris Bayer <joris.bayer@sentry.io> Co-authored-by: Mischan Toosarani-Hausberger <mischan@abovevacant.com> Co-authored-by: Priscila Oliveira <priscilawebdev@gmail.com> Co-authored-by: Neel Shah <neelshah.sa@gmail.com> Co-authored-by: Philipp Hofmann <philipp.hofmann@sentry.io> Co-authored-by: Roman Zavarnitsyn <rom4ek93@gmail.com> Co-authored-by: Nicholas Meisenheimer <76002357+souredoutlook@users.noreply.github.com> Co-authored-by: Matt Johnson-Pint <mattjohnsonpint@gmail.com> Co-authored-by: Stefan Jandl <reg@bitfox.at> Co-authored-by: Jérémy Barbet <jeremgraph@gmail.com> Co-authored-by: Leander Rodrigues <leander.rodrigues@sentry.io> Co-authored-by: LucasZF <lucas-zimerman1@hotmail.com> Co-authored-by: Iker Barriocanal <32816711+iker-barriocanal@users.noreply.github.com> Co-authored-by: Scott Cooper <scttcper@users.noreply.github.com> Co-authored-by: Denis Andrašec <denrase@gmail.com> Co-authored-by: Shruthi <shruthilaya.jaganathan@sentry.io>

check in progress

0e3dbfa

Merge branch 'master' into feat/add-docs-for-release-health-dataset

ec1536a

vercel bot deployed to Preview May 27, 2022 16:03 View deployment

shruthilayaj added 2 commits May 30, 2022 07:00

docs

e43d058

remove anchor

f23f0ea

shruthilayaj marked this pull request as ready for review May 30, 2022 11:07

shruthilayaj requested review from imatwawana and a team May 30, 2022 11:08

vercel bot deployed to Preview May 30, 2022 11:34 View deployment

shruthilayaj commented May 30, 2022

View reviewed changes

imatwawana reviewed May 30, 2022

View reviewed changes

shruthilayaj added 3 commits May 31, 2022 10:27

merge conflicts

5bc332a

address comments

9f2e2ce

exact dataset name

3bcaca1

shruthilayaj commented May 31, 2022

View reviewed changes

shruthilayaj requested a review from imatwawana May 31, 2022 14:40

vercel bot deployed to Preview May 31, 2022 15:13 View deployment

imatwawana approved these changes May 31, 2022

View reviewed changes

src/docs/product/dashboards/widget-library/index.mdx Outdated Show resolved Hide resolved

src/docs/product/dashboards/widget-library/index.mdx Outdated Show resolved Hide resolved

src/docs/product/dashboards/widget-library/index.mdx Outdated Show resolved Hide resolved

shruthilayaj and others added 5 commits June 8, 2022 10:41

Merge branch 'master' into feat/add-docs-for-release-health-dataset

67dd643

remove latest condition

eba1b97

Update src/docs/product/dashboards/widget-library/index.mdx

3dbb52e

Co-authored-by: Isabel <76437239+imatwawana@users.noreply.github.com>

Update src/docs/product/dashboards/widget-library/index.mdx

d655bdb

Co-authored-by: Isabel <76437239+imatwawana@users.noreply.github.com>

Update src/docs/product/dashboards/widget-library/index.mdx

efd22e7

Co-authored-by: Isabel <76437239+imatwawana@users.noreply.github.com>

vercel bot deployed to Preview June 8, 2022 15:32 View deployment

shruthilayaj merged commit 407365f into master Jun 8, 2022

shruthilayaj deleted the feat/add-docs-for-release-health-dataset branch June 8, 2022 15:43

adinauer pushed a commit that referenced this pull request Jun 9, 2022

docs(dashboards): Releases in Dashboards (#5083)

796748d

Documentation for the Releases widget in Dashboard

github-actions bot locked and limited conversation to collaborators Jun 24, 2022

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

docs(dashboards): Releases in Dashboards #5083

docs(dashboards): Releases in Dashboards #5083

shruthilayaj commented May 27, 2022 •

edited

Loading

vercel bot commented May 27, 2022 •

edited

Loading

shruthilayaj May 30, 2022

imatwawana May 30, 2022

shruthilayaj May 31, 2022

imatwawana left a comment

imatwawana May 30, 2022

imatwawana May 30, 2022

shruthilayaj May 31, 2022

imatwawana May 30, 2022

shruthilayaj May 31, 2022

imatwawana May 30, 2022

shruthilayaj May 31, 2022

imatwawana May 30, 2022

shruthilayaj May 31, 2022

imatwawana May 30, 2022

shruthilayaj commented May 30, 2022

shruthilayaj May 31, 2022

imatwawana May 31, 2022

imatwawana left a comment

		- Crash Rates for Recent Releases: Percentage of crashed sessions for your recent releases
		- Session Health: The total number of abnormal, crashed, errored and healthy sessions


		</Note>

		Choosing "Releases" allows you to query properites specific to a release of your application, primarily session data. Choose this data set if you want to display healthy, errored and crashed sessions and crash rates for your releases or projects on your dashboard. Doesn't apply to World Map. Some widget examples include:


		- Search condition 1: `release:{version}`

		To monitor the health of your latest releases, update the Search condition to use the `latest` keyword:

docs(dashboards): Releases in Dashboards #5083

docs(dashboards): Releases in Dashboards #5083

Conversation

shruthilayaj commented May 27, 2022 • edited Loading

vercel bot commented May 27, 2022 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

imatwawana left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

shruthilayaj commented May 30, 2022

Choose a reason for hiding this comment

Choose a reason for hiding this comment

imatwawana left a comment

Choose a reason for hiding this comment

shruthilayaj commented May 27, 2022 •

edited

Loading

vercel bot commented May 27, 2022 •

edited

Loading