Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update GraphQL docs for Java SDK #7647

Merged
merged 30 commits into from
Aug 18, 2023
Merged

Update GraphQL docs for Java SDK #7647

merged 30 commits into from
Aug 18, 2023

Conversation

adinauer
Copy link
Member

@adinauer adinauer commented Aug 16, 2023

Pre-merge checklist

If you work at Sentry, you're able to merge your own PR without review, but please don't unless there's a good reason.

  • Checked Vercel preview for correctness, including links
  • PR was reviewed and approved by any necessary SMEs
  • PR was reviewed and approved by a member of the Sentry docs team

Description of changes

Documents changes done in getsentry/sentry-java#2856

Legal Boilerplate

Look, I get it. The entity doing business as "Sentry" was incorporated in the State of Delaware in 2015 as Functional Software, Inc. and is gonna need some rights from me in order to utilize my contributions in this here PR. So here's the deal: I retain all rights, title and interest in and to my contributions, and by keeping this boilerplate intact I confirm that Sentry can use, modify, copy, and redistribute my contributions, under Sentry's choice of terms.

Extra resources

@vercel
Copy link

vercel bot commented Aug 16, 2023

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 Aug 18, 2023 8:38am

@adinauer adinauer marked this pull request as ready for review August 16, 2023 08:02
@adinauer adinauer requested a review from a team as a code owner August 16, 2023 08:02
Copy link
Contributor

@lbloder lbloder left a comment

Choose a reason for hiding this comment

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

LGTM 👍

Copy link
Contributor

@lizokm lizokm left a comment

Choose a reason for hiding this comment

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

Looks great, just made some language tweaks. Hopefully they aren't changing the meaning.

Comment on lines 46 to 48
Create a new instance of `SentryGenericDataFetcherExceptionHandler`, pass the delegate that handles the exception, and configure `defaultDataFetcherExceptionHandler` when building a `GraphQL` instance.
Create a new instance of `SentryInstrumentation` and configure `instrumentation` when building a `GraphQL` instance.
You may want to filter some of the errors by using `beforeSend` or an `EventProcessor` (see <PlatformLink to="/configuration/filtering/">Filters</PlatformLink>).
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
Create a new instance of `SentryGenericDataFetcherExceptionHandler`, pass the delegate that handles the exception, and configure `defaultDataFetcherExceptionHandler` when building a `GraphQL` instance.
Create a new instance of `SentryInstrumentation` and configure `instrumentation` when building a `GraphQL` instance.
You may want to filter some of the errors by using `beforeSend` or an `EventProcessor` (see <PlatformLink to="/configuration/filtering/">Filters</PlatformLink>).
- To integrate `GraphQL` through `SentryGenericDataFetcherExceptionHandler`, create a new instance, pass the delegate that handles the exception, then configure `defaultDataFetcherExceptionHandler`.
- To integrate `GraphQL` through `SentryInstrumentation`, create a new instance and configure `instrumentation`.
You may want to filter some of the errors by using `beforeSend` or an `EventProcessor` (read more about <PlatformLink to="/configuration/filtering/">Filters</PlatformLink>).

In case you're wondering about setup vs set up - Set up is the verb, so when you're telling someone to "Set up a new instance..." vs. setup, which is a noun, so "your setup process..." :)

Copy link
Member Author

Choose a reason for hiding this comment

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

Thanks :-)

Hmm this one I'm not sure about. You need to provide both SentryGenericDataFetcherExceptionHandler and SentryInstrumentation after the latest changes.

<Note>

Capturing transactions requires that you first <PlatformLink to="/performance/">set up performance monitoring</PlatformLink> if you haven't already.
If you've been using the now deprecated `SentryDataFetcherExceptionHandler`, please upgrade to `SentryGenericDataFetcherExceptionHandler` and also make sure `SentryInstrumentation` is configured to have more exceptions captured, more detailed exceptions, breacrumbs and better hub propagation. You may want to filter some of the errors by using `beforeSend` or an `EventProcessor` (see <PlatformLink to="/configuration/filtering/">Filters</PlatformLink>).
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
If you've been using the now deprecated `SentryDataFetcherExceptionHandler`, please upgrade to `SentryGenericDataFetcherExceptionHandler` and also make sure `SentryInstrumentation` is configured to have more exceptions captured, more detailed exceptions, breacrumbs and better hub propagation. You may want to filter some of the errors by using `beforeSend` or an `EventProcessor` (see <PlatformLink to="/configuration/filtering/">Filters</PlatformLink>).
The `SentryDataFetcherExceptionHandler` has been deprecated. Please upgrade to `SentryGenericDataFetcherExceptionHandler` and make sure `SentryInstrumentation` is configured to have more exceptions captured, more detailed exceptions, breadcrumbs, and better hub propagation. You may want to filter the errors by using `beforeSend` or an `EventProcessor` (read more about <PlatformLink to="/configuration/filtering/">Filters</PlatformLink>).

This seems like a daunting list of thing to "make sure of..." do you think it's clear to users why they need to do this and how to do it? If not, maybe we can write a separate section about it?

Copy link
Member Author

Choose a reason for hiding this comment

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

It's just meant as a side note for people who already used our GraphQL integration before the latest changes. This should put them on the right track to upgrade plus some reasons why in case they missed the changelog entry.

adinauer and others added 13 commits August 18, 2023 08:53
Co-authored-by: vivianyentran <[email protected]>
Co-authored-by: Steven Eubank <[email protected]>
Co-authored-by: getsantry[bot] <66042841+getsantry[bot]@users.noreply.github.com>
* update banner

* update date

* remove first sentence per Ben

* Update src/components/banner.tsx

Co-authored-by: Liza Mock <[email protected]>

---------

Co-authored-by: Liza Mock <[email protected]>
* adding responses section explaining timeout

* Update src/docs/product/integrations/integration-platform/webhooks.mdx

Co-authored-by: vivianyentran <[email protected]>

* Update src/docs/product/integrations/integration-platform/webhooks.mdx

Co-authored-by: vivianyentran <[email protected]>

---------

Co-authored-by: vivianyentran <[email protected]>
Profiling team is retiring the "flame chart" term

Instead will use Flame Graph and Aggregated Flame Graph in our docs - This makes the terminology more intuitive.  
-Ash.
Profiling team is retiring the "flame chart" term

Instead will use Flame Graph and Aggregated Flame Graph in our docs - This should make the terminology more intuitive.
Profiling team is retiring the "flame chart" term

Instead will use Flame Graph and Aggregated Flame Graph in our docs - This should make the terminology more intuitive.
This adds a small note to the Resolve Issues by Commit section on the Associate Commits page to explain that resolving issues can also be done through PRs in the same way.

Page updated: /product/releases/associate-commits/#resolve-issues-by-commit

Closes #54525!
A customer recently ran into trouble because they were trying to associate commits using the form `some-repo@123abc` rather than the form `some-org/some-repo@123abc`. Though we do have a note about this in the docs, in the section on releases, it's easy to miss. We also don't mention it at all in the CLI docs.

This fixes that by pulling it out into a highlighted note in both places.
hubertdeng123 and others added 7 commits August 18, 2023 08:57
Co-authored-by: getsantry[bot] <getsantry[bot]@users.noreply.github.com>
* Add Discord to integration index

* Remove random asterisk from slack docs. idk why this was there

* Add Discord product docs

* style(lint): Auto commit lint changes

* Fix Discord links

* Make a couple images wider

* Move Discord out of integrations and into EA features

* Make requested changes

* Move discord docs to ea features directory

* Change title to Discord Integration

---------

Co-authored-by: getsantry[bot] <66042841+getsantry[bot]@users.noreply.github.com>
…7652)

Adds information about the new event dropdown and the new Recommended event.
* Add browser profiling to profiling getting started

* Update src/docs/product/profiling/getting-started.mdx
@adinauer adinauer requested review from a team and kamilogorek as code owners August 18, 2023 07:19
@github-actions
Copy link
Contributor

github-actions bot commented Aug 18, 2023

🏷 The following changes will be made to the repository labels

Validating provided labels
Fetching labels from GitHub
Labels are already up to date

@adinauer
Copy link
Member Author

I've reworded the "Set up" section a bit. Please let me know if you'd like me to change it and I can send another PR (once I'm back from my vacation). Going to merge this so users can get more up-to-date docs for GraphQL and not wait until I'm back.

@adinauer adinauer merged commit aae383f into master Aug 18, 2023
7 checks passed
@adinauer adinauer deleted the feat/java-graphql branch August 18, 2023 08:49
@github-actions github-actions bot locked and limited conversation to collaborators Sep 3, 2023
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.