From fa698f4a031a07615e372aa455ff6bffbc26e664 Mon Sep 17 00:00:00 2001 From: Francesco Novy Date: Mon, 27 Jan 2025 18:15:45 +0100 Subject: [PATCH 1/5] ref: Drop remaining usage of `` --- .../relay/transaction-span-ratelimits.mdx | 8 +++--- .../integrations/azuredevops/index.mdx | 4 +-- .../data-model/event-payloads/lockreason.mdx | 4 +-- .../javascript-sdks/browser-tracing.mdx | 12 ++++---- develop-docs/sdk/telemetry/check-ins.mdx | 4 +-- develop-docs/sdk/telemetry/sessions/index.mdx | 4 +-- develop-docs/sdk/telemetry/traces/index.mdx | 4 +-- docs/account/user-settings/index.mdx | 4 +-- docs/api/auth.mdx | 4 +-- docs/api/ratelimits.mdx | 4 +-- docs/cli/configuration.mdx | 6 ++-- docs/cli/installation.mdx | 4 +-- docs/cli/releases.mdx | 4 +-- .../data-management/event-grouping/index.mdx | 4 +-- .../event-grouping/stack-trace-rules.mdx | 10 +++---- docs/concepts/key-terms/dsn-explainer.mdx | 4 +-- docs/concepts/key-terms/sample-rates.mdx | 4 +-- .../key-terms/tracing/distributed-tracing.mdx | 6 ++-- docs/concepts/search/index.mdx | 8 +++--- .../search/searchable-properties/events.mdx | 4 +-- .../search/searchable-properties/issues.mdx | 4 +-- .../approach/product-docs/write-index.mdx | 4 +-- .../sdk-docs/write-getting-started.mdx | 8 +++--- docs/contributing/pages/images.mdx | 4 +-- docs/contributing/pages/redirects.mdx | 4 +-- docs/contributing/platforms/index.mdx | 4 +-- .../authentication/sso/azure-sso.mdx | 8 +++--- .../authentication/sso/okta-sso/okta-scim.mdx | 4 +-- docs/organization/getting-started/index.mdx | 4 +-- .../cloud-monitoring/aws-lambda/index.mdx | 12 ++++---- .../cloudflare-workers/index.mdx | 4 +-- .../cloud-monitoring/gcp-cloud-run/index.mdx | 4 +-- .../integrations/compliance/truto/index.mdx | 4 +-- .../integrations/compliance/vanta/index.mdx | 4 +-- .../data-visualization/amazon-sqs/index.mdx | 4 +-- .../data-visualization/segment/index.mdx | 4 +-- .../data-visualization/splunk/index.mdx | 16 +++++------ .../integrations/debugging/apigene/index.mdx | 4 +-- .../integrations/debugging/foamai/index.mdx | 4 +-- .../debugging/revisedev/index.mdx | 4 +-- .../integrations/debugging/rookout/index.mdx | 4 +-- .../integrations/deployment/heroku/index.mdx | 4 +-- .../integrations/deployment/vercel/index.mdx | 4 +-- .../feature-flag/launchdarkly/index.mdx | 8 +++--- .../integrations/feature-flag/split/index.mdx | 4 +-- .../internal-integration.mdx | 4 +-- .../public-integration.mdx | 4 +-- .../ui-components/index.mdx | 4 +-- .../integration-platform/webhooks.mdx | 4 +-- .../webhooks/issue-alerts.mdx | 4 +-- .../webhooks/metric-alerts.mdx | 8 +++--- .../issue-tracking/asana/index.mdx | 4 +-- .../issue-tracking/clickup/index.mdx | 4 +-- .../issue-tracking/goast/index.mdx | 4 +-- .../issue-tracking/height/index.mdx | 4 +-- .../issue-tracking/incidentio/index.mdx | 4 +-- .../issue-tracking/kitemaker/index.mdx | 4 +-- .../issue-tracking/linear/index.mdx | 4 +-- .../issue-tracking/shortcut/index.mdx | 4 +-- .../issue-tracking/teamwork/index.mdx | 4 +-- .../notification-incidents/blar/index.md | 4 +-- .../notification-incidents/discord/index.mdx | 8 +++--- .../notification-incidents/msteams/index.mdx | 8 +++--- .../notification-incidents/opsgenie/index.mdx | 8 +++--- .../pagerduty/index.mdx | 4 +-- .../pagertree/index.mdx | 4 +-- .../notification-incidents/rootly/index.mdx | 4 +-- .../notification-incidents/signl4/index.mdx | 4 +-- .../notification-incidents/slack/index.mdx | 4 +-- .../notification-incidents/spikesh/index.mdx | 4 +-- .../session-replay/atlas/index.mdx | 4 +-- .../session-replay/betterbugs.mdx | 6 ++-- .../integrations/session-replay/index.mdx | 4 +-- .../integrations/session-replay/jam.mdx | 4 +-- .../source-code-mgmt/bitbucket/index.mdx | 12 ++++---- .../source-code-mgmt/github/index.mdx | 16 +++++------ .../source-code-mgmt/gitlab/index.mdx | 12 ++++---- docs/organization/membership/index.mdx | 12 ++++---- .../apple/common/configuration/app-hangs.mdx | 8 +++--- .../apple/common/configuration/options.mdx | 8 +++--- .../apple/common/configuration/releases.mdx | 8 +++--- .../apple/common/configuration/sampling.mdx | 4 +-- .../configuration/watchdog-terminations.mdx | 8 +++--- .../apple-privacy-manifest.mdx | 8 +++--- .../debug-files/identifiers/index.mdx | 4 +-- .../data-management/debug-files/index.mdx | 8 +++--- .../data-management/sensitive-data/index.mdx | 4 +-- .../enriching-events/attachments/index.mdx | 8 +++--- .../common/enriching-events/context/index.mdx | 4 +-- .../enriching-events/identify-user/index.mdx | 4 +-- .../enriching-events/screenshots/index.mdx | 4 +-- .../common/enriching-events/tags/index.mdx | 4 +-- .../enriching-events/viewhierarchy/index.mdx | 10 +++---- .../common/features/experimental-features.mdx | 4 +-- .../platforms/apple/common/features/index.mdx | 4 +-- docs/platforms/apple/common/index.mdx | 8 +++--- .../common/install/swift-package-manager.mdx | 8 +++--- .../apple/common/integrations/default.mdx | 8 +++--- docs/platforms/apple/common/metrics/index.mdx | 4 +-- .../apple/common/profiling/index.mdx | 18 ++++++------ .../automatic-instrumentation.mdx | 16 +++++------ .../custom-instrumentation.mdx | 4 +-- .../swiftui-instrumentation.mdx | 4 ++- .../tracing/trace-propagation/index.mdx | 4 +-- docs/platforms/apple/common/usage/index.mdx | 4 +-- .../apple/guides/ios/session-replay/index.mdx | 4 +-- .../apple/guides/macos/features/index.mdx | 8 +++--- .../dotnet/common/configuration/msbuild.mdx | 4 +-- .../dotnet/common/configuration/options.mdx | 8 +++--- .../dotnet/common/configuration/releases.mdx | 12 ++++---- .../dotnet/common/configuration/sampling.mdx | 4 +-- docs/platforms/dotnet/common/crons/index.mdx | 4 +-- .../debug-files/identifiers/index.mdx | 4 +-- .../data-management/debug-files/index.mdx | 8 +++--- .../debug-files/source-context/index.mdx | 4 +-- .../debug-files/upload/index.mdx | 4 +-- .../data-management/sensitive-data/index.mdx | 4 +-- .../enriching-events/attachments/index.mdx | 8 +++--- .../common/enriching-events/context/index.mdx | 4 +-- .../enriching-events/identify-user/index.mdx | 4 +-- .../common/enriching-events/tags/index.mdx | 4 +-- docs/platforms/dotnet/common/index.mdx | 4 +-- .../dotnet/common/profiling/index.mdx | 4 +-- .../platforms/dotnet/common/tracing/index.mdx | 4 +-- .../automatic-instrumentation.mdx | 4 +-- .../custom-instrumentation/index.mdx | 4 +-- docs/platforms/dotnet/common/usage/index.mdx | 4 +-- .../dotnet/common/user-feedback/index.mdx | 4 +-- .../tracing/included-instrumentation.mdx | 4 +-- .../automatic-instrumentation.mdx | 4 +-- .../guides/azure-functions-worker/index.mdx | 4 +-- .../guides/extensions-logging/index.mdx | 8 +++--- .../platforms/dotnet/guides/log4net/index.mdx | 4 +-- .../platforms/dotnet/guides/serilog/index.mdx | 4 +-- docs/platforms/dotnet/guides/uwp/index.mdx | 4 +-- docs/platforms/dotnet/guides/winui/index.mdx | 8 +++--- docs/platforms/dotnet/guides/wpf/index.mdx | 4 +-- .../apple-privacy-manifest.mdx | 8 +++--- .../dotnet/guides/xamarin/troubleshooting.mdx | 10 +++---- docs/platforms/dotnet/index.mdx | 10 +++---- .../elixir/configuration/releases.mdx | 4 +-- .../data-management/sensitive-data/index.mdx | 4 +-- .../elixir/enriching-events/context/index.mdx | 4 +-- .../enriching-events/identify-user/index.mdx | 4 +-- .../elixir/enriching-events/tags/index.mdx | 4 +-- docs/platforms/elixir/index.mdx | 8 +++--- docs/platforms/elixir/usage/index.mdx | 4 +-- .../flutter/configuration/options.mdx | 8 +++--- .../flutter/configuration/releases.mdx | 8 +++--- .../flutter/configuration/sampling.mdx | 4 +-- .../apple-privacy-manifest.mdx | 8 +++--- .../debug-files/file-formats/index.mdx | 4 +-- .../debug-files/identifiers/index.mdx | 4 +-- .../data-management/debug-files/index.mdx | 8 +++--- .../debug-files/source-context/index.mdx | 4 +-- .../data-management/sensitive-data/index.mdx | 4 +-- .../enriching-events/attachments/index.mdx | 4 +-- .../enriching-events/context/index.mdx | 4 +-- .../flutter/enriching-events/tags/index.mdx | 4 +-- .../enriching-events/viewhierarchy/index.mdx | 8 +++--- docs/platforms/flutter/index.mdx | 4 +-- .../app-start-instrumentation.mdx | 8 +++--- .../integrations/routing-instrumentation.mdx | 4 +-- ...slow-and-frozen-frames-instrumentation.mdx | 4 +-- docs/platforms/flutter/metrics/index.mdx | 4 +-- docs/platforms/flutter/profiling/index.mdx | 4 +-- .../flutter/session-replay/index.mdx | 4 +-- docs/platforms/flutter/tracing/index.mdx | 4 +-- .../automatic-instrumentation.mdx | 4 +-- .../custom-instrumentation.mdx | 4 +-- docs/platforms/flutter/upload-debug.mdx | 24 ++++++++-------- docs/platforms/flutter/usage/index.mdx | 4 +-- .../go/common/configuration/releases.mdx | 4 +-- .../go/common/configuration/sampling.mdx | 4 +-- .../data-management/sensitive-data/index.mdx | 4 +-- .../enriching-events/attachments/index.mdx | 8 +++--- .../common/enriching-events/context/index.mdx | 4 +-- .../go/common/enriching-events/tags/index.mdx | 4 +-- docs/platforms/go/common/index.mdx | 4 +-- docs/platforms/go/common/tracing/index.mdx | 4 +-- .../custom-instrumentation/index.mdx | 4 +-- docs/platforms/go/common/usage/index.mdx | 4 +-- .../java/common/configuration/options.mdx | 4 +-- .../java/common/configuration/releases.mdx | 4 +-- .../java/common/configuration/sampling.mdx | 4 +-- .../data-management/sensitive-data/index.mdx | 4 +-- .../enriching-events/attachments/index.mdx | 4 +-- .../common/enriching-events/context/index.mdx | 4 +-- .../common/enriching-events/tags/index.mdx | 4 +-- docs/platforms/java/common/gradle/index.mdx | 4 +-- docs/platforms/java/common/index.mdx | 4 +-- .../java/common/integrations/graphql.mdx | 8 +++--- .../java/common/integrations/graphql22.mdx | 8 +++--- .../java/common/integrations/quartz.mdx | 8 +++--- docs/platforms/java/common/tracing/index.mdx | 4 +-- .../common/tracing/instrumentation/apollo.mdx | 12 ++++---- .../tracing/instrumentation/apollo3.mdx | 12 ++++---- .../custom-instrumentation/index.mdx | 4 +-- .../tracing/instrumentation/file-io.mdx | 4 +-- .../common/tracing/instrumentation/jdbc.mdx | 4 +-- .../common/tracing/instrumentation/okhttp.mdx | 4 +-- .../tracing/instrumentation/open-feign.mdx | 4 +-- docs/platforms/java/common/usage/index.mdx | 4 +-- .../guides/spring-boot/logging-frameworks.mdx | 8 +++--- .../java/guides/spring-boot/record-user.mdx | 4 +-- .../automatic-instrumentation.mdx | 4 +-- .../automatic-instrumentation.mdx | 4 +-- .../common/best-practices/micro-frontends.mdx | 22 +++++++-------- .../multiple-sentry-instances.mdx | 4 +-- .../best-practices/shared-environments.mdx | 4 +-- .../application-not-responding.mdx | 4 +-- .../common/configuration/filtering.mdx | 8 +++--- .../integrations/inboundfilters.mdx | 4 +-- .../common/configuration/options.mdx | 4 +-- .../common/configuration/releases.mdx | 8 +++--- .../common/configuration/sampling.mdx | 4 +-- .../common/configuration/tree-shaking.mdx | 12 ++++---- .../javascript/common/crons/index.mdx | 8 +++--- .../debug-files/identifiers/index.mdx | 4 +-- .../data-management/debug-files/index.mdx | 8 +++--- .../data-management/sensitive-data/index.mdx | 4 +-- .../enriching-events/attachments/index.mdx | 4 +-- .../common/enriching-events/context/index.mdx | 8 +++--- .../common/enriching-events/tags/index.mdx | 4 +-- .../transaction-name/index.mdx | 4 +-- docs/platforms/javascript/common/index.mdx | 4 +-- .../javascript/common/install/index.mdx | 4 +-- .../common/install/late-initialization.mdx | 4 +-- .../common/opentelemetry/custom-setup.mdx | 12 ++++---- .../using-opentelemetry-apis.mdx | 4 +-- .../common/profiling/browser-profiling.mdx | 4 +-- .../common/profiling/node-profiling.mdx | 4 +-- .../common/session-replay/configuration.mdx | 6 ++-- .../common/session-replay/index.mdx | 4 +-- .../common/session-replay/issue-types.mdx | 8 +++--- .../sourcemaps/uploading/angular-nx.mdx | 8 +++--- .../sourcemaps/uploading/angular-webpack.mdx | 8 +++--- .../sourcemaps/uploading/create-react-app.mdx | 4 +-- .../common/sourcemaps/uploading/esbuild.mdx | 8 +++--- .../sourcemaps/uploading/hosting-publicly.mdx | 4 +-- .../common/sourcemaps/uploading/rollup.mdx | 4 +-- .../sourcemaps/uploading/typescript.mdx | 10 +++---- .../common/sourcemaps/uploading/vite.mdx | 8 +++--- .../common/sourcemaps/uploading/webpack.mdx | 12 ++++---- .../javascript/common/tracing/index.mdx | 4 +-- .../automatic-instrumentation.mdx | 24 ++++++++-------- .../custom-instrumentation/index.mdx | 4 +-- .../custom-instrumentation/queues-module.mdx | 8 +++--- .../requests-module.mdx | 4 +-- .../javascript/common/usage/index.mdx | 4 +-- .../user-feedback/configuration/index.mdx | 4 +-- .../javascript/guides/aws-lambda/index.mdx | 4 +-- .../guides/aws-lambda/install/cjs-layer.mdx | 4 +-- .../guides/aws-lambda/install/esm-npm.mdx | 4 +-- .../guides/cordova/upload-debug.mdx | 4 +-- .../javascript/guides/gatsby/index.mdx | 4 +-- .../javascript/guides/gcp-functions/index.mdx | 4 +-- .../guides/nestjs/features/event-emitter.mdx | 6 ++-- .../nestjs/features/sentry-cron-decorator.mdx | 8 +++--- .../features/sentry-traced-decorator.mdx | 4 +-- .../javascript/guides/nextjs/manual-setup.mdx | 4 +-- .../guides/react/features/react-router/v6.mdx | 4 +-- .../guides/react/features/react-router/v7.mdx | 4 +-- .../javascript/guides/remix/manual-setup.mdx | 12 ++++---- .../guides/solid/features/index.mdx | 4 +-- .../guides/solid/features/solid-router.mdx | 4 +-- .../guides/solidstart/features/index.mdx | 4 +-- .../solidstart/features/solid-router.mdx | 4 +-- .../guides/sveltekit/manual-setup.mdx | 16 +++++------ .../configuration/releases.mdx | 4 +-- .../apple-privacy-manifest.mdx | 8 +++--- .../data-management/sensitive-data/index.mdx | 4 +-- .../enriching-events/attachments/index.mdx | 4 +-- .../enriching-events/context/index.mdx | 4 +-- .../enriching-events/screenshots/index.mdx | 4 +-- .../enriching-events/tags/index.mdx | 4 +-- .../enriching-events/viewhierarchy/index.mdx | 4 +-- .../kotlin-multiplatform/features/index.mdx | 4 +-- .../guides/kotlin-multiplatform/index.mdx | 4 +-- .../initialization-strategies.mdx | 8 +++--- .../manual-setup/index.mdx | 4 +-- .../kotlin-multiplatform/troubleshooting.mdx | 4 +-- .../kotlin-multiplatform/usage/index.mdx | 4 +-- .../native/common/configuration/releases.mdx | 8 +++--- .../native/common/configuration/sampling.mdx | 8 +++--- .../debug-files/identifiers/index.mdx | 4 +-- .../data-management/debug-files/index.mdx | 8 +++--- .../data-management/sensitive-data/index.mdx | 4 +-- .../enriching-events/attachments/index.mdx | 4 +-- .../common/enriching-events/context/index.mdx | 4 +-- .../common/enriching-events/tags/index.mdx | 4 +-- docs/platforms/native/common/index.mdx | 4 +-- .../platforms/native/common/tracing/index.mdx | 4 +-- .../custom-instrumentation.mdx | 4 +-- docs/platforms/native/common/usage/index.mdx | 4 +-- docs/platforms/native/guides/wasm/index.mdx | 4 +-- .../php/common/configuration/options.mdx | 8 +++--- .../php/common/configuration/releases.mdx | 4 +-- .../php/common/configuration/sampling.mdx | 4 +-- .../data-management/sensitive-data/index.mdx | 4 +-- .../common/enriching-events/context/index.mdx | 4 +-- .../common/enriching-events/tags/index.mdx | 4 +-- docs/platforms/php/common/metrics/index.mdx | 4 +-- docs/platforms/php/common/profiling/index.mdx | 8 +++--- docs/platforms/php/common/tracing/index.mdx | 4 +-- .../custom-instrumentation.mdx | 6 ++-- docs/platforms/php/common/usage/index.mdx | 4 +-- .../laravel/configuration/laravel-options.mdx | 4 +-- .../guides/laravel/integrations/eloquent.mdx | 8 +++--- .../php/guides/laravel/metrics/index.mdx | 4 +-- .../laravel/other-versions/laravel4.mdx | 4 +-- .../laravel/other-versions/laravel5.mdx | 4 +-- .../laravel/other-versions/laravel8-10.mdx | 4 +-- .../php/guides/laravel/profiling/index.mdx | 8 +++--- .../symfony/enriching-events/tags/index.mdx | 4 +-- .../php/guides/symfony/metrics/index.mdx | 4 +-- .../php/guides/symfony/profiling/index.mdx | 8 +++--- .../powershell/configuration/options.mdx | 4 +-- .../powershell/configuration/releases.mdx | 14 +++++----- .../powershell/configuration/sampling.mdx | 4 +-- .../data-management/sensitive-data/index.mdx | 4 +-- .../enriching-events/attachments/index.mdx | 4 +-- .../enriching-events/context/index.mdx | 4 +-- .../enriching-events/identify-user/index.mdx | 4 +-- .../enriching-events/tags/index.mdx | 4 +-- docs/platforms/powershell/index.mdx | 4 +-- docs/platforms/powershell/tracing/index.mdx | 4 +-- .../custom-instrumentation.mdx | 4 +-- docs/platforms/powershell/usage/index.mdx | 4 +-- .../react-native/configuration/options.mdx | 4 +-- .../react-native/configuration/releases.mdx | 8 +++--- .../react-native/configuration/sampling.mdx | 4 +-- .../configuration/touchevents.mdx | 4 +-- .../apple-privacy-manifest.mdx | 8 +++--- .../debug-files/file-formats/index.mdx | 4 +-- .../debug-files/identifiers/index.mdx | 4 +-- .../data-management/debug-files/index.mdx | 8 +++--- .../data-management/sensitive-data/index.mdx | 4 +-- .../enriching-events/attachments/index.mdx | 4 +-- .../enriching-events/context/index.mdx | 4 +-- .../enriching-events/tags/index.mdx | 4 +-- .../enriching-events/viewhierarchy/index.mdx | 4 +-- docs/platforms/react-native/index.mdx | 4 +-- .../react-native/manual-setup/hermes.mdx | 8 +++--- .../react-native/manual-setup/native-init.mdx | 4 +-- .../react-native/manual-setup/ram-bundles.mdx | 4 +-- .../react-native/migration/before-v5.mdx | 8 +++--- .../react-native/profiling/index.mdx | 4 +-- .../react-native/session-replay/index.mdx | 4 +-- .../react-native/sourcemaps/index.mdx | 6 ++-- .../legacy-uploading-methods.mdx | 4 +-- .../sourcemaps/uploading/hermes.mdx | 4 +-- .../automatic-instrumentation.mdx | 12 ++++---- .../custom-instrumentation.mdx | 4 +-- .../user-interaction-instrumentation.mdx | 12 ++++---- .../react-native/troubleshooting/index.mdx | 8 +++--- docs/platforms/react-native/usage/index.mdx | 4 +-- .../rust/common/configuration/options.mdx | 4 +-- .../rust/common/configuration/releases.mdx | 8 +++--- .../rust/common/configuration/sampling.mdx | 4 +-- .../data-management/sensitive-data/index.mdx | 4 +-- .../common/enriching-events/context/index.mdx | 4 +-- .../common/enriching-events/tags/index.mdx | 4 +-- docs/platforms/rust/common/tracing/index.mdx | 4 +-- .../automatic-instrumentation.mdx | 4 +-- .../custom-instrumentation.mdx | 4 +-- docs/platforms/rust/common/usage/index.mdx | 4 +-- docs/platforms/rust/index.mdx | 8 +++--- .../platforms/unity/configuration/options.mdx | 8 +++--- .../unity/configuration/releases.mdx | 16 +++++------ .../unity/configuration/sampling.mdx | 4 +-- .../debug-files/identifiers/index.mdx | 4 +-- .../data-management/debug-files/index.mdx | 8 +++--- .../debug-files/source-context/index.mdx | 4 +-- .../debug-files/upload/index.mdx | 8 +++--- .../data-management/sensitive-data/index.mdx | 4 +-- .../enriching-events/attachments/index.mdx | 8 +++--- .../unity/enriching-events/context/index.mdx | 8 +++--- .../unity/enriching-events/tags/index.mdx | 4 +-- docs/platforms/unity/index.mdx | 4 +-- docs/platforms/unity/metrics/index.mdx | 4 +-- docs/platforms/unity/migration/index.mdx | 4 +-- docs/platforms/unity/native-support/index.mdx | 8 +++--- docs/platforms/unity/tracing/index.mdx | 4 +-- .../custom-instrumentation.mdx | 4 +-- docs/platforms/unity/usage/index.mdx | 4 +-- docs/platforms/unity/user-feedback/index.mdx | 4 +-- .../debug-files/identifiers/index.mdx | 4 +-- .../data-management/debug-files/index.mdx | 8 +++--- .../data-management/sensitive-data/index.mdx | 4 +-- .../unreal/enriching-events/context/index.mdx | 8 +++--- .../unreal/enriching-events/tags/index.mdx | 4 +-- docs/platforms/unreal/tracing/index.mdx | 4 +-- .../custom-instrumentation.mdx | 4 +-- docs/platforms/unreal/usage/index.mdx | 4 +-- docs/pricing/index.mdx | 8 +++--- docs/pricing/legacy-pricing.mdx | 12 ++++---- docs/pricing/quotas/index.mdx | 4 +-- .../legacy-manage-transaction-quota.mdx | 16 +++++------ .../quotas/manage-attachments-quota.mdx | 12 ++++---- docs/pricing/quotas/manage-cron-monitors.mdx | 10 +++---- .../quotas/manage-event-stream-guide.mdx | 16 +++++------ docs/pricing/quotas/manage-replay-quota.mdx | 8 +++--- .../quotas/manage-transaction-quota.mdx | 8 +++--- docs/pricing/quotas/spend-allocation.mdx | 12 ++++---- docs/pricing/quotas/spike-protection.mdx | 12 ++++---- docs/product/alerts/alert-types.mdx | 7 ++--- docs/product/alerts/create-alerts/index.mdx | 4 +-- .../create-alerts/metric-alert-config.mdx | 16 +++++------ docs/product/alerts/index.mdx | 4 +-- docs/product/codecov/set-up.mdx | 8 +++--- .../crons/getting-started/http/index.mdx | 8 +++--- .../explore/discover-queries/index.mdx | 4 +-- .../discover-queries/query-builder.mdx | 6 ++-- .../discover-queries/uncover-trends.mdx | 4 +-- docs/product/explore/metrics/index.mdx | 4 +-- .../explore/metrics/metrics-explorer-page.mdx | 4 +-- .../profiling/differential-flamegraphs.mdx | 4 +-- .../explore/profiling/flame-charts-graphs.mdx | 4 +-- docs/product/explore/profiling/index.mdx | 4 +-- .../profiling/performance-overhead.mdx | 4 +-- .../explore/session-replay/web/index.mdx | 4 +-- .../web/performance-overhead.mdx | 8 +++--- docs/product/explore/traces/index.mdx | 28 ++++--------------- .../llm-monitoring/getting-started/index.mdx | 4 +-- .../getting-started/the-dashboard.mdx | 4 +-- docs/product/insights/backend/queries.mdx | 4 +-- docs/product/insights/frontend/assets.mdx | 4 +-- .../insights/frontend/web-vitals/index.mdx | 16 +++++------ .../web-vitals/web-vitals-concepts.mdx | 12 ++++---- .../grouping-and-fingerprints/index.mdx | 4 +-- docs/product/issues/index.mdx | 4 +-- .../consecutive-http/index.mdx | 4 +-- .../performance-issues/frame-drop/index.mdx | 4 +-- .../http-overhead/index.mdx | 4 +-- .../performance-issues/index.mdx | 4 +-- .../slow-db-queries/index.mdx | 4 +-- .../issue-details/replay-issues/index.mdx | 4 +-- .../replay-issues/rage-clicks.mdx | 4 +-- .../issues/issue-details/sentry-ai/index.mdx | 9 +++--- docs/product/issues/issue-priority/index.mdx | 4 +-- docs/product/issues/issue-views/index.mdx | 8 +++--- docs/product/issues/states-triage/index.mdx | 4 +-- docs/product/issues/suspect-commits/index.mdx | 8 +++--- .../performance/filters-display/widgets.mdx | 4 +-- docs/product/performance/index.mdx | 8 +++--- docs/product/performance/metrics.mdx | 4 +-- .../performance/performance-overhead.mdx | 4 +-- .../retention-priorities/index.mdx | 16 +++++------ .../performance/transaction-summary.mdx | 12 ++++---- docs/product/relay/getting-started.mdx | 8 +++--- docs/product/relay/index.mdx | 4 +-- docs/product/relay/modes/index.mdx | 4 +-- .../relay/modes/pii-and-data-scrubbing.mdx | 4 +-- docs/product/relay/projects.mdx | 4 +-- .../releases/associate-commits/index.mdx | 16 +++++------ docs/product/releases/health/index.mdx | 16 +++++------ docs/product/releases/index.mdx | 12 ++++---- docs/product/releases/setup/index.mdx | 8 +++--- .../setup/release-automation/index.mdx | 8 +++--- .../integrate-backend/capturing-errors.mdx | 4 +-- .../integrate-backend/getting-started.mdx | 10 +++---- docs/product/stats/index.mdx | 4 +-- .../scrubbing/server-side-scrubbing/index.mdx | 4 +-- .../security/ai-ml-policy.mdx | 4 +-- .../custom-measurements-units-disclaimer.mdx | 4 +-- includes/debug-id-requirement.mdx | 4 +-- ...e-available-for-plan-business-no-trial.mdx | 4 +-- .../feature-available-for-plan-business.mdx | 4 +-- .../feature-available-for-plan-enterprise.mdx | 4 +-- includes/feature-available-for-plan-team.mdx | 4 +-- ...ture-available-for-plan-trial-business.mdx | 4 +-- ...re-available-for-plan-trial-enterprise.mdx | 4 +-- .../feature-available-for-plan-trial-team.mdx | 4 +-- ...available-for-user-group-early-adopter.mdx | 4 +-- ...available-for-user-group-limited-avail.mdx | 4 +-- .../feature-limited-on-team-retention.mdx | 4 +-- includes/feature-stage-alpha-metrics.mdx | 4 +-- includes/feature-stage-alpha.mdx | 4 +-- includes/feature-stage-beta-metrics.mdx | 4 +-- includes/feature-stage-beta-uptime.mdx | 4 +-- includes/feature-stage-beta.mdx | 4 +-- includes/feature-stage-preview.mdx | 4 +-- includes/insights-requests-body.mdx | 8 +++--- includes/javascript-crons-upsert.mdx | 8 +++--- includes/merge-escalating-note.mdx | 4 +-- includes/only-error-issues-note.mdx | 4 +-- includes/performance-moving.mdx | 4 +-- includes/profiling-node-runtime-flags.mdx | 4 +-- ...ython-use-older-sdk-for-legacy-support.mdx | 4 +-- includes/sentry-cli-sourcemaps.mdx | 8 +++--- includes/session-replay-web-report-bug.mdx | 4 +-- platform-includes/capture-error/_default.mdx | 4 +-- platform-includes/capture-error/apple.mdx | 4 +-- .../before-send-check-in/php.laravel.mdx | 4 +-- .../before-send-check-in/php.symfony.mdx | 4 +-- .../before-send-fingerprint/php.laravel.mdx | 4 +-- .../before-send-fingerprint/php.symfony.mdx | 4 +-- .../before-send-hint/php.laravel.mdx | 4 +-- .../before-send-hint/php.symfony.mdx | 4 +-- .../before-send-transaction/php.laravel.mdx | 4 +-- .../before-send-transaction/php.symfony.mdx | 4 +-- .../configuration/before-send/php.laravel.mdx | 4 +-- .../configuration/before-send/php.symfony.mdx | 4 +-- .../configuration/config-intro/dotnet.mdx | 4 +-- .../configuration/config-intro/unity.mdx | 8 +++--- .../configuration/config-intro/unreal.mdx | 4 +-- .../diagnostic-logger/dotnet.mdx | 4 +-- platform-includes/crons/setup/python.mdx | 4 +-- .../debug-symbols-apple/_default.mdx | 12 ++++---- .../enriching-events/add-attachment/java.mdx | 8 +++--- .../attach-screenshots/android.mdx | 4 +-- .../attach-screenshots/apple.mdx | 4 +-- .../attach-screenshots/flutter.mdx | 4 +-- .../attach-screenshots/unity.mdx | 4 +-- .../attach-screenshots/unreal.mdx | 8 +++--- .../attach-viewhierarchy/apple.mdx | 4 +-- .../kotlin.kotlin-multiplatform.mdx | 4 +-- .../attachment-init-with-path/dart.mdx | 4 +-- .../before-breadcrumb/php.laravel.mdx | 4 +-- .../before-breadcrumb/php.symfony.mdx | 4 +-- .../scopes/with-scope/unreal.mdx | 4 +-- .../enriching-events/set-user/native.mdx | 4 +-- .../getting-started-config/dotnet.mdx | 4 +-- .../getting-started-config/java.jul.mdx | 8 +++--- .../getting-started-config/java.log4j2.mdx | 8 +++--- .../getting-started-config/java.logback.mdx | 8 +++--- .../javascript.ember.mdx | 4 +-- .../javascript.solid.mdx | 4 +-- .../javascript.solidstart.mdx | 8 +++--- .../getting-started-config/unreal.mdx | 4 +-- .../getting-started-install/java.jul.mdx | 4 +-- .../getting-started-install/java.log4j2.mdx | 4 +-- .../getting-started-install/java.logback.mdx | 4 +-- .../getting-started-install/java.mdx | 4 +-- .../getting-started-install/java.servlet.mdx | 4 +-- .../java.spring-boot.mdx | 4 +-- .../getting-started-install/java.spring.mdx | 4 +-- .../getting-started-install/javascript.mdx | 4 +-- .../javascript.nextjs.mdx | 4 +-- .../javascript.nuxt.mdx | 4 +-- .../javascript.remix.mdx | 4 +-- .../javascript.sveltekit.mdx | 4 +-- .../getting-started-install/native.qt.mdx | 4 +-- .../getting-started-install/unity.mdx | 4 +-- .../getting-started-install/unreal.mdx | 12 ++++---- .../getting-started-node/javascript.mdx | 4 +-- .../getting-started-primer/java.jul.mdx | 4 +-- .../getting-started-primer/java.log4j2.mdx | 4 +-- .../getting-started-primer/java.logback.mdx | 4 +-- .../getting-started-primer/java.mdx | 4 +-- .../java.spring-boot.mdx | 4 +-- .../getting-started-primer/java.spring.mdx | 4 +-- .../javascript.cordova.mdx | 4 +-- .../javascript.deno.mdx | 4 +-- .../javascript.ember.mdx | 4 +-- .../javascript.nextjs.mdx | 4 +-- .../javascript.react.mdx | 4 +-- .../javascript.remix.mdx | 4 +-- .../javascript.svelte.mdx | 4 +-- .../javascript.sveltekit.mdx | 4 +-- .../kotlin.kotlin-multiplatform.mdx | 8 +++--- .../getting-started-primer/native.mdx | 4 +-- .../getting-started-primer/native.qt.mdx | 4 +-- .../javascript.angular.mdx | 4 +-- .../javascript.astro.mdx | 4 +-- .../getting-started-verify/javascript.mdx | 4 +-- .../javascript.nextjs.mdx | 4 +-- .../javascript.remix.mdx | 4 +-- .../javascript.sveltekit.mdx | 4 +-- .../performance/connect-errors-spans/java.mdx | 4 +-- .../connect-services/javascript.mdx | 8 +++--- .../traces-sampler-as-filter/php.laravel.mdx | 4 +-- .../traces-sampler-as-filter/php.symfony.mdx | 4 +-- .../javascript.react.mdx | 4 +-- .../profiling/index/preface/go.mdx | 4 +-- .../profiling/index/preface/ruby.mdx | 4 +-- .../sensitive-data/set-tag/_default.mdx | 4 +-- .../sensitive-data/set-user/_default.mdx | 4 +-- .../install/javascript.astro.mdx | 4 +-- .../install/javascript.remix.mdx | 4 +-- .../install/javascript.sveltekit.mdx | 4 +-- .../setup/javascript.capacitor.mdx | 4 +-- .../artifact-bundles/javascript.mdx | 4 +-- .../legacy-troubleshooting/javascript.mdx | 4 +-- .../legacy-uploading-methods/javascript.mdx | 4 +-- .../sourcemaps/overview/javascript.mdx | 12 ++++---- .../sourcemaps/overview/javascript.remix.mdx | 4 +-- .../sourcemaps/overview/javascript.svelte.mdx | 12 ++++---- .../sourcemaps/overview/javascript.vue.mdx | 12 ++++---- .../sourcemaps/troubleshooting/javascript.mdx | 4 +-- .../sourcemaps/upload/primer/javascript.mdx | 8 +++--- .../install/javascript.astro.mdx | 4 +-- .../install/javascript.remix.mdx | 4 +-- .../install/javascript.sveltekit.mdx | 4 +-- .../user-feedback/sdk-api-example/unreal.mdx | 4 +-- src/components/alert.tsx | 8 ------ src/components/orgAuthTokenNote.tsx | 4 +-- src/components/signInNote.tsx | 4 +-- 599 files changed, 1650 insertions(+), 1678 deletions(-) diff --git a/develop-docs/ingestion/relay/transaction-span-ratelimits.mdx b/develop-docs/ingestion/relay/transaction-span-ratelimits.mdx index 6883ea14fdf51..844d0b49c6dd5 100644 --- a/develop-docs/ingestion/relay/transaction-span-ratelimits.mdx +++ b/develop-docs/ingestion/relay/transaction-span-ratelimits.mdx @@ -69,19 +69,19 @@ Relay stage: customer managed, PoP-Relay or Processing-Relay. Until spans are ex should count the contained spans and generate an outcome with the contained span quantity + 1, for the segment span which would be generated from the transaction itself. - + While it is desirable to have span counts correctly extracted from dropped transactions, it may not be feasible to do so at any stage of the processing pipeline. For example, it may not be possible to do so (malformed transactions) or simply too expensive to compute. - + After spans have been extracted, the transaction is no longer a container of span items and just represents itself, thus, a dropped transaction with spans already extracted only generates outcomes for the total transactions and indexed transaction categories. - + Span quotas are equivalent to transactions quotas, so all the above also applies for a span quota. - + ## Examples diff --git a/develop-docs/integrations/azuredevops/index.mdx b/develop-docs/integrations/azuredevops/index.mdx index 20c200bc4fc2c..2ee89e44f6934 100644 --- a/develop-docs/integrations/azuredevops/index.mdx +++ b/develop-docs/integrations/azuredevops/index.mdx @@ -25,12 +25,12 @@ When configuring the app, use the following values: | Supported account types | Accounts in any organizational directory | | Redirect URI | `{YOUR_DOMAIN}/extensions/vsts/setup` | - + Take note of your App ID as we'll need it later. ![App ID](./app-id.png) - +> Next go to Manager -> API Permissions to add the following permissions: * Azure DevOps (`vso.code`, `vso.graph`, `vso.work_item`, `vso.service_endpoint`) diff --git a/develop-docs/sdk/data-model/event-payloads/lockreason.mdx b/develop-docs/sdk/data-model/event-payloads/lockreason.mdx index 0a63e1f36101f..0a44a3c3a6ed0 100644 --- a/develop-docs/sdk/data-model/event-payloads/lockreason.mdx +++ b/develop-docs/sdk/data-model/event-payloads/lockreason.mdx @@ -6,11 +6,11 @@ Represents an instance of a held lock (monitor object) in a thread. Typically, t to determine which other thread is holding the lock in case the current thread is blocked. In languages like `Java` or `Kotlin` this typically will be represented by a `java.lang.Object` type. - + Lock reasons are always part of a [thread](/sdk/data-model/event-payloads/threads/). They cannot be declared as a top-level event property. - +> ## Attributes diff --git a/develop-docs/sdk/platform-specifics/javascript-sdks/browser-tracing.mdx b/develop-docs/sdk/platform-specifics/javascript-sdks/browser-tracing.mdx index b899f12ef00eb..bf7077a340577 100644 --- a/develop-docs/sdk/platform-specifics/javascript-sdks/browser-tracing.mdx +++ b/develop-docs/sdk/platform-specifics/javascript-sdks/browser-tracing.mdx @@ -6,12 +6,12 @@ sidebar_order: 10 The tracing behavior in our browser SDKs is somewhat unique and significantly differs from tracing in the backend. This page collects the most important aspects. - + The aspects described in this document apply to all browser SDKs. This includes `@sentry/browser` and all SDKs building on top of it like `@sentry/react`, `@sentry/angular` or `@sentry/vue` but also the client-side parts of meta frameworks like `@sentry/nextjs`. - +> Please note that any kind of automatic tracing instrumentation in the browser requires the `browserTracingIntegration()` to be added to the SDK configuration. The default configuration of the SDK does not include any performance or tracing-related instrumentation to save on [bundle size](../bundle-size) for errors-only users. @@ -103,13 +103,13 @@ There are sometimes discrepancies between the values we capture and the values t Generally speaking, most web vitals are accumulated while the pageload span is active and captured when we _end_ the pageload span. This works well for vitals that stabilize themselves very early in the lifecycle but it leads to discrepancies for vitals that are still changing after the pageload span ends. This is the case for `LCP` and `CLS` in particular. - +> At the time of writing, we're transitioning to a [more sophisticated `LCP` and `CLS` capturing technique](https://github.com/getsentry/sentry-javascript/issues/12714) that should improve the accuracy of these metrics. It will essentially work like `INP` collection works today. - +> ### Interaction To Next paint (INP) @@ -134,13 +134,13 @@ This tracing model has a couple of consequences that are important to understand - **Quota Management**: Since the trace state does not change throughout a single page or route, the sampling decision of the initial span is carried over for all subsequent events. This means that the sampling decision is only made once per page or route and is not reevaluated for each event. Furthermore, subsequent http (`fetch` or `XmlHttpRequest`) also propagate this sampling decision to potential downstream services. This can lead to a higher number of events being sent to Sentry than before. - **Long-lived Traces**: Not every web application features navigations (hard or soft). For pages where users simply remain on one page without making navigations (e.g. a chat application), the trace id will remain constant for the entire duration of the user journey. This can lead to very long-lived traces that can potentially grow very large. - +> As outlined above, some of the consequences have negative product or UX implications. This is a known issue and we're working on an update to the trace lifetime model to address these issues. However, this is a complex topic and we're still in the process of evaluating the best solution. - +> ## Trace Propagation diff --git a/develop-docs/sdk/telemetry/check-ins.mdx b/develop-docs/sdk/telemetry/check-ins.mdx index 5fecd7afbb732..21b720cb89e4a 100644 --- a/develop-docs/sdk/telemetry/check-ins.mdx +++ b/develop-docs/sdk/telemetry/check-ins.mdx @@ -135,10 +135,10 @@ result in a poor DX. ### Schedule configuration - + This configuration format differs slightly from what is accepted in the monitors frontend APIs. - +> `type` diff --git a/develop-docs/sdk/telemetry/sessions/index.mdx b/develop-docs/sdk/telemetry/sessions/index.mdx index 50d4e9c131b19..b423528c1309f 100644 --- a/develop-docs/sdk/telemetry/sessions/index.mdx +++ b/develop-docs/sdk/telemetry/sessions/index.mdx @@ -3,11 +3,11 @@ title: Sessions sidebar_order: 6 --- - + Looking for Sentry's **Session Replay**? Click here to learn more. - +> For basic health tracking Sentry accepts envelopes containing session update events. These session update events can be used to diff --git a/develop-docs/sdk/telemetry/traces/index.mdx b/develop-docs/sdk/telemetry/traces/index.mdx index b05f9decc6282..bd5e005b7a8f9 100644 --- a/develop-docs/sdk/telemetry/traces/index.mdx +++ b/develop-docs/sdk/telemetry/traces/index.mdx @@ -14,11 +14,11 @@ Reference implementations: - [JavaScript SDK](https://github.com/getsentry/sentry-javascript/tree/master/packages/core/src/tracing) - [Python SDK](https://github.com/getsentry/sentry-python/blob/master/sentry_sdk/tracing.py) - + This document uses standard interval notation, where `[` and `]` indicates closed intervals, which include the endpoints of the interval, while `(` and `)` indicates open intervals, which exclude the endpoints of the interval. An interval `[x, y)` covers all values starting from `x` up to but excluding `y`. - +> ## SDK Configuration diff --git a/docs/account/user-settings/index.mdx b/docs/account/user-settings/index.mdx index 22be5378efe25..df320be4bab63 100644 --- a/docs/account/user-settings/index.mdx +++ b/docs/account/user-settings/index.mdx @@ -14,11 +14,11 @@ Security Settings include options to reset a password, sign out of all devices, After setting up your two-factor authentication codes, click "View Codes" to download, print, or copy your codes to a secure location. If you cannot receive two-factor authentication codes in the future, such as if you lose your device, use your recovery codes to access your account. - + Clicking "Sign out of all devices" will end your sessions with any device logged in to Sentry using your account. - +> ## Notifications diff --git a/docs/api/auth.mdx b/docs/api/auth.mdx index 952be7377a0b0..0b789405000d5 100644 --- a/docs/api/auth.mdx +++ b/docs/api/auth.mdx @@ -51,8 +51,8 @@ As an example, to get information about the project which your key is bound to, curl -u {API_KEY}: https://sentry.io/api/0/organizations/{organization_slug}/projects/ ``` - + You **must** pass a value for the password, which is the reason the `:` is present in our example. - +> diff --git a/docs/api/ratelimits.mdx b/docs/api/ratelimits.mdx index 19f7da9f5cc54..6af326636b87c 100644 --- a/docs/api/ratelimits.mdx +++ b/docs/api/ratelimits.mdx @@ -32,8 +32,8 @@ Every API request response includes the following headers: The rate limiter looks at the caller's identity instead of the bearer token or cookie. As such, the rate limit cannot be bypassed by generating multiple tokens. - + Polling the API for updates is likely to quickly trigger rate limiting. We recommend using our [webhooks](/organization/integrations/integration-platform/webhooks/), if possible. - +> diff --git a/docs/cli/configuration.mdx b/docs/cli/configuration.mdx index 60dc57eb7b176..036f4525adccb 100644 --- a/docs/cli/configuration.mdx +++ b/docs/cli/configuration.mdx @@ -26,9 +26,9 @@ You can manually create an [Organization Auth Token](https://sentry.io/orgredire You can also sign in to your Sentry account (if you're not already) and create an Auth Token directly from this page. - + Some CLI functionality, such as [Crons Monitoring](/product/crons/getting-started/cli/), is dependent on DSN authentication. - +> You can create an Auth Token from this page in one of the following three ways: @@ -112,7 +112,7 @@ The header that will be added to every outgoing request in `key:value` format. `SENTRY_ALLOW_FAILURE` -Note: This option will ignore the CLI's failure when uploading symbols. **BE AWARE** this will unblock your CI in case Sentry has issues, but you won't have unminified/unsymbolicated crashes in production. +Note: This option will ignore the CLI's failure when uploading symbols. **BE AWARE** this will unblock your CI in case Sentry has issues, but you won't have unminified/unsymbolicated crashes in production. When using this flag, you should download your sourcemaps/debug files from CI, to re-run the upload symbols command at a later point once Sentry is available. (_http.keepalive_): diff --git a/docs/cli/installation.mdx b/docs/cli/installation.mdx index 9797f684037ef..65814700338de 100644 --- a/docs/cli/installation.mdx +++ b/docs/cli/installation.mdx @@ -61,11 +61,11 @@ In case you want to install this with npm system wide with sudo you will need to sudo npm install -g @sentry/cli --unsafe-perm ``` - + This installation is not recommended however. - +> ### Downloading From a Custom Source diff --git a/docs/cli/releases.mdx b/docs/cli/releases.mdx index 056996d2b75b2..db5bfc565a25a 100644 --- a/docs/cli/releases.mdx +++ b/docs/cli/releases.mdx @@ -6,11 +6,11 @@ description: "Sentry's command line interface can be used for release management The `sentry-cli` tool can be used for release management on Sentry. It allows you to create, edit and delete releases as well as upload release artifacts for them. Note that releases are global per organization. If you want the releases in different projects to be treated as separate entities, make the version name unique across the organization. For example, if you have projectA and projectB that share version numbers, you can name the releases `projectA-1.0` and `projectB-1.0` respectively. - + Because releases work on projects you will need to specify the organization and project you are working with. For more information about this refer to [Working with Projects](/cli/configuration/#sentry-cli-working-with-projects). - +> ## Creating Releases diff --git a/docs/concepts/data-management/event-grouping/index.mdx b/docs/concepts/data-management/event-grouping/index.mdx index eab51900c22ac..f32e6451312fb 100644 --- a/docs/concepts/data-management/event-grouping/index.mdx +++ b/docs/concepts/data-management/event-grouping/index.mdx @@ -70,11 +70,11 @@ You can customize error grouping using a combination of the following options, l 1. In your SDK, using [SDK Fingerprinting](/platform-redirect/?next=/usage/sdk-fingerprinting/) > Sets a new fingerprint for incoming events based on matchers in the SDK. This doesn't affect already existing issues. Note that is not supported in WebAssembly. - + Stack trace rules can work as a combination of both SDK and project settings. As a result, we maintain the documentation in one location. - +> ## How to View the Fingerprint diff --git a/docs/concepts/data-management/event-grouping/stack-trace-rules.mdx b/docs/concepts/data-management/event-grouping/stack-trace-rules.mdx index 3b08813980124..0afacdabc9dde 100644 --- a/docs/concepts/data-management/event-grouping/stack-trace-rules.mdx +++ b/docs/concepts/data-management/event-grouping/stack-trace-rules.mdx @@ -8,7 +8,7 @@ description: "Learn how to use stack trace rules to group incoming events based Stack trace rules improve issue tracking by ensuring accurate grouping and better classification of stack frames as in-app or system. This helps focus on relevant code, reduces noise, and minimizes false positives. By tailoring rules to your project, you can streamline debugging and maintain consistency across teams or multiple applications. -When you set stack trace rules (previously known as _grouping enhancements_) for grouping in Sentry, they influence the data that's fed into the grouping algorithm. These rules can be configured on a per-project basis by going to your project settings and then clicking on "Issue Grouping". +When you set stack trace rules (previously known as _grouping enhancements_) for grouping in Sentry, they influence the data that's fed into the grouping algorithm. These rules can be configured on a per-project basis by going to your project settings and then clicking on "Issue Grouping". Here are a few things to note about stack trace rules: @@ -16,14 +16,14 @@ Here are a few things to note about stack trace rules: - Rules consist of one or more match expressions followed by one or more actions triggered when all expressions match. - Rules are applied sequentially, from top to bottom, across all frames in the stack trace. -In addition, the stack trace rules using the below matchers and actions can also be applied to incoming profiles to improve frame classification (in-app vs system, for example). +In addition, the stack trace rules using the below matchers and actions can also be applied to incoming profiles to improve frame classification (in-app vs system, for example). Allowed Matchers: * `stack.abs_path` * `stack.module` * `stack.function` * `stack.package` - + Allowed Actions: * `+app` * `-app` @@ -235,11 +235,11 @@ stack.function:std::* -app stack.function:boost::* -app ``` - + You need to force all frames to be in-app first because there might already have been some defaults set by the client SDK or earlier processing. - +> If you're using the `sentry-cocoa` SDK, you can also achieve the same result by marking other frames `not inApp`. The following sample marks functions from the classes `DataRequest` and `DownloadRequest` as `not inApp`. diff --git a/docs/concepts/key-terms/dsn-explainer.mdx b/docs/concepts/key-terms/dsn-explainer.mdx index 1abb06ae3bc7c..0fb09b2a28b68 100644 --- a/docs/concepts/key-terms/dsn-explainer.mdx +++ b/docs/concepts/key-terms/dsn-explainer.mdx @@ -48,8 +48,8 @@ Has the following settings: - Public Key = public - Project ID = 1 - + The secret part of the DSN is optional and effectively deprecated. While clients will still honor it, if supplied, future versions of Sentry will entirely ignore it. - +> diff --git a/docs/concepts/key-terms/sample-rates.mdx b/docs/concepts/key-terms/sample-rates.mdx index 61a5825650e01..9cbfa59a970ff 100644 --- a/docs/concepts/key-terms/sample-rates.mdx +++ b/docs/concepts/key-terms/sample-rates.mdx @@ -23,9 +23,9 @@ Choose a sampling rate that balances data accuracy with performance and storage ## Sampling Rate Options - + Some of the options below aren't available in every SDK; check out our platform-specific docs for more info. - +> ### Error Events diff --git a/docs/concepts/key-terms/tracing/distributed-tracing.mdx b/docs/concepts/key-terms/tracing/distributed-tracing.mdx index 8c3edc97ef34c..114993575a694 100644 --- a/docs/concepts/key-terms/tracing/distributed-tracing.mdx +++ b/docs/concepts/key-terms/tracing/distributed-tracing.mdx @@ -4,7 +4,7 @@ sidebar_order: 10 description: With distributed tracing, you can track software performance and measure throughput & latency, while seeing the impact of errors across multiple systems. --- -Distributed tracing provides a connected view of your application from frontend to backend. It helps track software performance, measure [metrics](/product/performance/metrics/) like throughput and latency, and display the impact of errors across multiple systems. This makes Sentry a more complete [performance monitoring](/product/performance/) solution, aiding in diagnosing problems and measuring your application's overall health. +Distributed tracing provides a connected view of your application from frontend to backend. It helps track software performance, measure [metrics](/product/performance/metrics/) like throughput and latency, and display the impact of errors across multiple systems. This makes Sentry a more complete [performance monitoring](/product/performance/) solution, aiding in diagnosing problems and measuring your application's overall health. [Tracing](/concepts/key-terms/tracing/distributed-tracing/) in Sentry provides insights such as: @@ -36,11 +36,11 @@ Transactions share most properties (start and end time, tags, and so on) with th Before the transaction is sent, the `tags` and `data` properties will get merged with data from the global scope. (Global scope data is set in `Sentry.init()` or by using `Sentry.configureScope()`, `Sentry.setTag()`, `Sentry.setUser()`, or `Sentry.setExtra()`.) - + Transaction names can contain **sensitive data**. See [Scrubbing Sensitive Data](/platforms/javascript/data-management/sensitive-data/#scrubbing-data) for more information. - +> #### Spans diff --git a/docs/concepts/search/index.mdx b/docs/concepts/search/index.mdx index 7aa946166ba94..ca6c505ececc0 100644 --- a/docs/concepts/search/index.mdx +++ b/docs/concepts/search/index.mdx @@ -8,9 +8,9 @@ Search is available on several features throughout [sentry.io](https://sentry.io ## Query Syntax - + You'll only need to use query syntax if you're using a Sentry [API](/api/). You'll get pre-populated suggestions once you start typing in your search terms when using the search bar anywhere in [Sentry.io](https://sentry.sentry.io/). - +> Search queries are constructed using a `key:value` pattern, with an optional raw search at the end. Each `key:value` pair is a `token` and the optional raw search is itself a single `token`. The `key:value` pair `tokens` are treated as issue or event properties. The optional raw search is treated as a single `token` and searches event titles/messages. @@ -52,11 +52,11 @@ Here are some examples of valid comparison operator searches: ### Using `OR` and `AND` - +> `OR` and `AND` search conditions are only available for [Discover](/product/explore/discover-queries/), [Performance](/product/performance/), and [Metric Alerts](/product/alerts-notifications/metric-alerts/). - +> Use `OR` and `AND` between tokens, and use parentheses `()` to group conditions. `AND` can also be used between non-aggregates and aggregates. However, `OR` cannot. diff --git a/docs/concepts/search/searchable-properties/events.mdx b/docs/concepts/search/searchable-properties/events.mdx index 16df7fa963433..e43e524ef423f 100644 --- a/docs/concepts/search/searchable-properties/events.mdx +++ b/docs/concepts/search/searchable-properties/events.mdx @@ -14,11 +14,11 @@ You can search by event properties in the following [sentry.io](https://sentry.i - Issues - as indicated in the list below - Alerts - when creating a metric alert - + Please note that in Alerts only a limited number of properties are available for [filtering transaction events](/product/alerts/create-alerts/metric-alert-config/#tags--properties). - +> When searching on event properties within the **Issues** page, the search will return any issue that has _one or more events_ matching the supplied event properties filter. diff --git a/docs/concepts/search/searchable-properties/issues.mdx b/docs/concepts/search/searchable-properties/issues.mdx index e7d11d91063a4..9305b053f9eeb 100644 --- a/docs/concepts/search/searchable-properties/issues.mdx +++ b/docs/concepts/search/searchable-properties/issues.mdx @@ -10,9 +10,9 @@ sidebar_order: 10 Below is a list of keys and tokens that can be used in the issues search. - + You'll only need to use query syntax for **datetime** and **relative time** searchable property types if you're using the Sentry [API](/api/). - +> diff --git a/docs/contributing/approach/product-docs/write-index.mdx b/docs/contributing/approach/product-docs/write-index.mdx index bf9840b6d5e44..8952558ad54cd 100644 --- a/docs/contributing/approach/product-docs/write-index.mdx +++ b/docs/contributing/approach/product-docs/write-index.mdx @@ -6,11 +6,11 @@ sidebar_order: 10 This guide to writing index pages is just that—a guide. It won’t answer every question you have about how to write a good index page, but it will help you make a good start. - + While we use the term “index page” to refer to the top-level page about a feature in Docs, we don’t use this terminology in the actual Docs. Learn more in [Other Guidelines](#other-guidelines). - +> The index page: diff --git a/docs/contributing/approach/sdk-docs/write-getting-started.mdx b/docs/contributing/approach/sdk-docs/write-getting-started.mdx index 4c3609226830c..4120c77b611ba 100644 --- a/docs/contributing/approach/sdk-docs/write-getting-started.mdx +++ b/docs/contributing/approach/sdk-docs/write-getting-started.mdx @@ -28,11 +28,11 @@ Explain the SDK at a high level in these two parts: 1. An italicized sentence that explains what the SDK enables (errors, or errors and transactions) 2. A brief paragraph that provides technical insight and the versions supported - + If the primer content isn't developed, this fallback will display "_Sentry's SDKs enable automatic reporting of errors and exceptions_." - + > Add the primer content to this directory: @@ -54,11 +54,11 @@ Add the configuration code sample to this directory: - [`/platform-includes/getting-started-config/`](https://github.com/getsentry/sentry-docs/tree/master/platform-includes/getting-started-config) - + If the SDK supports performance monitoring, add it to the list that links back into the SDK content from Product, stored in [`/docs/product/performance/getting-started.mdx`](https://github.com/getsentry/sentry-docs/blob/master/docs/product/performance/getting-started.mdx). - + ## Verification Code Sample diff --git a/docs/contributing/pages/images.mdx b/docs/contributing/pages/images.mdx index df4a071b7cf03..65b86849b2acb 100644 --- a/docs/contributing/pages/images.mdx +++ b/docs/contributing/pages/images.mdx @@ -11,9 +11,9 @@ If an image is used in multiple places, it's best to put it in `includes/common- Alternatively, images can also be added to the `public` folder and referenced using their relative or full path within the folder. See [public images](#public-images) - + Every image path that starts with `/` (instead of `./`) is considered to be in the `public` folder. - +> ### Examples diff --git a/docs/contributing/pages/redirects.mdx b/docs/contributing/pages/redirects.mdx index ebc01fdf4148f..5a7a3a7cd3619 100644 --- a/docs/contributing/pages/redirects.mdx +++ b/docs/contributing/pages/redirects.mdx @@ -13,9 +13,9 @@ There are two ways to add redirects in the Sentry docs: - [Add a New Redirect in `middleware.ts` (Recommended)](#add-a-new-redirect-in-middlewarets-recommended) - [Add a New Redirect in `redirects.js`](#example-redirect-in-redirectsjs) - + Both files make the distinction between SDK docs (ie. end user docs) and developer docs. - +> Because Sentry has a limited number of `next.config.js` redirects, you should configure your redirects in `middleware.ts` whenever possible. You should only use `redirects.js` ie (`next.config.js`) if you need to use regular expressions and wildcard path segments in your redirects. diff --git a/docs/contributing/platforms/index.mdx b/docs/contributing/platforms/index.mdx index e2e54c65573a2..427b4192270f8 100644 --- a/docs/contributing/platforms/index.mdx +++ b/docs/contributing/platforms/index.mdx @@ -92,11 +92,11 @@ All of this content will be automatically duplicated within every guide. This le Sometimes a page may not make sense within the context of a given guide. To control this, you can use the `supported` and `notSupported` frontmatter on common pages in platforms. - + Page visibility works similar to the supported/notSupported attributes in other platform components (such as `PlatformSection`). - +> For example, if you wanted to make hide the content for a platform by default, but enable it for a guide, you can do that like so: diff --git a/docs/organization/authentication/sso/azure-sso.mdx b/docs/organization/authentication/sso/azure-sso.mdx index 8aa49a1b9bfc6..c922965a9db19 100644 --- a/docs/organization/authentication/sso/azure-sso.mdx +++ b/docs/organization/authentication/sso/azure-sso.mdx @@ -80,11 +80,11 @@ If you change your organization slug, you'll need to make the same update in the ## SCIM Integration - + This feature is only available if your organization is on a Business or Enterprise plan; it is not available on Trial plans. - +> @@ -133,8 +133,8 @@ As a result of these changes, users who are assigned will be sent an invitation You can use Use Group Provisioning to sync and assign groups in Azure; they will be reflected in Sentry teams. - +> Please see the [Microsoft AD tutorial](https://docs.microsoft.com/en-us/azure/active-directory/saas-apps/sentry-provisioning-tutorial) for further documentation on Azure provisioning setup. If you are using a custom enterprise application, you **must** follow the instructions for only enabling attribute mappings that Sentry supports (Step 5). - +> diff --git a/docs/organization/authentication/sso/okta-sso/okta-scim.mdx b/docs/organization/authentication/sso/okta-sso/okta-scim.mdx index 405d9d74455ee..609cf975af162 100644 --- a/docs/organization/authentication/sso/okta-sso/okta-scim.mdx +++ b/docs/organization/authentication/sso/okta-sso/okta-scim.mdx @@ -4,11 +4,11 @@ sidebar_order: 3 description: "Set up Okta's SCIM Integration for Member and Team Provisioning" --- - + This feature is only available if your organization is on a Business or Enterprise plan. - +> diff --git a/docs/organization/getting-started/index.mdx b/docs/organization/getting-started/index.mdx index c5cb26a80bce5..a47b3a9eb2e4c 100644 --- a/docs/organization/getting-started/index.mdx +++ b/docs/organization/getting-started/index.mdx @@ -81,11 +81,11 @@ For a list of all supported integrations, check out out our [full Integrations d You can set up automated issue management when you create alerts that route to [Azure DevOps](/organization/integrations/source-code-mgmt/azure-devops/#automatically) and [Jira](/organization/integrations/issue-tracking/jira/#automatically). External issues will be created for new Sentry issues on your behalf, and these issues will use the configured fields in your Azure DevOps or Jira workspace. For other issue tracking solutions, you can manually link Sentry issues. - + Automatic issue management is available only if your organization is on a Business or Trial plan. - +> ## 4. Create Projects diff --git a/docs/organization/integrations/cloud-monitoring/aws-lambda/index.mdx b/docs/organization/integrations/cloud-monitoring/aws-lambda/index.mdx index 2a8be914d22f8..d8510724cbe98 100644 --- a/docs/organization/integrations/cloud-monitoring/aws-lambda/index.mdx +++ b/docs/organization/integrations/cloud-monitoring/aws-lambda/index.mdx @@ -4,22 +4,22 @@ sidebar_order: 1 description: "Learn more about Sentry's AWS Lambda integration and how you can automatically instrument your Node or Python Lambda functions with Sentry without changing your code." --- - + This method of setting up Sentry in your Lambda functions only works if your Lambda functions are run in Node CommonJS (`require` syntax) or in Python. For all other setups, check out these docs for [Node](/platforms/javascript/guides/aws-lambda/) or [Python](/platforms/python/integrations/aws-lambda/) instead. - +> Connect Sentry to your AWS account to automatically add Sentry error and performance monitoring to your Node/Python Lambda functions. ## Install - +> Sentry owner, manager, or admin permissions are required to install this integration. - +> 1. Navigate to **Settings > Integrations > AWS Lambda**. @@ -49,11 +49,11 @@ Sentry owner, manager, or admin permissions are required to install this integra ![](./img/aws_account_2.png) - +> You need to create the CloudFormation stack only once per account, even when installing the integration in multiple regions. If you are setting up the integration in a second region, copy the externalId from the existing CloudFormation stack on the "Parameters" tab into the form shown above. - +> 8. Select the Lambda functions to automatically add the Sentry layer and necessary environment variables when you **Finish Setup**. **Note:** You can enable or disable Sentry on Lambda functions after installation. diff --git a/docs/organization/integrations/cloud-monitoring/cloudflare-workers/index.mdx b/docs/organization/integrations/cloud-monitoring/cloudflare-workers/index.mdx index 382a4c2a4f5bb..2fa48feffcc16 100644 --- a/docs/organization/integrations/cloud-monitoring/cloudflare-workers/index.mdx +++ b/docs/organization/integrations/cloud-monitoring/cloudflare-workers/index.mdx @@ -10,11 +10,11 @@ This integration is maintained and supported by the company that created it. For ## Install and Configure - + Sentry owner, manager, or admin permissions are required to install this integration. - +> 1. Navigate to **Settings > Integrations > Cloudflare Workers** diff --git a/docs/organization/integrations/cloud-monitoring/gcp-cloud-run/index.mdx b/docs/organization/integrations/cloud-monitoring/gcp-cloud-run/index.mdx index a7909cdb4fdd2..94a818fa3e3c8 100644 --- a/docs/organization/integrations/cloud-monitoring/gcp-cloud-run/index.mdx +++ b/docs/organization/integrations/cloud-monitoring/gcp-cloud-run/index.mdx @@ -8,11 +8,11 @@ Cloud Run helps developers save time in building and deploying their application ## Install and Configure - + Sentry owner, manager, or admin permissions are required to install this integration. - +> 1. [Create an account](https://sentry.io/signup/) (or [Login](https://sentry.io/auth/login/)) on Sentry diff --git a/docs/organization/integrations/compliance/truto/index.mdx b/docs/organization/integrations/compliance/truto/index.mdx index e3d6596a19fb4..6730d4391947e 100644 --- a/docs/organization/integrations/compliance/truto/index.mdx +++ b/docs/organization/integrations/compliance/truto/index.mdx @@ -8,11 +8,11 @@ This integration is maintained and supported by the company that created it. For ## Install and Configure - + Sentry Owner, Manager, or Admin permissions are required to install this integration. - +> 1. Navigate to **Settings > Integrations > Truto** diff --git a/docs/organization/integrations/compliance/vanta/index.mdx b/docs/organization/integrations/compliance/vanta/index.mdx index 1d8a5211e4e0f..ca92bc7f99ce3 100644 --- a/docs/organization/integrations/compliance/vanta/index.mdx +++ b/docs/organization/integrations/compliance/vanta/index.mdx @@ -8,11 +8,11 @@ Sentry's Vanta integration grants Vanta read-only access to verify that Sentry o ## Install and Configure - + Sentry owner, manager, or admin permissions are required to install this integration. - +> 1. Navigate to **Settings > Integrations > Vanta** diff --git a/docs/organization/integrations/data-visualization/amazon-sqs/index.mdx b/docs/organization/integrations/data-visualization/amazon-sqs/index.mdx index 8d98716e5dc97..5d27b19cc1142 100644 --- a/docs/organization/integrations/data-visualization/amazon-sqs/index.mdx +++ b/docs/organization/integrations/data-visualization/amazon-sqs/index.mdx @@ -10,11 +10,11 @@ This integration needs to be set up in each project for which you wish to use it ## Install and Configure - + Sentry owner, manager, or admin permissions are required to install this integration. - +> Navigate to **Settings > Integrations > Amazon SQS** diff --git a/docs/organization/integrations/data-visualization/segment/index.mdx b/docs/organization/integrations/data-visualization/segment/index.mdx index bd1cbbe7ec855..85b93cf4b9157 100644 --- a/docs/organization/integrations/data-visualization/segment/index.mdx +++ b/docs/organization/integrations/data-visualization/segment/index.mdx @@ -16,11 +16,11 @@ This integration needs to be set up in each project for which you wish to use it ## Install and Configure - + Sentry owner, manager, or admin permissions are required to install this integration. - +> Navigate to **Settings > Integrations > Segment** diff --git a/docs/organization/integrations/data-visualization/splunk/index.mdx b/docs/organization/integrations/data-visualization/splunk/index.mdx index 6c8dbc18472f5..6bf9f726fbbb6 100644 --- a/docs/organization/integrations/data-visualization/splunk/index.mdx +++ b/docs/organization/integrations/data-visualization/splunk/index.mdx @@ -6,21 +6,21 @@ description: "Learn more about Sentry's Splunk integration, which allows you to Connect Splunk to Sentry with the [Data Forwarding](/concepts/data-management/data-forwarding/) feature. - + We only support Splunk Cloud plans. We do not support Splunk Enterprise plans. See the [Splunk documentation](https://dev.splunk.com/) for specific details on your Splunk installation. - +> This integration needs to be set up in each project for which you wish to use it. It is maintained and supported by the [Sentry community](https://open.sentry.io/). ## Install and Configure - +> Sentry owner, manager, or admin permissions are required to install this integration. - +> Navigate to **Settings > Integrations > Splunk** @@ -46,11 +46,11 @@ Change **All Tokens** to **Enabled**, and note the HTTP Port Number (`8088` by d ![Splunk global settings](./img/splunk-hec-global-settings.png) - +> If you’re running Splunk in a privileged environment, you may need to expose the HEC port. - +> ### Creating a Sentry Input @@ -111,10 +111,10 @@ Once you’ve filled in the required fields, hit **Save Changes**: We’ll now begin forwarding all new events into your Splunk instance. - +> Sentry will internally limit the maximum number of events sent to your Splunk instance to 1000 per second. - +> ![Splunk page showing Sentry data](./img/splunk-search-sentry.png) diff --git a/docs/organization/integrations/debugging/apigene/index.mdx b/docs/organization/integrations/debugging/apigene/index.mdx index 8ae7eff29aa58..b9a583213c108 100644 --- a/docs/organization/integrations/debugging/apigene/index.mdx +++ b/docs/organization/integrations/debugging/apigene/index.mdx @@ -12,11 +12,11 @@ This integration is maintained and supported by the company that created it. For ## Install and Configure - + Sentry owner, manager, or admin permissions are required to install this integration. - +> 1. Navigate to **Settings > Integrations > Apigene** diff --git a/docs/organization/integrations/debugging/foamai/index.mdx b/docs/organization/integrations/debugging/foamai/index.mdx index 2ca5a15b006c4..9e5fb8d7e08f0 100644 --- a/docs/organization/integrations/debugging/foamai/index.mdx +++ b/docs/organization/integrations/debugging/foamai/index.mdx @@ -9,11 +9,11 @@ This integration is maintained and supported by Foam.ai. For more details, check ## Install and Configure - + Sentry owner, manager, or admin permissions are required to install this integration. - +> 1. Navigate to **Settings > Integrations > Foam** diff --git a/docs/organization/integrations/debugging/revisedev/index.mdx b/docs/organization/integrations/debugging/revisedev/index.mdx index 4df4ba43f0a0d..ffcc653196d91 100644 --- a/docs/organization/integrations/debugging/revisedev/index.mdx +++ b/docs/organization/integrations/debugging/revisedev/index.mdx @@ -11,11 +11,11 @@ This integration is maintained and supported by the company that created it. For ## Install and Configure - + Sentry owner, manager, or admin permissions are required to install this integration. - +> 1. Navigate to **Settings > Integrations > Revise.dev** diff --git a/docs/organization/integrations/debugging/rookout/index.mdx b/docs/organization/integrations/debugging/rookout/index.mdx index 446a8eff64b50..5c5543feb2521 100644 --- a/docs/organization/integrations/debugging/rookout/index.mdx +++ b/docs/organization/integrations/debugging/rookout/index.mdx @@ -10,13 +10,13 @@ This integration is maintained and supported by the company that created it. For ## Install and Configure - + Sentry owner, manager, or admin permissions are required to install this integration. Rookout **won't** work with self-hosted Sentry. - +> 1. Navigate to **Settings > Integrations > Rookout** diff --git a/docs/organization/integrations/deployment/heroku/index.mdx b/docs/organization/integrations/deployment/heroku/index.mdx index bc90faf51209b..7ed59d20bdce4 100644 --- a/docs/organization/integrations/deployment/heroku/index.mdx +++ b/docs/organization/integrations/deployment/heroku/index.mdx @@ -18,11 +18,11 @@ Once done, you’ll be able to confirm that Sentry’s credentials are available heroku config:get SENTRY_DSN ``` - + If you’re not using the add-on, you can still bind the `SENTRY_DSN` environment variable which the SDK will automatically pick up. - +> ### Install the SDK diff --git a/docs/organization/integrations/deployment/vercel/index.mdx b/docs/organization/integrations/deployment/vercel/index.mdx index 17a9b46003464..c0f3df32967cf 100644 --- a/docs/organization/integrations/deployment/vercel/index.mdx +++ b/docs/organization/integrations/deployment/vercel/index.mdx @@ -15,11 +15,11 @@ To learn more about using Sentry in your Next.js app, check out the [Next.js SDK ## Install - + Sentry owner, manager, or admin permissions are required to install this integration. - +> 1. Visit [https://vercel.com/integrations/sentry](https://vercel.com/integrations/sentry) diff --git a/docs/organization/integrations/feature-flag/launchdarkly/index.mdx b/docs/organization/integrations/feature-flag/launchdarkly/index.mdx index 1829324ff395c..6ce3d3b648de0 100644 --- a/docs/organization/integrations/feature-flag/launchdarkly/index.mdx +++ b/docs/organization/integrations/feature-flag/launchdarkly/index.mdx @@ -41,17 +41,17 @@ This integration is maintained and supported by the company that created it. For ### Install and Configure - + Sentry owner or manager permissions are required to install this integration. - +> - +> The LaunchDarkly integration is only available to organizations with a Business or Enterprise plan. - +> 1. Navigate to **Settings > Integrations > LaunchDarkly** diff --git a/docs/organization/integrations/feature-flag/split/index.mdx b/docs/organization/integrations/feature-flag/split/index.mdx index 8c6de468d477a..77fe42ff14516 100644 --- a/docs/organization/integrations/feature-flag/split/index.mdx +++ b/docs/organization/integrations/feature-flag/split/index.mdx @@ -16,13 +16,13 @@ This integration is maintained and supported by the company that created it. For ## Install and Configure - + Sentry owner, manager, or admin permissions are required to install this integration. The Split integration is available only for organizations on the Business and Enterprise plans. Split **won't** work with self-hosted Sentry. - +> 1. Navigate to **Settings > Integrations > Split** diff --git a/docs/organization/integrations/integration-platform/internal-integration.mdx b/docs/organization/integrations/integration-platform/internal-integration.mdx index 76df207257712..8caec8edebc88 100644 --- a/docs/organization/integrations/integration-platform/internal-integration.mdx +++ b/docs/organization/integrations/integration-platform/internal-integration.mdx @@ -4,11 +4,11 @@ sidebar_order: 2 description: "Learn more about internal integrations, which are custom-made for your organization." --- - + We've built an [example application](https://github.com/getsentry/integration-platform-example) to help you get started with building on Sentry's integration platform. Check it out for useful code snippets for adding these features in Python and TypeScript. See the [docs](/organization/integrations/integration-platform/#example-app) for more information. - +> Internal integrations are meant for custom integrations unique to your organization. They can also be as simple as an organization-wide token. Whether you are using just the API or all the integration platform features combined, internal integrations are for use within a single Sentry organization. diff --git a/docs/organization/integrations/integration-platform/public-integration.mdx b/docs/organization/integrations/integration-platform/public-integration.mdx index 13a9c873561be..d3a522179d29a 100644 --- a/docs/organization/integrations/integration-platform/public-integration.mdx +++ b/docs/organization/integrations/integration-platform/public-integration.mdx @@ -4,11 +4,11 @@ sidebar_order: 1 description: "Learn more about public integrations, which are available to all Sentry users." --- - + We've built an [example application](https://github.com/getsentry/integration-platform-example) to help you get started with building on Sentry's integration platform. Check it out for useful code snippets for adding these features in Python and TypeScript. See the [docs](/organization/integrations/integration-platform/#example-app) for more information. - +> Public integrations are for the "general public" of Sentry users. These start in an unpublished state for development purposes and can be submitted later for approval to publish. For more information, check out the [Publication section](#publication) of this page. diff --git a/docs/organization/integrations/integration-platform/ui-components/index.mdx b/docs/organization/integrations/integration-platform/ui-components/index.mdx index 703da3966b3ae..3ec92cec29521 100644 --- a/docs/organization/integrations/integration-platform/ui-components/index.mdx +++ b/docs/organization/integrations/integration-platform/ui-components/index.mdx @@ -4,11 +4,11 @@ sidebar_order: 4 description: "Learn more about Sentry's integration platform User Interface (UI) components." --- - + We've built an [example application](https://github.com/getsentry/integration-platform-example) to help you get started with building on Sentry's integration platform! Check it out for useful code snippets for adding these features in Python and TypeScript. See the [docs](/organization/integrations/integration-platform/#example-app) for more information. - +> The Sentry integration platform provides developers with the ability to define components to render within specific parts of [sentry.io](https://sentry.io), through a JSON-based schema. diff --git a/docs/organization/integrations/integration-platform/webhooks.mdx b/docs/organization/integrations/integration-platform/webhooks.mdx index 7f42ce882da47..445f26a52b8f7 100644 --- a/docs/organization/integrations/integration-platform/webhooks.mdx +++ b/docs/organization/integrations/integration-platform/webhooks.mdx @@ -4,11 +4,11 @@ sidebar_order: 3 description: "Learn more about Sentry's integration platform webhooks and how they allow your service to receive requests about specific resources, such as installation, issues, and alerts." --- - + We've built an [example application](https://github.com/getsentry/integration-platform-example) to help you get started with building on Sentry's integration platform. Check it out for useful code snippets for adding these features in Python and TypeScript. See the [docs](/organization/integrations/integration-platform/#example-app) for more information. - +> Webhooks are a way for two applications or services to communicate over the web, allowing one application to send automatic notifications or data updates to another in near real-time. diff --git a/docs/organization/integrations/integration-platform/webhooks/issue-alerts.mdx b/docs/organization/integrations/integration-platform/webhooks/issue-alerts.mdx index f7fe684759135..025d59b8de2e3 100644 --- a/docs/organization/integrations/integration-platform/webhooks/issue-alerts.mdx +++ b/docs/organization/integrations/integration-platform/webhooks/issue-alerts.mdx @@ -51,11 +51,11 @@ The interactive demo below shows how to set up an internal integration that can - type: string - description: the label of the rule that was triggered - + The following two fields are for [alert rule action UI components](/organization/integrations/integration-platform/ui-components/alert-rule-action) only. - +> ### data['issue_alert']['title'] diff --git a/docs/organization/integrations/integration-platform/webhooks/metric-alerts.mdx b/docs/organization/integrations/integration-platform/webhooks/metric-alerts.mdx index 2116300989a36..b893bae428405 100644 --- a/docs/organization/integrations/integration-platform/webhooks/metric-alerts.mdx +++ b/docs/organization/integrations/integration-platform/webhooks/metric-alerts.mdx @@ -56,11 +56,11 @@ The interactive demo below shows how to set up an internal integration that can - type: string - description: the api url for the incident - + The following field is for [alert rule action UI components](/organization/integrations/integration-platform/ui-components/alert-rule-action) only. - +> ### data['metric_alert']['alert_rule']['triggers'][0]['actions'][0]['settings'] @@ -69,11 +69,11 @@ The following field is for [alert rule action UI components](/organization/integ ## Payload - +> Note: The webhook payload stack frame order lists the oldest frame to the most recent (where the exception happened). - +> ```json { diff --git a/docs/organization/integrations/issue-tracking/asana/index.mdx b/docs/organization/integrations/issue-tracking/asana/index.mdx index 5eababf9e82c7..28e5879b50f80 100644 --- a/docs/organization/integrations/issue-tracking/asana/index.mdx +++ b/docs/organization/integrations/issue-tracking/asana/index.mdx @@ -8,11 +8,11 @@ This integration needs to be set up in each project for which you wish to use it ## Install and Configure - + Sentry owner, manager, or admin permissions are required to install this integration. - +> 1. Navigate to **Settings > Integrations > Asana** diff --git a/docs/organization/integrations/issue-tracking/clickup/index.mdx b/docs/organization/integrations/issue-tracking/clickup/index.mdx index 4491fdf111b76..5eb3d6ec5d8a9 100644 --- a/docs/organization/integrations/issue-tracking/clickup/index.mdx +++ b/docs/organization/integrations/issue-tracking/clickup/index.mdx @@ -10,13 +10,13 @@ This integration is maintained and supported by the company that created it. For ## Install and Configure - + Sentry owner, manager, or admin permissions are required to install this integration. ClickUp **won't** work with self-hosted Sentry. - +> 1. Navigate to **Settings > Integrations > ClickUp** diff --git a/docs/organization/integrations/issue-tracking/goast/index.mdx b/docs/organization/integrations/issue-tracking/goast/index.mdx index 7399af100826a..6300eae2c93c5 100644 --- a/docs/organization/integrations/issue-tracking/goast/index.mdx +++ b/docs/organization/integrations/issue-tracking/goast/index.mdx @@ -8,11 +8,11 @@ description: "Goast’s Sentry integration brings you an automated platform for This integration is maintained and supported by the company that created it. For more details, or questions, please feel free to reach out to support@goast.ai! ## Install and Configure - + Sentry owner, manager, or admin permissions are required to install this integration. - +> 1. Navigate to **Settings > Integrations > Goast** diff --git a/docs/organization/integrations/issue-tracking/height/index.mdx b/docs/organization/integrations/issue-tracking/height/index.mdx index f74db9b632515..40c5c1a7ecf65 100644 --- a/docs/organization/integrations/issue-tracking/height/index.mdx +++ b/docs/organization/integrations/issue-tracking/height/index.mdx @@ -10,13 +10,13 @@ This integration is maintained and supported by the company that created it. For ## Install and Configure - + Sentry owner, manager, or admin permissions are required to install this integration. Height **won't** work with self-hosted Sentry. - +> To add the Height integration, navigate to **Settings > Integrations > Height** and click "Install". diff --git a/docs/organization/integrations/issue-tracking/incidentio/index.mdx b/docs/organization/integrations/issue-tracking/incidentio/index.mdx index 4f61d0e0174e4..320046b96424e 100644 --- a/docs/organization/integrations/issue-tracking/incidentio/index.mdx +++ b/docs/organization/integrations/issue-tracking/incidentio/index.mdx @@ -10,13 +10,13 @@ This integration is maintained and supported by the company that created it. For ## Install - + Sentry owner, manager, or admin permissions are required to install this integration. incident.io **won't** work with self-hosted Sentry. - +> The preferred way to install the incident.io integration is by sharing a Sentry link in your active incident Slack channel, which prompts you to add the integration: diff --git a/docs/organization/integrations/issue-tracking/kitemaker/index.mdx b/docs/organization/integrations/issue-tracking/kitemaker/index.mdx index 2cd0a0422c17a..c53c13ccd1c68 100644 --- a/docs/organization/integrations/issue-tracking/kitemaker/index.mdx +++ b/docs/organization/integrations/issue-tracking/kitemaker/index.mdx @@ -8,11 +8,11 @@ description: "Kitemaker’s integration with Sentry allows you to automatically This integration is maintained and supported by the company that created it. For more details, or questions, please feel free to reach out to hi@kitemaker.co! ## Install and Configure - + Sentry owner, manager, or admin permissions are required to install this integration. - +> 1. Navigate to **Settings > Integrations > Kitemaker** diff --git a/docs/organization/integrations/issue-tracking/linear/index.mdx b/docs/organization/integrations/issue-tracking/linear/index.mdx index bc0d8e04e989e..02dd5040fd6a6 100644 --- a/docs/organization/integrations/issue-tracking/linear/index.mdx +++ b/docs/organization/integrations/issue-tracking/linear/index.mdx @@ -10,13 +10,13 @@ This integration is maintained and supported by the company that created it. For ## Install and Configure - + Sentry owner, manager, or admin permissions are required to install this integration. Linear **won't** work with self-hosted Sentry. - +> 1. Navigate to **Settings > Integrations > Linear** diff --git a/docs/organization/integrations/issue-tracking/shortcut/index.mdx b/docs/organization/integrations/issue-tracking/shortcut/index.mdx index 4bad40c0714b8..d092c5771abd9 100644 --- a/docs/organization/integrations/issue-tracking/shortcut/index.mdx +++ b/docs/organization/integrations/issue-tracking/shortcut/index.mdx @@ -10,13 +10,13 @@ This integration is maintained and supported by the company that created it. For ## Install and Configure - + Sentry owner, manager, or admin permissions are required to install this integration. Shortcut **won't** work with self-hosted Sentry. - +> 1. Navigate to **Settings > Integrations > Shortcut** diff --git a/docs/organization/integrations/issue-tracking/teamwork/index.mdx b/docs/organization/integrations/issue-tracking/teamwork/index.mdx index 079b7c38149c4..06bcebb321c10 100644 --- a/docs/organization/integrations/issue-tracking/teamwork/index.mdx +++ b/docs/organization/integrations/issue-tracking/teamwork/index.mdx @@ -8,13 +8,13 @@ Teamwork needs to set up only once per organization, then it is available for _a ## Install and Configure - + Sentry owner, manager, or admin permissions are required to install this integration. Teamwork **won't** work with self-hosted Sentry. - +> 1. Navigate to **Settings > Integrations > Teamwork** diff --git a/docs/organization/integrations/notification-incidents/blar/index.md b/docs/organization/integrations/notification-incidents/blar/index.md index 064458d4e41ba..86076763ee4fd 100644 --- a/docs/organization/integrations/notification-incidents/blar/index.md +++ b/docs/organization/integrations/notification-incidents/blar/index.md @@ -11,11 +11,11 @@ This integration is maintained and supported by the company that created it. For ## Install and Configure - + Sentry owner, manager, or admin permissions are required to install this integration. - +> 1. Navigate to **Settings > Integrations > Blar** diff --git a/docs/organization/integrations/notification-incidents/discord/index.mdx b/docs/organization/integrations/notification-incidents/discord/index.mdx index 02638632e4ef1..c7bc287469f2f 100644 --- a/docs/organization/integrations/notification-incidents/discord/index.mdx +++ b/docs/organization/integrations/notification-incidents/discord/index.mdx @@ -8,11 +8,11 @@ Set up a Discord integration so you can get notified about, then triage, resolve ## Install - + Sentry owner, manager, or admin permissions are required to install this integration. - +> 1. Navigate to **Settings > Integrations > Discord** in [Sentry](https://sentry.io). @@ -24,10 +24,10 @@ Sentry owner, manager, or admin permissions are required to install this integra 4. Use the dropdown menu to select the Discord server you'd like to add Sentry to and click "Continue". - + > You'll need to have the "Manage Server" permission enabled for your Discord account in the server you're trying to add the bot to. - + > ![Select server](./img/discord-server-select.png) diff --git a/docs/organization/integrations/notification-incidents/msteams/index.mdx b/docs/organization/integrations/notification-incidents/msteams/index.mdx index e2a42bef28628..7d6cc16e12a81 100644 --- a/docs/organization/integrations/notification-incidents/msteams/index.mdx +++ b/docs/organization/integrations/notification-incidents/msteams/index.mdx @@ -10,11 +10,11 @@ Set this integration up once per organization, then it's available for _all_ pro ## Install - + Sentry owner, manager, or admin permissions are required to install this integration. - +> 1. Visit [the Microsoft Teams App Store](https://teams.microsoft.com/l/app/5adee720-30de-4006-a342-d454317db1d4) @@ -39,11 +39,11 @@ Use Microsoft Teams for [alerts](/product/alerts/) regarding issues, environment ### Alert Rules - +> If Microsoft Teams is not appearing as an option in issue alert actions, re-install the integration using "Add to team". - +> Set up an alert rule by going to **Alerts** and clicking "Create Alert". From here, you can configure alerts to route notifications to your Microsoft Team's channels. diff --git a/docs/organization/integrations/notification-incidents/opsgenie/index.mdx b/docs/organization/integrations/notification-incidents/opsgenie/index.mdx index 8e3d0db159ab4..bba9ca4f33e98 100644 --- a/docs/organization/integrations/notification-incidents/opsgenie/index.mdx +++ b/docs/organization/integrations/notification-incidents/opsgenie/index.mdx @@ -10,11 +10,11 @@ The Opsgenie integration allows you to connect your Sentry organization with one ## Install - + You'll need Sentry owner, manager, or admin-level permissions to be able to install this integration. - +> 1. To get started, go to **Settings > Integrations > Opsgenie (Integration)** and click "Add Installation". @@ -30,11 +30,11 @@ The Opsgenie integration should now be installed. Go to the configuration page t If you added an integration key during installation, it'll appear on the configuration page with the label 'my-first-key'. You can change this label at any time. - +> If you choose to create a key via the Opsgenie API, you will need to set "allowConfigurationAccess" to true. Integration keys are validated via the Opsgenie authentication endpoint, which requires a key to have configuration access. - +> ![Opsgenie configuration page](./img/opsgenie-config.png) diff --git a/docs/organization/integrations/notification-incidents/pagerduty/index.mdx b/docs/organization/integrations/notification-incidents/pagerduty/index.mdx index d08c8beae8822..7b80cb55bd766 100644 --- a/docs/organization/integrations/notification-incidents/pagerduty/index.mdx +++ b/docs/organization/integrations/notification-incidents/pagerduty/index.mdx @@ -8,11 +8,11 @@ The PagerDuty integration allows you to connect your Sentry organization with on ## Install - + Sentry owner, manager, or admin permissions are required to install this integration. - +> 1. Navigate to **Settings > Integrations > PagerDuty** diff --git a/docs/organization/integrations/notification-incidents/pagertree/index.mdx b/docs/organization/integrations/notification-incidents/pagertree/index.mdx index 08bc8f6396e00..8e7cbfa158237 100644 --- a/docs/organization/integrations/notification-incidents/pagertree/index.mdx +++ b/docs/organization/integrations/notification-incidents/pagertree/index.mdx @@ -7,11 +7,11 @@ description: "Learn about Sentry's PagerTree integration, which can be used to s This integration is maintained and supported by the company that created it. For more details, or questions, please feel free to reach out to support@pagertree.com. ## Install and Configure - + Sentry owner, manager, or admin permissions are required to install this integration. - +> 1. Navigate to **Settings > Integrations > PagerTree** diff --git a/docs/organization/integrations/notification-incidents/rootly/index.mdx b/docs/organization/integrations/notification-incidents/rootly/index.mdx index a66741566e0f0..31c5f2307f2e5 100644 --- a/docs/organization/integrations/notification-incidents/rootly/index.mdx +++ b/docs/organization/integrations/notification-incidents/rootly/index.mdx @@ -10,13 +10,13 @@ This integration is maintained and supported by the company that created it. For ## Install and Configure - + Sentry owner, manager, or admin permissions are required to install this integration. Rootly **won't** work with self-hosted Sentry. - +> 1. Navigate to **Settings > Integrations > Rootly** diff --git a/docs/organization/integrations/notification-incidents/signl4/index.mdx b/docs/organization/integrations/notification-incidents/signl4/index.mdx index b36d77287cb0b..31d25339eb7eb 100644 --- a/docs/organization/integrations/notification-incidents/signl4/index.mdx +++ b/docs/organization/integrations/notification-incidents/signl4/index.mdx @@ -9,11 +9,11 @@ SIGNL4 is a mobile alerting, and incident response service. This integration is ## Install and Configure - + Sentry owner, manager, or admin permissions are required to install this integration. - +> 1. Navigate to **Settings > Integrations > SIGNL4** diff --git a/docs/organization/integrations/notification-incidents/slack/index.mdx b/docs/organization/integrations/notification-incidents/slack/index.mdx index d41f8a4eeff6b..58e6c4ae62c05 100644 --- a/docs/organization/integrations/notification-incidents/slack/index.mdx +++ b/docs/organization/integrations/notification-incidents/slack/index.mdx @@ -6,11 +6,11 @@ description: "Learn more about Sentry's Slack integration and how you can triage ## Install - + Sentry owner, manager, or admin permissions are required to install this integration. - +> Slack defaults to let any workspace member authorize apps, but they may have to request access. See this [Slack help article](https://get.slack.help/hc/en-us/articles/202035138-Add-an-app-to-your-workspace) for more details. diff --git a/docs/organization/integrations/notification-incidents/spikesh/index.mdx b/docs/organization/integrations/notification-incidents/spikesh/index.mdx index 696377b9d9a08..1a0b1b8baf0ce 100644 --- a/docs/organization/integrations/notification-incidents/spikesh/index.mdx +++ b/docs/organization/integrations/notification-incidents/spikesh/index.mdx @@ -10,13 +10,13 @@ This integration is maintained and supported by the company that created it. For ## Install and Configure - + Sentry owner, manager, or admin permissions are required to install this integration. Spike.sh **won't** work with self-hosted Sentry. - +> 1. Navigate to **Settings > Integrations > Spike.sh** diff --git a/docs/organization/integrations/session-replay/atlas/index.mdx b/docs/organization/integrations/session-replay/atlas/index.mdx index 4eec26707a202..d4baae6672e64 100644 --- a/docs/organization/integrations/session-replay/atlas/index.mdx +++ b/docs/organization/integrations/session-replay/atlas/index.mdx @@ -10,13 +10,13 @@ This integration is maintained and supported by the company that created it. For ## Install and Configure - + Sentry owner, manager, or admin permissions are required to install this integration. Atlas **won't** work with self-hosted Sentry. - +> 1. Navigate to **App Configuration > Sentry** in Atlas diff --git a/docs/organization/integrations/session-replay/betterbugs.mdx b/docs/organization/integrations/session-replay/betterbugs.mdx index 7894ed0bee4fb..13fdfab5dcf26 100644 --- a/docs/organization/integrations/session-replay/betterbugs.mdx +++ b/docs/organization/integrations/session-replay/betterbugs.mdx @@ -5,15 +5,15 @@ description: "Learn about Sentry's BetterBugs integration." --- BetterBugs + Sentry integration connects your Sentry infrastructure to your BetterBugs account. You get Sentry event logs (both frontend and backend) auto-attached to every bug report. -This integration is maintained and supported by the company that created it. +This integration is maintained and supported by the company that created it. ## Install and Configure - + Sentry owner or manager permissions are required to install this integration. - +> 1. Navigate to Settings > Integrations > BetterBugs diff --git a/docs/organization/integrations/session-replay/index.mdx b/docs/organization/integrations/session-replay/index.mdx index 3338f39158baa..23d5424862a80 100644 --- a/docs/organization/integrations/session-replay/index.mdx +++ b/docs/organization/integrations/session-replay/index.mdx @@ -4,11 +4,11 @@ sidebar_order: 70 description: "Learn more about third-party session replay integrations." --- - + Looking for Sentry's built-in Session Replay product? Click here to learn more. - +> - [Atlas](/organization/integrations/session-replay/atlas/) - [BetterBugs](/organization/integrations/session-replay/betterbugs/) diff --git a/docs/organization/integrations/session-replay/jam.mdx b/docs/organization/integrations/session-replay/jam.mdx index 406e29c819aee..9ddf120e00642 100644 --- a/docs/organization/integrations/session-replay/jam.mdx +++ b/docs/organization/integrations/session-replay/jam.mdx @@ -10,10 +10,10 @@ The Jam Sentry integration gives you visibility of a bug from the frontend (capt ## Install and Configure - + Sentry owner or manager permissions are required to install this integration. - +> You can find [installation instructions here](https://jam.dev/docs/integrations/sentry). diff --git a/docs/organization/integrations/source-code-mgmt/bitbucket/index.mdx b/docs/organization/integrations/source-code-mgmt/bitbucket/index.mdx index b196b00f5df3e..9ab4bf933490c 100644 --- a/docs/organization/integrations/source-code-mgmt/bitbucket/index.mdx +++ b/docs/organization/integrations/source-code-mgmt/bitbucket/index.mdx @@ -6,11 +6,11 @@ description: "Learn more about Sentry's Bitbucket integration and how it can tra ## Install - + Sentry owner, manager, or admin permissions, and Bitbucket admin permissions are required to install this integration. - +> 1. Navigate to **Settings > Integrations > Bitbucket**. @@ -168,11 +168,11 @@ When Sentry sees this, we’ll automatically annotate the matching issue with re ### Stack Trace Linking - +> This feature is currently only supported for Ruby, Python, Php, Node, JavaScript, Go and Elixir. - +> Stack trace linking takes you from a file in your Sentry stack trace to that same file in your source code. If you have commit tracking set up in Sentry, we can take you to the exact version (using the commit associated with the event) of the source code when the error occurred. Otherwise we'll link you to the current state of the source code (using the default branch). @@ -193,11 +193,11 @@ Stack trace linking takes you from a file in your Sentry stack trace to that sam #### Stack Trace Root and Source Code Root - +> The following information is only valid for platforms which use traditional file paths. Platforms with package names require additional steps. For **Java**, read more in the [page on source context](/platforms/java/source-context#setting-up-code-mappings). - +> First, navigate to a stack trace that you wish to map. Find an **In App** frame, which is denoted by a bubble on the right side of the frame. The filename will be shown as the first piece of text at the left hand side of the frame header. In this example, it is `src/main.py`. diff --git a/docs/organization/integrations/source-code-mgmt/github/index.mdx b/docs/organization/integrations/source-code-mgmt/github/index.mdx index c88d5303fadf8..134c96ca15cd5 100644 --- a/docs/organization/integrations/source-code-mgmt/github/index.mdx +++ b/docs/organization/integrations/source-code-mgmt/github/index.mdx @@ -10,11 +10,11 @@ Self-hosted GitHub Enterprise accounts typically have URLs that look more like ` ## Install - + Sentry owner, manager, or admin permissions, and GitHub owner permissions are required to install this integration. - +> 1. Navigate to **Settings > Integrations > [GitHub](https://sentry.io/orgredirect/organizations/:orgslug/settings/integrations/github)**. @@ -36,12 +36,12 @@ The GitHub integration is available for all projects under your Sentry organizat ## GitHub Enterprise - +> If your GitHub Enterprise instance is self-hosted/on-prem, follow the instructions below. If you're using GitHub Enterprise Cloud, follow the [instructions for GitHub](/organization/integrations/source-code-mgmt/github/#install). - +> #### Add new GitHub App @@ -296,11 +296,11 @@ By default, this feature is automatically enabled once your GitHub integration h ### Stack Trace Linking - +> Sentry will automatically try to set up code mappings on C#, Go, JavaScript, Node.js, PHP, Python, and Ruby projects for organizations with the GitHub integration installed. If your project uses a different SDK, you can add code mappings manually. Support for other languages and other source code integrations is being worked on. - +> Stack trace linking takes you from a file in your Sentry stack trace to that same file in your source code. If you have commit tracking set up in Sentry, we can take you to the exact version (using the commit associated with the event) of the source code when the error occurred. Otherwise we'll link you to the current state of the source code (using the default **branch**). @@ -321,11 +321,11 @@ Stack trace linking takes you from a file in your Sentry stack trace to that sam #### Stack Trace Root and Source Code Root - +> The following information is only valid for platforms which use traditional file paths. Platforms with package names require additional steps. For **Java**, read more in the [page on source context](/platforms/java/source-context#setting-up-code-mappings). - +> First, navigate to a stack trace that you wish to map. Find an **In App** frame, which is denoted by a bubble on the right side of the frame. The filename will be shown as the first piece of text at the left hand side of the frame header. In this example, it is `src/main.py`. diff --git a/docs/organization/integrations/source-code-mgmt/gitlab/index.mdx b/docs/organization/integrations/source-code-mgmt/gitlab/index.mdx index db81df23187b0..9670983c10b36 100644 --- a/docs/organization/integrations/source-code-mgmt/gitlab/index.mdx +++ b/docs/organization/integrations/source-code-mgmt/gitlab/index.mdx @@ -6,11 +6,11 @@ description: "Learn more about Sentry’s GitLab integration and how it helps yo ## Install - + Sentry owner, manager, or admin permissions and GitLab owner or maintainer permissions are required to install this integration. - +> 1. Navigate to **Settings > Integrations > GitLab**. @@ -108,11 +108,11 @@ A `` may look something like 'BACKEND-C' in the image below. ### Stack Trace Linking - +> This feature is currently only supported for Ruby, Python, Php, Node, JavaScript, Go and Elixir. - +> Stack trace linking takes you from a file in your Sentry stack trace to that same file in your source code. If you have commit tracking set up in Sentry, we can take you to the exact version (using the commit associated with the event) of the source code when the error occurred. Otherwise we'll link you to the current state of the source code (using the default **branch**). @@ -133,11 +133,11 @@ Stack trace linking takes you from a file in your Sentry stack trace to that sam #### Stack Trace Root and Source Code Root - +> The following information is only valid for platforms which use traditional file paths. Platforms with package names (such as **Java**, **Cocoa**, and **Flutter**) require additional steps. - +> First, navigate to a stack trace that you wish to map. Find an **In App** frame, which is denoted by a bubble on the right side of the frame. The filename will be shown as the first piece of text at the left hand side of the frame header. In this example, it is `src/main.py`. diff --git a/docs/organization/membership/index.mdx b/docs/organization/membership/index.mdx index 9ee7d86eea0f0..7374298a10c36 100644 --- a/docs/organization/membership/index.mdx +++ b/docs/organization/membership/index.mdx @@ -18,11 +18,11 @@ All users and their organization-level roles are listed in **Settings > Members* - **Org Managers** have full management access to all teams and projects. They can also manage the organization's membership. Org Managers can perform Team Admin actions without needing to join the team. - **Org Owners** have full access to the organization, its data, and settings. Org Owners can perform Team Admin actions without needing to join the team. - + For Business and Enterprise plans, the Org Admin role has been replaced by Team Admins and can no longer be assigned to new users. Existing users with Org Admin roles will retain their admin privileges. - +> ### Permissions @@ -55,11 +55,11 @@ Organization-level roles enable broad access to the entire organization, as desc ## Team-level Roles - +> Team-level roles are only available for Business and Enterprise accounts. - +> All members of a specific team and their team-level roles are listed in **Settings > Teams > [Team] > Members**. Alternatively, go to **Settings > Members > [Member]** to see a specific member's teams and team-level roles. @@ -118,9 +118,9 @@ Projects can only be accessed by that project's team(s). Team Admins, Org Manage Any Org Member can get access to a project by joining the team that's associated with that project. Once you've joined a project you'll also be able to edit [ownership rules](/product/issues/ownership-rules/) for that project. ### Adding New Members - +> This feature is currently only available for [Early Adopters](/organization/early-adopter-features/). - +> Users with Manager and Owner-level permissions can add, remove, and change members for a project or organization. They can also toggle on the "Let Members Invite Others" setting to allow any org member to freely invite anyone they like without needing org owner or manager approval. diff --git a/docs/platforms/apple/common/configuration/app-hangs.mdx b/docs/platforms/apple/common/configuration/app-hangs.mdx index 862859fd3dbe3..56878b1f3e96f 100644 --- a/docs/platforms/apple/common/configuration/app-hangs.mdx +++ b/docs/platforms/apple/common/configuration/app-hangs.mdx @@ -4,7 +4,7 @@ sidebar_order: 11 description: "Learn about how to add app hang detection reporting." --- - + We recommend disabling this feature for Widgets and Live Activities because it might detect false positives. @@ -12,7 +12,7 @@ Furthermore, the Cocoa SDK might report app hangs when the OS opens a system dia such as whether the user wants to allow your app to paste from the clipboard. As we can't reliably detect these scenarios, we advise you to [pause and resume tracking app hangs](#pause-and-resume-app-hang-tracking) to circumvent this problem. - +> This integration tracks app hangs. This feature is available on iOS, tvOS, and macOS. @@ -133,11 +133,11 @@ SentrySDK.resumeAppHangTracking() ### App Hangs V2 - +> This feature is experimental and may have bugs. - +> As of version 8.39.0-beta.1, you can enable AppHangsV2, which is available on iOS and tvOS. The main difference is that AppHangsV2 differentiates between fully-blocking and non-fully-blocking app hangs, which you might choose to ignore. A fully-blocking app hang is when the main thread is stuck completely, and the app can't render a single frame. A non-fully-blocking app hang is when the app appears stuck to the user, but can still render a few frames. Fully-blocking app hangs are more actionable because the stacktrace shows the exact blocking location on the main thread. Non-fully-blocking app hangs can have a stacktrace that doesn't highlight the exact blocking location, since the main thread isn't completely blocked. diff --git a/docs/platforms/apple/common/configuration/options.mdx b/docs/platforms/apple/common/configuration/options.mdx index 68a691c4dd90d..91e972ac300ea 100644 --- a/docs/platforms/apple/common/configuration/options.mdx +++ b/docs/platforms/apple/common/configuration/options.mdx @@ -104,11 +104,11 @@ It's crucial for developers to understand that the OS sends a SIGTERM to their a If this flag is enabled, certain personally identifiable information (PII) is added by active integrations. By default, no such data is sent. - + If you are using Sentry in your mobile app, read our [frequently asked questions about mobile data privacy](/security-legal-pii/security/mobile-privacy/) to assist with Apple App Store and Google Play app privacy details. - +> This option is turned off by default. @@ -275,11 +275,11 @@ If is not provided, trac - +> This feature is experimental, may have bugs and is new in [sentry-cocoa version 8.41.0](https://github.com/getsentry/sentry-cocoa/blob/main/CHANGELOG.md#8410). - +> When enabled, the SDK finishes the ongoing transaction bound to the scope and links them to the crash event when your app crashes. The SDK skips adding profiles to increase the chance of keeping the transaction. This option defaults to `false`. diff --git a/docs/platforms/apple/common/configuration/releases.mdx b/docs/platforms/apple/common/configuration/releases.mdx index 8d466776a0610..7786cabca214e 100644 --- a/docs/platforms/apple/common/configuration/releases.mdx +++ b/docs/platforms/apple/common/configuration/releases.mdx @@ -29,11 +29,11 @@ The value can be arbitrary, but we recommend either of these naming strategies: - `build` is the number that identifies an iteration of your app (`CFBundleVersion` on iOS, `versionCode` on Android) - **Commit SHA**: If you use a version control system like Git, we recommend using the identifying hash (for example, the commit SHA, `da39a3ee5e6b4b0d3255bfef95601890afd80709`). You can let Sentry CLI automatically determine this hash for supported version control systems. Learn more in our [Sentry CLI](/cli/releases/#creating-releases) documentation. - + Releases are global per organization; prefix them with something project-specific for easy differentiation. - +> The behavior of a few features depends on whether a project is using semantic or time-based versioning. @@ -62,11 +62,11 @@ After configuring your SDK, you can install a repository integration or manually Monitor the [health of releases](/product/releases/health/) by observing user adoption, usage of the application, percentage of [crashes](/product/releases/health/#crash), and [session data](/product/releases/health/#session). Release health will provide insight into the impact of crashes and bugs as it relates to user experience, and reveal trends with each new issue through the [Release Details](/product/releases/release-details/) graphs and filters. - +> Crash reporting and app hang detection are not available for watchOS. - +> In order to monitor release health, the SDK sends session data. diff --git a/docs/platforms/apple/common/configuration/sampling.mdx b/docs/platforms/apple/common/configuration/sampling.mdx index bc66495c36665..f9226c37f149c 100644 --- a/docs/platforms/apple/common/configuration/sampling.mdx +++ b/docs/platforms/apple/common/configuration/sampling.mdx @@ -14,11 +14,11 @@ To send a representative sample of your errors to Sentry, set the + Changing the error sample rate requires re-deployment. In addition, setting an SDK sample rate limits visibility into the source of events. Setting a rate limit for your project (which only drops events when volume is high) may better suit your needs. - +> ## Sampling Transaction Events diff --git a/docs/platforms/apple/common/configuration/watchdog-terminations.mdx b/docs/platforms/apple/common/configuration/watchdog-terminations.mdx index 29eaef459a6a4..bba096b22d55c 100644 --- a/docs/platforms/apple/common/configuration/watchdog-terminations.mdx +++ b/docs/platforms/apple/common/configuration/watchdog-terminations.mdx @@ -4,21 +4,21 @@ sidebar_order: 10 description: "Learn how to turn off Watchdog Termination tracking" --- - + This integration is available since version 8.0.0 of Sentry Apple SDK. It was named{" "} Out of Memory{" "} before the 8.0.0 release. - +> This integration tracks [watchdog terminations](https://developer.apple.com/documentation/xcode/addressing-watchdog-terminations) based on heuristics. This feature is available for iOS, tvOS, and Mac Catalyst, works only if the application was in the foreground, and doesn't track watchdog terminations for unit tests. When a typical unhandled error occurs, the Apple SDK writes a report to disk before the app terminates. It includes the current state of your application with details like the stack trace, tags, breadcrumbs, and so on. The watchdog terminates your app without notice, which means the SDK can't write a report to disk. -A common reason for the watchdog to terminate your app is an Out Of Memory problem. +A common reason for the watchdog to terminate your app is an Out Of Memory problem. -Note, that there are some security-related types of crashes where the OS immediately terminates the app. These are usually infrequent, and include stack buffer overflows or exceptions with a termination reason related to code signing. Third-party libraries like Sentry can't report these incidents. +Note, that there are some security-related types of crashes where the OS immediately terminates the app. These are usually infrequent, and include stack buffer overflows or exceptions with a termination reason related to code signing. Third-party libraries like Sentry can't report these incidents. Those types of crashes can sometimes be visible in the [Xcode Organizer](https://developer.apple.com/documentation/xcode/acquiring-crash-reports-and-diagnostic-logs), though. If the app is terminated because it hangs, we won't create a watchdog termination event. An `AppHangs` event will be created instead. diff --git a/docs/platforms/apple/common/data-management/apple-privacy-manifest.mdx b/docs/platforms/apple/common/data-management/apple-privacy-manifest.mdx index dbd9209cde7e8..37891625261a7 100644 --- a/docs/platforms/apple/common/data-management/apple-privacy-manifest.mdx +++ b/docs/platforms/apple/common/data-management/apple-privacy-manifest.mdx @@ -4,15 +4,15 @@ description: "Troubleshoot and resolve common issues with the Apple Privacy Mani sidebar_order: 50 --- - + This guide requires [sentry-cocoa@8.25.0](https://github.com/getsentry/sentry-cocoa/releases/tag/8.25.0) or newer. - +> Sentry's SDKs provide error and tracing for mobile applications running on Apple devices. To do this, the SDK needs to access certain information about the device and the application. Some of the APIs required for this are considered privacy-relevant by Apple. In order to submit apps to the App Store, Apple requires all apps - and libraries used within these apps - to provide privacy manifest files stating which APIs are used under which allowed reasons. For more details, read Apple's guidelines on [Describing use of required reason API](https://developer.apple.com/documentation/bundleresources/privacy_manifest_files/describing_use_of_required_reason_api). - +> The information and steps in this guide are still being worked on and might change because of new tools or updated [Apple requirements](https://developer.apple.com/documentation/bundleresources/privacy_manifest_files). - +> If you are using dynamically linked frameworks, Apple will automatically process the SDK's privacy manifest. If you are using statically linked libraries, you need to provide the privacy manifest yourself. This guide will help you create the privacy manifest for your applications. diff --git a/docs/platforms/apple/common/data-management/debug-files/identifiers/index.mdx b/docs/platforms/apple/common/data-management/debug-files/identifiers/index.mdx index aebce9d77c759..c66167aa1a0a3 100644 --- a/docs/platforms/apple/common/data-management/debug-files/identifiers/index.mdx +++ b/docs/platforms/apple/common/data-management/debug-files/identifiers/index.mdx @@ -24,14 +24,14 @@ compute a _Debug Identifier_ for each uploaded file. This identifier is associated with executables and libraries as well as debug companions to ensure that they can be uniquely located via one common mechanism. - + Debug information does not have to be associated with releases. The unique debug identifier ensures that Sentry can choose the right files for every crash report. However, it is still recommended to configure releases in the client to benefit from other features. - +> For native events, the issue details page displays a list of _Loaded Images_. This list contains the executable and all loaded dynamic libraries including diff --git a/docs/platforms/apple/common/data-management/debug-files/index.mdx b/docs/platforms/apple/common/data-management/debug-files/index.mdx index b5a401b9febf2..68d9d758dae78 100644 --- a/docs/platforms/apple/common/data-management/debug-files/index.mdx +++ b/docs/platforms/apple/common/data-management/debug-files/index.mdx @@ -24,12 +24,12 @@ the following formats: - [_ProGuard mappings_](./file-formats/#proguard-mappings) for Java and Android - + Source maps, while also being debug information files, are handled differently in Sentry. For more information see [Source Maps in sentry-cli](/cli/releases/#sentry-cli-sourcemaps). - +> Sentry requires access to debug information files of your application as well as system libraries to provide fully symbolicated crash reports. You can either @@ -46,11 +46,11 @@ for automatic downloads. From the [Project Details](/product/projects/project-details/) page, click into settings, then click on _Debug Files_ in the page navigation. - +> ProGuard files are listed separately, in the _ProGuard_ section of the project settings page. - +> ## Retention Policy diff --git a/docs/platforms/apple/common/data-management/sensitive-data/index.mdx b/docs/platforms/apple/common/data-management/sensitive-data/index.mdx index 8b5526b2680e9..5e508053de283 100644 --- a/docs/platforms/apple/common/data-management/sensitive-data/index.mdx +++ b/docs/platforms/apple/common/data-management/sensitive-data/index.mdx @@ -23,13 +23,13 @@ We offer the following options depending on your legal and operational needs: - [configuring server-side scrubbing](/security-legal-pii/scrubbing/server-side-scrubbing/) to ensure Sentry does _not store_ data. Configuration changes are done in the Sentry UI and apply immediately for new events. - [running a local Relay](/product/relay/) on your own server between the SDK and Sentry, so that data is _not sent to_ Sentry while configuration can still be applied without deploying. - + Ensure that your team is aware of your company's policy around what can and cannot be sent to Sentry. We recommend determining this policy early in your implementation and communicating it as well as enforcing it via code review. If you are using Sentry in your mobile app, read our [frequently asked questions about mobile data privacy](/security-legal-pii/security/mobile-privacy/) to assist with Apple App Store and Google Play app privacy details. - +> If you _do not_ wish to use the default PII behavior, you can also choose to identify users in a more controlled manner, using our [user identity context](../../enriching-events/identify-user/). diff --git a/docs/platforms/apple/common/enriching-events/attachments/index.mdx b/docs/platforms/apple/common/enriching-events/attachments/index.mdx index 9cb01f9a02d9e..fe81280a99d53 100644 --- a/docs/platforms/apple/common/enriching-events/attachments/index.mdx +++ b/docs/platforms/apple/common/enriching-events/attachments/index.mdx @@ -45,19 +45,19 @@ The specific media content type that determines how the attachment is rendered i Attachments live on the Scope. You can either add an attachment on the global scope to be sent with every event or add it on the local Scope to just send the attachment with one specific event. - + Adding attachments to crashes is currently not supported. - +> - +> Sentry allows at most 20MB for a compressed request, and at most 100MB of uncompressed attachments per event, including the crash report file (if applicable). Uploads exceeding this size are rejected with HTTP error `413 Payload Too Large` and the data is dropped immediately. To add larger or more files, consider secondary storage options. - +> Attachments persist for 30 days; if your total storage included in your quota is exceeded, attachments will not be stored. You can delete attachments or their containing events at any time. Deleting an attachment does not affect your quota - Sentry counts an attachment toward your quota as soon as it is stored. diff --git a/docs/platforms/apple/common/enriching-events/context/index.mdx b/docs/platforms/apple/common/enriching-events/context/index.mdx index dd07e216bbb9f..61e9904c92205 100644 --- a/docs/platforms/apple/common/enriching-events/context/index.mdx +++ b/docs/platforms/apple/common/enriching-events/context/index.mdx @@ -7,11 +7,11 @@ Custom contexts allow you to attach arbitrary data to an event. Often, this cont - + If you need to be able to search on custom data, [use tags](../tags) instead. - +> ## Structured Context diff --git a/docs/platforms/apple/common/enriching-events/identify-user/index.mdx b/docs/platforms/apple/common/enriching-events/identify-user/index.mdx index e5649a7fcdfa4..d69589209fef4 100644 --- a/docs/platforms/apple/common/enriching-events/identify-user/index.mdx +++ b/docs/platforms/apple/common/enriching-events/identify-user/index.mdx @@ -9,11 +9,11 @@ Users consist of a few critical pieces of information that construct a unique id ### `userId` - + If you don't provide a `userId`, the SDK falls back to `installationId`, which the SDK randomly generates once during an app's installation. - +> Your internal identifier for the user. diff --git a/docs/platforms/apple/common/enriching-events/screenshots/index.mdx b/docs/platforms/apple/common/enriching-events/screenshots/index.mdx index 79f9b0ce16cb3..c8644ef518c67 100644 --- a/docs/platforms/apple/common/enriching-events/screenshots/index.mdx +++ b/docs/platforms/apple/common/enriching-events/screenshots/index.mdx @@ -14,9 +14,9 @@ Sentry makes it possible to automatically take a screenshot and include it as an This feature is only available for SDKs with a user interface, like the ones for mobile and desktop applications. It's also limited by whether taking a screenshot is possible or not. For example, in some environments, like native iOS, taking a screenshot requires the UI thread, which often isn't available in the event of a crash. Another example where a screenshot might not be available is when the event happens before the screen starts to load. So inherently, this feature is a best effort solution. - + App hang events won't have a screenshot because the main thread is blocked and Sentry can't interact with UI elements in a background view. - +> ## Enabling Screenshots diff --git a/docs/platforms/apple/common/enriching-events/tags/index.mdx b/docs/platforms/apple/common/enriching-events/tags/index.mdx index 5707e7b98110c..fce84a22ffbbe 100644 --- a/docs/platforms/apple/common/enriching-events/tags/index.mdx +++ b/docs/platforms/apple/common/enriching-events/tags/index.mdx @@ -17,11 +17,11 @@ Define the tag: - + Some tags are automatically set by Sentry. We strongly recommend against overwriting these [tags](/concepts/search/searchable-properties/#search-properties). Instead, name your tags with your organization's nomenclature. If you overwrite an automatically set tag, you must use [explicit tag syntax](/concepts/search/#explicit-tag-syntax) to search for it. - +> Once you've started sending tagged data, you'll see it when logged in to sentry.io. There, you can view the filters within the sidebar on the Project page, summarized within an event, and on the Tags page for an aggregated event. diff --git a/docs/platforms/apple/common/enriching-events/viewhierarchy/index.mdx b/docs/platforms/apple/common/enriching-events/viewhierarchy/index.mdx index 74f77e62fb306..be453424b0a1e 100644 --- a/docs/platforms/apple/common/enriching-events/viewhierarchy/index.mdx +++ b/docs/platforms/apple/common/enriching-events/viewhierarchy/index.mdx @@ -14,15 +14,15 @@ Sentry makes it possible to render a JSON representation of the view hierarchy o This feature only applies to SDKs with a user interface, such as the ones for mobile and desktop applications. In some environments like native iOS, rendering the view hierarchy requires the UI thread and in the event of a crash, that might not be available. Another example where the view hierarchy might not be available is when the event happens before the screen starts to load. So inherently, this feature is a best effort solution. - + App hang events will not have view hierarchy because the main thread is blocked and Sentry can't interact with UI elements in a background view. - +> - +> Deobfuscation for view hierarchies is fully supported for native SDKs, and React Native, but is currently not supported for Flutter. View hierarchies are not supported for SwiftUI. - +> ## Enabling View Hierarchy Attachments @@ -61,4 +61,4 @@ View hierarchies appear in the "Attachments" tab, where you can view all attachm On the **Issue Details** page, you can interact with the view hierarchy attachment in a section called "View Hierarchy". This section represents the state of your application at the time of an error event. There are three displays: a tree view, wireframe, and detailed view for a selected node. You can select nodes in either the tree or the wireframe to view the properties collected by the SDK. The SDK will report on the following keys for each node in the view: `alpha`, `visible`, `x`, `y`, `width`, `height`, `type`, and `identifier` if applicable, but there may be additional values specific to the SDK. This feature can be used as an exploratory tool to debug layout issues, visualize unnecessarily rendered content, or gain a better understanding of the relationship between views. - \ No newline at end of file + diff --git a/docs/platforms/apple/common/features/experimental-features.mdx b/docs/platforms/apple/common/features/experimental-features.mdx index 40a7001e63a28..a03a147c6662c 100644 --- a/docs/platforms/apple/common/features/experimental-features.mdx +++ b/docs/platforms/apple/common/features/experimental-features.mdx @@ -14,10 +14,10 @@ Do you want to try some new experimental features? On the latest version of the - If you use Swift concurrency, stitch together stack traces of your async code with the `swiftAsyncStacktraces` option. Note that you can enable this in your Objective-C project, but only async code written in Swift will be stitched together. - Enable AppHangsV2 to get more detailed app hangs. The main difference is that AppHangsV2 differentiates between fully-blocking and non-fully-blocking app hangs. - + Experimental features are still a work-in-progress and may have bugs. We recognize the irony. - +> ```swift {tabTitle:Swift} import Sentry diff --git a/docs/platforms/apple/common/features/index.mdx b/docs/platforms/apple/common/features/index.mdx index 755cd8a3f6030..711683d4a22ec 100644 --- a/docs/platforms/apple/common/features/index.mdx +++ b/docs/platforms/apple/common/features/index.mdx @@ -6,11 +6,11 @@ description: "Here's a list of Sentry's Apple SDK features." Sentry's Apple SDK enables automatic reporting of errors and exceptions, and identifies performance issues in your application. - + The SDK builds a crash report that persists to disk. While it attempts to send the report right after the crash, it may not always work because the environment may be unstable at the time of the crash. If this is the case, the report will be sent upon application start. - +> **Features:** diff --git a/docs/platforms/apple/common/index.mdx b/docs/platforms/apple/common/index.mdx index 78ba49ba5e5be..edcb4ffcada8f 100644 --- a/docs/platforms/apple/common/index.mdx +++ b/docs/platforms/apple/common/index.mdx @@ -1,10 +1,10 @@ On this page, we get you up and running with Sentry's Apple SDK, which will automatically report errors and exceptions in your application. - + If you don't already have an account and Sentry project established, head over to [sentry.io](https://sentry.io/signup/), then return to this page. - +> @@ -232,11 +232,11 @@ struct SwiftUIApp: App { Verify that your app is sending events to Sentry by adding the following snippet, which includes an intentional error. You should see the error reported in Sentry within a few minutes. - +> To verify crashes, ensure you run your application without a debugger attached. Otherwise, the SDK won't capture the crash. - +> ```swift {tabTitle:Swift} import Sentry diff --git a/docs/platforms/apple/common/install/swift-package-manager.mdx b/docs/platforms/apple/common/install/swift-package-manager.mdx index 6d9e346878220..a7f16cddd1c1e 100644 --- a/docs/platforms/apple/common/install/swift-package-manager.mdx +++ b/docs/platforms/apple/common/install/swift-package-manager.mdx @@ -16,10 +16,10 @@ You will then be prompted to choose one of the options `Sentry`, `Sentry-Dynamic - `Sentry-Dynamic` is the dynamic framework. - `SentrySwiftUI` is used to track performance of SwiftUI views, see more information in the [docs](https://docs.sentry.io/platforms/apple/guides/ios/tracing/instrumentation/swiftui-instrumentation/). - + Xcode allows you to choose many options, but you should choose only one of the options above. - +> Alternatively, when your project uses a `Package.swift` file to manage dependencies, you can specify the target with: @@ -27,8 +27,8 @@ Alternatively, when your project uses a `Package.swift` file to manage dependenc .package(url: "https://github.com/getsentry/sentry-cocoa", from: "{{@inject packages.version('sentry.cocoa') }}"), ``` - +> Version tags or branches need to have the Package.swift file in it or Xcode won't be able to install the package. This means versions previous to `4.4.3` _cannot_ be installed using SPM. - + > diff --git a/docs/platforms/apple/common/integrations/default.mdx b/docs/platforms/apple/common/integrations/default.mdx index 5c7b4f435d8de..fccf563b6c94a 100644 --- a/docs/platforms/apple/common/integrations/default.mdx +++ b/docs/platforms/apple/common/integrations/default.mdx @@ -11,17 +11,17 @@ System integrations are enabled by default to integrate into the standard librar This integration is the core part of the SDK. It hooks into all signal and exception handlers to capture uncaught errors or crashes. This integration is also responsible for adding most of the device information to events. If it is disabled, you will not receive crash reports, nor will events contain much device data. - + Crash detection is not available for watchOS, and Mach exceptions are not reported on tvOS. - +> - +> Signal and exception handlers can't be installed if a debugger is attached. To test crashes locally, ensure that you've unchecked the "Debug executable" option in the Xcode scheme's Run action for your app. - +> ### SentryAutoBreadcrumbTrackingIntegration diff --git a/docs/platforms/apple/common/metrics/index.mdx b/docs/platforms/apple/common/metrics/index.mdx index d72d189cdd736..8f8f71a5ab0a7 100644 --- a/docs/platforms/apple/common/metrics/index.mdx +++ b/docs/platforms/apple/common/metrics/index.mdx @@ -7,11 +7,11 @@ sidebar_hidden: true - + Metrics are supported with Sentry Cocoa SDK version `8.23.0` and above. - +> Sentry metrics help you pinpoint and solve issues that impact user experience and app performance by measuring the data points that are important to you. You can track things like processing time, event size, user signups, and conversion rates, then correlate them back to tracing data in order to get deeper insights and solve issues faster. diff --git a/docs/platforms/apple/common/profiling/index.mdx b/docs/platforms/apple/common/profiling/index.mdx index 52803d47e39b1..f7aeb7f2aaaba 100644 --- a/docs/platforms/apple/common/profiling/index.mdx +++ b/docs/platforms/apple/common/profiling/index.mdx @@ -44,11 +44,11 @@ By default, some transactions will be created automatically for common operation ## Enable Profiling - + iOS profiling is available starting in SDK version `8.12.0`. - +> ```swift {tabTitle:Swift} @@ -73,19 +73,19 @@ SentrySDK.start { options in }]; ``` - +> The setting is _relative_ to the setting. - +> ## Enable Launch Profiling - +> This feature is experimental and may have bugs. - +> _(New in version 8.21.0)_ @@ -99,17 +99,17 @@ Currently, launch profiles are attached to a special performance transaction ope ## Continuous Profiling - +> This feature is experimental and may have bugs. - +> _(New in version 8.36.0)_ The current profiling implementation stops the profiler automatically after 30 seconds (unless you manually stop it earlier). Naturally, this limitation makes it difficult to get full coverage of your app's execution. We now offer an experimental continuous mode, where profiling data is periodically uploaded while running, with no limit to how long the profiler may run. -Previously, profiles only ran in tandem with performance transactions that were started either automatically or manually with `SentrySDK.startTransaction`. Now, you can start and stop the profiler directly with `SentrySDK.startProfiler` and `SentrySDK.stopProfiler`. You can also start a profile at app launch by setting `SentryOptions.enableAppLaunchProfiling = true` in your call to `SentrySDK.startWithOptions`. +Previously, profiles only ran in tandem with performance transactions that were started either automatically or manually with `SentrySDK.startTransaction`. Now, you can start and stop the profiler directly with `SentrySDK.startProfiler` and `SentrySDK.stopProfiler`. You can also start a profile at app launch by setting `SentryOptions.enableAppLaunchProfiling = true` in your call to `SentrySDK.startWithOptions`. Continuous profiling mode is enabled by default, requiring no changes to `SentryOptions` when you start the SDK to opt in. If you had previously set `SentryOptions.profilesSampleRate` or `SentryOptions.profilesSampler` to use transaction-based profiling, then remove those lines of code from your configuration. diff --git a/docs/platforms/apple/common/tracing/instrumentation/automatic-instrumentation.mdx b/docs/platforms/apple/common/tracing/instrumentation/automatic-instrumentation.mdx index c392e27fcb05d..7695cb507b578 100644 --- a/docs/platforms/apple/common/tracing/instrumentation/automatic-instrumentation.mdx +++ b/docs/platforms/apple/common/tracing/instrumentation/automatic-instrumentation.mdx @@ -4,7 +4,7 @@ sidebar_order: 10 description: "Learn what transactions are captured after tracing is enabled." --- - + Once you set up tracing, the SDK enables the following features by default: @@ -16,7 +16,7 @@ Once you set up tracing, the SDK ena - Core Data Tracing - User Interaction Tracing - +> ## UIViewController Tracing @@ -321,11 +321,11 @@ SentrySDK.start { options in The SDK composes the transaction name out of the host `UIViewController` and the method that the `UIView` is calling; for example, `YourApp_LoginUIViewController.loginButton`. The SDK sets the transaction operation to `ui.action`. If the SDK detects the interaction's origin was a click, it adds `click` as a suffix to the operation. The transaction finishes automatically after it reaches the specified [idleTimeout](/platforms/android/configuration/options/#idle-timeout) and all of its child spans are finished. The `idleTimeoout` defaults to `3000` milliseconds (three seconds). - +> If the UI transaction has idled but didn't have any child spans added, the SDK will drop it. - +> The SDK binds user interaction transactions to the `Scope` automatically if there's no other transaction set. Because of that, you can create spans using custom instrumentation, and those spans will be automatically associated with the running UI transaction. @@ -355,11 +355,11 @@ When the user interaction transaction is not finished yet, but the user makes a ## Time to Initial Display - +> This feature only works for UIViewControllers and not for SwiftUI. - +> By adding a span for a view controller when it's loaded, time to initial display (TTID) provides insight into how long it takes for your view controller to launch and draw its first UI frame. The SDK sets the span operation to `ui.load.initial-display` and the span description to the view controller's name, followed by `initial display` - for example, `MainViewController initial display`. @@ -371,11 +371,11 @@ Since Cocoa SDK version 8.33.0, the SDK doesn't create time to initial display ( ## Time to Full Display - +> This feature only works for UIViewControllers and not for SwiftUI. - +> By adding a span for a view controller when it's loaded, time to full display (TTFD) provides insight into how long it takes your view controller to launch and load all of its content. The span starts when the view of a view controller is loaded, and there is no other view controller transaction happening at the moment. The SDK sets the span operation to `ui.load.full-display` and the span description to the view controllers' name, followed by `full display` - for example, `MainActivity full display`. diff --git a/docs/platforms/apple/common/tracing/instrumentation/custom-instrumentation.mdx b/docs/platforms/apple/common/tracing/instrumentation/custom-instrumentation.mdx index 2d9a41622d610..2ce7ab182f70c 100644 --- a/docs/platforms/apple/common/tracing/instrumentation/custom-instrumentation.mdx +++ b/docs/platforms/apple/common/tracing/instrumentation/custom-instrumentation.mdx @@ -4,11 +4,11 @@ description: "Learn how to capture performance data on any action in your app." sidebar_order: 20 --- - + To capture transactions and spans customized to your organization's needs, you must first set up tracing. - +> diff --git a/docs/platforms/apple/common/tracing/instrumentation/swiftui-instrumentation.mdx b/docs/platforms/apple/common/tracing/instrumentation/swiftui-instrumentation.mdx index 671f098388e06..08fce77d9e19a 100644 --- a/docs/platforms/apple/common/tracing/instrumentation/swiftui-instrumentation.mdx +++ b/docs/platforms/apple/common/tracing/instrumentation/swiftui-instrumentation.mdx @@ -4,7 +4,9 @@ sidebar_order: 12 description: "Learn how to monitor the performance of your SwiftUI views." --- -This feature is stable since version 8.17.0. + +This feature is stable since version 8.17.0. + You can monitor the performance of your views in a SwiftUI project with the SentrySwiftUI library, which you can install via SPM (Swift package manager) or CocoaPods: diff --git a/docs/platforms/apple/common/tracing/trace-propagation/index.mdx b/docs/platforms/apple/common/tracing/trace-propagation/index.mdx index 4584f4b688ddf..38fc1cc03abb3 100644 --- a/docs/platforms/apple/common/tracing/trace-propagation/index.mdx +++ b/docs/platforms/apple/common/tracing/trace-propagation/index.mdx @@ -40,9 +40,9 @@ this down to only specific URLs, add those URLs to the `tracePropagationTargets` string and regexes). The SDK will then only attach the `sentry-trace` and `baggage` headers to outgoing requests whose destination either contains a string or matches a regex in your allowlist. - + The `tracePropagationTargets` option matches the entire request URL, not just the domain. Using stricter regex to match certain parts of the URL ensures that requests don't unnecessarily have additional headers attached. - +> Since the value of `tracePropagationTargets` is `['.*']` by default, tracing headers are attached to all requests unless otherwise specified. diff --git a/docs/platforms/apple/common/usage/index.mdx b/docs/platforms/apple/common/usage/index.mdx index b16027dca53db..c1a3a8529cf51 100644 --- a/docs/platforms/apple/common/usage/index.mdx +++ b/docs/platforms/apple/common/usage/index.mdx @@ -6,7 +6,7 @@ sidebar_order: 10 Sentry's SDK hooks into your runtime environment and automatically reports errors, uncaught exceptions, and unhandled rejections as well as other types of errors depending on the platform. - + Key terms: @@ -15,7 +15,7 @@ Key terms: - The reporting of an event is called _capturing_. When an event is captured, it’s sent to Sentry. - +> The most common form of capturing is to capture errors. What can be captured as an error varies by platform. In general, if you have something that looks like an exception, it can be captured. For some SDKs, you can also omit the argument to and Sentry will attempt to capture the current exception. It is also useful for manual reporting of errors or messages to Sentry. diff --git a/docs/platforms/apple/guides/ios/session-replay/index.mdx b/docs/platforms/apple/guides/ios/session-replay/index.mdx index 3caf4e36fef32..09bb74bf0f134 100644 --- a/docs/platforms/apple/guides/ios/session-replay/index.mdx +++ b/docs/platforms/apple/guides/ios/session-replay/index.mdx @@ -67,11 +67,11 @@ Sampling begins as soon as a session starts. `sessionSampleRate` is evaluated fi The SDK is recording and aggressively masking all text, images, and webviews by default. If your app has any sensitive data, you should only turn the default masking off after explicitly masking out the sensitive data, using the APIs described below. If you want to manually mask parts of your app's data, read our guide on [custom masking](/platforms/apple/guides/ios/session-replay/customredact). - + If you encounter any data not being redacted with the default settings, please let us know through a [GitHub issue](https://github.com/getsentry/sentry-cocoa/issues/new?assignees=&labels=Platform%3A+Cocoa%2CType%3A+Bug&projects=&template=bug.yml). - +> To disable redaction altogether (not to be used on applications with sensitive data): diff --git a/docs/platforms/apple/guides/macos/features/index.mdx b/docs/platforms/apple/guides/macos/features/index.mdx index 00b89913edf8b..cb4b93cd6bdd7 100644 --- a/docs/platforms/apple/guides/macos/features/index.mdx +++ b/docs/platforms/apple/guides/macos/features/index.mdx @@ -6,17 +6,17 @@ description: "Learn about Sentry's Apple SDK features for macOS." Sentry's Apple SDK for macOS enables automatic reporting of errors and exceptions, and identifies performance issues in your application. The minimum supported macOS version is 10.10. The below, is a list of features that are available as part of this SDK. - + For macOS, a simple [manual setup](/platforms/apple/guides/macos/usage/#capturing-uncaught-exceptions) is required for the SDK to report uncaught exceptions. - +> - +> The SDK builds a crash report that persists to disk. While it attempts to send the report right after the crash, it may not always work because the environment may be unstable at the time of the crash. If this is the case, the report will be sent upon application start. - +> **Features:** diff --git a/docs/platforms/dotnet/common/configuration/msbuild.mdx b/docs/platforms/dotnet/common/configuration/msbuild.mdx index 571b75e68870a..3e6922c2145d3 100644 --- a/docs/platforms/dotnet/common/configuration/msbuild.mdx +++ b/docs/platforms/dotnet/common/configuration/msbuild.mdx @@ -203,12 +203,12 @@ Controls whether source code files are uploaded to Sentry during the build. Defa Set this property to `true` to opt-in to sending source code to Sentry. This enables the display of [source context](../../data-management/debug-files/source-context/) when viewing stack traces. - + If you are already embedding source code in your symbol files using [`EmbedAllSources`](https://github.com/dotnet/sourcelink/blob/main/docs/README.md#embedallsources), you do not need to upload them to Sentry separately. In other words, use _either_ `SentryUploadSources` or `EmbedAllSources`, not both. - +> diff --git a/docs/platforms/dotnet/common/configuration/options.mdx b/docs/platforms/dotnet/common/configuration/options.mdx index d9e7461042915..d7e47190307b9 100644 --- a/docs/platforms/dotnet/common/configuration/options.mdx +++ b/docs/platforms/dotnet/common/configuration/options.mdx @@ -31,11 +31,11 @@ Learn more about [DSN utilization](/product/sentry-basics/dsn-explainer/#dsn-uti Before version 3.0.0 of the Sentry SDK for .NET, there was no special treatment for the stack trace. Sentry reported what .NET made available at runtime. This behavior now called `StackTraceMode.Original`. With the introduction of 3.0, a new default mode is `Enhanced`. - + Changing this value will affect issue grouping. Since the frame significantly changes shape. - +> @@ -135,11 +135,11 @@ Grouping in Sentry is different for events with stack traces and without. As a r If this flag is enabled, certain personally identifiable information (PII) is added by active integrations. By default, no such data is sent. - +> If you are using Sentry in your mobile app, read our [frequently asked questions about mobile data privacy](/security-legal-pii/security/mobile-privacy/) to assist with Apple App Store and Google Play app privacy details. - +> This option is turned off by default. diff --git a/docs/platforms/dotnet/common/configuration/releases.mdx b/docs/platforms/dotnet/common/configuration/releases.mdx index 43f8984dc810b..169b641785a4c 100644 --- a/docs/platforms/dotnet/common/configuration/releases.mdx +++ b/docs/platforms/dotnet/common/configuration/releases.mdx @@ -29,11 +29,11 @@ The value can be arbitrary, but we recommend either of these naming strategies: - `build` is the number that identifies an iteration of your app (`CFBundleVersion` on iOS, `versionCode` on Android) - **Commit SHA**: If you use a version control system like Git, we recommend using the identifying hash (for example, the commit SHA, `da39a3ee5e6b4b0d3255bfef95601890afd80709`). You can let Sentry CLI automatically determine this hash for supported version control systems. Learn more in our [Sentry CLI](/cli/releases/#creating-releases) documentation. - + Releases are global per organization; prefix them with something project-specific for easy differentiation. - +> The behavior of a few features depends on whether a project is using semantic or time-based versioning. @@ -62,11 +62,11 @@ After configuring your SDK, you can install a repository integration or manually Monitor the [health of releases](/product/releases/health/) by observing user adoption, usage of the application, percentage of [crashes](/product/releases/health/#crash), and [session data](/product/releases/health/#session). Release health will provide insight into the impact of crashes and bugs as it relates to user experience, and reveal trends with each new issue through the [Release Details](/product/releases/release-details/) graphs and filters. - +> Crash reporting and app hang detection are not available for watchOS. - +> In order to monitor release health, the SDK sends session data. @@ -76,9 +76,9 @@ A session represents the interaction between the user and the application. Sessi - +> Release health support for .NET is currently limited to single-instance **client** applications only. This means it can be used with WPF, Xamarin, WinForms and similar app models. Support for server frameworks such as ASP.NET is planned. - +> diff --git a/docs/platforms/dotnet/common/configuration/sampling.mdx b/docs/platforms/dotnet/common/configuration/sampling.mdx index bc66495c36665..f9226c37f149c 100644 --- a/docs/platforms/dotnet/common/configuration/sampling.mdx +++ b/docs/platforms/dotnet/common/configuration/sampling.mdx @@ -14,11 +14,11 @@ To send a representative sample of your errors to Sentry, set the + Changing the error sample rate requires re-deployment. In addition, setting an SDK sample rate limits visibility into the source of events. Setting a rate limit for your project (which only drops events when volume is high) may better suit your needs. - +> ## Sampling Transaction Events diff --git a/docs/platforms/dotnet/common/crons/index.mdx b/docs/platforms/dotnet/common/crons/index.mdx index f6298ca18aef2..3688245df2f30 100644 --- a/docs/platforms/dotnet/common/crons/index.mdx +++ b/docs/platforms/dotnet/common/crons/index.mdx @@ -6,11 +6,11 @@ sidebar_order: 5750 Once implemented, it'll allow you to get alerts and metrics to help you solve errors, detect timeouts, and prevent disruptions to your service. - + If you are using [Hangfire](https://www.hangfire.io/), please see how to setup monitoring for Hangfire jobs. - +> ## Requirements diff --git a/docs/platforms/dotnet/common/data-management/debug-files/identifiers/index.mdx b/docs/platforms/dotnet/common/data-management/debug-files/identifiers/index.mdx index aebce9d77c759..c66167aa1a0a3 100644 --- a/docs/platforms/dotnet/common/data-management/debug-files/identifiers/index.mdx +++ b/docs/platforms/dotnet/common/data-management/debug-files/identifiers/index.mdx @@ -24,14 +24,14 @@ compute a _Debug Identifier_ for each uploaded file. This identifier is associated with executables and libraries as well as debug companions to ensure that they can be uniquely located via one common mechanism. - + Debug information does not have to be associated with releases. The unique debug identifier ensures that Sentry can choose the right files for every crash report. However, it is still recommended to configure releases in the client to benefit from other features. - +> For native events, the issue details page displays a list of _Loaded Images_. This list contains the executable and all loaded dynamic libraries including diff --git a/docs/platforms/dotnet/common/data-management/debug-files/index.mdx b/docs/platforms/dotnet/common/data-management/debug-files/index.mdx index b5a401b9febf2..68d9d758dae78 100644 --- a/docs/platforms/dotnet/common/data-management/debug-files/index.mdx +++ b/docs/platforms/dotnet/common/data-management/debug-files/index.mdx @@ -24,12 +24,12 @@ the following formats: - [_ProGuard mappings_](./file-formats/#proguard-mappings) for Java and Android - + Source maps, while also being debug information files, are handled differently in Sentry. For more information see [Source Maps in sentry-cli](/cli/releases/#sentry-cli-sourcemaps). - +> Sentry requires access to debug information files of your application as well as system libraries to provide fully symbolicated crash reports. You can either @@ -46,11 +46,11 @@ for automatic downloads. From the [Project Details](/product/projects/project-details/) page, click into settings, then click on _Debug Files_ in the page navigation. - +> ProGuard files are listed separately, in the _ProGuard_ section of the project settings page. - +> ## Retention Policy diff --git a/docs/platforms/dotnet/common/data-management/debug-files/source-context/index.mdx b/docs/platforms/dotnet/common/data-management/debug-files/source-context/index.mdx index 52e3fd63e7874..1146c985c2ac9 100644 --- a/docs/platforms/dotnet/common/data-management/debug-files/source-context/index.mdx +++ b/docs/platforms/dotnet/common/data-management/debug-files/source-context/index.mdx @@ -20,7 +20,7 @@ needs to be uploaded alongside the debug information files. The recommended way to do this is by using `sentry-cli`. See [Creating Source Bundles](/cli/dif/#creating-source-bundles) for more information. - + For .NET projects, you can [configure MSBuild](../../../configuration/msbuild/) to call `sentry-cli` automatically. Enable the `SentryUploadSources` property to @@ -34,7 +34,7 @@ extracted from them automatically. Also note that the similar `EmbedUntrackedSources` option is not yet supported, but may be added in the future. Referer to [this issue](https://github.com/getsentry/symbolic/issues/735) for details. - +> After they've been uploaded you can review and manage source bundles the same as any other debug information file. See [Managing Debug Information Files](../#managing-debug-information-files). diff --git a/docs/platforms/dotnet/common/data-management/debug-files/upload/index.mdx b/docs/platforms/dotnet/common/data-management/debug-files/upload/index.mdx index 1ea1bb85c4ee8..0b7bf0ccc2be4 100644 --- a/docs/platforms/dotnet/common/data-management/debug-files/upload/index.mdx +++ b/docs/platforms/dotnet/common/data-management/debug-files/upload/index.mdx @@ -11,7 +11,7 @@ application: - + Depending on application type, target platform, and build configuration, the Sentry support for .NET may require uploading debug files in order to show a @@ -26,7 +26,7 @@ Refer to [msbuild configuration](/platforms/dotnet/configuration/msbuild) for de The remaining information on this page describes invoking the Sentry CLI manually. - +> diff --git a/docs/platforms/dotnet/common/data-management/sensitive-data/index.mdx b/docs/platforms/dotnet/common/data-management/sensitive-data/index.mdx index cf4de7c59a119..f9f67ae76bc95 100644 --- a/docs/platforms/dotnet/common/data-management/sensitive-data/index.mdx +++ b/docs/platforms/dotnet/common/data-management/sensitive-data/index.mdx @@ -23,13 +23,13 @@ We offer the following options depending on your legal and operational needs: - [configuring server-side scrubbing](/security-legal-pii/scrubbing/server-side-scrubbing/) to ensure Sentry does _not store_ data. Configuration changes are done in the Sentry UI and apply immediately for new events. - [running a local Relay](/product/relay/) on your own server between the SDK and Sentry, so that data is _not sent to_ Sentry while configuration can still be applied without deploying. - + Ensure that your team is aware of your company's policy around what can and cannot be sent to Sentry. We recommend determining this policy early in your implementation and communicating it as well as enforcing it via code review. If you are using Sentry in your mobile app, read our [frequently asked questions about mobile data privacy](/security-legal-pii/security/mobile-privacy/) to assist with Apple App Store and Google Play app privacy details. - +> ## Personally Identifiable Information (PII) diff --git a/docs/platforms/dotnet/common/enriching-events/attachments/index.mdx b/docs/platforms/dotnet/common/enriching-events/attachments/index.mdx index 57b07ad193711..d2a60f65b0bff 100644 --- a/docs/platforms/dotnet/common/enriching-events/attachments/index.mdx +++ b/docs/platforms/dotnet/common/enriching-events/attachments/index.mdx @@ -3,11 +3,11 @@ title: Attachments description: "Learn more about how Sentry can store additional files in the same request as event attachments." --- - + This feature is supported in version 3.0 and higher of Sentry's .NET SDK. - +> Sentry can enrich your events for further investigation by storing additional files, such as config or log files, as attachments. @@ -53,11 +53,11 @@ Attachments live on the Scope - +> Sentry allows at most 20MB for a compressed request, and at most 100MB of uncompressed attachments per event, including the crash report file (if applicable). Uploads exceeding this size are rejected with HTTP error `413 Payload Too Large` and the data is dropped immediately. To add larger or more files, consider secondary storage options. - +> Attachments persist for 30 days; if your total storage included in your quota is exceeded, attachments will not be stored. You can delete attachments or their containing events at any time. Deleting an attachment does not affect your quota - Sentry counts an attachment toward your quota as soon as it is stored. diff --git a/docs/platforms/dotnet/common/enriching-events/context/index.mdx b/docs/platforms/dotnet/common/enriching-events/context/index.mdx index 3fa1c3fffd8af..b912f6eda8c84 100644 --- a/docs/platforms/dotnet/common/enriching-events/context/index.mdx +++ b/docs/platforms/dotnet/common/enriching-events/context/index.mdx @@ -7,11 +7,11 @@ Custom contexts allow you to attach arbitrary data to an event. Often, this cont - + If you need to be able to search on custom data, [use tags](../tags) instead. - +> ## Structured Context diff --git a/docs/platforms/dotnet/common/enriching-events/identify-user/index.mdx b/docs/platforms/dotnet/common/enriching-events/identify-user/index.mdx index d20a55786a759..aa65ab3f86ec1 100644 --- a/docs/platforms/dotnet/common/enriching-events/identify-user/index.mdx +++ b/docs/platforms/dotnet/common/enriching-events/identify-user/index.mdx @@ -9,11 +9,11 @@ Users consist of a few critical pieces of information that construct a unique id ### `id` - + If you don't provide an `id`, the SDK falls back to `installationId`, which the SDK randomly generates once during an app's installation. - +> Your internal identifier for the user. diff --git a/docs/platforms/dotnet/common/enriching-events/tags/index.mdx b/docs/platforms/dotnet/common/enriching-events/tags/index.mdx index 5707e7b98110c..fce84a22ffbbe 100644 --- a/docs/platforms/dotnet/common/enriching-events/tags/index.mdx +++ b/docs/platforms/dotnet/common/enriching-events/tags/index.mdx @@ -17,11 +17,11 @@ Define the tag: - + Some tags are automatically set by Sentry. We strongly recommend against overwriting these [tags](/concepts/search/searchable-properties/#search-properties). Instead, name your tags with your organization's nomenclature. If you overwrite an automatically set tag, you must use [explicit tag syntax](/concepts/search/#explicit-tag-syntax) to search for it. - +> Once you've started sending tagged data, you'll see it when logged in to sentry.io. There, you can view the filters within the sidebar on the Project page, summarized within an event, and on the Tags page for an aggregated event. diff --git a/docs/platforms/dotnet/common/index.mdx b/docs/platforms/dotnet/common/index.mdx index 696b47e1f3efd..9f03d7a2736af 100644 --- a/docs/platforms/dotnet/common/index.mdx +++ b/docs/platforms/dotnet/common/index.mdx @@ -28,10 +28,10 @@ This snippet includes an intentional error, so you can test that everything is w - + Learn more about manually capturing an error or message in our Usage documentation. - +> To view and resolve the recorded error, log into [sentry.io](https://sentry.io) and select your project. Clicking on the error's title will open a page where you can see detailed information and mark it as resolved. diff --git a/docs/platforms/dotnet/common/profiling/index.mdx b/docs/platforms/dotnet/common/profiling/index.mdx index c77888bc35fe8..4021c881c2b99 100644 --- a/docs/platforms/dotnet/common/profiling/index.mdx +++ b/docs/platforms/dotnet/common/profiling/index.mdx @@ -8,7 +8,7 @@ sidebar_order: 5000 With [profiling](/product/explore/profiling/), Sentry allows you to collect and analyze performance profiles from real user devices in production to give you a complete picture of how your application performs in a variety of environments. - + Sentry profiling for .NET is available in _Alpha_ on .NET 6.0+ (tested on .NET 7.0 & .NET 8.0 as well) for: @@ -18,7 +18,7 @@ Sentry profiling for .NET is available in _Alpha_ on .NET 6.0+ (tested on .NET 7 - iOS - Mac Catalyst - +> ## Enable Profiling diff --git a/docs/platforms/dotnet/common/tracing/index.mdx b/docs/platforms/dotnet/common/tracing/index.mdx index 3e546f2bbeefb..a1b27aae7fdb2 100644 --- a/docs/platforms/dotnet/common/tracing/index.mdx +++ b/docs/platforms/dotnet/common/tracing/index.mdx @@ -6,11 +6,11 @@ sidebar_order: 4000 With [tracing](/product/performance/), Sentry tracks your software performance, measuring metrics like throughput and latency, and displaying the impact of errors across multiple systems. Sentry captures distributed traces consisting of transactions and spans, which measure individual services and individual operations within those services. Learn more about our model in [Distributed Tracing](/product/sentry-basics/tracing/distributed-tracing/). - + If you’re adopting Tracing in a high-throughput environment, we recommend testing prior to deployment to ensure that your service’s performance characteristics maintain expectations. - +> ## Configure diff --git a/docs/platforms/dotnet/common/tracing/instrumentation/automatic-instrumentation.mdx b/docs/platforms/dotnet/common/tracing/instrumentation/automatic-instrumentation.mdx index 1a82c3110ad05..efc2dfeef5f59 100644 --- a/docs/platforms/dotnet/common/tracing/instrumentation/automatic-instrumentation.mdx +++ b/docs/platforms/dotnet/common/tracing/instrumentation/automatic-instrumentation.mdx @@ -6,11 +6,11 @@ sidebar_order: 20 ## Propagating a Trace - + If you are using Sentry's ASP.NET Core integration, trace propagation is enabled automatically on all clients created by an HTTP client factory. Read more about it here. - +> Sentry SDK provides a custom HTTP handler, `SentryHttpMessageHandler`. This handler can be used inside `HttpClient` to automatically propagate traces and create spans to track outgoing requests. diff --git a/docs/platforms/dotnet/common/tracing/instrumentation/custom-instrumentation/index.mdx b/docs/platforms/dotnet/common/tracing/instrumentation/custom-instrumentation/index.mdx index a9e53aaa98de7..25785c62501ea 100644 --- a/docs/platforms/dotnet/common/tracing/instrumentation/custom-instrumentation/index.mdx +++ b/docs/platforms/dotnet/common/tracing/instrumentation/custom-instrumentation/index.mdx @@ -4,11 +4,11 @@ description: "Learn how to capture performance data on any action in your app." sidebar_order: 20 --- - + To capture transactions and spans customized to your organization's needs, you must first set up tracing. - +> diff --git a/docs/platforms/dotnet/common/usage/index.mdx b/docs/platforms/dotnet/common/usage/index.mdx index b16027dca53db..c1a3a8529cf51 100644 --- a/docs/platforms/dotnet/common/usage/index.mdx +++ b/docs/platforms/dotnet/common/usage/index.mdx @@ -6,7 +6,7 @@ sidebar_order: 10 Sentry's SDK hooks into your runtime environment and automatically reports errors, uncaught exceptions, and unhandled rejections as well as other types of errors depending on the platform. - + Key terms: @@ -15,7 +15,7 @@ Key terms: - The reporting of an event is called _capturing_. When an event is captured, it’s sent to Sentry. - +> The most common form of capturing is to capture errors. What can be captured as an error varies by platform. In general, if you have something that looks like an exception, it can be captured. For some SDKs, you can also omit the argument to and Sentry will attempt to capture the current exception. It is also useful for manual reporting of errors or messages to Sentry. diff --git a/docs/platforms/dotnet/common/user-feedback/index.mdx b/docs/platforms/dotnet/common/user-feedback/index.mdx index c3ee3df48b1c1..aa7a26c9ec6fd 100644 --- a/docs/platforms/dotnet/common/user-feedback/index.mdx +++ b/docs/platforms/dotnet/common/user-feedback/index.mdx @@ -8,11 +8,11 @@ When a user experiences an error, Sentry provides the ability to collect additio ## Use the .NET SDK - + User Feedback for **[ASP.NET](/platforms/dotnet/guides/aspnet/user-feedback/#integration)** or **[ASP.NET Core](/platforms/dotnet/guides/aspnetcore/user-feedback/#integration)** supply integrations specific to supporting those SDKs. - +> You can create a form to collect the user input in your preferred framework, and use the SDK's API to send the information to Sentry. You can also use the widget, as described below. If you'd prefer an alternative to the widget or do not have a JavaScript frontend, you can use this API: diff --git a/docs/platforms/dotnet/guides/aspnet/tracing/included-instrumentation.mdx b/docs/platforms/dotnet/guides/aspnet/tracing/included-instrumentation.mdx index cfa08436a50d1..b8ae84e8ce5e4 100644 --- a/docs/platforms/dotnet/guides/aspnet/tracing/included-instrumentation.mdx +++ b/docs/platforms/dotnet/guides/aspnet/tracing/included-instrumentation.mdx @@ -4,11 +4,11 @@ sidebar_order: 20 description: "Learn what transactions are captured after tracing is enabled." --- - + Capturing transactions requires that you first set up tracing if you haven't already. You'll also need to enable the base Sentry integration. - +> ASP.NET integration, once enabled, captures each incoming HTTP request and turns it into a transaction with the help of a custom middleware. To enable tracing on ASP.NET, you need to update your `Global.asax.cs` file like this: diff --git a/docs/platforms/dotnet/guides/aspnetcore/tracing/instrumentation/automatic-instrumentation.mdx b/docs/platforms/dotnet/guides/aspnetcore/tracing/instrumentation/automatic-instrumentation.mdx index 92bf14b84a9e4..a534c3ee20ba3 100644 --- a/docs/platforms/dotnet/guides/aspnetcore/tracing/instrumentation/automatic-instrumentation.mdx +++ b/docs/platforms/dotnet/guides/aspnetcore/tracing/instrumentation/automatic-instrumentation.mdx @@ -4,11 +4,11 @@ sidebar_order: 20 description: "Learn what transactions are captured after tracing is enabled." --- - + Capturing transactions requires that you first set up tracing if you haven't already. You'll also need to enable the base Sentry integration for ASP.NET Core. - +> ### Server Integration diff --git a/docs/platforms/dotnet/guides/azure-functions-worker/index.mdx b/docs/platforms/dotnet/guides/azure-functions-worker/index.mdx index 95d9c34c1345c..bb9264bb20fd4 100644 --- a/docs/platforms/dotnet/guides/azure-functions-worker/index.mdx +++ b/docs/platforms/dotnet/guides/azure-functions-worker/index.mdx @@ -34,11 +34,11 @@ This package extends [Sentry.Extensions.Logging](/platforms/dotnet/guides/extens Sentry integration with Azure Functions is done by calling `.UseSentry()` and specifying the options, for example: - + If using the ASP.NET Core integration add `UseSentry` to the `ConfigureFunctionsWebApplication` call instead. - +> ```csharp {"onboardingOptions": {"performance": "11-13"}} using Sentry.Azure.Functions.Worker; diff --git a/docs/platforms/dotnet/guides/extensions-logging/index.mdx b/docs/platforms/dotnet/guides/extensions-logging/index.mdx index 4fb36bfd3ad3a..7148e575c0acd 100644 --- a/docs/platforms/dotnet/guides/extensions-logging/index.mdx +++ b/docs/platforms/dotnet/guides/extensions-logging/index.mdx @@ -33,11 +33,11 @@ dotnet add package Sentry.Extensions.Logging -v {{@inject packages.version('sent This package extends `Sentry` main SDK. That means that besides the logging related features, through this package you'll also get access to all API and features available in the main `Sentry` SDK. - + Messages logged from assemblies with the name starting with `Sentry` will not generate events. - +> ## Configure @@ -119,11 +119,11 @@ More settings can be passed via the callback configuring the `SentryOptions`. In cases where `AddSentry` is called without arguments, it's worth noting that an overload exists where `SentryOptions` can be configured just like if `SentrySdk.Init` had been called. - +> The SDK needs to be initialized only once. If the `DSN` is made available to this integration, by default it **will** initialize the SDK. If you do not wish to initialize the SDK via this configuration, set the `InitializeSdk` flag to **false**. Not providing a DSN or leaving it as an _empty string_ will disable the SDK. - +> For example: diff --git a/docs/platforms/dotnet/guides/log4net/index.mdx b/docs/platforms/dotnet/guides/log4net/index.mdx index 5c6d087f1f0ea..84a2f90ff0282 100644 --- a/docs/platforms/dotnet/guides/log4net/index.mdx +++ b/docs/platforms/dotnet/guides/log4net/index.mdx @@ -37,11 +37,11 @@ This can be done, for example, via the `app.config` for console and desktop apps ``` - + Only a subset of the options are exposed via the log4net appender configuration. If you wish to access an [SDK option](/platforms/dotnet/configuration/options/) which is not listed below, you'll need to initialize the SDK via [SentrySdk.Init](/platforms/dotnet/) instead of doing it via this integration as described below. - +> ### SendIdentity diff --git a/docs/platforms/dotnet/guides/serilog/index.mdx b/docs/platforms/dotnet/guides/serilog/index.mdx index 19563e98f00e8..caae1dbdca6d0 100644 --- a/docs/platforms/dotnet/guides/serilog/index.mdx +++ b/docs/platforms/dotnet/guides/serilog/index.mdx @@ -64,11 +64,11 @@ Log.Logger = new LoggerConfiguration() .CreateLogger(); ``` - + The SDK only needs to be initialized once. If a `DSN` is made available to this integration, by default it **will** initialize the SDK. If you do not wish to initialize the SDK via this integration, set the `InitializeSdk` flag to **false**. Not providing a DSN or leaving it as `null` instructs the integration not to initialize the SDK and unless another integration initializes it or you call `SentrySdk.Init`, the SDK will stay disabled. - +> ### Options diff --git a/docs/platforms/dotnet/guides/uwp/index.mdx b/docs/platforms/dotnet/guides/uwp/index.mdx index ac0b502fad23a..8964cceb8baf6 100644 --- a/docs/platforms/dotnet/guides/uwp/index.mdx +++ b/docs/platforms/dotnet/guides/uwp/index.mdx @@ -21,11 +21,11 @@ Select which Sentry features you'd like to install in addition to Error Monitori In addition to [initializing the SDK with `SentrySdk.Init`](/platforms/dotnet/), you must configure the UWP specific `Application.UnhandledException` and `Application.Suspending` events. - + The SDK should be initialized in the constructor of your application class (usually `App.xaml.cs`). Do not initialize the SDK in the `OnLaunched` event of the application or the `Hub` will not be initialized correctly. - +> ```csharp {"onboardingOptions": {"performance": "18-21"}} diff --git a/docs/platforms/dotnet/guides/winui/index.mdx b/docs/platforms/dotnet/guides/winui/index.mdx index f204fe0097973..7141687179950 100644 --- a/docs/platforms/dotnet/guides/winui/index.mdx +++ b/docs/platforms/dotnet/guides/winui/index.mdx @@ -21,11 +21,11 @@ Select which Sentry features you'd like to install in addition to Error Monitori If you don't have [Trimming](https://learn.microsoft.com/en-us/dotnet/core/deploying/trimming/trimming-options?pivots=dotnet-8-0) enabled when publishing your application then all you need to do is [initialize the SDK with `SentrySdk.Init`](/platforms/dotnet/) in the constructor of your application class (usually `App.xaml.cs`). Sentry's integration for WinUI will automatically capture any unhandled exceptions in your application and send these to Sentry. - + Do not initialize the SDK in the `OnLaunched` event of the application or the `Hub` will not be initialized correctly. - +> In addition to capturing errors, you can monitor interactions between multiple services or applications by [enabling tracing](/concepts/key-terms/tracing/). @@ -72,11 +72,11 @@ sealed partial class App : Application If you have [Trimming](https://learn.microsoft.com/en-us/dotnet/core/deploying/trimming/trimming-options?pivots=dotnet-8-0) enabled when publishing your application then, in addition to [initializing the SDK with `SentrySdk.Init`](/platforms/dotnet/), you must also configure an UnhandledException handler in the constructor of your application class (usually `App.xaml.cs`). - +> Do not initialize the SDK in the `OnLaunched` event of the application or the `Hub` will not be initialized correctly. - +> ```csharp diff --git a/docs/platforms/dotnet/guides/wpf/index.mdx b/docs/platforms/dotnet/guides/wpf/index.mdx index 10f67a71770f0..6928f00867530 100644 --- a/docs/platforms/dotnet/guides/wpf/index.mdx +++ b/docs/platforms/dotnet/guides/wpf/index.mdx @@ -21,11 +21,11 @@ Select which Sentry features you'd like to install in addition to Error Monitori In addition to [initializing the SDK with `SentrySdk.Init`](/platforms/dotnet/), you must configure the WPF specific error handler. - + The SDK should be initialized in the constructor of your application class (usually `App.xaml.cs`). Do not initialize the SDK in the `OnStartup()` event of the application or the `Hub` will not be initialized correctly. - +> The SDK automatically handles `AppDomain.UnhandledException`. On WPF, for production apps (when no debugger is attached), WPF catches exception to show the dialog to the user. You can also configure your app to capture those exceptions before the dialog shows up: diff --git a/docs/platforms/dotnet/guides/xamarin/data-management/apple-privacy-manifest.mdx b/docs/platforms/dotnet/guides/xamarin/data-management/apple-privacy-manifest.mdx index 19f96a5451089..a65010e58711f 100644 --- a/docs/platforms/dotnet/guides/xamarin/data-management/apple-privacy-manifest.mdx +++ b/docs/platforms/dotnet/guides/xamarin/data-management/apple-privacy-manifest.mdx @@ -4,15 +4,15 @@ description: "Troubleshoot and resolve common issues with the Apple Privacy Mani sidebar_order: 50 --- - + This guide requires [@sentry/xamarin@2.1.0](https://github.com/getsentry/sentry-xamarin/releases/tag/2.1.0) or newer. - +> Sentry's SDKs provide error and tracing for mobile applications running on Apple devices. To do this, the SDK needs to access certain information about the device and the application. Some of the APIs required for this are considered privacy-relevant by Apple. In order to submit apps to the App Store, Apple requires all apps - and libraries used within these apps - to provide privacy manifest files stating which APIs are used under which allowed reasons. For more details, read Apple's guidelines on [Describing use of required reason API](https://developer.apple.com/documentation/bundleresources/privacy_manifest_files/describing_use_of_required_reason_api). - +> The information and steps in this guide are still being worked on and might change because of new tools or updated [Apple requirements](https://developer.apple.com/documentation/bundleresources/privacy_manifest_files). - +> During the build process, the SDK will provide your project a privacy manifest file containing only the required information used by the SDK. If you are providing your own privacy manifest, you'll need to include the below rules in your `privacyinfo.xcprivacy` file. This guide will help you create the privacy manifest for your Xamarin applications. diff --git a/docs/platforms/dotnet/guides/xamarin/troubleshooting.mdx b/docs/platforms/dotnet/guides/xamarin/troubleshooting.mdx index df4a25607bd99..14fe525dcc35b 100644 --- a/docs/platforms/dotnet/guides/xamarin/troubleshooting.mdx +++ b/docs/platforms/dotnet/guides/xamarin/troubleshooting.mdx @@ -35,10 +35,10 @@ To solve this, you will need to follow the steps below: - `Visual Studio (Mac)`: Right-click on your iOS project and at the bottom, select the option `Edit Project File`. - `Visual Studio (Windows)`: Right-click on your iOS project, select the option `Unload Project`. By doing that action, it'll open your raw project solution, otherwise, right-click your iOS project and select the option `Edit project file`. - + You can also use an external text editor or another IDE to edit your iOS project. - +> 2. Locate the `ItemGroup` that contains `PackageReference`. @@ -50,12 +50,12 @@ To solve this, you will need to follow the steps below: ``` - +> It's important to add the `IncludeAssets` as `None`, or this fix will not work. - +> -Using Reference will not work, it must be PackageReference. +>Using Reference will not work, it must be PackageReference.t> 4. Save the edited `csproj` file and reload your project if it was unloaded: diff --git a/docs/platforms/dotnet/index.mdx b/docs/platforms/dotnet/index.mdx index 06be7c279f3f4..97548a59df1af 100644 --- a/docs/platforms/dotnet/index.mdx +++ b/docs/platforms/dotnet/index.mdx @@ -8,11 +8,11 @@ aliases: - C# --- - + If you don't already have an account and Sentry project established, head over to [sentry.io](https://sentry.io/signup/), then return to this page. - +> You can use these instructions to run Sentry in an app running on: @@ -54,11 +54,11 @@ Install the **NuGet** package to add the Sentry dependency: - + > Sentry profiling for .NET is available in Alpha on .NET 6.0 and newer. - + > ```shell {tabTitle:.NET Core CLI} dotnet add package Sentry -v {{@inject packages.version('sentry.dotnet') }} @@ -66,7 +66,7 @@ Install the **NuGet** package to add the Sentry dependency: ``` ```powershell {tabTitle:Package Manager} - Install-Package Sentry -Version {{@inject packages.version('sentry.dotnet') }} + Install-Package Sentry -Version {{@inject packages.version('sentry.dotnet') }} Install-Package Sentry.Profiling -Version {{@inject packages.version('sentry.dotnet.profiling') }} ``` diff --git a/docs/platforms/elixir/configuration/releases.mdx b/docs/platforms/elixir/configuration/releases.mdx index babb58d14dcbd..55156ebd7329b 100644 --- a/docs/platforms/elixir/configuration/releases.mdx +++ b/docs/platforms/elixir/configuration/releases.mdx @@ -29,11 +29,11 @@ The value can be arbitrary, but we recommend either of these naming strategies: - `build` is the number that identifies an iteration of your app (`CFBundleVersion` on iOS, `versionCode` on Android) - **Commit SHA**: If you use a version control system like Git, we recommend using the identifying hash (for example, the commit SHA, `da39a3ee5e6b4b0d3255bfef95601890afd80709`). You can let Sentry CLI automatically determine this hash for supported version control systems. Learn more in our [Sentry CLI](/cli/releases/#creating-releases) documentation. - + Releases are global per organization; prefix them with something project-specific for easy differentiation. - +> The behavior of a few features depends on whether a project is using semantic or time-based versioning. diff --git a/docs/platforms/elixir/data-management/sensitive-data/index.mdx b/docs/platforms/elixir/data-management/sensitive-data/index.mdx index 8712656e07c42..f00f388bddc67 100644 --- a/docs/platforms/elixir/data-management/sensitive-data/index.mdx +++ b/docs/platforms/elixir/data-management/sensitive-data/index.mdx @@ -23,13 +23,13 @@ We offer the following options depending on your legal and operational needs: - [configuring server-side scrubbing](/security-legal-pii/scrubbing/server-side-scrubbing/) to ensure Sentry does _not store_ data. Configuration changes are done in the Sentry UI and apply immediately for new events. - [running a local Relay](/product/relay/) on your own server between the SDK and Sentry, so that data is _not sent to_ Sentry while configuration can still be applied without deploying. - + Ensure that your team is aware of your company's policy around what can and cannot be sent to Sentry. We recommend determining this policy early in your implementation and communicating it as well as enforcing it via code review. If you are using Sentry in your mobile app, read our [frequently asked questions about mobile data privacy](/security-legal-pii/security/mobile-privacy/) to assist with Apple App Store and Google Play app privacy details. - +> If you _do not_ wish to use the default PII behavior, you can also choose to identify users in a more controlled manner, using our [user identity context](../../enriching-events/identify-user/). diff --git a/docs/platforms/elixir/enriching-events/context/index.mdx b/docs/platforms/elixir/enriching-events/context/index.mdx index 491b30006b806..87d9f488cdad8 100644 --- a/docs/platforms/elixir/enriching-events/context/index.mdx +++ b/docs/platforms/elixir/enriching-events/context/index.mdx @@ -7,11 +7,11 @@ Custom contexts allow you to attach arbitrary data to an event. Often, this cont - + If you need to be able to search on custom data, [use tags](../tags) instead. - +> ## Structured Context diff --git a/docs/platforms/elixir/enriching-events/identify-user/index.mdx b/docs/platforms/elixir/enriching-events/identify-user/index.mdx index 6d5e03315faee..7aa8ac9261155 100644 --- a/docs/platforms/elixir/enriching-events/identify-user/index.mdx +++ b/docs/platforms/elixir/enriching-events/identify-user/index.mdx @@ -9,11 +9,11 @@ Users consist of a few critical pieces of information that construct a unique id ### `id` - + If you don't provide an `id`, the SDK falls back to `installationId`, which the SDK randomly generates once during an app's installation. - +> Your internal identifier for the user. diff --git a/docs/platforms/elixir/enriching-events/tags/index.mdx b/docs/platforms/elixir/enriching-events/tags/index.mdx index 8035c211bf7cd..5190f4bb8bccc 100644 --- a/docs/platforms/elixir/enriching-events/tags/index.mdx +++ b/docs/platforms/elixir/enriching-events/tags/index.mdx @@ -15,11 +15,11 @@ Define the tag: - + Some tags are automatically set by Sentry. We strongly recommend against overwriting these [tags](/concepts/search/searchable-properties/#search-properties). Instead, name your tags with your organization's nomenclature. If you overwrite an automatically set tag, you must use [explicit tag syntax](/concepts/search/#explicit-tag-syntax) to search for it. - +> Once you've started sending tagged data, you'll see it when logged in to sentry.io. There, you can view the filters within the sidebar on the Project page, summarized within an event, and on the Tags page for an aggregated event. diff --git a/docs/platforms/elixir/index.mdx b/docs/platforms/elixir/index.mdx index dd86c1a4f6784..6701c9b2c12ce 100644 --- a/docs/platforms/elixir/index.mdx +++ b/docs/platforms/elixir/index.mdx @@ -9,9 +9,9 @@ showIntegrationsInSearch: true On this page, we get you up and running with Sentry's SDK. - + You don't have an account and Sentry project established? Head over to [sentry.io](https://sentry.io/signup/), then return to this page. - +> ## Install @@ -31,10 +31,10 @@ This snippet includes an intentional error, so you can test that everything is w - +> Learn more about manually capturing an error or message in our Usage documentation. - +> To view and resolve the recorded error, log into [sentry.io](https://sentry.io) and select your project. Clicking on the error's title will open a page where you can see detailed information and mark it as resolved. diff --git a/docs/platforms/elixir/usage/index.mdx b/docs/platforms/elixir/usage/index.mdx index b16027dca53db..c1a3a8529cf51 100644 --- a/docs/platforms/elixir/usage/index.mdx +++ b/docs/platforms/elixir/usage/index.mdx @@ -6,7 +6,7 @@ sidebar_order: 10 Sentry's SDK hooks into your runtime environment and automatically reports errors, uncaught exceptions, and unhandled rejections as well as other types of errors depending on the platform. - + Key terms: @@ -15,7 +15,7 @@ Key terms: - The reporting of an event is called _capturing_. When an event is captured, it’s sent to Sentry. - +> The most common form of capturing is to capture errors. What can be captured as an error varies by platform. In general, if you have something that looks like an exception, it can be captured. For some SDKs, you can also omit the argument to and Sentry will attempt to capture the current exception. It is also useful for manual reporting of errors or messages to Sentry. diff --git a/docs/platforms/flutter/configuration/options.mdx b/docs/platforms/flutter/configuration/options.mdx index ef94188d858a0..d5b1303e10907 100644 --- a/docs/platforms/flutter/configuration/options.mdx +++ b/docs/platforms/flutter/configuration/options.mdx @@ -95,11 +95,11 @@ Grouping in Sentry is different for events with stack traces and without. As a r If this flag is enabled, certain personally identifiable information (PII) is added by active integrations. By default, no such data is sent. - + If you are using Sentry in your mobile app, read our [frequently asked questions about mobile data privacy](/security-legal-pii/security/mobile-privacy/) to assist with Apple App Store and Google Play app privacy details. - +> This option is turned off by default. @@ -320,10 +320,10 @@ Set this boolean to `false` to disable auto [tracing](/product/performance/) tra - +> Available since version 8.0.0 of Sentry Apple SDK. It was named `enableOutOfMemoryTracking` before the 8.0.0 release. - +> Set this boolean to `false` to disable [watchdog termination](/platforms/apple/guides/ios/configuration/watchdog-terminations/) tracking on iOS. diff --git a/docs/platforms/flutter/configuration/releases.mdx b/docs/platforms/flutter/configuration/releases.mdx index 7e60fca65b402..6643b1add4f97 100644 --- a/docs/platforms/flutter/configuration/releases.mdx +++ b/docs/platforms/flutter/configuration/releases.mdx @@ -29,11 +29,11 @@ The value can be arbitrary, but we recommend either of these naming strategies: - `build` is the number that identifies an iteration of your app (`CFBundleVersion` on iOS, `versionCode` on Android) - **Commit SHA**: If you use a version control system like Git, we recommend using the identifying hash (for example, the commit SHA, `da39a3ee5e6b4b0d3255bfef95601890afd80709`). You can let Sentry CLI automatically determine this hash for supported version control systems. Learn more in our [Sentry CLI](/cli/releases/#creating-releases) documentation. - + Releases are global per organization; prefix them with something project-specific for easy differentiation. - +> The behavior of a few features depends on whether a project is using semantic or time-based versioning. @@ -64,11 +64,11 @@ Monitor the [health of releases](/product/releases/health/) by observing user ad In order to monitor release health, the SDK sends session data. - +> Release health in Flutter is only available for Android, iOS, and macOS. - +> ### Sessions diff --git a/docs/platforms/flutter/configuration/sampling.mdx b/docs/platforms/flutter/configuration/sampling.mdx index 322d5ba1034f7..6717470b649e3 100644 --- a/docs/platforms/flutter/configuration/sampling.mdx +++ b/docs/platforms/flutter/configuration/sampling.mdx @@ -14,11 +14,11 @@ To send a representative sample of your errors to Sentry, set the + Changing the error sample rate requires re-deployment. In addition, setting an SDK sample rate limits visibility into the source of events. Setting a rate limit for your project (which only drops events when volume is high) may better suit your needs. - +> ## Sampling Transaction Events diff --git a/docs/platforms/flutter/data-management/apple-privacy-manifest.mdx b/docs/platforms/flutter/data-management/apple-privacy-manifest.mdx index 98e5d58a3ffca..0f765d21bf788 100644 --- a/docs/platforms/flutter/data-management/apple-privacy-manifest.mdx +++ b/docs/platforms/flutter/data-management/apple-privacy-manifest.mdx @@ -4,15 +4,15 @@ description: "Troubleshoot and resolve common issues with the Apple Privacy Mani sidebar_order: 50 --- - + This guide requires [@sentry/dart@7.20.1](https://github.com/getsentry/sentry-dart/releases/tag/7.20.1) or newer. - +> Sentry's SDKs provide error and tracing for mobile applications running on Apple devices. To do this, the SDK needs to access certain information about the device and the application. Some of the APIs required for this are considered privacy-relevant by Apple. In order to submit apps to the App Store, Apple requires all apps - and libraries used within these apps - to provide privacy manifest files stating which APIs are used under which allowed reasons. For more details, read Apple's guidelines on [Describing use of required reason API](https://developer.apple.com/documentation/bundleresources/privacy_manifest_files/describing_use_of_required_reason_api). - +> The information and steps in this guide are still being worked on and might change because of new tools or updated [Apple requirements](https://developer.apple.com/documentation/bundleresources/privacy_manifest_files). - +> If you are using dynamically linked frameworks, which is the default for Flutter applications, Apple will automatically process the SDK's privacy manifest. If you are using statically linked libraries, you need to provide the privacy manifest yourself. This guide will help you create the privacy manifest for your Flutter applications. diff --git a/docs/platforms/flutter/data-management/debug-files/file-formats/index.mdx b/docs/platforms/flutter/data-management/debug-files/file-formats/index.mdx index dd5d74925a8b3..7468fcc652af9 100644 --- a/docs/platforms/flutter/data-management/debug-files/file-formats/index.mdx +++ b/docs/platforms/flutter/data-management/debug-files/file-formats/index.mdx @@ -180,11 +180,11 @@ while removing all debug information from the release binary. ## ProGuard Mappings - + The recommended method for [Android users is to use the Gradle plugin](/platforms/android/configuration/gradle/). - +> ProGuard mapping files allow Sentry to resolve obfuscated Java classpaths and method names into their original form. In that sense, they act as debug diff --git a/docs/platforms/flutter/data-management/debug-files/identifiers/index.mdx b/docs/platforms/flutter/data-management/debug-files/identifiers/index.mdx index aebce9d77c759..c66167aa1a0a3 100644 --- a/docs/platforms/flutter/data-management/debug-files/identifiers/index.mdx +++ b/docs/platforms/flutter/data-management/debug-files/identifiers/index.mdx @@ -24,14 +24,14 @@ compute a _Debug Identifier_ for each uploaded file. This identifier is associated with executables and libraries as well as debug companions to ensure that they can be uniquely located via one common mechanism. - + Debug information does not have to be associated with releases. The unique debug identifier ensures that Sentry can choose the right files for every crash report. However, it is still recommended to configure releases in the client to benefit from other features. - +> For native events, the issue details page displays a list of _Loaded Images_. This list contains the executable and all loaded dynamic libraries including diff --git a/docs/platforms/flutter/data-management/debug-files/index.mdx b/docs/platforms/flutter/data-management/debug-files/index.mdx index b5a401b9febf2..68d9d758dae78 100644 --- a/docs/platforms/flutter/data-management/debug-files/index.mdx +++ b/docs/platforms/flutter/data-management/debug-files/index.mdx @@ -24,12 +24,12 @@ the following formats: - [_ProGuard mappings_](./file-formats/#proguard-mappings) for Java and Android - + Source maps, while also being debug information files, are handled differently in Sentry. For more information see [Source Maps in sentry-cli](/cli/releases/#sentry-cli-sourcemaps). - +> Sentry requires access to debug information files of your application as well as system libraries to provide fully symbolicated crash reports. You can either @@ -46,11 +46,11 @@ for automatic downloads. From the [Project Details](/product/projects/project-details/) page, click into settings, then click on _Debug Files_ in the page navigation. - +> ProGuard files are listed separately, in the _ProGuard_ section of the project settings page. - +> ## Retention Policy diff --git a/docs/platforms/flutter/data-management/debug-files/source-context/index.mdx b/docs/platforms/flutter/data-management/debug-files/source-context/index.mdx index 0e3997027df09..b4f6302441a45 100644 --- a/docs/platforms/flutter/data-management/debug-files/source-context/index.mdx +++ b/docs/platforms/flutter/data-management/debug-files/source-context/index.mdx @@ -20,11 +20,11 @@ needs to be uploaded alongside the debug information files. The recommended way to do this is by using `sentry-cli`. See [Creating Source Bundles](/cli/dif/#creating-source-bundles) for more information. - + For Flutter Android, iOS, and macOS, follow the instructions in the [Debug Symbols](/platforms/flutter/upload-debug/#uploading-source-code-context-for-flutter-android-ios-and-macos) guide. - +> After they've been uploaded you can review and manage source bundles the same as any other debug information file. See [Managing Debug Information Files](../#managing-debug-information-files). diff --git a/docs/platforms/flutter/data-management/sensitive-data/index.mdx b/docs/platforms/flutter/data-management/sensitive-data/index.mdx index 8712656e07c42..f00f388bddc67 100644 --- a/docs/platforms/flutter/data-management/sensitive-data/index.mdx +++ b/docs/platforms/flutter/data-management/sensitive-data/index.mdx @@ -23,13 +23,13 @@ We offer the following options depending on your legal and operational needs: - [configuring server-side scrubbing](/security-legal-pii/scrubbing/server-side-scrubbing/) to ensure Sentry does _not store_ data. Configuration changes are done in the Sentry UI and apply immediately for new events. - [running a local Relay](/product/relay/) on your own server between the SDK and Sentry, so that data is _not sent to_ Sentry while configuration can still be applied without deploying. - + Ensure that your team is aware of your company's policy around what can and cannot be sent to Sentry. We recommend determining this policy early in your implementation and communicating it as well as enforcing it via code review. If you are using Sentry in your mobile app, read our [frequently asked questions about mobile data privacy](/security-legal-pii/security/mobile-privacy/) to assist with Apple App Store and Google Play app privacy details. - +> If you _do not_ wish to use the default PII behavior, you can also choose to identify users in a more controlled manner, using our [user identity context](../../enriching-events/identify-user/). diff --git a/docs/platforms/flutter/enriching-events/attachments/index.mdx b/docs/platforms/flutter/enriching-events/attachments/index.mdx index 2985c7acf86b4..d8f817f8447aa 100644 --- a/docs/platforms/flutter/enriching-events/attachments/index.mdx +++ b/docs/platforms/flutter/enriching-events/attachments/index.mdx @@ -47,11 +47,11 @@ Attachments live on the Scope - + Sentry allows at most 20MB for a compressed request, and at most 100MB of uncompressed attachments per event, including the crash report file (if applicable). Uploads exceeding this size are rejected with HTTP error `413 Payload Too Large` and the data is dropped immediately. To add larger or more files, consider secondary storage options. - +> Attachments persist for 30 days; if your total storage included in your quota is exceeded, attachments will not be stored. You can delete attachments or their containing events at any time. Deleting an attachment does not affect your quota - Sentry counts an attachment toward your quota as soon as it is stored. diff --git a/docs/platforms/flutter/enriching-events/context/index.mdx b/docs/platforms/flutter/enriching-events/context/index.mdx index dd07e216bbb9f..61e9904c92205 100644 --- a/docs/platforms/flutter/enriching-events/context/index.mdx +++ b/docs/platforms/flutter/enriching-events/context/index.mdx @@ -7,11 +7,11 @@ Custom contexts allow you to attach arbitrary data to an event. Often, this cont - + If you need to be able to search on custom data, [use tags](../tags) instead. - +> ## Structured Context diff --git a/docs/platforms/flutter/enriching-events/tags/index.mdx b/docs/platforms/flutter/enriching-events/tags/index.mdx index 5707e7b98110c..fce84a22ffbbe 100644 --- a/docs/platforms/flutter/enriching-events/tags/index.mdx +++ b/docs/platforms/flutter/enriching-events/tags/index.mdx @@ -17,11 +17,11 @@ Define the tag: - + Some tags are automatically set by Sentry. We strongly recommend against overwriting these [tags](/concepts/search/searchable-properties/#search-properties). Instead, name your tags with your organization's nomenclature. If you overwrite an automatically set tag, you must use [explicit tag syntax](/concepts/search/#explicit-tag-syntax) to search for it. - +> Once you've started sending tagged data, you'll see it when logged in to sentry.io. There, you can view the filters within the sidebar on the Project page, summarized within an event, and on the Tags page for an aggregated event. diff --git a/docs/platforms/flutter/enriching-events/viewhierarchy/index.mdx b/docs/platforms/flutter/enriching-events/viewhierarchy/index.mdx index ba601c80a9b08..9268c2bf49a42 100644 --- a/docs/platforms/flutter/enriching-events/viewhierarchy/index.mdx +++ b/docs/platforms/flutter/enriching-events/viewhierarchy/index.mdx @@ -9,11 +9,11 @@ Sentry makes it possible to render a JSON representation of the view hierarchy o This feature only applies to SDKs with a user interface, such as the ones for mobile and desktop applications. In some environments like native iOS, rendering the view hierarchy requires the UI thread and in the event of a crash, that might not be available. Another example where the view hierarchy might not be available is when the event happens before the screen starts to load. So inherently, this feature is a best effort solution. - + Deobfuscation for view hierarchies is fully supported for native SDKs, and React Native, but is currently not supported for Flutter. - +> ## Enabling View Hierarchy Attachments @@ -23,11 +23,11 @@ View hierarchy debugging is an opt-in feature. You can enable it as shown below: ### Customize View Hierarchy Capturing - +> Requires SDK version `8.13.0` or higher. - +> Capturing view hierarchies on Flutter is limited to once every 2 seconds by default to minimize performance impact. While this debounce interval is fixed, you can override individual capture decisions by implementing the `beforeCaptureViewHierarchy` option in your `SentryFlutterOptions`. diff --git a/docs/platforms/flutter/index.mdx b/docs/platforms/flutter/index.mdx index 195ab2adccf56..1288a957be35e 100644 --- a/docs/platforms/flutter/index.mdx +++ b/docs/platforms/flutter/index.mdx @@ -13,11 +13,11 @@ categories: On this page, we get you up and running with Sentry's Flutter SDK. - + If you don't already have an account and Sentry project established, head over to [sentry.io](https://sentry.io/signup/), then return to this page. - +> ## Features diff --git a/docs/platforms/flutter/integrations/app-start-instrumentation.mdx b/docs/platforms/flutter/integrations/app-start-instrumentation.mdx index 23f7f85e9873a..6656e20fd7afe 100644 --- a/docs/platforms/flutter/integrations/app-start-instrumentation.mdx +++ b/docs/platforms/flutter/integrations/app-start-instrumentation.mdx @@ -10,11 +10,11 @@ categories: Sentry's app start instrumentation provides insight into how long your application takes to launch. - + App start instrumentation is available on **iOS** and **Android**. - +> ## Instrumentation Behaviour @@ -27,11 +27,11 @@ When the SDK receives the start and end times of the app launch, the SDK: - Attaches a span with either `app.start.cold` or `app.start.warm` operation - Adds app start metrics to the transaction - +> While the SDK differentiates between cold and warm starts, it doesn't track hot starts/resumes. - +> ## Prerequisites diff --git a/docs/platforms/flutter/integrations/routing-instrumentation.mdx b/docs/platforms/flutter/integrations/routing-instrumentation.mdx index d95e5173770c9..77c2c081433b8 100644 --- a/docs/platforms/flutter/integrations/routing-instrumentation.mdx +++ b/docs/platforms/flutter/integrations/routing-instrumentation.mdx @@ -11,11 +11,11 @@ categories: Sentry's routing instrumentation for Flutter automatically tracks and reports page navigation events in your app. It supports both [traditional Flutter routing](https://docs.flutter.dev/ui/navigation) and the [GoRouter](https://pub.dev/packages/go_router) package. - + The routing instrumentation feature is shipped with Sentry's Flutter SDK automatically. - +> ## Prerequisites diff --git a/docs/platforms/flutter/integrations/slow-and-frozen-frames-instrumentation.mdx b/docs/platforms/flutter/integrations/slow-and-frozen-frames-instrumentation.mdx index f4a79aa952711..c482a70499d98 100644 --- a/docs/platforms/flutter/integrations/slow-and-frozen-frames-instrumentation.mdx +++ b/docs/platforms/flutter/integrations/slow-and-frozen-frames-instrumentation.mdx @@ -12,11 +12,11 @@ Unresponsive UI and animation hitches annoy users and degrade the user experienc This integration can help. Set it up and identify these problems in your app by tracking and showing **slow frames**, **frozen frames**, and **frame delay** metrics for spans. Learn more about frame delay [here](https://develop.sentry.dev/sdk/performance/frames-delay/). - + Frames tracking instrumentation is available on **iOS**, **macOS** and **Android**. - +> ## Instrumentation Behaviour diff --git a/docs/platforms/flutter/metrics/index.mdx b/docs/platforms/flutter/metrics/index.mdx index b9ab11be0d474..573ce7cd90fc5 100644 --- a/docs/platforms/flutter/metrics/index.mdx +++ b/docs/platforms/flutter/metrics/index.mdx @@ -7,11 +7,11 @@ sidebar_hidden: true - + Metrics are supported with Sentry Flutter SDK version `7.19.0` and above. - +> Sentry metrics help you pinpoint and solve issues that impact user experience and app performance by measuring the data points that are important to you. You can track things like processing time, event size, user signups, and conversion rates, then correlate them back to tracing data in order to get deeper insights and solve issues faster. diff --git a/docs/platforms/flutter/profiling/index.mdx b/docs/platforms/flutter/profiling/index.mdx index 74fcb42a6144f..9991a01c04a7f 100644 --- a/docs/platforms/flutter/profiling/index.mdx +++ b/docs/platforms/flutter/profiling/index.mdx @@ -9,11 +9,11 @@ sidebar_order: 5000 The profiling feature captures profiles across multiple language layers, including native languages (such as Swift and Objective-C) as well as Dart. - + Flutter Profiling alpha is available for **iOS** and **macOS** since SDK version `7.12.0`. - +> ## Enable Tracing diff --git a/docs/platforms/flutter/session-replay/index.mdx b/docs/platforms/flutter/session-replay/index.mdx index e5c1fbef33f86..422ae56488bbf 100644 --- a/docs/platforms/flutter/session-replay/index.mdx +++ b/docs/platforms/flutter/session-replay/index.mdx @@ -5,11 +5,11 @@ notSupported: description: "Learn how to enable Session Replay in your mobile app." --- - + Flutter Session Replay is available on **iOS** and **Android**. This SDK support is still experimental as we iron out any bugs that are reported. If you encounter any issues please let us know via a GitHub ticket. - +> [Session Replay](/product/explore/session-replay/) helps you get to the root cause of an error or latency issue faster by providing you with a reproduction of what was happening in the user's device before, during, and after the issue. You can rewind and replay your application's state and see key user interactions, like taps, swipes, network requests, and console entries, in a single UI. diff --git a/docs/platforms/flutter/tracing/index.mdx b/docs/platforms/flutter/tracing/index.mdx index 3c8f0ff00637c..ac73e1ce2f823 100644 --- a/docs/platforms/flutter/tracing/index.mdx +++ b/docs/platforms/flutter/tracing/index.mdx @@ -6,11 +6,11 @@ sidebar_order: 4000 With [tracing](/product/performance/), Sentry tracks your software performance, measuring metrics like throughput and latency, and displaying the impact of errors across multiple systems. Sentry captures distributed traces consisting of transactions and spans, which measure individual services and individual operations within those services. Learn more about our model in [Distributed Tracing](/product/sentry-basics/tracing/distributed-tracing/). - + If you’re adopting Tracing in a high-throughput environment, we recommend testing prior to deployment to ensure that your service’s performance characteristics maintain expectations. - +> ## Configure diff --git a/docs/platforms/flutter/tracing/instrumentation/automatic-instrumentation.mdx b/docs/platforms/flutter/tracing/instrumentation/automatic-instrumentation.mdx index 45134cbb4ddf8..14bac52388500 100644 --- a/docs/platforms/flutter/tracing/instrumentation/automatic-instrumentation.mdx +++ b/docs/platforms/flutter/tracing/instrumentation/automatic-instrumentation.mdx @@ -4,11 +4,11 @@ description: "Learn what transactions are captured after tracing is enabled." sidebar_order: 10 --- - + Capturing transactions requires that you first set up tracing if you haven't already. - +> ### Routing diff --git a/docs/platforms/flutter/tracing/instrumentation/custom-instrumentation.mdx b/docs/platforms/flutter/tracing/instrumentation/custom-instrumentation.mdx index ff29395a8e6d4..28bba1956ab23 100644 --- a/docs/platforms/flutter/tracing/instrumentation/custom-instrumentation.mdx +++ b/docs/platforms/flutter/tracing/instrumentation/custom-instrumentation.mdx @@ -4,11 +4,11 @@ description: "Learn how to capture performance data on any action in your app." sidebar_order: 20 --- - + To capture transactions and spans customized to your organization's needs, you must first set up tracing. - +> diff --git a/docs/platforms/flutter/upload-debug.mdx b/docs/platforms/flutter/upload-debug.mdx index 1ef2ee76c73be..441f43b57861a 100644 --- a/docs/platforms/flutter/upload-debug.mdx +++ b/docs/platforms/flutter/upload-debug.mdx @@ -10,11 +10,11 @@ We offer a range of methods to provide Sentry with debug symbols so that you can With default settings, complete stack traces are available in your Dart error, out of the box, unless you use [`split-debug-info`](https://flutter.dev/docs/perf/app-size#reducing-app-size) and [`obfuscate`](https://flutter.dev/docs/deployment/obfuscate). In those cases, you need to upload the debug information files generated by the `flutter` build, so Sentry can show you proper stack traces. - + For Flutter Desktop (Windows/Linux) `split-debug-info` and `obfuscate` flags are not supported yet. See this [issue](https://github.com/getsentry/sentry-dart/issues/433). - +> Errors raised from the native layer in Flutter apps require certain debug information files to be uploaded. For example, an Android app can use `proguard` for minification and obfuscation. And when using NDK, dwarf debug files need to be uploaded. Flutter Web requires sourcemaps and iOS apps also require dwarf debug information files. @@ -44,11 +44,11 @@ sentry: auth_token: ___ORG_AUTH_TOKEN___ ``` - +> The option `upload_debug_symbols` is enabled by default. That means the plugin will automatically upload debug symbols for all platforms except Flutter Web. - +> #### Source Maps @@ -75,12 +75,12 @@ sentry: ``` - +> This uploads the source files of the Dart/Flutter code, not the native code. If you want to use source context for native code, you need to setup source context in the respective native platform. - +> In addition to configuring the plugin in the `pubspec.yaml` file, the plugin supports using a properties file or environment variables. For more information, read the [Sentry Dart Plugin README](https://github.com/getsentry/sentry-dart-plugin/tree/main?tab=readme-ov-file#configuration-optional). @@ -100,11 +100,11 @@ For an obfuscated build: - `flutter build ios --obfuscate --split-debug-info=` - `flutter build macos --obfuscate --split-debug-info=` - +> For Flutter web run `flutter build web --release --source-maps` to generate source maps. - +> ### 4. Run @@ -114,11 +114,11 @@ Now we can run the plugin to upload the debug symbols, source maps, and sources flutter packages pub run sentry_dart_plugin ``` - +> If you choose not to obfuscate your build, the plugin will not upload debug symbols but will still configure source context if enabled. - +> ### Proguard @@ -167,11 +167,11 @@ See our docs on uploading [Debug Information Files](/cli/dif/#uploading-files) m If you're using a version of `sentry_flutter` earlier than 5.1, native symbolication on Android requires a specific configuration. Refer to [Troubleshooting](/platforms/flutter/troubleshooting/#native-symbolication-on-android) for more information. - +> Sentry's Flutter SDK doesn't currently support the `uploadNativeSymbols` flag from the [Sentry Gradle Plugin](/platforms/android/configuration/gradle/). - +> ### Web diff --git a/docs/platforms/flutter/usage/index.mdx b/docs/platforms/flutter/usage/index.mdx index b16027dca53db..c1a3a8529cf51 100644 --- a/docs/platforms/flutter/usage/index.mdx +++ b/docs/platforms/flutter/usage/index.mdx @@ -6,7 +6,7 @@ sidebar_order: 10 Sentry's SDK hooks into your runtime environment and automatically reports errors, uncaught exceptions, and unhandled rejections as well as other types of errors depending on the platform. - + Key terms: @@ -15,7 +15,7 @@ Key terms: - The reporting of an event is called _capturing_. When an event is captured, it’s sent to Sentry. - +> The most common form of capturing is to capture errors. What can be captured as an error varies by platform. In general, if you have something that looks like an exception, it can be captured. For some SDKs, you can also omit the argument to and Sentry will attempt to capture the current exception. It is also useful for manual reporting of errors or messages to Sentry. diff --git a/docs/platforms/go/common/configuration/releases.mdx b/docs/platforms/go/common/configuration/releases.mdx index babb58d14dcbd..55156ebd7329b 100644 --- a/docs/platforms/go/common/configuration/releases.mdx +++ b/docs/platforms/go/common/configuration/releases.mdx @@ -29,11 +29,11 @@ The value can be arbitrary, but we recommend either of these naming strategies: - `build` is the number that identifies an iteration of your app (`CFBundleVersion` on iOS, `versionCode` on Android) - **Commit SHA**: If you use a version control system like Git, we recommend using the identifying hash (for example, the commit SHA, `da39a3ee5e6b4b0d3255bfef95601890afd80709`). You can let Sentry CLI automatically determine this hash for supported version control systems. Learn more in our [Sentry CLI](/cli/releases/#creating-releases) documentation. - + Releases are global per organization; prefix them with something project-specific for easy differentiation. - +> The behavior of a few features depends on whether a project is using semantic or time-based versioning. diff --git a/docs/platforms/go/common/configuration/sampling.mdx b/docs/platforms/go/common/configuration/sampling.mdx index bc66495c36665..f9226c37f149c 100644 --- a/docs/platforms/go/common/configuration/sampling.mdx +++ b/docs/platforms/go/common/configuration/sampling.mdx @@ -14,11 +14,11 @@ To send a representative sample of your errors to Sentry, set the + Changing the error sample rate requires re-deployment. In addition, setting an SDK sample rate limits visibility into the source of events. Setting a rate limit for your project (which only drops events when volume is high) may better suit your needs. - +> ## Sampling Transaction Events diff --git a/docs/platforms/go/common/data-management/sensitive-data/index.mdx b/docs/platforms/go/common/data-management/sensitive-data/index.mdx index 8712656e07c42..f00f388bddc67 100644 --- a/docs/platforms/go/common/data-management/sensitive-data/index.mdx +++ b/docs/platforms/go/common/data-management/sensitive-data/index.mdx @@ -23,13 +23,13 @@ We offer the following options depending on your legal and operational needs: - [configuring server-side scrubbing](/security-legal-pii/scrubbing/server-side-scrubbing/) to ensure Sentry does _not store_ data. Configuration changes are done in the Sentry UI and apply immediately for new events. - [running a local Relay](/product/relay/) on your own server between the SDK and Sentry, so that data is _not sent to_ Sentry while configuration can still be applied without deploying. - + Ensure that your team is aware of your company's policy around what can and cannot be sent to Sentry. We recommend determining this policy early in your implementation and communicating it as well as enforcing it via code review. If you are using Sentry in your mobile app, read our [frequently asked questions about mobile data privacy](/security-legal-pii/security/mobile-privacy/) to assist with Apple App Store and Google Play app privacy details. - +> If you _do not_ wish to use the default PII behavior, you can also choose to identify users in a more controlled manner, using our [user identity context](../../enriching-events/identify-user/). diff --git a/docs/platforms/go/common/enriching-events/attachments/index.mdx b/docs/platforms/go/common/enriching-events/attachments/index.mdx index c963923aca4d8..db5185aa5a760 100644 --- a/docs/platforms/go/common/enriching-events/attachments/index.mdx +++ b/docs/platforms/go/common/enriching-events/attachments/index.mdx @@ -3,11 +3,11 @@ title: Attachments description: "Learn more about how Sentry can store additional files in the same request as event attachments." --- - + Attachments are supported in `sentry-go` version `0.23.0` and above. - +> Sentry can enrich your events for further investigation by storing additional files, such as config or log files, as attachments. @@ -15,11 +15,11 @@ Sentry can enrich your events for further investigation by storing additional fi - +> Sentry allows at most 20MB for a compressed request, and at most 100MB of uncompressed attachments per event, including the crash report file (if applicable). Uploads exceeding this size are rejected with HTTP error `413 Payload Too Large` and the data is dropped immediately. To add larger or more files, consider secondary storage options. - +> Attachments persist for 30 days; if your total storage included in your quota is exceeded, attachments will not be stored. You can delete attachments or their containing events at any time. Deleting an attachment does not affect your quota - Sentry counts an attachment toward your quota as soon as it is stored. diff --git a/docs/platforms/go/common/enriching-events/context/index.mdx b/docs/platforms/go/common/enriching-events/context/index.mdx index dd07e216bbb9f..61e9904c92205 100644 --- a/docs/platforms/go/common/enriching-events/context/index.mdx +++ b/docs/platforms/go/common/enriching-events/context/index.mdx @@ -7,11 +7,11 @@ Custom contexts allow you to attach arbitrary data to an event. Often, this cont - + If you need to be able to search on custom data, [use tags](../tags) instead. - +> ## Structured Context diff --git a/docs/platforms/go/common/enriching-events/tags/index.mdx b/docs/platforms/go/common/enriching-events/tags/index.mdx index 5707e7b98110c..fce84a22ffbbe 100644 --- a/docs/platforms/go/common/enriching-events/tags/index.mdx +++ b/docs/platforms/go/common/enriching-events/tags/index.mdx @@ -17,11 +17,11 @@ Define the tag: - + Some tags are automatically set by Sentry. We strongly recommend against overwriting these [tags](/concepts/search/searchable-properties/#search-properties). Instead, name your tags with your organization's nomenclature. If you overwrite an automatically set tag, you must use [explicit tag syntax](/concepts/search/#explicit-tag-syntax) to search for it. - +> Once you've started sending tagged data, you'll see it when logged in to sentry.io. There, you can view the filters within the sidebar on the Project page, summarized within an event, and on the Tags page for an aggregated event. diff --git a/docs/platforms/go/common/index.mdx b/docs/platforms/go/common/index.mdx index 5eee98f614226..e05d67985c606 100644 --- a/docs/platforms/go/common/index.mdx +++ b/docs/platforms/go/common/index.mdx @@ -26,10 +26,10 @@ This snippet includes an intentional error, so you can test that everything is w - + Learn more about manually capturing an error or message in our Usage documentation. - +> To view and resolve the recorded error, log into [sentry.io](https://sentry.io) and select your project. Clicking on the error's title will open a page where you can see detailed information and mark it as resolved. diff --git a/docs/platforms/go/common/tracing/index.mdx b/docs/platforms/go/common/tracing/index.mdx index b8dac419bd1ec..f14d518739278 100644 --- a/docs/platforms/go/common/tracing/index.mdx +++ b/docs/platforms/go/common/tracing/index.mdx @@ -6,11 +6,11 @@ sidebar_order: 4000 With [tracing](/product/performance/), Sentry tracks your software performance, measuring metrics like throughput and latency, and displaying the impact of errors across multiple systems. Sentry captures distributed traces consisting of transactions and spans, which measure individual services and individual operations within those services. Learn more about our model in [Distributed Tracing](/product/sentry-basics/tracing/distributed-tracing/). - + If you’re adopting Tracing in a high-throughput environment, we recommend testing prior to deployment to ensure that your service’s performance characteristics maintain expectations. - +> diff --git a/docs/platforms/go/common/tracing/instrumentation/custom-instrumentation/index.mdx b/docs/platforms/go/common/tracing/instrumentation/custom-instrumentation/index.mdx index a9e53aaa98de7..25785c62501ea 100644 --- a/docs/platforms/go/common/tracing/instrumentation/custom-instrumentation/index.mdx +++ b/docs/platforms/go/common/tracing/instrumentation/custom-instrumentation/index.mdx @@ -4,11 +4,11 @@ description: "Learn how to capture performance data on any action in your app." sidebar_order: 20 --- - + To capture transactions and spans customized to your organization's needs, you must first set up tracing. - +> diff --git a/docs/platforms/go/common/usage/index.mdx b/docs/platforms/go/common/usage/index.mdx index b16027dca53db..c1a3a8529cf51 100644 --- a/docs/platforms/go/common/usage/index.mdx +++ b/docs/platforms/go/common/usage/index.mdx @@ -6,7 +6,7 @@ sidebar_order: 10 Sentry's SDK hooks into your runtime environment and automatically reports errors, uncaught exceptions, and unhandled rejections as well as other types of errors depending on the platform. - + Key terms: @@ -15,7 +15,7 @@ Key terms: - The reporting of an event is called _capturing_. When an event is captured, it’s sent to Sentry. - +> The most common form of capturing is to capture errors. What can be captured as an error varies by platform. In general, if you have something that looks like an exception, it can be captured. For some SDKs, you can also omit the argument to and Sentry will attempt to capture the current exception. It is also useful for manual reporting of errors or messages to Sentry. diff --git a/docs/platforms/java/common/configuration/options.mdx b/docs/platforms/java/common/configuration/options.mdx index 80356f85d070b..8bf21febaf9d5 100644 --- a/docs/platforms/java/common/configuration/options.mdx +++ b/docs/platforms/java/common/configuration/options.mdx @@ -95,11 +95,11 @@ Grouping in Sentry is different for events with stack traces and without. As a r If this flag is enabled, certain personally identifiable information (PII) is added by active integrations. By default, no such data is sent. - + If you are using Sentry in your mobile app, read our [frequently asked questions about mobile data privacy](/security-legal-pii/security/mobile-privacy/) to assist with Apple App Store and Google Play app privacy details. - +> This option is turned off by default. diff --git a/docs/platforms/java/common/configuration/releases.mdx b/docs/platforms/java/common/configuration/releases.mdx index bbf6336dae8e6..47a401a7ad770 100644 --- a/docs/platforms/java/common/configuration/releases.mdx +++ b/docs/platforms/java/common/configuration/releases.mdx @@ -31,11 +31,11 @@ The value can be arbitrary, but we recommend either of these naming strategies: - `build` is the number that identifies an iteration of your app (`CFBundleVersion` on iOS, `versionCode` on Android) - **Commit SHA**: If you use a version control system like Git, we recommend using the identifying hash (for example, the commit SHA, `da39a3ee5e6b4b0d3255bfef95601890afd80709`). You can let Sentry CLI automatically determine this hash for supported version control systems. Learn more in our [Sentry CLI](/cli/releases/#creating-releases) documentation. - + Releases are global per organization; prefix them with something project-specific for easy differentiation. - +> The behavior of a few features depends on whether a project is using semantic or time-based versioning. diff --git a/docs/platforms/java/common/configuration/sampling.mdx b/docs/platforms/java/common/configuration/sampling.mdx index b11df278e4715..308ecec732881 100644 --- a/docs/platforms/java/common/configuration/sampling.mdx +++ b/docs/platforms/java/common/configuration/sampling.mdx @@ -14,11 +14,11 @@ To send a representative sample of your errors to Sentry, set the + Changing the error sample rate requires re-deployment. In addition, setting an SDK sample rate limits visibility into the source of events. Setting a rate limit for your project (which only drops events when volume is high) may better suit your needs. - +> ## Sampling Transaction Events diff --git a/docs/platforms/java/common/data-management/sensitive-data/index.mdx b/docs/platforms/java/common/data-management/sensitive-data/index.mdx index cf4de7c59a119..f9f67ae76bc95 100644 --- a/docs/platforms/java/common/data-management/sensitive-data/index.mdx +++ b/docs/platforms/java/common/data-management/sensitive-data/index.mdx @@ -23,13 +23,13 @@ We offer the following options depending on your legal and operational needs: - [configuring server-side scrubbing](/security-legal-pii/scrubbing/server-side-scrubbing/) to ensure Sentry does _not store_ data. Configuration changes are done in the Sentry UI and apply immediately for new events. - [running a local Relay](/product/relay/) on your own server between the SDK and Sentry, so that data is _not sent to_ Sentry while configuration can still be applied without deploying. - + Ensure that your team is aware of your company's policy around what can and cannot be sent to Sentry. We recommend determining this policy early in your implementation and communicating it as well as enforcing it via code review. If you are using Sentry in your mobile app, read our [frequently asked questions about mobile data privacy](/security-legal-pii/security/mobile-privacy/) to assist with Apple App Store and Google Play app privacy details. - +> ## Personally Identifiable Information (PII) diff --git a/docs/platforms/java/common/enriching-events/attachments/index.mdx b/docs/platforms/java/common/enriching-events/attachments/index.mdx index 8bf58e602c1ef..daf6ba0e8d09d 100644 --- a/docs/platforms/java/common/enriching-events/attachments/index.mdx +++ b/docs/platforms/java/common/enriching-events/attachments/index.mdx @@ -49,11 +49,11 @@ Attachments live on the Scope - + Sentry allows at most 20MB for a compressed request, and at most 100MB of uncompressed attachments per event, including the crash report file (if applicable). Uploads exceeding this size are rejected with HTTP error `413 Payload Too Large` and the data is dropped immediately. To add larger or more files, consider secondary storage options. - +> Attachments persist for 30 days; if your total storage included in your quota is exceeded, attachments will not be stored. You can delete attachments or their containing events at any time. Deleting an attachment does not affect your quota - Sentry counts an attachment toward your quota as soon as it is stored. diff --git a/docs/platforms/java/common/enriching-events/context/index.mdx b/docs/platforms/java/common/enriching-events/context/index.mdx index dd07e216bbb9f..61e9904c92205 100644 --- a/docs/platforms/java/common/enriching-events/context/index.mdx +++ b/docs/platforms/java/common/enriching-events/context/index.mdx @@ -7,11 +7,11 @@ Custom contexts allow you to attach arbitrary data to an event. Often, this cont - + If you need to be able to search on custom data, [use tags](../tags) instead. - +> ## Structured Context diff --git a/docs/platforms/java/common/enriching-events/tags/index.mdx b/docs/platforms/java/common/enriching-events/tags/index.mdx index 5707e7b98110c..fce84a22ffbbe 100644 --- a/docs/platforms/java/common/enriching-events/tags/index.mdx +++ b/docs/platforms/java/common/enriching-events/tags/index.mdx @@ -17,11 +17,11 @@ Define the tag: - + Some tags are automatically set by Sentry. We strongly recommend against overwriting these [tags](/concepts/search/searchable-properties/#search-properties). Instead, name your tags with your organization's nomenclature. If you overwrite an automatically set tag, you must use [explicit tag syntax](/concepts/search/#explicit-tag-syntax) to search for it. - +> Once you've started sending tagged data, you'll see it when logged in to sentry.io. There, you can view the filters within the sidebar on the Project page, summarized within an event, and on the Tags page for an aggregated event. diff --git a/docs/platforms/java/common/gradle/index.mdx b/docs/platforms/java/common/gradle/index.mdx index 22658a88101e3..55337c9ea2570 100644 --- a/docs/platforms/java/common/gradle/index.mdx +++ b/docs/platforms/java/common/gradle/index.mdx @@ -29,11 +29,11 @@ plugins { } ``` - + For non-Android projects, the plugin only collects external dependencies and uploads Source Context. - +> ### Configure diff --git a/docs/platforms/java/common/index.mdx b/docs/platforms/java/common/index.mdx index 29537b01815ea..7614784a774db 100644 --- a/docs/platforms/java/common/index.mdx +++ b/docs/platforms/java/common/index.mdx @@ -26,10 +26,10 @@ This snippet includes an intentional error, so you can test that everything is w - + Learn more about manually capturing an error or message in our Usage documentation. - +> To view and resolve the recorded error, log into [sentry.io](https://sentry.io) and select your project. Clicking on the error's title will open a page where you can see detailed information and mark it as resolved. diff --git a/docs/platforms/java/common/integrations/graphql.mdx b/docs/platforms/java/common/integrations/graphql.mdx index 7296b10388e6c..15f0c5da989a0 100644 --- a/docs/platforms/java/common/integrations/graphql.mdx +++ b/docs/platforms/java/common/integrations/graphql.mdx @@ -14,11 +14,11 @@ Sentry's [GraphQL Java](https://github.com/graphql-java/graphql-java/) integrati Our GraphQL integration can be configured automatically if you're using `spring-graphql` with either the `sentry-spring-boot-starter` or the `sentry-spring-boot-jakarta-starter` integration. - + If you're using version 22 of `graphql-java`, please refer to GraphQL 22 docs. - +> ## Install @@ -98,11 +98,11 @@ val graphql = GraphQL.newGraphQL() .build() ``` - +> 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 Filters). - +> ## Capture Tracing Information diff --git a/docs/platforms/java/common/integrations/graphql22.mdx b/docs/platforms/java/common/integrations/graphql22.mdx index 0299e9efd06dd..c8d8160f1c21e 100644 --- a/docs/platforms/java/common/integrations/graphql22.mdx +++ b/docs/platforms/java/common/integrations/graphql22.mdx @@ -14,11 +14,11 @@ Sentry's [GraphQL Java](https://github.com/graphql-java/graphql-java/) integrati Our GraphQL integration can be configured automatically if you're using `spring-graphql` with either the `sentry-spring-boot-starter` or the `sentry-spring-boot-jakarta-starter` integration. - + If you're using version 21 or older of `graphql-java`, please refer to GraphQL docs. - +> ## Install @@ -98,11 +98,11 @@ val graphql = GraphQL.newGraphQL() .build() ``` - +> 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 Filters). - +> ## Capture Tracing Information diff --git a/docs/platforms/java/common/integrations/quartz.mdx b/docs/platforms/java/common/integrations/quartz.mdx index 9a443a48258fa..f19ada0883df5 100644 --- a/docs/platforms/java/common/integrations/quartz.mdx +++ b/docs/platforms/java/common/integrations/quartz.mdx @@ -58,14 +58,14 @@ SimpleTriggerFactoryBean trigger = new SimpleTriggerFactoryBean(); trigger.setJobDataAsMap(Collections.singletonMap(SENTRY_SLUG_KEY, "monitor_slug_simple_trigger")); ``` - + Setting the monitor slug on the `Trigger` will override what is set on the `JobDetail`. This also means you can set up a separate monitor per `Trigger`. - +> - +> Setting a global job listener using a `SchedulerFactoryBeanCustomizer` in Spring Boot, will override the listener set by Sentry. For Sentry to work properly, you need to add a new `SentryJobListener` instance to the global job listeners. - +> diff --git a/docs/platforms/java/common/tracing/index.mdx b/docs/platforms/java/common/tracing/index.mdx index 24288935b2429..eac12074625cc 100644 --- a/docs/platforms/java/common/tracing/index.mdx +++ b/docs/platforms/java/common/tracing/index.mdx @@ -10,11 +10,11 @@ supported: With [tracing](/product/performance/), Sentry tracks your software performance, measuring metrics like throughput and latency, and displaying the impact of errors across multiple systems. Sentry captures distributed traces consisting of transactions and spans, which measure individual services and individual operations within those services. Learn more about our model in [Distributed Tracing](/product/sentry-basics/tracing/distributed-tracing/). - + If you’re adopting Tracing in a high-throughput environment, we recommend testing prior to deployment to ensure that your service’s performance characteristics maintain expectations. - +> diff --git a/docs/platforms/java/common/tracing/instrumentation/apollo.mdx b/docs/platforms/java/common/tracing/instrumentation/apollo.mdx index 7c21921928c13..435d7c2439ddd 100644 --- a/docs/platforms/java/common/tracing/instrumentation/apollo.mdx +++ b/docs/platforms/java/common/tracing/instrumentation/apollo.mdx @@ -9,19 +9,19 @@ notSupported: - java.jul --- - + Capturing transactions requires that you first set up tracing if you haven't already. - +> Sentry Apollo integration provides the `SentryApolloInterceptor`, which creates a span for each outgoing HTTP request executed with an [Apollo Android](https://github.com/apollographql/apollo-android) GraphQL client. - +> This integration supports Apollo 2.x. For Apollo 3.x use our Apollo3 integration. - +> ## Install @@ -81,11 +81,11 @@ Sentry.init(options -> { }, true) ``` - +> In Global Hub Mode, all threads use the same Hub. - +> ## Using With Kotlin Coroutines diff --git a/docs/platforms/java/common/tracing/instrumentation/apollo3.mdx b/docs/platforms/java/common/tracing/instrumentation/apollo3.mdx index 1f1aa50edba16..ff243eac389de 100644 --- a/docs/platforms/java/common/tracing/instrumentation/apollo3.mdx +++ b/docs/platforms/java/common/tracing/instrumentation/apollo3.mdx @@ -9,19 +9,19 @@ notSupported: - java.jul --- - + To be able to capture transactions, you'll need to first set up tracing. - +> Sentry's Apollo3 integration provides both the `SentryApollo3Interceptor` and the `SentryApollo3HttpInterceptor`, which create a span for each outgoing HTTP request executed with an [Apollo Kotlin](https://github.com/apollographql/apollo-kotlin) GraphQL client. The integration also provides extension functions on the `ApolloClient.Builder`. - +> This integration supports Apollo 3.x. It does not yet support Apollo4. If you're using Apollo4 and are interested in an integration for it, please track and upvote the related issue. - +> ## Install @@ -123,11 +123,11 @@ Sentry.init(options -> { }, true) ``` - +> In Global Hub Mode, all threads use the same Hub. - +> ## Using With Kotlin Coroutines diff --git a/docs/platforms/java/common/tracing/instrumentation/custom-instrumentation/index.mdx b/docs/platforms/java/common/tracing/instrumentation/custom-instrumentation/index.mdx index 54eec878909f6..f77ef3323f641 100644 --- a/docs/platforms/java/common/tracing/instrumentation/custom-instrumentation/index.mdx +++ b/docs/platforms/java/common/tracing/instrumentation/custom-instrumentation/index.mdx @@ -4,11 +4,11 @@ description: "Learn how to capture performance data on any action in your app." sidebar_order: 20 --- - + To capture transactions and spans customized to your organization's needs, you must first set up tracing. - +> diff --git a/docs/platforms/java/common/tracing/instrumentation/file-io.mdx b/docs/platforms/java/common/tracing/instrumentation/file-io.mdx index fc58082918fb8..c94556fbfb968 100644 --- a/docs/platforms/java/common/tracing/instrumentation/file-io.mdx +++ b/docs/platforms/java/common/tracing/instrumentation/file-io.mdx @@ -8,11 +8,11 @@ notSupported: - java.jul --- - + Capturing transactions requires that you first set up tracing if you haven't already. - +> Sentry file I/O integration provides the `SentryFileInputStream`/`SentryFileOutputStream` and `SentryFileReader`/`SentryFileWriter`, which create a span for each File read/write operation. diff --git a/docs/platforms/java/common/tracing/instrumentation/jdbc.mdx b/docs/platforms/java/common/tracing/instrumentation/jdbc.mdx index b019ab18b8666..559f793c90c64 100644 --- a/docs/platforms/java/common/tracing/instrumentation/jdbc.mdx +++ b/docs/platforms/java/common/tracing/instrumentation/jdbc.mdx @@ -9,11 +9,11 @@ notSupported: - java.jul --- - + Capturing transactions requires that you first set up tracing if you haven't already. - +> Sentry JDBC integration provides the `SentryJdbcEventListener` for [P6Spy](https://github.com/p6spy/p6spy/) database activity interceptor, which creates a span for each JDBC statement executed over a proxied instance of `javax.sql.DataSource`. diff --git a/docs/platforms/java/common/tracing/instrumentation/okhttp.mdx b/docs/platforms/java/common/tracing/instrumentation/okhttp.mdx index 6b69cfdfd30ce..44ed035ade28d 100644 --- a/docs/platforms/java/common/tracing/instrumentation/okhttp.mdx +++ b/docs/platforms/java/common/tracing/instrumentation/okhttp.mdx @@ -9,11 +9,11 @@ notSupported: - java.jul --- - + To be able to capture transactions, you'll need to first set up tracing. - +> The `sentry-okhttp` library provides [OkHttp](https://github.com/square/okhttp) support for Sentry via the `SentryOkHttpInterceptor` and the `SentryOkHttpEventListener`, which create a span for each outgoing HTTP request executed with an OkHttp client. The source can be found [on GitHub](https://github.com/getsentry/sentry-java/tree/main/sentry-okhttp). diff --git a/docs/platforms/java/common/tracing/instrumentation/open-feign.mdx b/docs/platforms/java/common/tracing/instrumentation/open-feign.mdx index 4480b247668d7..bc8b71833422f 100644 --- a/docs/platforms/java/common/tracing/instrumentation/open-feign.mdx +++ b/docs/platforms/java/common/tracing/instrumentation/open-feign.mdx @@ -9,11 +9,11 @@ notSupported: - java.jul --- - + Capturing transactions requires that you first set up tracing if you haven't already. - +> Sentry OpenFeign integration provides the `SentryFeignClient`, which creates a span for each outgoing HTTP request executed with a [Feign](https://github.com/OpenFeign/feign)-based HTTP client. diff --git a/docs/platforms/java/common/usage/index.mdx b/docs/platforms/java/common/usage/index.mdx index b16027dca53db..c1a3a8529cf51 100644 --- a/docs/platforms/java/common/usage/index.mdx +++ b/docs/platforms/java/common/usage/index.mdx @@ -6,7 +6,7 @@ sidebar_order: 10 Sentry's SDK hooks into your runtime environment and automatically reports errors, uncaught exceptions, and unhandled rejections as well as other types of errors depending on the platform. - + Key terms: @@ -15,7 +15,7 @@ Key terms: - The reporting of an event is called _capturing_. When an event is captured, it’s sent to Sentry. - +> The most common form of capturing is to capture errors. What can be captured as an error varies by platform. In general, if you have something that looks like an exception, it can be captured. For some SDKs, you can also omit the argument to and Sentry will attempt to capture the current exception. It is also useful for manual reporting of errors or messages to Sentry. diff --git a/docs/platforms/java/guides/spring-boot/logging-frameworks.mdx b/docs/platforms/java/guides/spring-boot/logging-frameworks.mdx index a50d5878c5a2b..e20615ed5da59 100644 --- a/docs/platforms/java/guides/spring-boot/logging-frameworks.mdx +++ b/docs/platforms/java/guides/spring-boot/logging-frameworks.mdx @@ -57,13 +57,13 @@ If you decide to opt-out from the `application.properties` based Spring Boot log ``` - + You do not need to configure your DSN in the Logback configuration file since Sentry is configured from the Spring Boot integration. However, if errors that may appear during startup should to be sent to Sentry, the DSN must be provided to both the Logback and Spring Boot configurations. - +> ### Log4j 2 @@ -110,10 +110,10 @@ Then [follow the guide on configuring Log4j 2 with Spring Boot](https://docs.spr ``` - +> You do not need to configure your DSN in the Log4j 2 configuration file since Sentry is configured from the Spring Boot integration. However, if errors that may appear during startup should to be sent to Sentry, the DSN must be provided to both the Log4j 2 and Spring Boot configurations. - +> diff --git a/docs/platforms/java/guides/spring-boot/record-user.mdx b/docs/platforms/java/guides/spring-boot/record-user.mdx index 6166ec00dcfbd..303c73a76fe07 100644 --- a/docs/platforms/java/guides/spring-boot/record-user.mdx +++ b/docs/platforms/java/guides/spring-boot/record-user.mdx @@ -4,9 +4,9 @@ sidebar_order: 7 description: "Learn about how you can record or customize the capture of user information." --- - + Recording user information is available only in the Spring MVC integration. - +> Record user information from an HTTP request or by registering a Spring bean for custom user information capture. diff --git a/docs/platforms/java/guides/spring-boot/tracing/instrumentation/automatic-instrumentation.mdx b/docs/platforms/java/guides/spring-boot/tracing/instrumentation/automatic-instrumentation.mdx index c09767b03044d..ba1b104a4100f 100644 --- a/docs/platforms/java/guides/spring-boot/tracing/instrumentation/automatic-instrumentation.mdx +++ b/docs/platforms/java/guides/spring-boot/tracing/instrumentation/automatic-instrumentation.mdx @@ -4,11 +4,11 @@ sidebar_order: 20 description: "Learn what transactions are captured after tracing is enabled." --- - + Capturing transactions requires that you first set up tracing if you haven't already. - +> ### Spring MVC Integration diff --git a/docs/platforms/java/guides/spring/tracing/instrumentation/automatic-instrumentation.mdx b/docs/platforms/java/guides/spring/tracing/instrumentation/automatic-instrumentation.mdx index cee7fd1feb5c2..1561569a4b8d0 100644 --- a/docs/platforms/java/guides/spring/tracing/instrumentation/automatic-instrumentation.mdx +++ b/docs/platforms/java/guides/spring/tracing/instrumentation/automatic-instrumentation.mdx @@ -4,11 +4,11 @@ sidebar_order: 20 description: "Learn what transactions we capture after tracing is enabled." --- - + Capturing transactions requires that you first set up tracing if you haven't already. - +> ### Spring MVC Integration diff --git a/docs/platforms/javascript/common/best-practices/micro-frontends.mdx b/docs/platforms/javascript/common/best-practices/micro-frontends.mdx index 6094889f64ac4..48a9dbdb58f9f 100644 --- a/docs/platforms/javascript/common/best-practices/micro-frontends.mdx +++ b/docs/platforms/javascript/common/best-practices/micro-frontends.mdx @@ -32,16 +32,16 @@ If your app uses micro frontends, it's very useful to be able to track which one Below you'll find setup instructions for both an automatic and a manual way to route errors to different Sentry projects. - + In all cases `Sentry.init()` must never be called more than once, doing so will result in undefined behavior. - +> ## Automatically Route Errors to Different Projects `ModuleMetadata` and `makeMultiplexedTransport` can be used together to automatically route events to specific Sentry projects that represent your micro frontend services. Events will be routed once the service where the error occurred has been identified, ensuring errors are tracked in the correct project. - +>
  • Requires version `2.18.0` or higher of `@sentry/webpack-plugin`, @@ -50,7 +50,7 @@ Below you'll find setup instructions for both an automatic and a manual way to r
  • Requires SDK version `7.59.0` or higher.
