Skip to content

Conversation

@ArthurKnaus
Copy link
Member

@ArthurKnaus ArthurKnaus commented May 27, 2024

Display v7 configuration instructions for metrics as comment.

Relates to getsentry/sentry#71510

@ArthurKnaus ArthurKnaus requested review from AbhiPrasad and mydea May 27, 2024 11:20
@vercel
Copy link

vercel bot commented May 27, 2024

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

Name Status Preview Comments Updated (UTC)
sentry-docs ✅ Ready (Inspect) Visit Preview 💬 Add feedback May 27, 2024 0:27am

```

```JavaScript
// instrumentation.js
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We had not filename for the server side configuration snippet of NextJS.
From what I gathered it should be instrumentation.js?

@codecov
Copy link

codecov bot commented May 27, 2024

Bundle Report

Changes will decrease total bundle size by 13 bytes ⬇️

Bundle name Size Change
sentry-docs-server 7.42MB 4 bytes ⬇️
sentry-docs-edge-server 461.86kB 3 bytes ⬇️
sentry-docs-client 6.18MB 6 bytes ⬇️

@ArthurKnaus ArthurKnaus requested a review from a team May 27, 2024 11:29
dsn: '___PUBLIC_DSN___',
// Only needed for SDK versions < 8.0.0
// integrations: [
// Sentry.metrics.metricsAggregatorIntegration(),
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hmm, where does this come from? We don't really do this for any other thing, we always show up-to-date docs as far as I can tell? 🤔

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Because of metrics GA happening so close to v8, we had some confusion about this and people had troubles intrumenting custom metrics. Daniel gave the green light to have a short-term callout for this in docs.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Users that still use v7 were confused during the onboarding process.
We discussed it with @HazAT as a temporary measure for metrics GA in the planning today.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

alright, all good then!

@@ -1,10 +1,11 @@
To configure metrics, add the `metricsAggregator` experimental option to your `Sentry.init` call.
Metrics work out of the box by calling `Sentry.init` no further setup is required.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
Metrics work out of the box by calling `Sentry.init` no further setup is required.
Metrics work out of the box by calling `Sentry.init`, no further setup is required.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

right, thx! will also fix the source of the copy 🍝

@ArthurKnaus ArthurKnaus enabled auto-merge (squash) May 27, 2024 12:10
@ArthurKnaus ArthurKnaus merged commit 3d840bd into master May 27, 2024
@ArthurKnaus ArthurKnaus deleted the aknaus/feat/metrics/add-comments-for-v7-configuration branch May 27, 2024 12:27
@github-actions github-actions bot locked and limited conversation to collaborators Jun 12, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants