Update 3rd Party Docs with Sentry

[smeubank]

Overview

There are docs for programming languages, run times, frameworks, libraries and developer tools in general.

Sentry has its own docs as well, but often when devs are setting up a project for the first time with a certain framework, or trying to figure out a fix for a library they work with, they go straight to that tool's docs. In some cases Sentry is already in the docs. We can see in plausible that even we get thousands of visitors to our own docs from other docs like FastAPI.

Proposal

Every platform we support, we should think of a list of OSS docs we could PR and update to reference Sentry. There is room for creativity here but the most obvious things to reference in other docs is our error monitoring and tracing solutions. but everything is possible: crons, session replay, performance insights etc

The goal is not to get anything massive into 3rd party docs, it should be short sweet snippets and description with links to our docs. Easier to get that merged as well.

This should be tasteful.

Examples

FastAPI

• :( 🔥 Remove Sentry link from Advanced Middleware docs fastapi/fastapi#12031
• this was one of our biggest referrers

Flask

• https://flask.palletsprojects.com/en/3.0.x/debugging/
• https://flask.palletsprojects.com/en/3.0.x/errorhandling/

Flutter

• https://docs.flutter.dev/cookbook/maintenance/error-reporting

Hexdocs (elixir)

• https://hexdocs.pm/sentry/readme.html

Next.js

• looks like we were removed here too :(

Astro

• https://docs.astro.build/en/guides/backend/sentry/

Supabase

• https://supabase.com/docs/guides/platform/sentry-monitoring

fly.io

• https://fly.io/docs/monitoring/
• https://fly.io/docs/monitoring/sentry/#main-content-start

Cloudflare

• https://developers.cloudflare.com/pages/functions/plugins/sentry/#_top
• https://developers.cloudflare.com/workers/observability/sentry-integration/#_top
• https://developers.cloudflare.com/workers/get-started/quickstarts/#example-projects
• https://developers.cloudflare.com/pages/functions/plugins/sentry/

Laravel

• https://laravel.com/docs/11.x/errors#reporting-exceptions

Integrations Technically not the same but food for thought

• https://forge.laravel.com/docs/integrations/sentry.html#sentry

Tasks

Beta Give feedback

1. JavaScript
2. Python
3. PHP
4. Ruby
5. .NET
6. Java
7. Golang
8. react-native
9. android
10. iOS
11. Flutter
12. Unity
13. Unreal

[kahest]

• ✅ Expo (React Native): https://docs.expo.dev/guides/using-sentry/

[kahest]

Some ideas:

• Apollo https://www.apollographql.com/docs/
• OkHttp https://square.github.io/okhttp/works_with_okhttp/ (PR to works_with_okhttp.md)
• ✅ Flutter DIO https://github.com/cfug/dio
  • submit at Welcome to submit Dio's third-party plugins and related libraries here cfug/dio#347
  • already there https://pub-web.flutter-io.cn/documentation/dio/latest/topics/Plugins-topic.html

Probably far-fetched:

• React Native
  • ✅ we're listed as incubating partners in the repo https://github.com/facebook/react-native/blob/main/ECOSYSTEM.md#incubating-partners
  • ✅ we're listed in RN directory of libraries https://reactnative.directory/?search=sentry (@krystofwoldrich maybe we can do something to improve listing score)
  • there's no section on the docs that fits the purpose https://reactnative.dev/docs/getting-started
• KMP
  • https://www.jetbrains.com/help/kotlin-multiplatform-dev/get-started.html
  • https://kotlinlang.org/docs/multiplatform.html

[timfish]

I guess all SDKs based on Open Telemetry should be listed here?
https://opentelemetry.io/ecosystem/distributions/