Support Shield / Badges

[GiovanniCardamone]

Problem Statement

Missing a way to easly see errors outside of Sentry.

Solution Brainstorm

Would be nice to have a status badge / shield to summarize unsolved errors in repository example

Many applications provides this kind of integrations to display differents stats, Sentry could be one of those.

Would be nice to have the same style formats provided by shield.io because are the mainly used:

• plastic
• flat
• flat-square
• for-the-badge
• social

also with the possibility to customize if icon should be present or not.

Product Area

Dashboards

[getsantry[bot]]

Assigning to @getsentry/support for routing, due by Wednesday, May 17th at 5:00 pm (sfo). ⏲️

[getsantry[bot]]

Routing to @getsentry/product-owners-dashboards for triage, due by Friday, May 19th at 13:13 (yyz). ⏲️

[getsantry[bot]]

Routing to @getsentry/product-owners-settings-integrations for triage, due by Wednesday, May 24th at 5:00 pm (sfo). ⏲️

[Dhrumil-Sentry]

Hi @GiovanniCardamone - Thanks for bringing up this issue. We're actively looking at ways to surface Sentry errors outside sentry.io. In the examples you listed, I see issues being surfaced at a repository level.

What are you hoping to achieve with these error insights outside Sentry?

• Get a general sense of how many errors are spanning your codebase?
• Fix more bugs along the way as you develop features?

[GiovanniCardamone]

Hello @Dhrumil-Sentry i'll write here the recap about the badges integration and interesting points about the feature itself.

Sentry Badges

Purposes

1. have a fast recap of what's the status

   e.g.

   • pipeline: passed
   • coverage: 95%
   • vulnerability: 5
   • errors: 200

2. Ability to know if there is error without knowing / having access to the platform

   e.g.

   • public repository with private instances,
   • organization repository without infrastructure access

3. show integrations used in a project directly

   e.g.

   • codecov codecov badge
   • coveralls coveralls badge
   • CircleCI circle ci badge
   • snyk snyk badge
   • github pipelines github pipelines badge
   • npm/packagist/etc (third parts) shields.io

Example where shields are used

https://github.com/getsentry/sentry-javascript

General Badges Example

it should be customizable through query string

Colors

Events Count

unique events total events unique and total events

ℹ️ eventsCount[]: "unique" | "totals"

?eventsCount=unique
?eventsCount=totals
?eventsCount=unique&eventsCount=totals

Logo

colored logo with logo without logo

ℹ️ logo: "true" | "false" | "color" = "true"

?logo=true
?logo=false
?logo=colors

Danger Modes

ℹ️ dangerMode: "new-issue" | "previously-resolved" = "new-issue"

?dangerMode=new-issue // red when new issue, otherwise yellow, green on no error
?dangerMode=previously-resolved // red when previouslt resolved, otherwise yellow, green on no previously resolved
?dangerMode=new-issue&dangerMode=previously-resolved // MAX level win

Styles

https://shields.io/#styles

Link availability settings:

• public: no check

• token: revokable token ?token="sharable-token"

• private: browser login through cookie

  ℹ️ (should not be vulnerable to CSRF)

  

Dashboard integration

ui tools that create link based on customization options from ui itself

• share: markdown format with link to dashboard [![alt](image-link)](dashboard-link)

• share: markdown without lint to dashboard ![alt](image-link)

• share: RestructuredText // same as above

Shield I/O source code

https://github.com/badges/shields