Skip to content

Feat: Document Dio for Dart/Flutter #4857

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 16 commits into from
Mar 22, 2022
Merged

Feat: Document Dio for Dart/Flutter #4857

merged 16 commits into from
Mar 22, 2022

Conversation

marandaneto
Copy link
Contributor

@marandaneto marandaneto commented Mar 20, 2022 •
edited
Loading

@vercel
Copy link

vercel bot commented Mar 20, 2022 •
edited
Loading

This pull request is being automatically deployed with Vercel (learn more).
To see the status of your deployment, click below or on the icon next to each commit.

🔍 Inspect: https://vercel.com/sentry/sentry-docs/3mrM3Wdjy3DzEFfXxPApmFFwpnpd
✅ Preview: https://sentry-docs-git-feat-doc-dio.sentry.dev

@marandaneto
Copy link
Contributor Author

cc @ueman

marandaneto
marandaneto commented Mar 20, 2022
View reviewed changes
marandaneto
marandaneto commented Mar 20, 2022
View reviewed changes
marandaneto
marandaneto commented Mar 20, 2022
View reviewed changes
src/platforms/flutter/common/performance/instrumentation/automatic-instrumentation.mdx Outdated
@@ -22,6 +22,16 @@ When the HTTP request throws an `Exception`, Sentry's SDK associates this except

For more information see our [SentryHttpClient integration](/platforms/dart/configuration/integrations/http-integration/#performance-monitoring-for-http-requests).

### Dio Library Instrumentation
Copy link
Contributor Author

Choose a reason for hiding this comment

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

It's a dup from the Dart integration, but it's important that Fluter users see it too, is there a way to not duplicate this?

Copy link
Contributor

Choose a reason for hiding this comment

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

You could move this content into an include and drop it on both pages so the content remains consistent. But you'll still need to have two container pages.

@marandaneto marandaneto requested a review from imatwawana March 20, 2022 07:57
ueman
ueman reviewed Mar 20, 2022
View reviewed changes
src/platforms/dart/common/performance/instrumentation/automatic-instrumentation.mdx Outdated

### Dio Library Instrumentation

The Dio instrumentation, once added the Dio integration feature, starts a span out of the active span bound to the scope for each HTTP Request. The SDK sets the span `operation` to `http.client` and `description` to request `$method and $URL`; for example, `GET https://sentry.io`.
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
The Dio instrumentation, once added the Dio integration feature, starts a span out of the active span bound to the scope for each HTTP Request. The SDK sets the span `operation` to `http.client` and `description` to request `$method and $URL`; for example, `GET https://sentry.io`.
The Dio instrumentation, once added the Dio integration feature, starts a span out of the active span bound to the scope for each HTTP Request. The SDK sets the span `operation` to `http.client` and `description` to request `$method $URL`; for example, `GET https://sentry.io`.

Copy link
Contributor

@ueman ueman Mar 20, 2022 •
edited
Loading

Choose a reason for hiding this comment

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

It also provides spans for (de)serialization. See https://github.com/getsentry/sentry-dart/blob/main/dio/lib/src/sentry_transformer.dart

@bruno-garcia
Copy link
Member

release-registry/craft PRs merged, next release will include the package.

bruno-garcia
bruno-garcia reviewed Mar 20, 2022
View reviewed changes
Copy link
Member

@bruno-garcia bruno-garcia left a comment

Choose a reason for hiding this comment

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

since we'll return the fallback value until release registry has a release in it, this PR is no longer blocked so removing the Draft tag

@bruno-garcia bruno-garcia marked this pull request as ready for review March 20, 2022 14:30
@bruno-garcia bruno-garcia requested a review from a team as a code owner March 20, 2022 14:30
marandaneto
marandaneto commented Mar 20, 2022
View reviewed changes
imatwawana
imatwawana approved these changes Mar 21, 2022
View reviewed changes
Copy link
Contributor

@imatwawana imatwawana left a comment

Choose a reason for hiding this comment

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

There was one sentence that wasn't clear to me. If my edit is incorrect, ping me so I can circle back. Otherwise, just minor wording and style fixes.

marandaneto and others added 6 commits March 21, 2022 17:33
@marandaneto @imatwawana
Update src/platforms/dart/common/performance/instrumentation/automati…
0f2a0ce 
…c-instrumentation.mdx

Co-authored-by: Isabel <[email protected]>
@marandaneto @imatwawana
Update src/platforms/dart/common/performance/instrumentation/automati…
c380285 
…c-instrumentation.mdx

Co-authored-by: Isabel <[email protected]>
@marandaneto @imatwawana
Update src/platforms/dart/common/performance/instrumentation/automati…
7dc825a 
…c-instrumentation.mdx

Co-authored-by: Isabel <[email protected]>
@marandaneto @imatwawana
Update src/platforms/dart/common/performance/instrumentation/automati…
25047a1 
…c-instrumentation.mdx

Co-authored-by: Isabel <[email protected]>
@marandaneto @imatwawana
Update src/platforms/dart/configuration/integrations/dio.mdx
2dbbac7 
Co-authored-by: Isabel <[email protected]>
@marandaneto @imatwawana
Update src/platforms/dart/configuration/integrations/dio.mdx
d182301 
Co-authored-by: Isabel <[email protected]>
@marandaneto marandaneto enabled auto-merge (squash) March 22, 2022 07:16
@marandaneto marandaneto merged commit ce079ff into master Mar 22, 2022
@marandaneto marandaneto deleted the feat/doc-dio branch March 22, 2022 07:19
@github-actions github-actions bot locked and limited conversation to collaborators Apr 7, 2022
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Reviewers

@ueman ueman ueman left review comments

@bruno-garcia bruno-garcia bruno-garcia left review comments

@imatwawana imatwawana imatwawana approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Document dio package
4 participants
@marandaneto @bruno-garcia @ueman @imatwawana