- +> To identify the source of an error, you must first inject metadata that helps identify which bundles were responsible for the error. You can do this with any of the @@ -134,19 +134,19 @@ init({ Once this is set up, errors - both handled and unhandled - will be automatically routed to the right project. - +> By default, `args.getEvent` returns only error events. You can match against other event types like so: `args.getEvent(['event', 'transaction', 'replay_event'])`. This `getEvent` snippet will return matches for errors, transactions, and replays. - +> ## Manually Route Errors to Different Projects If you want more control to be able to explicitly specify the destination for each individual `captureException`, you can use the more advanced interface multiplexed transport offers. -Requires SDK version `7.59.0` or higher. +>Requires SDK version `7.59.0` or higher.t> The example below uses a `feature` tag to determine which Sentry project to send the event to. If the event doesn't have a `feature` tag, we send it to the @@ -179,7 +179,7 @@ init({ You can then set tags/contexts on events in individual micro-frontends to decide which Sentry project to send the event to as follows: - +> It's important to always use a local scope when setting the tag (either as shown below or using{" "} @@ -188,7 +188,7 @@ You can then set tags/contexts on events in individual micro-frontends to decide ). Using a global scope, for example, through `Sentry.setTag()` will result in all subsequent events being routed to the same DSN regardless of where they originated. - +> ```typescript captureException(new Error("oh no!"), (scope) => { @@ -204,9 +204,9 @@ Starting with version [8.7.0](https://github.com/getsentry/sentry-javascript/rel However, for use cases like micro frontends, where you might _want_ SDK interaction across multiple micro frontends or child applications, you'll need to ensure that all SDKs are using the same version. For example, if you initialize the SDK in a host or skeleton application, but make Sentry SDK calls (like `Sentry.captureException` or `Sentry.setTag`) in micro frontend child applications, you need to ensure that the SDK packages in the host and child applications are aligned to the same version. - +> If you can't get all your micro frontends aligned on the same SDK version, you can [follow this workaround](https://github.com/getsentry/sentry-javascript/discussions/10576#discussioncomment-11446422). However, interoperability isn't guaranteed and you could run into some unexpected behavior. - +> diff --git a/docs/platforms/javascript/common/best-practices/multiple-sentry-instances.mdx b/docs/platforms/javascript/common/best-practices/multiple-sentry-instances.mdx index d2fc2efe087a7..649012307e8df 100644 --- a/docs/platforms/javascript/common/best-practices/multiple-sentry-instances.mdx +++ b/docs/platforms/javascript/common/best-practices/multiple-sentry-instances.mdx @@ -16,11 +16,11 @@ notSupported: keywords: ["multiple clients", "BrowserClient", "NodeClient", "monorepo"] --- - + Creating multiple Sentry clients is **not recommended** in general, as it can lead to unexpected behavior. In case you are using Micro Frontends or similar, multiplexing might be a better solution than using multiple clients. Check out [Micro Frontends](/platforms/javascript/best-practices/micro-frontends) in the Best Practices for more information. - +> To be able to manage several Sentry instances without any conflicts between them you need to create your own `Client`. This also helps to prevent tracking of any parent application errors in case your application is integrated diff --git a/docs/platforms/javascript/common/best-practices/shared-environments.mdx b/docs/platforms/javascript/common/best-practices/shared-environments.mdx index 9180a170894fa..0bd0ac2e3b8c6 100644 --- a/docs/platforms/javascript/common/best-practices/shared-environments.mdx +++ b/docs/platforms/javascript/common/best-practices/shared-environments.mdx @@ -24,11 +24,11 @@ keywords: ] --- - + We recommend using JavaScript SDK `8.x` and above when using the SDK with shared environments. Check out our [migration docs](https://docs.sentry.io/platforms/javascript/migration/) to upgrade from an older SDK version to `8.x` and above. - +> These best practices are relevant for you if you set up Sentry in one of the following use-cases: diff --git a/docs/platforms/javascript/common/configuration/application-not-responding.mdx b/docs/platforms/javascript/common/configuration/application-not-responding.mdx index bc6ddae0d6b1c..ac7092877a230 100644 --- a/docs/platforms/javascript/common/configuration/application-not-responding.mdx +++ b/docs/platforms/javascript/common/configuration/application-not-responding.mdx @@ -34,11 +34,11 @@ Application Not Responding (ANR) errors, or Event Loop Stall errors, are trigger - + ANR detection is not supported for [Node.js clusters](https://nodejs.org/api/cluster.html). - +> _(Available in version 7.91.0 and above)_ diff --git a/docs/platforms/javascript/common/configuration/filtering.mdx b/docs/platforms/javascript/common/configuration/filtering.mdx index 51731aadb0547..ec7a49722e447 100644 --- a/docs/platforms/javascript/common/configuration/filtering.mdx +++ b/docs/platforms/javascript/common/configuration/filtering.mdx @@ -90,11 +90,11 @@ _Available in browser-based SDKs from version 8.10.0_ The `thirdPartyErrorFilterIntegration` allows you to filter out errors originating from third parties, such as browser extensions, code-injecting browsers, or widgets from third-party services that also use Sentry. This integration can be very helpful in reducing noise that's not related to your own application code. - + **Prerequisite**: To use the `thirdPartyErrorFilterIntegration`, ensure you are using a bundler and one of [Sentry's bundler plugins](https://github.com/getsentry/sentry-javascript-bundler-plugins). - +> This integration works by "marking" your JavaScript files with an "application key" during the build process. At runtime, if an error occurs, this integration checks application keys for each stack frame in the stack trace. @@ -190,12 +190,12 @@ There are four modes you can choose from: If you choose a mode to only apply tags, the tags can then be used in Sentry to filter your issue stream with the `third_party_code` tag in the issue search bar. - +> The `thirdPartyErrorFilterIntegration` will not work with the [Sentry Loader Script or CDN Bundles](https://docs.sentry.io/platforms/javascript/install/loader/). This is the case because the Sentry Loader Script and CDN Bundles are detected as "third party" by the integration. This makes it apply the chosen behavior to almost all events, since the Sentry SDK wraps many browser-native APIs. - +> ## Filtering Transaction Events diff --git a/docs/platforms/javascript/common/configuration/integrations/inboundfilters.mdx b/docs/platforms/javascript/common/configuration/integrations/inboundfilters.mdx index 476ef86287752..628e80f55af5c 100644 --- a/docs/platforms/javascript/common/configuration/integrations/inboundfilters.mdx +++ b/docs/platforms/javascript/common/configuration/integrations/inboundfilters.mdx @@ -21,11 +21,11 @@ Sentry.init({ ## Options - + Remember to pass these options to the root Sentry.init call, not the integration! -{" "} +>{" "} ### `ignoreErrors` diff --git a/docs/platforms/javascript/common/configuration/options.mdx b/docs/platforms/javascript/common/configuration/options.mdx index 0fca67939aa86..3835918f53787 100644 --- a/docs/platforms/javascript/common/configuration/options.mdx +++ b/docs/platforms/javascript/common/configuration/options.mdx @@ -14,12 +14,12 @@ initialized. The list of common options across SDKs. These work more or less the same in all SDKs, but some subtle differences will exist to better support the platform. Options that can be read from an environment variable (`SENTRY_DSN`, `SENTRY_ENVIRONMENT`, `SENTRY_RELEASE`) are read automatically. - + If you are using a framework or runtime that requires a prefix to expose environment variables to the client, you must set these options in the `init()` function. These options will not be read into the client side automatically. This applies to `NEXT_PUBLIC_` in [Next.js](https://nextjs.org/docs/app/building-your-application/configuring/environment-variables) and `VITE_` in [Vite](https://vitejs.dev/guide/env-and-mode.html#env-files), among others. - +> diff --git a/docs/platforms/javascript/common/configuration/releases.mdx b/docs/platforms/javascript/common/configuration/releases.mdx index 755f3d838912e..c5f03294cbe55 100644 --- a/docs/platforms/javascript/common/configuration/releases.mdx +++ b/docs/platforms/javascript/common/configuration/releases.mdx @@ -31,11 +31,11 @@ The value can be arbitrary, but we recommend either of these naming strategies: - `build` is the number that identifies an iteration of your app (`CFBundleVersion` on iOS, `versionCode` on Android) - **Commit SHA**: If you use a version control system like Git, we recommend using the identifying hash (for example, the commit SHA, `da39a3ee5e6b4b0d3255bfef95601890afd80709`). You can let Sentry CLI automatically determine this hash for supported version control systems. Learn more in our [Sentry CLI](/cli/releases/#creating-releases) documentation. - + Releases are global per organization; prefix them with something project-specific for easy differentiation. - +> The behavior of a few features depends on whether a project is using semantic or time-based versioning. @@ -64,11 +64,11 @@ After configuring your SDK, you can install a repository integration or manually Monitor the [health of releases](/product/releases/health/) by observing user adoption, usage of the application, percentage of [crashes](/product/releases/health/#crash), and [session data](/product/releases/health/#session). Release health will provide insight into the impact of crashes and bugs as it relates to user experience, and reveal trends with each new issue through the [Release Details](/product/releases/release-details/) graphs and filters. - +> Crash reporting and app hang detection are not available for watchOS. - +> In order to monitor release health, the SDK sends session data. diff --git a/docs/platforms/javascript/common/configuration/sampling.mdx b/docs/platforms/javascript/common/configuration/sampling.mdx index 0bb775bea4b77..5ea9849dbf3d9 100644 --- a/docs/platforms/javascript/common/configuration/sampling.mdx +++ b/docs/platforms/javascript/common/configuration/sampling.mdx @@ -14,11 +14,11 @@ To send a representative sample of your errors to Sentry, set the + Changing the error sample rate requires re-deployment. In addition, setting an SDK sample rate limits visibility into the source of events. Setting a rate limit for your project (which only drops events when volume is high) may better suit your needs. - +> diff --git a/docs/platforms/javascript/common/configuration/tree-shaking.mdx b/docs/platforms/javascript/common/configuration/tree-shaking.mdx index ac89d6049d938..6c5846113c0a5 100644 --- a/docs/platforms/javascript/common/configuration/tree-shaking.mdx +++ b/docs/platforms/javascript/common/configuration/tree-shaking.mdx @@ -17,7 +17,7 @@ If you want to minimize the bundle size of the Sentry SDK, we recommend reading The Sentry SDK ships with code that is not strictly required for it to collect your errors. This includes code to debug your Sentry configuration or code to enable tracing, for example. While debug code can be very useful in development environments, it's not typically necessary to include it in your production bundles where it takes up valuable space. The JavaScript SDK includes special flags in its CommonJS and ESM distributions, which can be used to facilitate tree shaking (removal) of this kind of code during the build process. - + Anything that you don't import and use will automatically be tree shaken away when using any modern bundler like Webpack, Rollup, Vite, or similar. This means that optional integrations like Replay, BrowserTracing, @@ -25,7 +25,7 @@ The Sentry SDK ships with code that is not strictly required for it to collect y bundle unless you import and use them yourself. The rest of this page relates to ways to tree shake internal SDK code, which isn't strictly required unless you use certain features. - +> @@ -118,9 +118,9 @@ Replacing this flag with `false` will tree shake any SDK code that's related to Replacing this flag with `false` will tree shake any SDK code that's related to tracing. - +> `__SENTRY_TRACING__` must not be replaced with `false` when you're using any tracing-related SDK features (for example,`Sentry.startTransaction()`). This flag is intended to be used in combination with packages like `@sentry/next` or `@sentry/sveltekit`, which automatically include the tracing functionality. - +> This has no effect if you did not add `browserTracingIntegration`. @@ -284,12 +284,12 @@ getCurrentScope().setClient(client); client.init(); ``` - +> In contrast to `Sentry.init`, the `Client` constructor expects options of type `ClientOptions` instead of `Options`. This means that the `ClientOptions.integrations` property is the final array of all integrations that will be used. - +> /___PUBLIC_KEY___/?status=error HTT Host: ___ORG_INGEST_DOMAIN___ ``` - + If you expect your scheduled jobs to overlap, read about [Overlapping Jobs](#overlapping-jobs-optional) below. - +> ### Specifying monitor environments (Optional) @@ -173,11 +173,11 @@ This is an object specifying a `schedule_type` of either `crontab` or `interval` The amount of time (in minutes) Sentry should wait for your check-in before it's considered missed ("grace period"). Optional. - +> We recommend that your check-in margin be less than or equal to your interval. - +> `max_runtime`: diff --git a/docs/platforms/javascript/common/data-management/debug-files/identifiers/index.mdx b/docs/platforms/javascript/common/data-management/debug-files/identifiers/index.mdx index 20115c925e77e..d9a2cad0dc3fe 100644 --- a/docs/platforms/javascript/common/data-management/debug-files/identifiers/index.mdx +++ b/docs/platforms/javascript/common/data-management/debug-files/identifiers/index.mdx @@ -27,14 +27,14 @@ compute a _Debug Identifier_ for each uploaded file. This identifier is associated with executables and libraries as well as debug companions to ensure that they can be uniquely located via one common mechanism. - + Debug information does not have to be associated with releases. The unique debug identifier ensures that Sentry can choose the right files for every crash report. However, it is still recommended to configure releases in the client to benefit from other features. - +> For native events, the issue details page displays a list of _Loaded Images_. This list contains the executable and all loaded dynamic libraries including diff --git a/docs/platforms/javascript/common/data-management/debug-files/index.mdx b/docs/platforms/javascript/common/data-management/debug-files/index.mdx index f2806f21db4bd..5c725cc16b84d 100644 --- a/docs/platforms/javascript/common/data-management/debug-files/index.mdx +++ b/docs/platforms/javascript/common/data-management/debug-files/index.mdx @@ -27,12 +27,12 @@ the following formats: - [_ProGuard mappings_](./file-formats/#proguard-mappings) for Java and Android - + Source maps, while also being debug information files, are handled differently in Sentry. For more information see [Source Maps in sentry-cli](/cli/releases/#sentry-cli-sourcemaps). - +> Sentry requires access to debug information files of your application as well as system libraries to provide fully symbolicated crash reports. You can either @@ -49,11 +49,11 @@ for automatic downloads. From the [Project Details](/product/projects/project-details/) page, click into settings, then click on _Debug Files_ in the page navigation. - +> ProGuard files are listed separately, in the _ProGuard_ section of the project settings page. - +> ## Retention Policy diff --git a/docs/platforms/javascript/common/data-management/sensitive-data/index.mdx b/docs/platforms/javascript/common/data-management/sensitive-data/index.mdx index e1484770d884d..473db37f58e6e 100644 --- a/docs/platforms/javascript/common/data-management/sensitive-data/index.mdx +++ b/docs/platforms/javascript/common/data-management/sensitive-data/index.mdx @@ -24,13 +24,13 @@ We offer the following options depending on your legal and operational needs: - [configuring server-side scrubbing](/security-legal-pii/scrubbing/server-side-scrubbing/) to ensure Sentry does _not store_ data. Configuration changes are done in the Sentry UI and apply immediately for new events. - [running a local Relay](/product/relay/) on your own server between the SDK and Sentry, so that data is _not sent to_ Sentry while configuration can still be applied without deploying. - + Ensure that your team is aware of your company's policy around what can and cannot be sent to Sentry. We recommend determining this policy early in your implementation and communicating it as well as enforcing it via code review. If you are using Sentry in your mobile app, read our [frequently asked questions about mobile data privacy](/security-legal-pii/security/mobile-privacy/) to assist with Apple App Store and Google Play app privacy details. - +> If you _do not_ wish to use the default PII behavior, you can also choose to identify users in a more controlled manner, using our [user identity context](../../enriching-events/identify-user/). diff --git a/docs/platforms/javascript/common/enriching-events/attachments/index.mdx b/docs/platforms/javascript/common/enriching-events/attachments/index.mdx index 1b6bebddcc4ab..57514b81b37d3 100644 --- a/docs/platforms/javascript/common/enriching-events/attachments/index.mdx +++ b/docs/platforms/javascript/common/enriching-events/attachments/index.mdx @@ -13,11 +13,11 @@ You'll first need to import the SDK, as usual: - + Sentry allows at most 20MB for a compressed request, and at most 100MB of uncompressed attachments per event, including the crash report file (if applicable). Uploads exceeding this size are rejected with HTTP error `413 Payload Too Large` and the data is dropped immediately. To add larger or more files, consider secondary storage options. - +> Attachments persist for 30 days; if your total storage included in your quota is exceeded, attachments will not be stored. You can delete attachments or their containing events at any time. Deleting an attachment does not affect your quota - Sentry counts an attachment toward your quota as soon as it is stored. diff --git a/docs/platforms/javascript/common/enriching-events/context/index.mdx b/docs/platforms/javascript/common/enriching-events/context/index.mdx index f28b365f281fe..9bf9f04df68fb 100644 --- a/docs/platforms/javascript/common/enriching-events/context/index.mdx +++ b/docs/platforms/javascript/common/enriching-events/context/index.mdx @@ -7,11 +7,11 @@ Custom contexts allow you to attach arbitrary data to an event. Often, this cont - + If you need to be able to search on custom data, [use tags](../tags) instead. - +> ## Structured Context @@ -90,11 +90,11 @@ Sentry.captureException(new Error("something went wrong"), () => scope); Context is held in the current scope and thus is cleared when the scope is removed ("popped"). You can push and pop your own scopes to apply context data to a specific code block or function. - +> For Node.js backend frameworks, the SDK will create a separate scope for each incoming request. Modifying the context of the current scope in a request handler will therefore only affect events related to the request being handled. - +> Sentry supports two different ways for unsetting context: diff --git a/docs/platforms/javascript/common/enriching-events/tags/index.mdx b/docs/platforms/javascript/common/enriching-events/tags/index.mdx index 9f70cfb7d967b..e497a46a56fe5 100644 --- a/docs/platforms/javascript/common/enriching-events/tags/index.mdx +++ b/docs/platforms/javascript/common/enriching-events/tags/index.mdx @@ -21,11 +21,11 @@ Define the tag: - + Some tags are automatically set by Sentry. We strongly recommend against overwriting these [tags](/concepts/search/searchable-properties/#search-properties). Instead, name your tags with your organization's nomenclature. If you overwrite an automatically set tag, you must use [explicit tag syntax](/concepts/search/#explicit-tag-syntax) to search for it. - +> Once you've started sending tagged data, you'll see it when logged in to sentry.io. There, you can view the filters within the sidebar on the Project page, summarized within an event, and on the Tags page for an aggregated event. diff --git a/docs/platforms/javascript/common/enriching-events/transaction-name/index.mdx b/docs/platforms/javascript/common/enriching-events/transaction-name/index.mdx index fa2c9714ebeab..1a66b12e2d848 100644 --- a/docs/platforms/javascript/common/enriching-events/transaction-name/index.mdx +++ b/docs/platforms/javascript/common/enriching-events/transaction-name/index.mdx @@ -115,9 +115,9 @@ Sentry.init({ }); ``` - + Only do this if you can't set the root span name earlier using other options. - +> ## Further Information diff --git a/docs/platforms/javascript/common/index.mdx b/docs/platforms/javascript/common/index.mdx index 7b131092338d6..d2c1c22e19953 100644 --- a/docs/platforms/javascript/common/index.mdx +++ b/docs/platforms/javascript/common/index.mdx @@ -102,11 +102,11 @@ This snippet includes an intentional error, so you can test that everything is w - + Learn more about manually capturing an error or message in our Usage documentation. - +> To view and resolve the recorded error, log into [sentry.io](https://sentry.io) and select your project. Clicking on the error's title will open a page where you can see detailed information and mark it as resolved. diff --git a/docs/platforms/javascript/common/install/index.mdx b/docs/platforms/javascript/common/install/index.mdx index fb65f1d213fef..5fd374049b5f6 100644 --- a/docs/platforms/javascript/common/install/index.mdx +++ b/docs/platforms/javascript/common/install/index.mdx @@ -74,11 +74,11 @@ Using the Loader Script is the easiest way to start using Sentry. Add a script t - **Lazy-loading**: If you just want to use Sentry for errors, we'll only load the SDK when an error occurs, reducing the amount of JavaScript loaded on your page until then. - + Note that when enabling Session Replay and/or Tracing, the SDK will be loaded immediately because we need to capture what's happening on the page as early as possible. - + > ### Why Choose NPM Over the Loader Script diff --git a/docs/platforms/javascript/common/install/late-initialization.mdx b/docs/platforms/javascript/common/install/late-initialization.mdx index 2f9285fe9139a..54e524b3a3d14 100644 --- a/docs/platforms/javascript/common/install/late-initialization.mdx +++ b/docs/platforms/javascript/common/install/late-initialization.mdx @@ -21,11 +21,11 @@ In order for auto-instrumentation to work, it is generally required to run `Sent However, in some cases this may not be possible to do—for example, if you are fetching your DSN from an external source. In this case, you can use the `@sentry/node/preload` hook to ensure modules are wrapped early, which allows you to call `Sentry.init()` later at a time of your choosing. - + We recommend to only use this method if strictly necessary. In most cases, it is better to find a way to run `Sentry.init()` early in your application, in order to ensure that no error can go unreported. - +> This initialization method is available starting in version **8.5.0**. diff --git a/docs/platforms/javascript/common/opentelemetry/custom-setup.mdx b/docs/platforms/javascript/common/opentelemetry/custom-setup.mdx index b05d4b79d7c6b..e9b1758842846 100644 --- a/docs/platforms/javascript/common/opentelemetry/custom-setup.mdx +++ b/docs/platforms/javascript/common/opentelemetry/custom-setup.mdx @@ -24,13 +24,13 @@ notSupported: sidebar_order: 0 --- - + Use this guide when you already have a completely custom OpenTelemetry setup or when you intend to add a custom OpenTelemetry setup next to the Sentry SDK. If you are looking to simply add individual OpenTelemetry instrumentation to your Sentry setup, you should read Adding Additional OpenTelemetry Instrumentation instead. - +> To use an existing OpenTelemetry setup, set `skipOpenTelemetrySetup: true` in your `init({})` config, then set up all the components that Sentry needs yourself. Finish by installing `@sentry/opentelemetry` and adding the following: @@ -93,7 +93,7 @@ In order for the Sentry SDK to work as expected, and for it to be in sync with O - **SentrySpanProcessor**: Ensures that spans are correctly sent to Sentry. - +> Trace propagation is needed for Sentry to automatically connect services together. (For example, if you want to connect the frontend and backend, or different backend services.) This makes it possible to see related errors @@ -101,7 +101,7 @@ In order for the Sentry SDK to work as expected, and for it to be in sync with O Learn more about Trace Propagation. - +> The following code snippet shows how to set up Sentry for error monitoring only: @@ -165,14 +165,14 @@ If tracing is not enabled (no `tracesSampleRate` is defined in the SDK configura - + > If tracing is not enabled, performance instrumentations will not be registered but they will still be included in the bundle. If you want to reduce the bundle size or used dependencies, you can also{" "} Set up Sentry without Performance Integrations - + > These are needed to make sure that trace propagation works correctly. diff --git a/docs/platforms/javascript/common/opentelemetry/using-opentelemetry-apis.mdx b/docs/platforms/javascript/common/opentelemetry/using-opentelemetry-apis.mdx index 4ea751284fd04..45fb1719d106f 100644 --- a/docs/platforms/javascript/common/opentelemetry/using-opentelemetry-apis.mdx +++ b/docs/platforms/javascript/common/opentelemetry/using-opentelemetry-apis.mdx @@ -47,7 +47,7 @@ Sentry.init({ }); ``` - + It is possible to add instrumentations via `registerInstrumentations()` from `@opentelemetry/instrumentation`. However, with ESM (`import`/`export` syntax) you need to be careful to do so before importing any modules that should be @@ -55,7 +55,7 @@ Sentry.init({ As a rule of thumb, `registerInstrumentations()` should be called right after, and in the same context as registering ESM Loaders. - +> ## Using an OpenTelemetry Tracer diff --git a/docs/platforms/javascript/common/profiling/browser-profiling.mdx b/docs/platforms/javascript/common/profiling/browser-profiling.mdx index 88ef66583980c..dc7dff4220b4a 100644 --- a/docs/platforms/javascript/common/profiling/browser-profiling.mdx +++ b/docs/platforms/javascript/common/profiling/browser-profiling.mdx @@ -22,11 +22,11 @@ notSupported: description: "Collect & view performance insights for JavaScript programs with Sentry's JavaScript Profiling integration." --- - + Browser Profiling is currently in beta. Beta features are still in progress and may have bugs. We recognize the irony. - +> The browser profiling integration is built using the [JS Self-Profiling API](https://wicg.github.io/js-self-profiling/) and will likely only move out of beta once the specification progresses and gains adoption. See [platform status](https://chromestatus.com/feature/5170190448852992). diff --git a/docs/platforms/javascript/common/profiling/node-profiling.mdx b/docs/platforms/javascript/common/profiling/node-profiling.mdx index 42ccf5fb0edd6..d80368646dfc3 100644 --- a/docs/platforms/javascript/common/profiling/node-profiling.mdx +++ b/docs/platforms/javascript/common/profiling/node-profiling.mdx @@ -21,11 +21,11 @@ supported: By default, Sentry error events will not get trace context unless you configure the scope with the transaction, as illustrated in the example below. - + If you're adopting Profiling in a high-throughput environment, we recommend testing prior to deployment to ensure that your service's performance characteristics maintain expectations. - +> ## Installation diff --git a/docs/platforms/javascript/common/session-replay/configuration.mdx b/docs/platforms/javascript/common/session-replay/configuration.mdx index d8a4c6ede5c41..4f819cb100eab 100644 --- a/docs/platforms/javascript/common/session-replay/configuration.mdx +++ b/docs/platforms/javascript/common/session-replay/configuration.mdx @@ -65,12 +65,12 @@ By default, Replay will capture basic information about all outgoing fetch and X To capture additional information such as request and response headers or bodies, you'll need to opt-in via `networkDetailAllowUrls` (requires SDK version >= [7.50.0](https://github.com/getsentry/sentry-javascript/releases/tag/7.50.0)). This will make it possible for you to elect to only add URLs that are safe for capturing bodies and avoid any endpoints that may contain Personal Identifiable Information, (PII). - + Content in bodies will be PII-sanitized server-side, based on object keys and values. Refer to our Replay Privacy section for more details. - +> Any URL matching the given pattern(s) will then be captured with additional details: @@ -102,7 +102,7 @@ replayIntegration({ }); ``` -Captured bodies will be truncated to 150k characters max. +>Captured bodies will be truncated to 150k characters max.t> ## Identifying Users diff --git a/docs/platforms/javascript/common/session-replay/index.mdx b/docs/platforms/javascript/common/session-replay/index.mdx index d2ab9693c85a2..6cc3d0ba0b117 100644 --- a/docs/platforms/javascript/common/session-replay/index.mdx +++ b/docs/platforms/javascript/common/session-replay/index.mdx @@ -125,11 +125,11 @@ If you're unable to update your CSP policy to allow inline web workers, you can A user session starts when the Session Replay SDK is first loaded and initialized. The session will capture any pageloads, refreshes, or navigations as long as the SDK is re-initialized on the same domain, and in the same browser tab, each time. Sessions continue capturing data until 5 minutes pass without any user interactions **or** until a maximum of 60 minutes have elapsed. Closing the browser tab will end the session immediately, according to the rules for [SessionStorage](https://developer.mozilla.org/en-US/docs/Web/API/Window/sessionStorage). - + An _interaction_ refers to either a mouse click or a browser navigation event. - +> ### Replay Captures on Errors Only diff --git a/docs/platforms/javascript/common/session-replay/issue-types.mdx b/docs/platforms/javascript/common/session-replay/issue-types.mdx index 270bafb9bacee..9d9af4130adce 100644 --- a/docs/platforms/javascript/common/session-replay/issue-types.mdx +++ b/docs/platforms/javascript/common/session-replay/issue-types.mdx @@ -32,10 +32,10 @@ You can configure which issue types are created by visiting Project Settings > R Sometimes rage or dead clicks will be detected on elements which are not expected to mutate the DOM, like a "Print" or "Download" button. In this case, you can configure `slowClickIgnoreSelectors`, which will prevent those buttons from generating new issues. - + You'll need to have SDK version 7.60.1 or higher in order to be able to see **rage click issues**. - +> ## Configuring Hydration Errors @@ -51,7 +51,7 @@ You can have your preferences configured in one of four ways: | disabled | enabled | Two issues created from both replay, and error data. The issues are duplicates. | | disabled | disabled | Issue created from captured error data. | - +> You'll need to have SDK version 7.87.0 or higher in order to be able to detect **hydration error issues** from replay data. - +> diff --git a/docs/platforms/javascript/common/sourcemaps/uploading/angular-nx.mdx b/docs/platforms/javascript/common/sourcemaps/uploading/angular-nx.mdx index ec66e95766ae6..983dae55f377a 100644 --- a/docs/platforms/javascript/common/sourcemaps/uploading/angular-nx.mdx +++ b/docs/platforms/javascript/common/sourcemaps/uploading/angular-nx.mdx @@ -45,13 +45,13 @@ Check out the example below: in your `project.json`, replace the default executo ## 2. Register the Sentry Bundler Plugin - + This guide assumes you are using a Sentry SDK on version `7.47.0` or higher. If you are on an older version and you want to upload source maps we recommend upgrading your SDK to the newest version. - +> To upload source maps you have to configure an [Organization Auth Token](https://sentry.io/orgredirect/organizations/:orgslug/settings/auth-tokens/). @@ -167,9 +167,9 @@ To upload the source maps, build your Angular application: nx build ``` - +> The Sentry webpack plugin doesn't upload source maps in watch-mode/development-mode. We recommend running a production build to test your implementation. - +> diff --git a/docs/platforms/javascript/common/sourcemaps/uploading/angular-webpack.mdx b/docs/platforms/javascript/common/sourcemaps/uploading/angular-webpack.mdx index 103d3b64b8653..c09572768f3f7 100644 --- a/docs/platforms/javascript/common/sourcemaps/uploading/angular-webpack.mdx +++ b/docs/platforms/javascript/common/sourcemaps/uploading/angular-webpack.mdx @@ -73,13 +73,13 @@ If you're using an Angular version below 13, only `ng build --prod` will leverag ### 2. Register the Sentry Webpack Plugin - + This guide assumes you are using a Sentry SDK on version `7.47.0` or higher. If you are on an older version and you want to upload source maps we recommend upgrading your SDK to the newest version. - +> To upload source maps you have to configure an [Organization Auth Token](https://sentry.io/orgredirect/organizations/:orgslug/settings/auth-tokens/). @@ -123,12 +123,12 @@ To upload the source maps, build your Angular application: ng build # add --prod for Angular versions below 13 ``` - +> The Sentry webpack plugin doesn't upload source maps in watch-mode/development-mode. We recommend running a production build to test your implementation. - +> Generating sourcemaps may expose them to the public, potentially causing your diff --git a/docs/platforms/javascript/common/sourcemaps/uploading/create-react-app.mdx b/docs/platforms/javascript/common/sourcemaps/uploading/create-react-app.mdx index e1bbfb041eed1..fa1f4b394aa66 100644 --- a/docs/platforms/javascript/common/sourcemaps/uploading/create-react-app.mdx +++ b/docs/platforms/javascript/common/sourcemaps/uploading/create-react-app.mdx @@ -45,11 +45,11 @@ yarn add @sentry/cli --dev pnpm add @sentry/cli --save-dev ``` - + For more info on `sentry-cli` configuration visit the [Sentry CLI configuration docs](/cli/configuration/). - +> Use the below environment variables to make sure `sentry-cli` is configured for your project: diff --git a/docs/platforms/javascript/common/sourcemaps/uploading/esbuild.mdx b/docs/platforms/javascript/common/sourcemaps/uploading/esbuild.mdx index f799160362ab3..8e10054b8a220 100644 --- a/docs/platforms/javascript/common/sourcemaps/uploading/esbuild.mdx +++ b/docs/platforms/javascript/common/sourcemaps/uploading/esbuild.mdx @@ -4,11 +4,11 @@ description: "Upload your source maps with the Sentry esbuild Plugin." sidebar_order: 4 --- - + This guide assumes you're using a Sentry **SDK version `7.47.0` or higher**. If you're on an older version and you want to upload source maps, we recommend upgrading your SDK to the newest version. - +> - +> The Sentry esbuild plugin doesn't upload source maps in watch-mode/development-mode. We recommend running a production build to test your configuration. - +> diff --git a/docs/platforms/javascript/common/sourcemaps/uploading/hosting-publicly.mdx b/docs/platforms/javascript/common/sourcemaps/uploading/hosting-publicly.mdx index d4c097aea568f..57d6029a0419f 100644 --- a/docs/platforms/javascript/common/sourcemaps/uploading/hosting-publicly.mdx +++ b/docs/platforms/javascript/common/sourcemaps/uploading/hosting-publicly.mdx @@ -15,11 +15,11 @@ notSupported: - javascript.nestjs --- - + The most reliable way to provide your source maps to Sentry is to [upload them](..), because it cuts down on network traffic and ensures the correct version of the code and source maps will be used. - +> By default, Sentry will look for source map directives in your compiled JavaScript files. These directives are located on the last line and have the following format: diff --git a/docs/platforms/javascript/common/sourcemaps/uploading/rollup.mdx b/docs/platforms/javascript/common/sourcemaps/uploading/rollup.mdx index c9205fa53c3d1..f4b4fd6a00cc6 100644 --- a/docs/platforms/javascript/common/sourcemaps/uploading/rollup.mdx +++ b/docs/platforms/javascript/common/sourcemaps/uploading/rollup.mdx @@ -5,11 +5,11 @@ sidebar_order: 5 customCanonicalTag: "/platforms/javascript/guides/koa/sourcemaps/uploading/rollup/" --- - + This guide assumes you're using a **Sentry SDK version `7.47.0` or higher**. If you're on an older version and you want to upload source maps, we recommend upgrading your SDK to the newest version. - +> You can use the Sentry Rollup plugin to automatically create releases and upload source maps to Sentry when bundling your app. diff --git a/docs/platforms/javascript/common/sourcemaps/uploading/typescript.mdx b/docs/platforms/javascript/common/sourcemaps/uploading/typescript.mdx index 8cf1f0613a50b..0aa917f0ac592 100644 --- a/docs/platforms/javascript/common/sourcemaps/uploading/typescript.mdx +++ b/docs/platforms/javascript/common/sourcemaps/uploading/typescript.mdx @@ -11,11 +11,11 @@ In this guide, you'll learn how to successfully upload source maps for TypeScrip - + This guide is only applicable if you're using `tsc` to compile your project. If you use another tool (such as webpack) in combination with TypeScript, you'll most likely want to follow that guide instead. - +> ## Automatic Setup @@ -56,9 +56,9 @@ During compilation, TypeScript will inject some of its runtime dependencies into As a workaround, you'll need to tell the TypeScript compiler to use `tslib`, its own 3rd party package, (which is internally the part of a compiler) instead of injecting runtime dependencies. You'll only need to change what's inside the TypeScript config file, not your source code. Here's how: -1. Make sure that `tslib` is listed as the dependency in your `package.json` file. +1. Make sure that `tslib` is listed as the dependency in your `package.json` file. 2. Once that's done, add two entries in `compilerOptions` section of your `tsconfig.json`: -- `"noEmitHelpers": true` and --`"importHelpers": true`. +- `"noEmitHelpers": true` and +-`"importHelpers": true`. That's it! Now you should be able to correctly map the source maps for all your stack trace frames, including internal TypeScript compiler code snippets. diff --git a/docs/platforms/javascript/common/sourcemaps/uploading/vite.mdx b/docs/platforms/javascript/common/sourcemaps/uploading/vite.mdx index 41ccd84a26b10..20d06f7f4b450 100644 --- a/docs/platforms/javascript/common/sourcemaps/uploading/vite.mdx +++ b/docs/platforms/javascript/common/sourcemaps/uploading/vite.mdx @@ -5,11 +5,11 @@ customCanonicalTag: "/platforms/javascript/sourcemaps/uploading/vite/" sidebar_order: 3 --- - + This guide assumes you're using a Sentry **SDK version `7.47.0` or higher**. If you're on an older version and you want to upload source maps, we recommend upgrading your SDK to the newest version. - +> You can use the Sentry Vite plugin to automatically create releases and upload source maps to Sentry when bundling your app. @@ -83,9 +83,9 @@ export default defineConfig({ option to delete source maps after they've been uploaded to Sentry. - +> The Sentry Vite plugin doesn't upload source maps in watch-mode/development-mode. We recommend running a production build to test your configuration. - +> diff --git a/docs/platforms/javascript/common/sourcemaps/uploading/webpack.mdx b/docs/platforms/javascript/common/sourcemaps/uploading/webpack.mdx index 614f922c9064d..7ffa9d593f34b 100644 --- a/docs/platforms/javascript/common/sourcemaps/uploading/webpack.mdx +++ b/docs/platforms/javascript/common/sourcemaps/uploading/webpack.mdx @@ -5,10 +5,10 @@ customCanonicalTag: "/platforms/javascript/sourcemaps/uploading/webpack/" sidebar_order: 1 --- - + This guide assumes you're using a Sentry **SDK version `7.47.0` or higher**. If you're on an older version and you want to upload source maps, we recommend upgrading your SDK to the newest version. - +> You can use the Sentry webpack plugin to automatically create releases and upload source maps to Sentry when bundling your app. @@ -106,15 +106,15 @@ exports.onCreateWebpackConfig = ({ actions }) => { option to delete source maps after they've been uploaded to Sentry. - +> The Sentry webpack plugin doesn't upload source maps in watch-mode/development-mode. We recommend running a production build to test your configuration. - +> - +> If you use [SourceMapDevToolPlugin](https://webpack.js.org/plugins/source-map-dev-tool-plugin) for more fine-grained control of source map generation, turn off `noSources` so Sentry can display proper source code context in event stack traces. - +> diff --git a/docs/platforms/javascript/common/tracing/index.mdx b/docs/platforms/javascript/common/tracing/index.mdx index f470c2150bd73..03f5b2846ebc1 100644 --- a/docs/platforms/javascript/common/tracing/index.mdx +++ b/docs/platforms/javascript/common/tracing/index.mdx @@ -11,9 +11,9 @@ With [tracing](/product/performance/), Sentry tracks your software performance, - + If you’re adopting Tracing in a high-throughput environment, we recommend testing prior to deployment to ensure that your service’s performance characteristics maintain expectations. - + > diff --git a/docs/platforms/javascript/common/tracing/instrumentation/automatic-instrumentation.mdx b/docs/platforms/javascript/common/tracing/instrumentation/automatic-instrumentation.mdx index 1014b7b4f2f27..bbccf1eb27889 100644 --- a/docs/platforms/javascript/common/tracing/instrumentation/automatic-instrumentation.mdx +++ b/docs/platforms/javascript/common/tracing/instrumentation/automatic-instrumentation.mdx @@ -6,11 +6,11 @@ notSupported: - javascript.cordova --- - + Capturing spans requires that you first set up tracing in your app if you haven't already. - +> @@ -53,11 +53,11 @@ Supported options: ### tracePropagationTargets - +> The `tracingOrigins` option was renamed `tracePropagationTargets` and deprecated in [version `7.19.0`](https://github.com/getsentry/sentry-javascript/releases/tag/7.19.0) of the JavaScript SDK. `tracingOrigins` will be removed in version 8. - +> A list of strings and regular expressions. The JavaScript SDK will attach the `sentry-trace` and `baggage` headers to all outgoing XHR/fetch requests whose destination contains a string in the list or matches a regex in the list. If your frontend is making requests to a different domain, you'll need to add it there to propagate the `sentry-trace` and `baggage` headers to the backend services, which is required to link spans together as part of a single trace. @@ -75,10 +75,10 @@ You will need to configure your web server [CORS](https://developer.mozilla.org/ - +> If you're using React, read our docs to learn how to set up your [React Router integration](/platforms/javascript/guides/react/configuration/integrations/react-router/). - +> ### shouldCreateSpanForRequest @@ -131,9 +131,9 @@ This option determines whether spans for long tasks automatically get created. The default is `true`. ### enableLongAnimationFrame - +> The `enableLongAnimationFrame` option requires SDK [version 8.18.0](https://github.com/getsentry/sentry-javascript/releases/tag/8.18.0) or higher. - +> This option determines whether spans for long animation frames get created automatically. If both `enableLongAnimationFrame` and `enableLongTask` are enabled, Sentry will send long animation frames and fallback to long tasks (if long animation frames aren't supported by the browser). @@ -141,19 +141,19 @@ The default is `true`. ### enableInp - +> The `enableInp` option requires SDK [version 7.104.0](https://github.com/getsentry/sentry-javascript/releases/tag/7.104.0) or higher. - +> This option determines whether interactions spans automatically get created when an [Interaction to Next Paint (INP)](/product/insights/web-vitals/web-vitals-concepts/#interaction-to-next-paint-inp) event is detected. Interactions are scored and surfaced in the [Web Vitals](/product/insights/web-vitals/) module. The default is `true` in `8.x` of the SDK, and `false` in `7.x`. - +> INP samples currently incur no cost to enable at Sentry. Basic samples contain limited information such as the interaction target, latency, and user. You may wish to enrich your INP samples by setting up [Session Replays](/platforms/javascript/session-replay/) and/or setting up [Browser Profiling](/platforms/javascript/profiling/) instrumentation around your interactive elements to gain further insights into your slowest interactions. Please note that any Session Replays and Browser Profiles used this way will incur their [standard cost](/pricing/#per-category-pricing) depending on your plan and are subject to the sampling rates configured. - +> diff --git a/docs/platforms/javascript/common/tracing/instrumentation/custom-instrumentation/index.mdx b/docs/platforms/javascript/common/tracing/instrumentation/custom-instrumentation/index.mdx index 8c175ad2a52e6..a11ca2ca35c77 100644 --- a/docs/platforms/javascript/common/tracing/instrumentation/custom-instrumentation/index.mdx +++ b/docs/platforms/javascript/common/tracing/instrumentation/custom-instrumentation/index.mdx @@ -4,11 +4,11 @@ description: "Learn how to capture performance data on any action in your app." sidebar_order: 20 --- - + To capture transactions and spans customized to your organization's needs, you must first set up tracing. - +> To add custom performance data to your application, you need to add custom instrumentation in the form of spans. Spans are a way to measure the time it takes for a specific action to occur. For example, you can create a span to measure the time it takes for a function to execute. diff --git a/docs/platforms/javascript/common/tracing/instrumentation/custom-instrumentation/queues-module.mdx b/docs/platforms/javascript/common/tracing/instrumentation/custom-instrumentation/queues-module.mdx index f48dac9b53bd7..a767d4adc61ea 100644 --- a/docs/platforms/javascript/common/tracing/instrumentation/custom-instrumentation/queues-module.mdx +++ b/docs/platforms/javascript/common/tracing/instrumentation/custom-instrumentation/queues-module.mdx @@ -38,11 +38,11 @@ To start capturing performance metrics, use the `Sentry.startSpan` function to w You must also include trace headers in your message using `spanToTraceHeader` and `spanToBaggageHeader` so that your consumers can continue your trace once your message is picked up. - + Your `queue.publish` span must exist as a child within a parent span in order to be recognized as a producer span. If you don't already have a parent producer span, you can start a new one using `Sentry.startSpan`. - +> ```javascript {filename:my-queue.js} app.post("/publish", async (req, res) => { @@ -88,11 +88,11 @@ To start capturing performance metrics, use the `Sentry.startSpan` function to w Use `Sentry.continueTrace` to connect your consumer spans to their associated producer spans, and `setStatus` to mark the trace of your message as success or failed. - +> Your `queue.process` span must exist as a child within a parent span in order to be recognized as a consumer span. If you don't have a parent span, you can create one to wrap the consumer span with by using `Sentry.startSpan`. - +> ```javascript {filename:my-consumer.js} const message = JSON.parse(await redisClient.lPop(QUEUE_KEY)); diff --git a/docs/platforms/javascript/common/tracing/instrumentation/custom-instrumentation/requests-module.mdx b/docs/platforms/javascript/common/tracing/instrumentation/custom-instrumentation/requests-module.mdx index 02225f82fca38..2116b5b580129 100644 --- a/docs/platforms/javascript/common/tracing/instrumentation/custom-instrumentation/requests-module.mdx +++ b/docs/platforms/javascript/common/tracing/instrumentation/custom-instrumentation/requests-module.mdx @@ -10,11 +10,11 @@ For detailed information about which data can be set, see the [Requests Module d ## Wrap HTTP Requests in a Span - + Refer to [HTTP Span Data Conventions](https://develop.sentry.dev/sdk/performance/span-data-conventions/#http) for a full list of the span data attributes. - +> Here is an example of an instrumented function that makes HTTP requests: diff --git a/docs/platforms/javascript/common/usage/index.mdx b/docs/platforms/javascript/common/usage/index.mdx index 3858ed86c8b35..2dd90279dda0e 100644 --- a/docs/platforms/javascript/common/usage/index.mdx +++ b/docs/platforms/javascript/common/usage/index.mdx @@ -6,7 +6,7 @@ sidebar_order: 4 Sentry's SDK hooks into your runtime environment and automatically reports errors, uncaught exceptions, and unhandled rejections as well as other types of errors depending on the platform. - + Key terms: @@ -15,7 +15,7 @@ Key terms: - The reporting of an event is called _capturing_. When an event is captured, it’s sent to Sentry. - +> The most common form of capturing is to capture errors. What can be captured as an error varies by platform. In general, if you have something that looks like an exception, it can be captured. For some SDKs, you can also omit the argument to and Sentry will attempt to capture the current exception. It is also useful for manual reporting of errors or messages to Sentry. diff --git a/docs/platforms/javascript/common/user-feedback/configuration/index.mdx b/docs/platforms/javascript/common/user-feedback/configuration/index.mdx index 05e33683e5ef9..3ec41b49132b6 100644 --- a/docs/platforms/javascript/common/user-feedback/configuration/index.mdx +++ b/docs/platforms/javascript/common/user-feedback/configuration/index.mdx @@ -362,9 +362,9 @@ document Because the `feedbackIntegration` is a user-facing integration, we offer two loading strategies that have bundle size implications. - + For most users, we recommend using `feedbackIntegration` in your `Sentry.init` call. This will set up user feedback with good defaults, matching the environment. - +> All of the code examples on this page use `feedbackIntegration` as a default because it's available regardless of whether you've chosen the CDN or NPM installation method. However, the implementation of `feedbackIntegration` is different for the two installation methods. For NPM users, `feedbackIntegration` is an alias of `feedbackSyncIntegration`. For CDN users, `feedbackIntegration` is an alias of `feedbackAsyncIntegration`. diff --git a/docs/platforms/javascript/guides/aws-lambda/index.mdx b/docs/platforms/javascript/guides/aws-lambda/index.mdx index 4de8d75745ece..25441f2b79516 100644 --- a/docs/platforms/javascript/guides/aws-lambda/index.mdx +++ b/docs/platforms/javascript/guides/aws-lambda/index.mdx @@ -7,11 +7,11 @@ categories: - serverless --- - + Looking for instructions on how to add Sentry without modifying your code? [Check out these docs instead](/organization/integrations/cloud-monitoring/aws-lambda/). - +> On this page you'll get an overview how to install, configure and use Sentry in your AWS Lambda functions. Once set up, our SDK will automatically report error and performance data from your Lambda Functions. Issues in Sentry will automatically include cloudwatch data, function details and execution time measurements. diff --git a/docs/platforms/javascript/guides/aws-lambda/install/cjs-layer.mdx b/docs/platforms/javascript/guides/aws-lambda/install/cjs-layer.mdx index fc10999fa1b80..71b45674d42d9 100644 --- a/docs/platforms/javascript/guides/aws-lambda/install/cjs-layer.mdx +++ b/docs/platforms/javascript/guides/aws-lambda/install/cjs-layer.mdx @@ -8,11 +8,11 @@ The easiest way to get started with Sentry is to use the Sentry [Lambda Layer](h If you follow this guide, you don't have to worry about deploying Sentry dependencies alongside your function code. To actually start the SDK, you can decide between setting up the SDK using environment variables or in your Lambda function code. We recommend using environment variables as it's the easiest way to get started. [Initializing the SDK in code](#alternative-initialize-the-sdk-in-code) instead of setting environment variables gives you more control over the SDK setup if you need it. - + This installation method **does not** work with Lambda functions running in EcmaScript Modules (ESM) mode, using `import` syntax. If you're running your function in ESM, follow the [ESM guide](../esm-npm). - +> ## 1. Prerequisites diff --git a/docs/platforms/javascript/guides/aws-lambda/install/esm-npm.mdx b/docs/platforms/javascript/guides/aws-lambda/install/esm-npm.mdx index 015b716e8bc12..c25a021b0be5c 100644 --- a/docs/platforms/javascript/guides/aws-lambda/install/esm-npm.mdx +++ b/docs/platforms/javascript/guides/aws-lambda/install/esm-npm.mdx @@ -8,12 +8,12 @@ In this guide you will learn how to set up the `@sentry/aws-serverless` SDK for We recommend starting the SDK automatically via environment variables so that you only have to make minimal code changes to your lambda function. If you need more control over the SDK setup, you can also [initialize the SDK in in code](#alternative-initialize-the-sdk-in-code). - + At this time, this guide shows the only way to use Sentry with ESM lambda functions. You cannot use the Sentry AWS Lambda Layer with ESM. We're working on an ESM lambda layer to provide a simpler setup but need to solve several OpenTelemetry-related limitations first. - +> ## 1. Prerequisites diff --git a/docs/platforms/javascript/guides/cordova/upload-debug.mdx b/docs/platforms/javascript/guides/cordova/upload-debug.mdx index d3b691c96a9c8..fbe2c8747fcc7 100644 --- a/docs/platforms/javascript/guides/cordova/upload-debug.mdx +++ b/docs/platforms/javascript/guides/cordova/upload-debug.mdx @@ -6,11 +6,11 @@ description: "Learn more about uploading debug symbols when building your app." Debug symbols help provide you with readable stack traces, which Sentry displays on the **Issue Details** page, to help you triage an issue. - + We do not currently support non-JavaScript automatic source map uploads or build scripts for Android. You must upload files manually [using our CLI](/cli/dif/#uploading-files). - +> ## JavaScript Source Maps diff --git a/docs/platforms/javascript/guides/gatsby/index.mdx b/docs/platforms/javascript/guides/gatsby/index.mdx index 4931c024b28e1..bf979907e4378 100644 --- a/docs/platforms/javascript/guides/gatsby/index.mdx +++ b/docs/platforms/javascript/guides/gatsby/index.mdx @@ -33,11 +33,11 @@ yarn add @sentry/gatsby pnpm add @sentry/gatsby ``` - + `@sentry/gatsby` is a wrapper around the `@sentry/react` package, with added functionality related to Gatsby. All methods available in the `@sentry/react` package can also be imported from `@sentry/gatsby`. - +> Register the `@sentry/gatsby` plugin in your Gatsby configuration file (typically `gatsby-config.js`). diff --git a/docs/platforms/javascript/guides/gcp-functions/index.mdx b/docs/platforms/javascript/guides/gcp-functions/index.mdx index e8f9615ed407c..aed92083226bf 100644 --- a/docs/platforms/javascript/guides/gcp-functions/index.mdx +++ b/docs/platforms/javascript/guides/gcp-functions/index.mdx @@ -7,9 +7,9 @@ categories: - serverless --- - + This guide is for version 8.0.0 and up of `@sentry/google-cloud-serverless`. - +> ## Features diff --git a/docs/platforms/javascript/guides/nestjs/features/event-emitter.mdx b/docs/platforms/javascript/guides/nestjs/features/event-emitter.mdx index eb381e5f0f31f..7c073e0302165 100644 --- a/docs/platforms/javascript/guides/nestjs/features/event-emitter.mdx +++ b/docs/platforms/javascript/guides/nestjs/features/event-emitter.mdx @@ -3,9 +3,9 @@ title: NestJS Event Emitter description: "Learn about instrumenting NestJS event-based services." --- - + The @nestjs/event-emitter module is auto-instrumented in `@sentry/nestjs` 8.39.0 and up. - +> The NestJS SDK wraps the `@OnEvent` decorator automatically to: @@ -15,4 +15,4 @@ The NestJS SDK wraps the `@OnEvent` decorator automatically to: When an event handler is executed, a new span is created to track its performance, and any errors are automatically reported to Sentry while preserving the original error behavior. -This instrumentation works transparently with existing NestJS event handlers without requiring any code changes to your application. \ No newline at end of file +This instrumentation works transparently with existing NestJS event handlers without requiring any code changes to your application. diff --git a/docs/platforms/javascript/guides/nestjs/features/sentry-cron-decorator.mdx b/docs/platforms/javascript/guides/nestjs/features/sentry-cron-decorator.mdx index ba28e5d7e276a..279a68e018977 100644 --- a/docs/platforms/javascript/guides/nestjs/features/sentry-cron-decorator.mdx +++ b/docs/platforms/javascript/guides/nestjs/features/sentry-cron-decorator.mdx @@ -3,18 +3,18 @@ title: SentryCron Decorator description: "Learn about Sentry's SentryCron decorator." --- - + The `@SentryCron` decorator is available from version `@sentry/nestjs` 8.16.0 and up. - +> The NestJS SDK includes a `@SentryCron` decorator that can be used to augment the native NestJS `@Cron` decorator to send check-ins to Sentry before and after each cron job run. To get started, import `SentryCron` from `@sentry/nestjs` and use it to decorate a cron job function in your NestJS application. - +> The `@SentryCron` decorator needs to be applied after the `@Cron` decorator, or else the instrumentation does not work. - +> ```typescript import { Cron } from '@nestjs/schedule'; diff --git a/docs/platforms/javascript/guides/nestjs/features/sentry-traced-decorator.mdx b/docs/platforms/javascript/guides/nestjs/features/sentry-traced-decorator.mdx index 2f77420d60a1f..ce99b3ee9b416 100644 --- a/docs/platforms/javascript/guides/nestjs/features/sentry-traced-decorator.mdx +++ b/docs/platforms/javascript/guides/nestjs/features/sentry-traced-decorator.mdx @@ -3,9 +3,9 @@ title: SentryTraced Decorator description: "Learn about Sentry's SentryTraced decorator." --- - + The `@SentryTraced` decorator is available from version `@sentry/nestjs` 8.15.0 and up. - +> The NestJS SDK includes a `@SentryTraced` decorator that will create spans whenever the method it decorates is invoked. This feature enables more granular performance monitoring and helps you gather detailed insights into the performance diff --git a/docs/platforms/javascript/guides/nextjs/manual-setup.mdx b/docs/platforms/javascript/guides/nextjs/manual-setup.mdx index 7b6877e9924c8..68675739b9b35 100644 --- a/docs/platforms/javascript/guides/nextjs/manual-setup.mdx +++ b/docs/platforms/javascript/guides/nextjs/manual-setup.mdx @@ -646,11 +646,11 @@ module.exports = withSentryConfig(nextConfig, { You can set the `automaticVercelMonitors` option to automatically create [Cron Monitors](/product/crons/) in Sentry if you have configured [Vercel Cron Jobs](https://vercel.com/docs/cron-jobs). - + Automatic instrumentation of Vercel cron jobs currently only works for the Pages Router. App Router route handlers are not yet supported. - +> ```javascript {tabTitle:ESM} {filename:next.config.mjs} export default withSentryConfig(nextConfig, { diff --git a/docs/platforms/javascript/guides/react/features/react-router/v6.mdx b/docs/platforms/javascript/guides/react/features/react-router/v6.mdx index b8f1d0bb3cc92..603ef0769bad1 100644 --- a/docs/platforms/javascript/guides/react/features/react-router/v6.mdx +++ b/docs/platforms/javascript/guides/react/features/react-router/v6.mdx @@ -179,10 +179,10 @@ Now, Sentry should generate `pageload`/`navigation` transactions with parameteri When using `react-router`, errors thrown inside route elements will only be re-thrown in **development mode** while using [`strict mode`](https://react.dev/reference/react/StrictMode). In production, these errors won't be surfaced unless manually captured. If you **don't** have a custom error boundary in place, `react-router` will create a default one that "swallows" all errors. - + Note, that this only applies to render method and lifecycle errors since React doesn't need error boundaries to handle errors in event handlers. - +> To send errors to Sentry while using a custom error boundary, use the `Sentry.captureException` method: diff --git a/docs/platforms/javascript/guides/react/features/react-router/v7.mdx b/docs/platforms/javascript/guides/react/features/react-router/v7.mdx index 2cdef7b321467..98e42de5c7db3 100644 --- a/docs/platforms/javascript/guides/react/features/react-router/v7.mdx +++ b/docs/platforms/javascript/guides/react/features/react-router/v7.mdx @@ -180,10 +180,10 @@ Now, Sentry should generate `pageload`/`navigation` transactions with parameteri When using `react-router`, errors thrown inside route elements will only be re-thrown in **development mode** while using [`strict mode`](https://react.dev/reference/react/StrictMode). In production, these errors won't be surfaced unless manually captured. If you **don't** have a custom error boundary in place, `react-router` will create a default one that "swallows" all errors. - + Note, that this only applies to render method and lifecycle errors since React doesn't need error boundaries to handle errors in event handlers. - +> To send errors to Sentry while using a custom error boundary, use the `Sentry.captureException` method: diff --git a/docs/platforms/javascript/guides/remix/manual-setup.mdx b/docs/platforms/javascript/guides/remix/manual-setup.mdx index 9f1eb67abe15a..c9cbf70e5d5c3 100644 --- a/docs/platforms/javascript/guides/remix/manual-setup.mdx +++ b/docs/platforms/javascript/guides/remix/manual-setup.mdx @@ -93,10 +93,10 @@ export const ErrorBoundary: V2_ErrorBoundaryComponent = () => { To catch React component errors (in Remix v1) and routing transactions (in all Remix versions), wrap your Remix root with `withSentry`. - + If you use Remix v1 with the `v2_errorBoundary` future flag, you must also configure your `ErrorBoundary`. - +> ```typescript {filename: root.tsx} import { @@ -130,11 +130,11 @@ function App() { export default withSentry(App); ``` - +> If you use Remix v2, `wrapWithErrorBoundary` is disabled by default. You still need to wrap your root component with `withSentry` to capture routing transactions. - +> You can disable or configure `ErrorBoundary` using a second parameter to `withSentry`. @@ -240,11 +240,11 @@ This snippet includes an intentional error, so you can test that everything is w - +> You can refer to [Remix Docs](https://remix.run/docs/en/main/guides/envvars#browser-environment-variables) to learn how to use your Sentry DSN with environment variables. - +> ## Custom Express Server diff --git a/docs/platforms/javascript/guides/solid/features/index.mdx b/docs/platforms/javascript/guides/solid/features/index.mdx index b3ec70bab9bad..b6e684c2e3f11 100644 --- a/docs/platforms/javascript/guides/solid/features/index.mdx +++ b/docs/platforms/javascript/guides/solid/features/index.mdx @@ -3,14 +3,14 @@ title: Solid Features description: "Learn how Sentry's Solid SDK exposes features for first class integration with Solid." --- - + This SDK is currently in **beta**. Beta features are still in progress and may have bugs. Please reach out on [GitHub](https://github.com/getsentry/sentry-javascript/issues/new/choose) if you have any feedback or concerns. This SDK is for [Solid](https://www.solidjs.com/), for [SolidStart](https://start.solidjs.com/) see our [SolidStart SDK](/platforms/javascript/guides/solidstart). - +> The Sentry Solid SDK offers Solid-specific features for first class integration with the framework. diff --git a/docs/platforms/javascript/guides/solid/features/solid-router.mdx b/docs/platforms/javascript/guides/solid/features/solid-router.mdx index 2c7cb20dbbf82..a384d966b2497 100644 --- a/docs/platforms/javascript/guides/solid/features/solid-router.mdx +++ b/docs/platforms/javascript/guides/solid/features/solid-router.mdx @@ -3,9 +3,9 @@ title: Solid Router description: "Learn about Sentry's Solid Router integration." --- - + The routing instrumentation supports [Solid Router](https://docs.solidjs.com/solid-router) 0.13.4 and up. - +> The Sentry SDK provides a routing instrumentation for Solid Router to create navigation spans to ensure you collect meaningful performance data about the health of your page loads and associated requests. diff --git a/docs/platforms/javascript/guides/solidstart/features/index.mdx b/docs/platforms/javascript/guides/solidstart/features/index.mdx index fe5374a087858..05554ca2811d1 100644 --- a/docs/platforms/javascript/guides/solidstart/features/index.mdx +++ b/docs/platforms/javascript/guides/solidstart/features/index.mdx @@ -3,12 +3,12 @@ title: SolidStart Features description: "Learn how Sentry's SolidStart SDK exposes features for first class integration with Solid." --- - + This SDK is currently in **beta**. Beta features are still in progress and may have bugs. Please reach out on [GitHub](https://github.com/getsentry/sentry-javascript/issues/new/choose) if you have any feedback or concerns. - +> The Sentry SolidStart SDK offers Solid-specific features for first class integration with the framework. diff --git a/docs/platforms/javascript/guides/solidstart/features/solid-router.mdx b/docs/platforms/javascript/guides/solidstart/features/solid-router.mdx index d8e7d5e49eb59..598b2f828813a 100644 --- a/docs/platforms/javascript/guides/solidstart/features/solid-router.mdx +++ b/docs/platforms/javascript/guides/solidstart/features/solid-router.mdx @@ -3,9 +3,9 @@ title: Solid Router description: "Learn about Sentry's Solid Router integration." --- - + The routing instrumentation supports [Solid Router](https://docs.solidjs.com/solid-router) 0.13.4 and up. - +> The Sentry SDK provides a routing instrumentation for Solid Router to create navigation spans to ensure you collect meaningful performance data about the health of your page loads and associated requests. diff --git a/docs/platforms/javascript/guides/sveltekit/manual-setup.mdx b/docs/platforms/javascript/guides/sveltekit/manual-setup.mdx index 0d8e237f28360..d62ff0c6bf77e 100644 --- a/docs/platforms/javascript/guides/sveltekit/manual-setup.mdx +++ b/docs/platforms/javascript/guides/sveltekit/manual-setup.mdx @@ -209,12 +209,12 @@ The SDK primarily uses [SvelteKit's hooks](https://kit.svelte.dev/docs/hooks) to Auto-instrumentation is enabled by default when you add the `sentrySvelteKit()` function call to your `vite.config.(js|ts)`. However, you can customize the behavior, or disable it entirely. If you disable it you can still manually wrap specific `load` functions with the `withSentry` function. - + The SDK will only auto-instrument `load` functions in `+page` or `+layout` files that don't contain any Sentry code. If you have custom Sentry code in these files, you'll have to [manually](#instrument-load-functions-manually) add the Sentry wrapper to your `load` functions. - +> #### Customize Auto-instrumentation @@ -259,11 +259,11 @@ export default { #### Configure CSP for Client-side `fetch` Instrumentation - +> Available since version `7.91.0` - +> The `sentryHandle` function you added to your `handle` hook in `hooks.server.ts` during [server-side setup](#server-side-setup) injects an inline `