diff --git a/.gitignore b/.gitignore index ab63228404c13..70e1d40725c68 100644 --- a/.gitignore +++ b/.gitignore @@ -97,6 +97,8 @@ tsconfig.tsbuildinfo # Ignore generated files /public/md-exports/ public/mdx-images/* +public/og-images/* +!public/og-images/README.md # yalc .yalc diff --git a/app/[[...path]]/page.tsx b/app/[[...path]]/page.tsx index 047369a36abb3..578d8ef997e5a 100644 --- a/app/[[...path]]/page.tsx +++ b/app/[[...path]]/page.tsx @@ -194,6 +194,41 @@ function formatCanonicalTag(tag: string) { return tag; } +// Helper function to resolve OG image URLs +function resolveOgImageUrl( + imageUrl: string | undefined, + domain: string, + pagePath: string[] +): string | null { + if (!imageUrl) { + return null; + } + + // Remove hash fragments (e.g., #600x400 from remark-image-size) + const cleanUrl = imageUrl.split('#')[0]; + + // External URLs - return as is + if (cleanUrl.startsWith('http://') || cleanUrl.startsWith('https://')) { + return cleanUrl; + } + + // Absolute paths (public folder) + if (cleanUrl.startsWith('/')) { + return `${domain}${cleanUrl}`; + } + + // Relative paths - resolve based on page path + if (cleanUrl.startsWith('./')) { + const relativePath = cleanUrl.slice(2); // Remove './' + const pageDir = pagePath.join('/'); + return `${domain}/${pageDir}/${relativePath}`; + } + + // Default case: treat as relative to page + const pageDir = pagePath.join('/'); + return `${domain}/${pageDir}/${cleanUrl}`; +} + export async function generateMetadata(props: MetadataProps): Promise { const params = await props.params; const domain = isDeveloperDocs @@ -208,12 +243,8 @@ export async function generateMetadata(props: MetadataProps): Promise let customCanonicalTag: string = ''; let description = 'Self-hosted and cloud-based application performance monitoring & error tracking that helps software teams see clearer, solve quicker, and learn continuously.'; - // show og image on the home page only - const images = - ((await props.params).path ?? []).length === 0 - ? [{url: `${previewDomain ?? domain}/og.png`, width: 1200, height: 630}] - : []; + let ogImageUrl: string | null = null; let noindex: undefined | boolean = undefined; const rootNode = await getDocsRootNode(); @@ -236,9 +267,25 @@ export async function generateMetadata(props: MetadataProps): Promise } noindex = pageNode.frontmatter.noindex; + + // Check for manual OG image override in frontmatter + if (pageNode.frontmatter.og_image) { + ogImageUrl = resolveOgImageUrl( + pageNode.frontmatter.og_image, + previewDomain ?? domain, + params.path + ); + } } } + // Default fallback + if (!ogImageUrl) { + ogImageUrl = `${previewDomain ?? domain}/og.png`; + } + + const images = [{url: ogImageUrl, width: 1200, height: 630}]; + const canonical = customCanonicalTag ? domain + customCanonicalTag : params.path diff --git a/develop-docs/application-architecture/dynamic-sampling/architecture.mdx b/develop-docs/application-architecture/dynamic-sampling/architecture.mdx index ac31cd66486f1..286c7120b2e56 100644 --- a/develop-docs/application-architecture/dynamic-sampling/architecture.mdx +++ b/develop-docs/application-architecture/dynamic-sampling/architecture.mdx @@ -1,6 +1,7 @@ --- title: Architecture sidebar_order: 3 +og_image: /og-images/application-architecture-dynamic-sampling-architecture.png --- The architecture that powers Dynamic Sampling is composed of several components that work together to get the organization's sample rate closer to the target fidelity. diff --git a/develop-docs/application-architecture/dynamic-sampling/fidelity-and-biases.mdx b/develop-docs/application-architecture/dynamic-sampling/fidelity-and-biases.mdx index c9c494cabf52a..2a503779caae6 100644 --- a/develop-docs/application-architecture/dynamic-sampling/fidelity-and-biases.mdx +++ b/develop-docs/application-architecture/dynamic-sampling/fidelity-and-biases.mdx @@ -1,6 +1,7 @@ --- title: Fidelity and Biases sidebar_order: 2 +og_image: /og-images/application-architecture-dynamic-sampling-fidelity-and-biases.png --- Dynamic Sampling allows Sentry to automatically adjust the amount of data retained based on how valuable the data is to the user. This is technically achieved by applying a **sample rate** to every event, which is determined by a **set of rules** that are evaluated for each event. diff --git a/develop-docs/application-architecture/dynamic-sampling/index.mdx b/develop-docs/application-architecture/dynamic-sampling/index.mdx index 9d52bdc363a23..da498e5178f40 100644 --- a/develop-docs/application-architecture/dynamic-sampling/index.mdx +++ b/develop-docs/application-architecture/dynamic-sampling/index.mdx @@ -1,7 +1,11 @@ --- title: Dynamic Sampling -description: Dynamic Sampling is a feature of the ingestion pipeline that allows Sentry to automatically adjust the amount of data retained based on the value of the data. +description: >- + Dynamic Sampling is a feature of the ingestion pipeline that allows Sentry to + automatically adjust the amount of data retained based on the value of the + data. sidebar_order: 50 +og_image: /og-images/application-architecture-dynamic-sampling.png --- From all the data received by the SDKs, Sentry is able to extract low-granularity information through metrics, while Dynamic Sampling makes the decision of whether to keep or drop data. diff --git a/develop-docs/application-architecture/dynamic-sampling/the-big-picture.mdx b/develop-docs/application-architecture/dynamic-sampling/the-big-picture.mdx index dc5e09e5f9b9f..210bf0089b4e6 100644 --- a/develop-docs/application-architecture/dynamic-sampling/the-big-picture.mdx +++ b/develop-docs/application-architecture/dynamic-sampling/the-big-picture.mdx @@ -1,7 +1,11 @@ --- title: The Big Picture -description: The lifecycle of an event in Sentry is a complex process which involves many components. Dynamic Sampling is one of these components, and it is important to understand how it fits into the bigger picture. +description: >- + The lifecycle of an event in Sentry is a complex process which involves many + components. Dynamic Sampling is one of these components, and it is important + to understand how it fits into the bigger picture. sidebar_order: 1 +og_image: /og-images/application-architecture-dynamic-sampling-the-big-picture.png --- ![Sequencing](./images/sequencing.png) diff --git a/develop-docs/backend/application-domains/database-migrations/index.mdx b/develop-docs/backend/application-domains/database-migrations/index.mdx index de0d06a32f3b5..4764915daf435 100644 --- a/develop-docs/backend/application-domains/database-migrations/index.mdx +++ b/develop-docs/backend/application-domains/database-migrations/index.mdx @@ -1,6 +1,7 @@ --- title: Database Migrations sidebar_order: 20 +og_image: /og-images/backend-application-domains-database-migrations.png --- Django migrations are how we handle changes to the database in Sentry. diff --git a/develop-docs/backend/application-domains/transaction-clustering/index.mdx b/develop-docs/backend/application-domains/transaction-clustering/index.mdx index 4b5284db2aea8..5b63ab8cca1f5 100644 --- a/develop-docs/backend/application-domains/transaction-clustering/index.mdx +++ b/develop-docs/backend/application-domains/transaction-clustering/index.mdx @@ -1,6 +1,7 @@ --- title: Clustering URL Transactions sidebar_order: 90 +og_image: /og-images/backend-application-domains-transaction-clustering.png --- Sentry attempts to scrub high-cardinality identifiers from URL transactions diff --git a/develop-docs/backend/issue-platform/index.mdx b/develop-docs/backend/issue-platform/index.mdx index e2c9938a78ac5..35043bd2f9f29 100644 --- a/develop-docs/backend/issue-platform/index.mdx +++ b/develop-docs/backend/issue-platform/index.mdx @@ -1,6 +1,7 @@ --- title: Issue Platform sidebar_order: 30 +og_image: /og-images/backend-issue-platform.jpg --- The Issue Platform allows developers to create new issue types from arbitrary data sources. If you have data about something that you want to track via an issue, you can build it on the issue platform. For example, building profiling issues on the issue platform allowed us to turn things like “JSON decoding on the main thread” into their own issue types. diff --git a/develop-docs/backend/issue-platform/writing-detectors/index.mdx b/develop-docs/backend/issue-platform/writing-detectors/index.mdx index 40ce8f5b8548a..b5bf009ac8e95 100644 --- a/develop-docs/backend/issue-platform/writing-detectors/index.mdx +++ b/develop-docs/backend/issue-platform/writing-detectors/index.mdx @@ -1,6 +1,7 @@ --- title: Writing Detectors sidebar_order: 10 +og_image: /og-images/backend-issue-platform-writing-detectors.png --- Issue detectors identify application issues by examining one or more datasets collected by Sentry, and report detected issue occurrences via the Issue Platform. Detectors must fingerprint issues accurately and provide actionable information to developers. diff --git a/develop-docs/development-infrastructure/environment/pycharm/index.mdx b/develop-docs/development-infrastructure/environment/pycharm/index.mdx index dba69f48c96be..e2644b06a0241 100644 --- a/develop-docs/development-infrastructure/environment/pycharm/index.mdx +++ b/develop-docs/development-infrastructure/environment/pycharm/index.mdx @@ -1,7 +1,10 @@ --- title: Configuring PyCharm -description: If you use PyCharm for developing there are a few things you need to configure in order to be able to run and debug. +description: >- + If you use PyCharm for developing there are a few things you need to configure + in order to be able to run and debug. sidebar_order: 30 +og_image: /og-images/development-infrastructure-environment-pycharm.png --- This document describes a few useful configurations for sentry development. diff --git a/develop-docs/development-infrastructure/frontend-development-server.mdx b/develop-docs/development-infrastructure/frontend-development-server.mdx index 426e94204de2d..54e5777b5bc6e 100644 --- a/develop-docs/development-infrastructure/frontend-development-server.mdx +++ b/develop-docs/development-infrastructure/frontend-development-server.mdx @@ -1,6 +1,7 @@ --- title: Frontend Development Server sidebar_order: 30 +og_image: /og-images/development-infrastructure-frontend-development-server.png --- (*see also: [Backend Development Server](/backend/development-server/)*) diff --git a/develop-docs/frontend/design-tenets.mdx b/develop-docs/frontend/design-tenets.mdx index e1300def30b8d..bd74d7a1c8149 100644 --- a/develop-docs/frontend/design-tenets.mdx +++ b/develop-docs/frontend/design-tenets.mdx @@ -1,6 +1,7 @@ --- title: Frontend Design Tenets sidebar_order: 20 +og_image: /og-images/frontend-design-tenets.png --- diff --git a/develop-docs/frontend/pull-request-previews.mdx b/develop-docs/frontend/pull-request-previews.mdx index 81676ea1b97f4..aed330771871e 100644 --- a/develop-docs/frontend/pull-request-previews.mdx +++ b/develop-docs/frontend/pull-request-previews.mdx @@ -1,6 +1,7 @@ --- title: Pull Request Previews sidebar_order: 90 +og_image: /og-images/frontend-pull-request-previews.png --- ## What are preview builds? diff --git a/develop-docs/integrations/azuredevops/index.mdx b/develop-docs/integrations/azuredevops/index.mdx index 20234b0a9b9e5..2ad479bf1694c 100644 --- a/develop-docs/integrations/azuredevops/index.mdx +++ b/develop-docs/integrations/azuredevops/index.mdx @@ -1,6 +1,7 @@ --- title: Azure DevOps Integration sidebar_title: Azure DevOps +og_image: /og-images/integrations-azuredevops.png --- ## Create an Azure Application diff --git a/develop-docs/integrations/bitbucket/index.mdx b/develop-docs/integrations/bitbucket/index.mdx index a5ae523575e3f..bded4e33d3540 100644 --- a/develop-docs/integrations/bitbucket/index.mdx +++ b/develop-docs/integrations/bitbucket/index.mdx @@ -1,6 +1,7 @@ --- title: Bitbucket Integration sidebar_title: Bitbucket +og_image: /og-images/integrations-bitbucket.png --- ## Prerequisites diff --git a/develop-docs/integrations/discord/index.mdx b/develop-docs/integrations/discord/index.mdx index 8b232664cb0fc..7d0b418de62ea 100644 --- a/develop-docs/integrations/discord/index.mdx +++ b/develop-docs/integrations/discord/index.mdx @@ -1,6 +1,7 @@ --- title: Discord Integration sidebar_title: Discord +og_image: /og-images/integrations-discord.png --- ## Create a Discord bot diff --git a/develop-docs/integrations/jira/index.mdx b/develop-docs/integrations/jira/index.mdx index 028f039a92580..71dc572a633fa 100644 --- a/develop-docs/integrations/jira/index.mdx +++ b/develop-docs/integrations/jira/index.mdx @@ -1,6 +1,7 @@ --- title: Jira Integration sidebar_title: Jira +og_image: /og-images/integrations-jira.png --- ## Create an Atlassian Cloud Developer Instance diff --git a/develop-docs/integrations/msteams/index.mdx b/develop-docs/integrations/msteams/index.mdx index 1ade8037e8d3f..e0a941b3df312 100644 --- a/develop-docs/integrations/msteams/index.mdx +++ b/develop-docs/integrations/msteams/index.mdx @@ -1,6 +1,7 @@ --- title: Microsoft Teams Integration sidebar_title: Microsoft Teams +og_image: /og-images/integrations-msteams.png --- diff --git a/develop-docs/integrations/slack/index.mdx b/develop-docs/integrations/slack/index.mdx index 911697c1e2d3d..c5e8d1ddd2f1a 100644 --- a/develop-docs/integrations/slack/index.mdx +++ b/develop-docs/integrations/slack/index.mdx @@ -1,6 +1,7 @@ --- title: Slack Integration sidebar_title: Slack +og_image: /og-images/integrations-slack.png --- ## Create a Slack App diff --git a/develop-docs/sdk/expected-features/setup-wizards/index.mdx b/develop-docs/sdk/expected-features/setup-wizards/index.mdx index 7025355d772cb..5c5e3baae7c65 100644 --- a/develop-docs/sdk/expected-features/setup-wizards/index.mdx +++ b/develop-docs/sdk/expected-features/setup-wizards/index.mdx @@ -1,6 +1,7 @@ --- title: Setup Wizards sidebar_order: 3 +og_image: /og-images/sdk-expected-features-setup-wizards.png --- Some SDKs support automatic SDK setup with the Sentry Wizard to make setting up the SDK as easy as possible. @@ -56,10 +57,10 @@ This ensures that users can revert the changes easily if something goes wrong. ### Respect Users' decisions Wizards should allow users to select the high-level Sentry features (e.g. tracing, replay, profiling) they want to install. -The SDK setup should be minimal, may be opinionated ("whatever makes sense for the platform") but -must respect users' decisions. +The SDK setup should be minimal, may be opinionated ("whatever makes sense for the platform") but +must respect users' decisions. -Some examples: +Some examples: - We should not enable a feature that users previously declined (e.g. set `tracesSampleRate` if users previously declined to enable tracing) - We may set additional options, like the `tunnelRoute` option in Next.Js, but we should ask for consent whenever reasonable. In this example, consent is important because setting this option potentially increases users' traffic and hence their infrastructure bill. - We may set additional options like `tracePropagationTargets` or `sendDefaultPii` as comments, if we think that these are options users should be aware of. diff --git a/develop-docs/sdk/miscellaneous/hub_and_scope_refactoring.mdx b/develop-docs/sdk/miscellaneous/hub_and_scope_refactoring.mdx index 743f1b53f6aa3..320c4fe86769d 100644 --- a/develop-docs/sdk/miscellaneous/hub_and_scope_refactoring.mdx +++ b/develop-docs/sdk/miscellaneous/hub_and_scope_refactoring.mdx @@ -1,6 +1,7 @@ --- title: Hub & Scope Refactoring sidebar_order: 3 +og_image: /og-images/sdk-miscellaneous-hub_and_scope_refactoring.png --- diff --git a/develop-docs/sdk/miscellaneous/unified-api/index.mdx b/develop-docs/sdk/miscellaneous/unified-api/index.mdx index d370215a46519..1bd3806dc40aa 100644 --- a/develop-docs/sdk/miscellaneous/unified-api/index.mdx +++ b/develop-docs/sdk/miscellaneous/unified-api/index.mdx @@ -1,6 +1,7 @@ --- title: Unified API (deprecated) sidebar_order: 1 +og_image: /og-images/sdk-miscellaneous-unified-api.png --- 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 03f83997d9405..44763322f7576 100644 --- a/develop-docs/sdk/platform-specifics/javascript-sdks/browser-tracing.mdx +++ b/develop-docs/sdk/platform-specifics/javascript-sdks/browser-tracing.mdx @@ -1,7 +1,10 @@ --- title: Tracing in the Browser -description: Interesting aspects of tracing and performance instrumentation in the browser SDKs. +description: >- + Interesting aspects of tracing and performance instrumentation in the browser + SDKs. sidebar_order: 10 +og_image: /og-images/sdk-platform-specifics-javascript-sdks-browser-tracing.png --- 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. diff --git a/develop-docs/sdk/platform-specifics/native-sdks/tracing.mdx b/develop-docs/sdk/platform-specifics/native-sdks/tracing.mdx index dcec183296f97..3610941dcf7aa 100644 --- a/develop-docs/sdk/platform-specifics/native-sdks/tracing.mdx +++ b/develop-docs/sdk/platform-specifics/native-sdks/tracing.mdx @@ -1,6 +1,7 @@ --- title: Tracing sidebar_order: 30 +og_image: /og-images/sdk-platform-specifics-native-sdks-tracing.png --- ## Scenarios diff --git a/develop-docs/sdk/platform-specifics/serverless-sdks/aws-lambda.mdx b/develop-docs/sdk/platform-specifics/serverless-sdks/aws-lambda.mdx index d28c95a64bd2a..d3a4b42c8b25c 100644 --- a/develop-docs/sdk/platform-specifics/serverless-sdks/aws-lambda.mdx +++ b/develop-docs/sdk/platform-specifics/serverless-sdks/aws-lambda.mdx @@ -1,6 +1,7 @@ --- title: AWS Lambda Primer sidebar_order: 100 +og_image: /og-images/sdk-platform-specifics-serverless-sdks-aws-lambda.png --- Lambda functions can be written in numerous programming languages (JavaScript, diff --git a/develop-docs/sdk/telemetry/scopes.mdx b/develop-docs/sdk/telemetry/scopes.mdx index affe84819137c..f147850d4cdd9 100644 --- a/develop-docs/sdk/telemetry/scopes.mdx +++ b/develop-docs/sdk/telemetry/scopes.mdx @@ -1,5 +1,6 @@ --- title: Scopes +og_image: /og-images/sdk-telemetry-scopes.png --- diff --git a/develop-docs/sdk/telemetry/sessions/index.mdx b/develop-docs/sdk/telemetry/sessions/index.mdx index b5d10a9eaeead..243e692db6e76 100644 --- a/develop-docs/sdk/telemetry/sessions/index.mdx +++ b/develop-docs/sdk/telemetry/sessions/index.mdx @@ -1,6 +1,7 @@ --- title: Sessions sidebar_order: 6 +og_image: /og-images/sdk-telemetry-sessions.png --- diff --git a/develop-docs/sdk/telemetry/traces/backpressure.mdx b/develop-docs/sdk/telemetry/traces/backpressure.mdx index fefda3e672d60..70dfd1e4a5b11 100644 --- a/develop-docs/sdk/telemetry/traces/backpressure.mdx +++ b/develop-docs/sdk/telemetry/traces/backpressure.mdx @@ -1,5 +1,6 @@ --- title: Backpressure Management +og_image: /og-images/sdk-telemetry-traces-backpressure.png --- Backend SDKs that are typically used in server environments are expected to implement a component for backpressure management. diff --git a/develop-docs/sdk/telemetry/traces/span-links.mdx b/develop-docs/sdk/telemetry/traces/span-links.mdx index 7100d790ef00c..a53880737b372 100644 --- a/develop-docs/sdk/telemetry/traces/span-links.mdx +++ b/develop-docs/sdk/telemetry/traces/span-links.mdx @@ -1,5 +1,6 @@ --- title: Span Links +og_image: /og-images/sdk-telemetry-traces-span-links.png --- Span links associate one span with one or more other spans. The most important application of linking traces are frontend applications. diff --git a/develop-docs/services/chartcuterie.mdx b/develop-docs/services/chartcuterie.mdx index 6ab0b76f5ad78..ff174d090bd09 100644 --- a/develop-docs/services/chartcuterie.mdx +++ b/develop-docs/services/chartcuterie.mdx @@ -1,5 +1,6 @@ --- title: Backend Chart Rendering +og_image: /og-images/services-chartcuterie.png --- Sentry's frontend provides users with detailed and interactive charts of diff --git a/docs/account/auth-tokens/index.mdx b/docs/account/auth-tokens/index.mdx index 03f6507a93245..9c2695930c1e5 100644 --- a/docs/account/auth-tokens/index.mdx +++ b/docs/account/auth-tokens/index.mdx @@ -1,7 +1,10 @@ --- -title: "Auth Tokens" +title: Auth Tokens sidebar_order: 45 -description: "Learn about the different kinds of Auth Tokens Sentry provides, and when to use which." +description: >- + Learn about the different kinds of Auth Tokens Sentry provides, and when to + use which. +og_image: /og-images/account-auth-tokens.png --- Auth tokens (short for _authentication tokens_) are a way to authenticate with Sentry. They are similar to passwords but are designed for programmatic interaction with Sentry. Some examples of what you would use auth tokens for include: diff --git a/docs/account/user-settings/index.mdx b/docs/account/user-settings/index.mdx index be63470cef5ee..342b70c9f732c 100644 --- a/docs/account/user-settings/index.mdx +++ b/docs/account/user-settings/index.mdx @@ -1,7 +1,10 @@ --- title: Account Preferences sidebar_order: 40 -description: "Learn how to customize your User Settings for a more personalized Sentry experience." +description: >- + Learn how to customize your User Settings for a more personalized Sentry + experience. +og_image: /og-images/account-user-settings.png --- [Account preferences](https://sentry.io/settings/account/details/) help you customize your Sentry experience. Manage your account by selecting "User settings" from the dropdown under your organization’s name. On this page, you can control the frequency of your [email notifications](#notifications), [change your primary email](#emails), and update your security settings. diff --git a/docs/api/guides/create-auth-token.mdx b/docs/api/guides/create-auth-token.mdx index 7b3fad7e2a2e2..bca7b8d32ba59 100644 --- a/docs/api/guides/create-auth-token.mdx +++ b/docs/api/guides/create-auth-token.mdx @@ -1,6 +1,7 @@ --- -title: "Tutorial: Create a Sentry Authentication Token" +title: 'Tutorial: Create a Sentry Authentication Token' sidebar_order: 8 +og_image: /og-images/api-guides-create-auth-token.gif --- To use Sentry's APIs, you must have an authentication token. This tutorial walks you through creating an organizational auth token through an internal integration. Sentry recommends using organizational auth tokens whenever possible, as they aren't linked to specific user accounts. diff --git a/docs/api/permissions.mdx b/docs/api/permissions.mdx index c6e14407dafb3..f809c6fe24906 100644 --- a/docs/api/permissions.mdx +++ b/docs/api/permissions.mdx @@ -1,6 +1,7 @@ --- title: Permissions & Scopes sidebar_order: 2 +og_image: /og-images/api-permissions.png --- If you're building on top of Sentry's API (i.e using [Auth Tokens](/api/auth/)), you'll need certain scopes to access diff --git a/docs/concepts/data-management/event-grouping/index.mdx b/docs/concepts/data-management/event-grouping/index.mdx index 0f0d1034f98a8..cfe5100e4590c 100644 --- a/docs/concepts/data-management/event-grouping/index.mdx +++ b/docs/concepts/data-management/event-grouping/index.mdx @@ -1,7 +1,10 @@ --- -title: "Issue Grouping" +title: Issue Grouping sidebar_order: 0 -description: "Learn about fingerprinting, Sentry's default error grouping algorithms, and other ways to customize how events are grouped into issues." +description: >- + Learn about fingerprinting, Sentry's default error grouping algorithms, and + other ways to customize how events are grouped into issues. +og_image: /og-images/concepts-data-management-event-grouping.png --- A fingerprint is a way to uniquely identify an event, and all events have one. Events with the same fingerprint are grouped together into an issue. diff --git a/docs/concepts/data-management/event-grouping/merging-issues/index.mdx b/docs/concepts/data-management/event-grouping/merging-issues/index.mdx index f4f4e2226093e..db9da1efe89e0 100644 --- a/docs/concepts/data-management/event-grouping/merging-issues/index.mdx +++ b/docs/concepts/data-management/event-grouping/merging-issues/index.mdx @@ -1,7 +1,8 @@ --- -title: "Merging Issues" +title: Merging Issues sidebar_order: 10 -description: "Learn about merging similar issues that aren't automatically grouped." +description: Learn about merging similar issues that aren't automatically grouped. +og_image: /og-images/concepts-data-management-event-grouping-merging-issues.png --- diff --git a/docs/concepts/data-management/filtering/index.mdx b/docs/concepts/data-management/filtering/index.mdx index e1a3509ce5bfa..2f4dcc88a0638 100644 --- a/docs/concepts/data-management/filtering/index.mdx +++ b/docs/concepts/data-management/filtering/index.mdx @@ -1,7 +1,8 @@ --- title: Inbound Filters sidebar_order: 5 -description: "Learn about the different methods for filtering data in your project." +description: Learn about the different methods for filtering data in your project. +og_image: /og-images/concepts-data-management-filtering.png --- Sentry provides several methods to filter data in your project. Using sentry.io to filter events is a simple method since you don't have to [configure and deploy your SDK to filter projects](/platform-redirect/?next=/configuration/filtering/). @@ -89,7 +90,7 @@ The following inbound filters **do** apply to Session Replays: The following inbound filters **do not** apply to Session Replays: - Error messages -- Browser extension errors +- Browser extension errors - Web crawler errors - Legacy browser filters - React hydration errors @@ -122,7 +123,7 @@ The following inbound filters **do** apply to Logs: The following inbound filters **do not** apply to Logs: - Error messages -- Browser extension errors +- Browser extension errors - Web crawler errors - Legacy browser filters - React hydration errors diff --git a/docs/concepts/key-terms/dsn-explainer.mdx b/docs/concepts/key-terms/dsn-explainer.mdx index dde1a702d9966..12937c61d1f03 100644 --- a/docs/concepts/key-terms/dsn-explainer.mdx +++ b/docs/concepts/key-terms/dsn-explainer.mdx @@ -1,7 +1,11 @@ --- title: Data Source Name (DSN) sidebar_order: 10 -description: "A Data Source Name (DSN) tells Sentry where to send events so they’re associated with the correct project. Learn more about DSN structure and use here." +description: >- + A Data Source Name (DSN) tells Sentry where to send events so they’re + associated with the correct project. Learn more about DSN structure and use + here. +og_image: /og-images/concepts-key-terms-dsn-explainer.png --- Sentry automatically assigns you a Data Source Name (DSN) when you create a project to start monitoring events in your app. diff --git a/docs/concepts/key-terms/enrich-data/index.mdx b/docs/concepts/key-terms/enrich-data/index.mdx index 1db65f3100269..70fd7444ef6e1 100644 --- a/docs/concepts/key-terms/enrich-data/index.mdx +++ b/docs/concepts/key-terms/enrich-data/index.mdx @@ -1,7 +1,10 @@ --- title: Event Data sidebar_order: 60 -description: "Learn about event data and how to configure Sentry workflows and tools to fine-tune the data sent to Sentry." +description: >- + Learn about event data and how to configure Sentry workflows and tools to + fine-tune the data sent to Sentry. +og_image: /og-images/concepts-key-terms-enrich-data.png --- The Sentry SDK captures errors, exceptions, crashes, transactions, and generally anything that goes wrong in your application in real-time. diff --git a/docs/concepts/key-terms/environments/index.mdx b/docs/concepts/key-terms/environments/index.mdx index abbe3fa9fa61a..c40b65ddba869 100644 --- a/docs/concepts/key-terms/environments/index.mdx +++ b/docs/concepts/key-terms/environments/index.mdx @@ -1,7 +1,10 @@ --- title: Creating and Filtering Environments sidebar_order: 20 -description: "Learn how environments can help you filter issues, releases, and user feedback in Sentry." +description: >- + Learn how environments can help you filter issues, releases, and user feedback + in Sentry. +og_image: /og-images/concepts-key-terms-environments.png --- `Environment` is a Sentry-supported tag that you can (and should) add to your SDK. Generally, the tag accepts any value, but it's intended to refer to your code deployments' naming convention, such as _development_, _testing_, _staging_, or _production_. diff --git a/docs/concepts/key-terms/tracing/distributed-tracing.mdx b/docs/concepts/key-terms/tracing/distributed-tracing.mdx index 70194d202a337..8c31212510365 100644 --- a/docs/concepts/key-terms/tracing/distributed-tracing.mdx +++ b/docs/concepts/key-terms/tracing/distributed-tracing.mdx @@ -1,7 +1,11 @@ --- title: Distributed Tracing sidebar_order: 20 -description: With distributed tracing, you can track software performance and measure throughput & latency, while seeing the impact of errors across multiple systems. +description: >- + With distributed tracing, you can track software performance and measure + throughput & latency, while seeing the impact of errors across multiple + systems. +og_image: /og-images/concepts-key-terms-tracing-distributed-tracing.png --- Distributed tracing provides a connected view of your application from frontend to backend. It helps track software performance, measure [metrics](/product/insights/overview/metrics/) like throughput and latency, and display the impact of errors across multiple systems. This makes Sentry a more complete [performance monitoring](/product/insights/overview/) solution, aiding in diagnosing problems and measuring your application's overall health. diff --git a/docs/concepts/key-terms/tracing/index.mdx b/docs/concepts/key-terms/tracing/index.mdx index b0e1e6491f24c..fcf4399afdf5e 100644 --- a/docs/concepts/key-terms/tracing/index.mdx +++ b/docs/concepts/key-terms/tracing/index.mdx @@ -1,7 +1,10 @@ --- title: Tracing sidebar_order: 70 -description: "Learn more about the tracing features Sentry offers to help you track your software performance across multiple systems." +description: >- + Learn more about the tracing features Sentry offers to help you track your + software performance across multiple systems. +og_image: /og-images/concepts-key-terms-tracing.png --- ## What's Tracing? @@ -42,7 +45,7 @@ You can view all the traces in your organization by going to the [Traces](https: ![A view of the Sentry Traces page showing traces and spans](./img/Traces-page.png) -If you want more information, click on any trace ID. This will take you to the [Trace View](/concepts/key-terms/tracing/trace-view/) page, which provides a more detailed view of the trace and its spans. Here, you'll see a waterfall view of the spans in the trace, which will show you how much time each service and operation took to complete, and may give you an indicator of where a problem may originate. +If you want more information, click on any trace ID. This will take you to the [Trace View](/concepts/key-terms/tracing/trace-view/) page, which provides a more detailed view of the trace and its spans. Here, you'll see a waterfall view of the spans in the trace, which will show you how much time each service and operation took to complete, and may give you an indicator of where a problem may originate. ![A detailed view of the Senty Traces page showing an expaned trace and spans](./img/Trace-view-page.png) diff --git a/docs/concepts/key-terms/tracing/trace-view.mdx b/docs/concepts/key-terms/tracing/trace-view.mdx index e37922f4643d8..250bafecae027 100644 --- a/docs/concepts/key-terms/tracing/trace-view.mdx +++ b/docs/concepts/key-terms/tracing/trace-view.mdx @@ -1,9 +1,13 @@ --- -title: "Trace View" +title: Trace View sidebar_order: 30 redirect_from: -- /concepts/key-terms/tracing/trace-view/ -description: "Learn more about the Trace View page, where you can drill down into the details of a single trace, allowing you to debug slow services, identify related errors, and find other bottlenecks." + - /concepts/key-terms/tracing/trace-view/ +description: >- + Learn more about the Trace View page, where you can drill down into the + details of a single trace, allowing you to debug slow services, identify + related errors, and find other bottlenecks. +og_image: /og-images/concepts-key-terms-tracing-trace-view.png --- The Trace View page is designed to be your one-stop-shop when debugging performance or errors. It gives you full context on what was happening when an error or performance issue occurred, all in one place. The waterfall Trace View allows you to see everything that may have occurred during a trace, including errors, performance issues, and any profiles that may have been collected. diff --git a/docs/concepts/migration/index.mdx b/docs/concepts/migration/index.mdx index cf73c48421b24..7f52556d904b2 100644 --- a/docs/concepts/migration/index.mdx +++ b/docs/concepts/migration/index.mdx @@ -1,7 +1,10 @@ --- title: Moving to SaaS sidebar_order: 300 -description: "Learn more about the reasons to move to Sentry's SaaS solution, which for many customers is less expensive to maintain, and easier to scale and support." +description: >- + Learn more about the reasons to move to Sentry's SaaS solution, which for many + customers is less expensive to maintain, and easier to scale and support. +og_image: /og-images/concepts-migration.png --- Sentry offers a cloud-hosted, software-as-a-service (SaaS) solution in addition to a self-hosted solution, which are both functionally the same. However, many customers find that self-hosted Sentry can quickly become expensive to maintain, scale, and support, making our SaaS product the better and less costly option. To facilitate moving from self-hosted to SaaS, we provide a self-serve process known as "relocation". diff --git a/docs/concepts/search/index.mdx b/docs/concepts/search/index.mdx index d5337c04a6e91..e2a7da75074e4 100644 --- a/docs/concepts/search/index.mdx +++ b/docs/concepts/search/index.mdx @@ -1,7 +1,10 @@ --- title: Search -description: "Learn more about how to search in Sentry, including the correct query syntax, searchable properties, and custom tags." +description: >- + Learn more about how to search in Sentry, including the correct query syntax, + searchable properties, and custom tags. sidebar_order: 50 +og_image: /og-images/concepts-search.png --- Search is available on several features throughout [sentry.io](https://sentry.io), such as **Issues**, **Discover** and **Dashboards**. diff --git a/docs/concepts/search/saved-searches.mdx b/docs/concepts/search/saved-searches.mdx index 567c5ac59a8ce..037c09e15ac74 100644 --- a/docs/concepts/search/saved-searches.mdx +++ b/docs/concepts/search/saved-searches.mdx @@ -1,8 +1,11 @@ --- title: Saved Searches sidebar_order: 20 -keywords: ["saved search", "premade searches"] -description: "Learn more about default, recommended, and saved searches." +keywords: + - saved search + - premade searches +description: 'Learn more about default, recommended, and saved searches.' +og_image: /og-images/concepts-search-saved-searches.gif --- diff --git a/docs/organization/authentication/sso/azure-sso.mdx b/docs/organization/authentication/sso/azure-sso.mdx index 3865bf574c9cd..052a0f37ce266 100644 --- a/docs/organization/authentication/sso/azure-sso.mdx +++ b/docs/organization/authentication/sso/azure-sso.mdx @@ -1,7 +1,8 @@ --- -title: "Azure Active Directory SSO" +title: Azure Active Directory SSO sidebar_order: 1 -description: "Set up Azure Active Directory single sign-on (SSO) on Sentry." +description: Set up Azure Active Directory single sign-on (SSO) on Sentry. +og_image: /og-images/organization-authentication-sso-azure-sso.png --- ## Installation diff --git a/docs/organization/authentication/sso/okta-sso/index.mdx b/docs/organization/authentication/sso/okta-sso/index.mdx index 43b23df169b23..b71c5c4c2c25c 100644 --- a/docs/organization/authentication/sso/okta-sso/index.mdx +++ b/docs/organization/authentication/sso/okta-sso/index.mdx @@ -1,7 +1,8 @@ --- -title: "Okta SSO" +title: Okta SSO sidebar_order: 2 -description: "Set up Okta single sign-on (SSO) on Sentry." +description: Set up Okta single sign-on (SSO) on Sentry. +og_image: /og-images/organization-authentication-sso-okta-sso.png --- ## Installation diff --git a/docs/organization/authentication/sso/okta-sso/okta-scim.mdx b/docs/organization/authentication/sso/okta-sso/okta-scim.mdx index cc037e9c85d10..a3340ab820f84 100644 --- a/docs/organization/authentication/sso/okta-sso/okta-scim.mdx +++ b/docs/organization/authentication/sso/okta-sso/okta-scim.mdx @@ -1,7 +1,8 @@ --- -title: "Okta SCIM Provisioning" +title: Okta SCIM Provisioning sidebar_order: 3 -description: "Set up Okta's SCIM Integration for Member and Team Provisioning" +description: Set up Okta's SCIM Integration for Member and Team Provisioning +og_image: /og-images/organization-authentication-sso-okta-sso-okta-scim.png --- diff --git a/docs/organization/authentication/sso/ping-sso.mdx b/docs/organization/authentication/sso/ping-sso.mdx index 30abe1aefaae6..a8913c1d6b3f0 100644 --- a/docs/organization/authentication/sso/ping-sso.mdx +++ b/docs/organization/authentication/sso/ping-sso.mdx @@ -1,7 +1,8 @@ --- -title: "Ping Identity SSO" +title: Ping Identity SSO sidebar_order: 3 -description: "Set up Ping Identity Single Sign-On (SSO) on Sentry." +description: Set up Ping Identity Single Sign-On (SSO) on Sentry. +og_image: /og-images/organization-authentication-sso-ping-sso.png --- ## Installation diff --git a/docs/organization/authentication/sso/saml2.mdx b/docs/organization/authentication/sso/saml2.mdx index 7c0efc8675cac..3b6eb3bc5a038 100644 --- a/docs/organization/authentication/sso/saml2.mdx +++ b/docs/organization/authentication/sso/saml2.mdx @@ -1,7 +1,8 @@ --- -title: "Custom SAML Provider" +title: Custom SAML Provider sidebar_order: 5 -description: "Learn about how to integrate the Custom SAML Provider." +description: Learn about how to integrate the Custom SAML Provider. +og_image: /og-images/organization-authentication-sso-saml2.png --- diff --git a/docs/organization/authentication/two-factor-authentication/index.mdx b/docs/organization/authentication/two-factor-authentication/index.mdx index b86337ae55a8e..5278aa7cd80a4 100644 --- a/docs/organization/authentication/two-factor-authentication/index.mdx +++ b/docs/organization/authentication/two-factor-authentication/index.mdx @@ -1,7 +1,8 @@ --- -title: "Two-Factor Authentication (2FA)" +title: Two-Factor Authentication (2FA) sidebar_order: 30 -description: "Learn about adding two-factor authentication (2FA) across your organization." +description: Learn about adding two-factor authentication (2FA) across your organization. +og_image: /og-images/organization-authentication-two-factor-authentication.png --- For an added layer of security, you can require your organization members to sign in to Sentry with two-factor authentication (2FA). diff --git a/docs/organization/dynamic-sampling/index.mdx b/docs/organization/dynamic-sampling/index.mdx index 34073361c598f..436c9ab67916d 100644 --- a/docs/organization/dynamic-sampling/index.mdx +++ b/docs/organization/dynamic-sampling/index.mdx @@ -7,14 +7,18 @@ redirect_from: - /product/data-management-settings/server-side-sampling/ - /product/data-management-settings/server-side-sampling/getting-started/ - /product/data-management-settings/server-side-sampling/current-limitations/ - - /product/data-management-settings/server-side-sampling/sampling-configurations/ + - >- + /product/data-management-settings/server-side-sampling/sampling-configurations/ - /product/data-management-settings/dynamic-sampling/current-limitations/ - /product/data-management-settings/dynamic-sampling/sampling-configurations/ - /product/data-management-settings/dynamic-sampling/ - /product/performance/performance-at-scale/ - /product/performance/performance-at-scale/getting-started/ - /product/performance/performance-at-scale/benefits-performance-at-scale/ -description: "Learn how to prioritize important events and increase visibility in lower-volume projects with Dynamic Sampling." +description: >- + Learn how to prioritize important events and increase visibility in + lower-volume projects with Dynamic Sampling. +og_image: /og-images/organization-dynamic-sampling.png --- ## Overview diff --git a/docs/organization/early-adopter-features/index.mdx b/docs/organization/early-adopter-features/index.mdx index 654943d08e2ab..d48883befdc29 100644 --- a/docs/organization/early-adopter-features/index.mdx +++ b/docs/organization/early-adopter-features/index.mdx @@ -1,7 +1,8 @@ --- -title: "Early Adopter Features" +title: Early Adopter Features sidebar_order: 60 -description: "Learn which features are currently in the early adopter phase." +description: Learn which features are currently in the early adopter phase. +og_image: /og-images/organization-early-adopter-features.png --- If you’re interested in being an Early Adopter, you can turn your organization’s Early Adopter status on/off in **Settings > General Settings**. This will affect all users in your organization and can be turned back off just as easily. diff --git a/docs/organization/getting-started/index.mdx b/docs/organization/getting-started/index.mdx index f4da14b37a81a..e5ed63321eaa3 100644 --- a/docs/organization/getting-started/index.mdx +++ b/docs/organization/getting-started/index.mdx @@ -1,7 +1,10 @@ --- title: Set Up Your Organization sidebar_order: 0 -description: "Learn how to set up a Sentry organization account, so you can start fixing errors right away." +description: >- + Learn how to set up a Sentry organization account, so you can start fixing + errors right away. +og_image: /og-images/organization-getting-started.png --- In this guide, we'll provide the recommended checklist for setting up your [Sentry organization account](https://sentry.io) so you can get started with Sentry error monitoring. diff --git a/docs/organization/integrations/cloud-monitoring/aws-lambda/how-it-works.mdx b/docs/organization/integrations/cloud-monitoring/aws-lambda/how-it-works.mdx index 3486f57e94cd5..8f0613db31b94 100644 --- a/docs/organization/integrations/cloud-monitoring/aws-lambda/how-it-works.mdx +++ b/docs/organization/integrations/cloud-monitoring/aws-lambda/how-it-works.mdx @@ -1,6 +1,8 @@ --- title: Lambda Layer Modifications -description: "Understand how the Sentry AWS Lambda integration works under the hood." +description: Understand how the Sentry AWS Lambda integration works under the hood. +og_image: >- + /og-images/organization-integrations-cloud-monitoring-aws-lambda-how-it-works.png --- ## Node diff --git a/docs/organization/integrations/cloud-monitoring/aws-lambda/index.mdx b/docs/organization/integrations/cloud-monitoring/aws-lambda/index.mdx index 641d0ef1a85ab..09b4e14eebd08 100644 --- a/docs/organization/integrations/cloud-monitoring/aws-lambda/index.mdx +++ b/docs/organization/integrations/cloud-monitoring/aws-lambda/index.mdx @@ -1,7 +1,11 @@ --- title: AWS Lambda 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." +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. +og_image: /og-images/organization-integrations-cloud-monitoring-aws-lambda.png --- Connect Sentry to your AWS account to automatically add Sentry error and performance monitoring to your Node/Python Lambda functions. 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 7c7868fa6bd49..72fd5ff67ffa4 100644 --- a/docs/organization/integrations/cloud-monitoring/gcp-cloud-run/index.mdx +++ b/docs/organization/integrations/cloud-monitoring/gcp-cloud-run/index.mdx @@ -1,7 +1,10 @@ --- title: Google Cloud Run sidebar_order: 1 -description: "Learn more about how you can use Sentry with your Google Cloud Run applications." +description: >- + Learn more about how you can use Sentry with your Google Cloud Run + applications. +og_image: /og-images/organization-integrations-cloud-monitoring-gcp-cloud-run.png --- Cloud Run helps developers save time in building and deploying their applications. Sentry helps save time in resolving production issues by providing detailed debugging capabilities. diff --git a/docs/organization/integrations/data-visualization/amazon-sqs/index.mdx b/docs/organization/integrations/data-visualization/amazon-sqs/index.mdx index f78e123de8705..397360990e6bb 100644 --- a/docs/organization/integrations/data-visualization/amazon-sqs/index.mdx +++ b/docs/organization/integrations/data-visualization/amazon-sqs/index.mdx @@ -1,7 +1,10 @@ --- title: Amazon SQS (Legacy) sidebar_order: 1 -description: "Learn about Sentry's Amazon SQS integration, which allows you to forward Sentry events to Amazon SQS for further analysis." +description: >- + Learn about Sentry's Amazon SQS integration, which allows you to forward + Sentry events to Amazon SQS for further analysis. +og_image: /og-images/organization-integrations-data-visualization-amazon-sqs.png --- diff --git a/docs/organization/integrations/data-visualization/segment/index.mdx b/docs/organization/integrations/data-visualization/segment/index.mdx index d6ef669d32aff..88120bfaeb11e 100644 --- a/docs/organization/integrations/data-visualization/segment/index.mdx +++ b/docs/organization/integrations/data-visualization/segment/index.mdx @@ -1,7 +1,10 @@ --- title: Segment (Legacy) sidebar_order: 1 -description: "Learn about Sentry's Segment integration, which allows you to collect all your client-side data for Sentry automatically." +description: >- + Learn about Sentry's Segment integration, which allows you to collect all your + client-side data for Sentry automatically. +og_image: /og-images/organization-integrations-data-visualization-segment.png --- diff --git a/docs/organization/integrations/data-visualization/splunk/index.mdx b/docs/organization/integrations/data-visualization/splunk/index.mdx index 6dd5768c4394f..b94c51992eb73 100644 --- a/docs/organization/integrations/data-visualization/splunk/index.mdx +++ b/docs/organization/integrations/data-visualization/splunk/index.mdx @@ -1,7 +1,10 @@ --- title: Splunk (Legacy) sidebar_order: 1 -description: "Learn more about Sentry's Splunk integration, which allows you to send Sentry events to Splunk." +description: >- + Learn more about Sentry's Splunk integration, which allows you to send Sentry + events to Splunk. +og_image: /og-images/organization-integrations-data-visualization-splunk.png --- diff --git a/docs/organization/integrations/debugging/rookout/index.mdx b/docs/organization/integrations/debugging/rookout/index.mdx index 51472f14d67a5..bf216cadfd3d0 100644 --- a/docs/organization/integrations/debugging/rookout/index.mdx +++ b/docs/organization/integrations/debugging/rookout/index.mdx @@ -1,7 +1,10 @@ --- title: Rookout sidebar_order: 1 -description: "Learn more about Sentry's Rookout integration and how it can help you debug an issue." +description: >- + Learn more about Sentry's Rookout integration and how it can help you debug an + issue. +og_image: /og-images/organization-integrations-debugging-rookout.png --- Rookout adds a layer of depth to Sentry issues by allowing you to jump right from an Issue to a non-breaking breakpoint on the line that caused the error. diff --git a/docs/organization/integrations/deployment/heroku/index.mdx b/docs/organization/integrations/deployment/heroku/index.mdx index a33301246f0f0..a6e11cc8e3543 100644 --- a/docs/organization/integrations/deployment/heroku/index.mdx +++ b/docs/organization/integrations/deployment/heroku/index.mdx @@ -1,7 +1,10 @@ --- title: Heroku (Legacy) sidebar_order: 1 -description: "Learn more about Sentry's Heroku integration, which allows you to create releases in Sentry when your Heroku app is deployed." +description: >- + Learn more about Sentry's Heroku integration, which allows you to create + releases in Sentry when your Heroku app is deployed. +og_image: /og-images/organization-integrations-deployment-heroku.png --- ## Deprecation Warning Heroku integration on Sentry is deprecated and will be removed on October 28, 2025. This plugin automatically tracked releases and deployments from your Heroku apps in Sentry, linking them to error tracking and performance monitoring. diff --git a/docs/organization/integrations/deployment/vercel/index.mdx b/docs/organization/integrations/deployment/vercel/index.mdx index cc62c3cf82db0..f160d5c67001f 100644 --- a/docs/organization/integrations/deployment/vercel/index.mdx +++ b/docs/organization/integrations/deployment/vercel/index.mdx @@ -1,7 +1,11 @@ --- title: Vercel sidebar_order: 1 -description: "Learn more about Sentry's Vercel integrations and how you can sync release deployments and source map uploads, as well as the Vercel Marketplace integration." +description: >- + Learn more about Sentry's Vercel integrations and how you can sync release + deployments and source map uploads, as well as the Vercel Marketplace + integration. +og_image: /og-images/organization-integrations-deployment-vercel.png --- ## Releases and Source Map Integration @@ -83,15 +87,15 @@ This issue typically occurs if you have an ad blocker blocking the conversation ## Vercel Marketplace -The Vercel Marketplace integration allows existing Vercel users to onboard to Sentry with a one-click workflow. This setup is designed for **new Sentry users** and unifies billing within the Vercel platform. +The Vercel Marketplace integration allows existing Vercel users to onboard to Sentry with a one-click workflow. This setup is designed for **new Sentry users** and unifies billing within the Vercel platform. There is no path for existing Sentry organizations to use the Vercel Marketplace integration. -When you configure Sentry using the Vercel Marketplace, you'll be able to set the name of your new Sentry Organization (referred to as an "Installation" in Vercel) and projects (Resources/Products in Vercel) during the setup process. +When you configure Sentry using the Vercel Marketplace, you'll be able to set the name of your new Sentry Organization (referred to as an "Installation" in Vercel) and projects (Resources/Products in Vercel) during the setup process. -### Billing Settings +### Billing Settings -When using the Vercel Marketplace native integration, users can modify their organizations billing information from within the Vercel platform, or within Sentry directly. Credit card settings can only be modified within Vercel. +When using the Vercel Marketplace native integration, users can modify their organizations billing information from within the Vercel platform, or within Sentry directly. Credit card settings can only be modified within Vercel. Subscription settings can only be modified within Sentry. During setup, organizations can choose between Developer, Team or Business plans. Pay-as-you-go budgets can be set after the initial setup is completed. @@ -101,27 +105,25 @@ Subscription settings can only be modified within Sentry. During setup, organiza Only the individual who sets up Sentry using the one-click workflow will have a Sentry user account created for them. To enable single sign-on access from Vercel for other users, they must be invited to the Sentry organization. -Vercel users will have single sign-on access to Sentry using the "Open in Sentry" button within Vercel, and will be able to create new projects in either Vercel or Sentry. +Vercel users will have single sign-on access to Sentry using the "Open in Sentry" button within Vercel, and will be able to create new projects in either Vercel or Sentry. Users will still be able to login to their Sentry organization directly, without using the Vercel single-sign on, by using the login they configured during the setup process. For non social based login (Google, Github, etc.) users, Sentry will prompt for password creation. ### Automatically Configured Environment Variables -For every project configured, the following environment variables will be set within the Vercel deployment: +For every project configured, the following environment variables will be set within the Vercel deployment: - **SENTRY_PROJECT** - **SENTRY_AUTH_TOKEN** - **NEXT_PUBLIC_SENTRY_DSN** -- **SENTRY_ORG** +- **SENTRY_ORG** -### Integration Deletion +### Integration Deletion -If the integration is deleted within Vercel, the Sentry organization **will not** be deleted. The deletion will permanently remove the connection between the Vercel account and the Sentry account, and is **irreversible**. +If the integration is deleted within Vercel, the Sentry organization **will not** be deleted. The deletion will permanently remove the connection between the Vercel account and the Sentry account, and is **irreversible**. -Preserving the Sentry organization allows teams to still access historical data from within Sentry, even if they are not sending monitoring data anymore. +Preserving the Sentry organization allows teams to still access historical data from within Sentry, even if they are not sending monitoring data anymore. -If the native integration is deleted, teams are still able to leverage the non-native Vercel integration described at the top of this document. Only one integration can be active at a time. +If the native integration is deleted, teams are still able to leverage the non-native Vercel integration described at the top of this document. Only one integration can be active at a time. For more information, see the [Introducing the Vercel Marketplace blog post](https://vercel.com/blog/introducing-the-vercel-marketplace). - - diff --git a/docs/organization/integrations/feature-flag/flagsmith/index.mdx b/docs/organization/integrations/feature-flag/flagsmith/index.mdx index 33626a3f9064a..b8d318e64e1c0 100644 --- a/docs/organization/integrations/feature-flag/flagsmith/index.mdx +++ b/docs/organization/integrations/feature-flag/flagsmith/index.mdx @@ -2,6 +2,7 @@ title: Flagsmith sidebar_order: 1 description: Learn about Sentry's Flagsmith integrations. +og_image: /og-images/organization-integrations-feature-flag-flagsmith.png --- ## Evaluation Tracking diff --git a/docs/organization/integrations/feature-flag/split/index.mdx b/docs/organization/integrations/feature-flag/split/index.mdx index 1d2feefafe63b..f0e1661ae8b38 100644 --- a/docs/organization/integrations/feature-flag/split/index.mdx +++ b/docs/organization/integrations/feature-flag/split/index.mdx @@ -1,7 +1,10 @@ --- title: Split sidebar_order: 4 -description: "Learn more about Sentry's Split integration, which allows you to use Sentry data in your Split analyses." +description: >- + Learn more about Sentry's Split integration, which allows you to use Sentry + data in your Split analyses. +og_image: /og-images/organization-integrations-feature-flag-split.png --- diff --git a/docs/organization/integrations/feature-flag/statsig/index.mdx b/docs/organization/integrations/feature-flag/statsig/index.mdx index 15c93fa2e9dbc..f901d8b467d95 100644 --- a/docs/organization/integrations/feature-flag/statsig/index.mdx +++ b/docs/organization/integrations/feature-flag/statsig/index.mdx @@ -2,6 +2,7 @@ title: Statsig sidebar_order: 3 description: Learn about Sentry's Statsig integrations. +og_image: /og-images/organization-integrations-feature-flag-statsig.png --- ## Evaluation Tracking diff --git a/docs/organization/integrations/feature-flag/unleash/index.mdx b/docs/organization/integrations/feature-flag/unleash/index.mdx index a498d59f72524..b9bf5fdd76d93 100644 --- a/docs/organization/integrations/feature-flag/unleash/index.mdx +++ b/docs/organization/integrations/feature-flag/unleash/index.mdx @@ -2,6 +2,7 @@ title: Unleash sidebar_order: 5 description: Learn about Sentry's Unleash integrations. +og_image: /og-images/organization-integrations-feature-flag-unleash.png --- ## Evaluation Tracking diff --git a/docs/organization/integrations/index.mdx b/docs/organization/integrations/index.mdx index 7b7e9124a5b47..e2371e3985c1c 100644 --- a/docs/organization/integrations/index.mdx +++ b/docs/organization/integrations/index.mdx @@ -1,7 +1,10 @@ --- title: Integrations sidebar_order: 5000 -description: "Learn more about the wide variety of apps and services integrated with Sentry and how you can add your own Sentry integration." +description: >- + Learn more about the wide variety of apps and services integrated with Sentry + and how you can add your own Sentry integration. +og_image: /og-images/organization-integrations.png --- Sentry integrates with your favorite apps and services. Each integration offers features that help track and triage your errors. If you're experiencing issues with some integrations after making changes to your Sentry instance or organization, check out our [troubleshooting guide](/organization/integrations/troubleshooting/). diff --git a/docs/organization/integrations/integration-platform/index.mdx b/docs/organization/integrations/integration-platform/index.mdx index 85fd528191e7c..67bac6acc6cd6 100644 --- a/docs/organization/integrations/integration-platform/index.mdx +++ b/docs/organization/integrations/integration-platform/index.mdx @@ -1,7 +1,10 @@ --- title: Integration Platform sidebar_order: 10 -description: "Learn how to create integrations so that external services can interact with Sentry." +description: >- + Learn how to create integrations so that external services can interact with + Sentry. +og_image: /og-images/organization-integrations-integration-platform.png --- Sentry’s integration platform provides a way for external services to interact with Sentry using [webhooks](/organization/integrations/integration-platform/webhooks/), [UI components](/organization/integrations/integration-platform/ui-components/), and the [REST API](/api). Integrations using this platform are first-class actors within Sentry. diff --git a/docs/organization/integrations/integration-platform/internal-integration.mdx b/docs/organization/integrations/integration-platform/internal-integration.mdx index 58d36a7a5fcfb..9943a22dd0b28 100644 --- a/docs/organization/integrations/integration-platform/internal-integration.mdx +++ b/docs/organization/integrations/integration-platform/internal-integration.mdx @@ -1,7 +1,11 @@ --- title: Internal Integrations sidebar_order: 2 -description: "Learn more about internal integrations, which are custom-made for your organization." +description: >- + Learn more about internal integrations, which are custom-made for your + organization. +og_image: >- + /og-images/organization-integrations-integration-platform-internal-integration.png --- diff --git a/docs/organization/integrations/integration-platform/public-integration.mdx b/docs/organization/integrations/integration-platform/public-integration.mdx index b35bb62fcd815..c4611ee3c6dc1 100644 --- a/docs/organization/integrations/integration-platform/public-integration.mdx +++ b/docs/organization/integrations/integration-platform/public-integration.mdx @@ -1,7 +1,9 @@ --- title: Public Integrations sidebar_order: 1 -description: "Learn more about public integrations, which are available to all Sentry users." +description: 'Learn more about public integrations, which are available to all Sentry users.' +og_image: >- + /og-images/organization-integrations-integration-platform-public-integration.png --- diff --git a/docs/organization/integrations/integration-platform/ui-components/alert-rule-action.mdx b/docs/organization/integrations/integration-platform/ui-components/alert-rule-action.mdx index c0c7767fb60f3..a3ed819260b88 100644 --- a/docs/organization/integrations/integration-platform/ui-components/alert-rule-action.mdx +++ b/docs/organization/integrations/integration-platform/ui-components/alert-rule-action.mdx @@ -1,7 +1,9 @@ --- title: Alert Rule Action sidebar_order: 2 -description: "Learn about the alert rule action UI component." +description: Learn about the alert rule action UI component. +og_image: >- + /og-images/organization-integrations-integration-platform-ui-components-alert-rule-action.png --- The alert rule action component gives you to access to parameters to define routing or configuration in alert rules for your service. When alert rules are triggered for a user, the configured service will receive [issue alert](/organization/integrations/integration-platform/webhooks/issue-alerts) and [metric alert](/organization/integrations/integration-platform/webhooks/metric-alerts) webhook events, with the specified settings for that service, to further route the alert. diff --git a/docs/organization/integrations/integration-platform/ui-components/issue-link.mdx b/docs/organization/integrations/integration-platform/ui-components/issue-link.mdx index 1daa1360b250a..716398bb7acd2 100644 --- a/docs/organization/integrations/integration-platform/ui-components/issue-link.mdx +++ b/docs/organization/integrations/integration-platform/ui-components/issue-link.mdx @@ -1,7 +1,9 @@ --- title: Issue Link sidebar_order: 1 -description: "Learn about the issue link UI component." +description: Learn about the issue link UI component. +og_image: >- + /og-images/organization-integrations-integration-platform-ui-components-issue-link.png --- With an issue linking UI component, you can connect Sentry issues with a task in your project management system. This functionality provides a way to use any project management tool you use or develop. diff --git a/docs/organization/integrations/integration-platform/ui-components/stacktrace-link.mdx b/docs/organization/integrations/integration-platform/ui-components/stacktrace-link.mdx index f2c8c2c27ad8c..66415ecb6d15c 100644 --- a/docs/organization/integrations/integration-platform/ui-components/stacktrace-link.mdx +++ b/docs/organization/integrations/integration-platform/ui-components/stacktrace-link.mdx @@ -1,7 +1,9 @@ --- title: Stack Trace Link sidebar_order: 3 -description: "Learn about the stack trace link UI component." +description: Learn about the stack trace link UI component. +og_image: >- + /og-images/organization-integrations-integration-platform-ui-components-stacktrace-link.png --- This feature allows you to insert a link within a stack trace frame. The link contains details about the project, the file name, and line number. This can be used to view the file on your service or continue the debugging with a helpful reference: diff --git a/docs/organization/integrations/integration-platform/webhooks.mdx b/docs/organization/integrations/integration-platform/webhooks.mdx index 307f847088d89..f512978c4a3d6 100644 --- a/docs/organization/integrations/integration-platform/webhooks.mdx +++ b/docs/organization/integrations/integration-platform/webhooks.mdx @@ -1,7 +1,11 @@ --- title: Webhooks 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." +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. +og_image: /og-images/organization-integrations-integration-platform-webhooks.png --- diff --git a/docs/organization/integrations/issue-tracking/asana/index.mdx b/docs/organization/integrations/issue-tracking/asana/index.mdx index 3e503f0a458c1..523041342d2a1 100644 --- a/docs/organization/integrations/issue-tracking/asana/index.mdx +++ b/docs/organization/integrations/issue-tracking/asana/index.mdx @@ -1,7 +1,10 @@ --- title: Asana (Legacy) sidebar_order: 1 -description: "Learn about Sentry's Asana integration and how you can create or link issues in Asana based on Sentry events." +description: >- + Learn about Sentry's Asana integration and how you can create or link issues + in Asana based on Sentry events. +og_image: /og-images/organization-integrations-issue-tracking-asana.png --- diff --git a/docs/organization/integrations/issue-tracking/clickup/index.mdx b/docs/organization/integrations/issue-tracking/clickup/index.mdx index 4448fae3d1014..45fa7de45937b 100644 --- a/docs/organization/integrations/issue-tracking/clickup/index.mdx +++ b/docs/organization/integrations/issue-tracking/clickup/index.mdx @@ -1,7 +1,10 @@ --- title: ClickUp sidebar_order: 1 -description: "Learn more about Sentry's ClickUp integration, which allows you to track and link Sentry issues in ClickUp." +description: >- + Learn more about Sentry's ClickUp integration, which allows you to track and + link Sentry issues in ClickUp. +og_image: /og-images/organization-integrations-issue-tracking-clickup.png --- ClickUp’s core focus is about removing frustrations, inefficiencies, and disconnect caused by current project management solutions. You can create an issue in ClickUp from a Sentry issue or link it to an existing issue. diff --git a/docs/organization/integrations/issue-tracking/height/index.mdx b/docs/organization/integrations/issue-tracking/height/index.mdx index 594d00301c8d7..86becc6fba8bc 100644 --- a/docs/organization/integrations/issue-tracking/height/index.mdx +++ b/docs/organization/integrations/issue-tracking/height/index.mdx @@ -1,7 +1,11 @@ --- title: Height sidebar_order: 1 -description: "Learn more about Sentry's Height integration and how you can effortlessly create new Height tasks from Sentry and link Sentry issues to existing Height tasks." +description: >- + Learn more about Sentry's Height integration and how you can effortlessly + create new Height tasks from Sentry and link Sentry issues to existing Height + tasks. +og_image: /og-images/organization-integrations-issue-tracking-height.png --- The Height Sentry integration allows your team to record and quickly resolve critical errors by linking new or existing Height tasks to Sentry issues. Linking tasks gives your teammates visibility into updates from Sentry, and they can automatically mark Sentry issues as _Resolved_ as the task status changes in Height. Additionally, set up custom alerts to create new Height tasks when key triggers you care about, like reported errors or session crashes, spike above a certain threshold. diff --git a/docs/organization/integrations/issue-tracking/incidentio/index.mdx b/docs/organization/integrations/issue-tracking/incidentio/index.mdx index 6395639e5208c..34f624c089ac8 100644 --- a/docs/organization/integrations/issue-tracking/incidentio/index.mdx +++ b/docs/organization/integrations/issue-tracking/incidentio/index.mdx @@ -1,7 +1,10 @@ --- title: incident.io sidebar_order: 1 -description: "Learn more about Sentry's incident.io integration and how you can easily attach Sentry issues to ongoing incidents." +description: >- + Learn more about Sentry's incident.io integration and how you can easily + attach Sentry issues to ongoing incidents. +og_image: /og-images/organization-integrations-issue-tracking-incidentio.png --- The incident.io Sentry integration supports Sentry exceptions as incident attachments and can manage Sentry resources from within [incident.io](https://incident.io/). diff --git a/docs/organization/integrations/issue-tracking/jira/index.mdx b/docs/organization/integrations/issue-tracking/jira/index.mdx index d246bac8cd065..bff6c3dc06600 100644 --- a/docs/organization/integrations/issue-tracking/jira/index.mdx +++ b/docs/organization/integrations/issue-tracking/jira/index.mdx @@ -1,7 +1,10 @@ --- title: Jira sidebar_order: 1 -description: "Learn more about Sentry's Jira integration and how it can help track and resolve bugs faster by connecting errors from Sentry with Jira issues." +description: >- + Learn more about Sentry's Jira integration and how it can help track and + resolve bugs faster by connecting errors from Sentry with Jira issues. +og_image: /og-images/organization-integrations-issue-tracking-jira.png --- ## Install diff --git a/docs/organization/integrations/issue-tracking/linear/index.mdx b/docs/organization/integrations/issue-tracking/linear/index.mdx index 273e54ce62eff..8ae4e0cb5dd53 100644 --- a/docs/organization/integrations/issue-tracking/linear/index.mdx +++ b/docs/organization/integrations/issue-tracking/linear/index.mdx @@ -1,7 +1,10 @@ --- title: Linear sidebar_order: 1 -description: "Learn more about Sentry's Linear integration, which streamlines issue creation and linking." +description: >- + Learn more about Sentry's Linear integration, which streamlines issue creation + and linking. +og_image: /og-images/organization-integrations-issue-tracking-linear.png --- Linear is an issue tracking tool built for speed, streamlining software projects, tasks, and bug tracking. Effortlessly create new Linear issues from Sentry and link Sentry issues to existing Linear issues. diff --git a/docs/organization/integrations/issue-tracking/sentry-linear-agent/index.mdx b/docs/organization/integrations/issue-tracking/sentry-linear-agent/index.mdx index a7e80e135373f..3fce90deb4494 100644 --- a/docs/organization/integrations/issue-tracking/sentry-linear-agent/index.mdx +++ b/docs/organization/integrations/issue-tracking/sentry-linear-agent/index.mdx @@ -1,7 +1,10 @@ --- title: Sentry Agent for Linear sidebar_order: 1 -description: "Learn more about the Sentry Agent for Linear, which allows users to have Seer create Root Cause Analysis and Issue Fixes for Sentry issues in Linear." +description: >- + Learn more about the Sentry Agent for Linear, which allows users to have Seer + create Root Cause Analysis and Issue Fixes for Sentry issues in Linear. +og_image: /og-images/organization-integrations-issue-tracking-sentry-linear-agent.png --- @@ -12,7 +15,7 @@ description: "Learn more about the Sentry Agent for Linear, which allows users t The Sentry Agent for Linear allows users to initiate Seer Issue Fix runs from within Linear. These results can then be used with other agents within Linear to trigger additional actions. -This integration highly benefits from having [automation configured within Seer](/product/ai-in-sentry/seer/#automation), to automatically create Root Cause Analysis and Solutions based on fixability scores from Seer. +This integration highly benefits from having [automation configured within Seer](/product/ai-in-sentry/seer/#automation), to automatically create Root Cause Analysis and Solutions based on fixability scores from Seer. ## Install and Configure @@ -27,17 +30,17 @@ Linear **won't** work with self-hosted Sentry. Navigate to **Settings > Integrations > Linear (Sentry Agent)**, accept and install. ![Install Sentry Agent for Linear](./img/Linear-Sentry-Agent-Install.png) - + ## Interaction Model -The Sentry Agent can be used in 2 different ways: +The Sentry Agent can be used in 2 different ways: 1. Delegating the Linear issue to Sentry via the Linear assignment flow. -2. Commenting `@sentry` from within the Linear issue and making your request via natural language. +2. Commenting `@sentry` from within the Linear issue and making your request via natural language. -When the issue is delegated to the agent, the agent will automatically check for a complete Issue Fix run and display the result. If one doesn't exist, the agent will request to run one. +When the issue is delegated to the agent, the agent will automatically check for a complete Issue Fix run and display the result. If one doesn't exist, the agent will request to run one. -For comment based interactions, the integration accepts natural language. We attempt to parse the intent of the question and trigger the appropriate response. If it fails, we'll prompt the help command that will guide you through options. +For comment based interactions, the integration accepts natural language. We attempt to parse the intent of the question and trigger the appropriate response. If it fails, we'll prompt the help command that will guide you through options. Currently the integration allows the user to run the following actions: @@ -51,32 +54,32 @@ Currently the integration allows the user to run the following actions: ![Select Sentry Agent for Linear](./img/Linear-Agent-Delegation.png) -2. Select "Sentry" from the dropdown menu. +2. Select "Sentry" from the dropdown menu. 3. The task will be moved into in-progress and the Sentry agent session will be created. If it's your first time using the Agent, you'll be prompted to authenticate. Use the "Link" button to link your Linear user to your Sentry user. ![Link Sentry Agent for Linear](./img/Linear-Linking-Auth.png) - -4. Once linked, you'll be asked if you want to run a Seer Issue Fix for the application. You can answer "Yes", or ask for "Help" to see more options. + +4. Once linked, you'll be asked if you want to run a Seer Issue Fix for the application. You can answer "Yes", or ask for "Help" to see more options. ![Run Seer in Linear](./img/Linear-Help.png) - + 5. If you answer "Yes", the Agent will run a Seer Issue Fix for the application. **Note**: You may need to prompt it for "Status" to see the results. ![RCA from Sentry Seer in Linear](./img/Linear-Sentry-RCA-2.png) - + ## Uninstalling the Integration -The Sentry integration installs a Linear based application within your Linear environment, as well as configures the integration within Sentry. Fully cleaning it out requires removing both of these. +The Sentry integration installs a Linear based application within your Linear environment, as well as configures the integration within Sentry. Fully cleaning it out requires removing both of these. -### Removing from Sentry +### Removing from Sentry 1. Navigate to Settings > Integrations > Linear (Sentry Agent) 2. Select "Uninstall" ![Uninstall Sentry from integrations](./img/Linear-Agent-Uninstall.png) - + ### Removing from Linear 1. Navigate to Settings > Applications > Sentry @@ -86,8 +89,3 @@ The Sentry integration installs a Linear based application within your Linear en 2. Select the "..." and select "Revoke Access" ![Revoke Access to Sentry from Linear applications](./img/Linear-App-Revoke.png) - - - - - \ No newline at end of file diff --git a/docs/organization/integrations/issue-tracking/shortcut/index.mdx b/docs/organization/integrations/issue-tracking/shortcut/index.mdx index ae8c354f0657d..8bd3fc0086a22 100644 --- a/docs/organization/integrations/issue-tracking/shortcut/index.mdx +++ b/docs/organization/integrations/issue-tracking/shortcut/index.mdx @@ -1,7 +1,10 @@ --- title: Shortcut sidebar_order: 1 -description: "Learn more about Sentry's Shortcut integration and how it can create a more efficient workflow by linking your Sentry Issues with your Shortcut Stories." +description: >- + Learn more about Sentry's Shortcut integration and how it can create a more + efficient workflow by linking your Sentry Issues with your Shortcut Stories. +og_image: /og-images/organization-integrations-issue-tracking-shortcut.png --- Errors, features, and anything else you track in Shortcut can now live side by side. The new Shortcut integration has feature parity with the Shortcut plugin. If you're choosing between the two, we recommend installing the Shortcut integration. diff --git a/docs/organization/integrations/issue-tracking/teamwork/index.mdx b/docs/organization/integrations/issue-tracking/teamwork/index.mdx index 2114504c955a8..3502fdc551f0c 100644 --- a/docs/organization/integrations/issue-tracking/teamwork/index.mdx +++ b/docs/organization/integrations/issue-tracking/teamwork/index.mdx @@ -1,7 +1,11 @@ --- title: Teamwork sidebar_order: 1 -description: "Learn more about Sentry's Teamwork integration and how you can turn Sentry issues into Teamwork tasks to streamline team collaboration and your development workflows." +description: >- + Learn more about Sentry's Teamwork integration and how you can turn Sentry + issues into Teamwork tasks to streamline team collaboration and your + development workflows. +og_image: /og-images/organization-integrations-issue-tracking-teamwork.png --- Teamwork needs to set up only once per organization, then it is available for _all_ projects. It is maintained and supported by the company that created it. For more details, check out our [Integration Platform documentation](/organization/integrations/integration-platform/). diff --git a/docs/organization/integrations/notification-incidents/discord/index.mdx b/docs/organization/integrations/notification-incidents/discord/index.mdx index 85a4eac6bfe38..bb4226de3f038 100644 --- a/docs/organization/integrations/notification-incidents/discord/index.mdx +++ b/docs/organization/integrations/notification-incidents/discord/index.mdx @@ -1,7 +1,10 @@ --- title: Discord sidebar_order: 1 -description: "Learn more about Sentry's Discord integration, which allows you to manage Sentry issues in Discord." +description: >- + Learn more about Sentry's Discord integration, which allows you to manage + Sentry issues in Discord. +og_image: /og-images/organization-integrations-notification-incidents-discord.png --- Set up a Discord integration so you can get notified about, then triage, resolve, and archive Sentry issues directly from Discord. diff --git a/docs/organization/integrations/notification-incidents/msteams/index.mdx b/docs/organization/integrations/notification-incidents/msteams/index.mdx index ebcb9150aa962..ff4beef99c78e 100644 --- a/docs/organization/integrations/notification-incidents/msteams/index.mdx +++ b/docs/organization/integrations/notification-incidents/msteams/index.mdx @@ -1,7 +1,10 @@ --- title: Microsoft Teams sidebar_order: 1 -description: "Learn more about Sentry's Microsoft Teams integration and how you can get alerts that let you triage issues directly in your Teams channels." +description: >- + Learn more about Sentry's Microsoft Teams integration and how you can get + alerts that let you triage issues directly in your Teams channels. +og_image: /og-images/organization-integrations-notification-incidents-msteams.png --- Microsoft Teams is a hub for teamwork in Office 365. Keep all your team's chats, meetings, files, and apps together in one place. Get alerts that let you assign, archive, and resolve issues right in your Teams channels with the Sentry integration for Microsoft Teams. diff --git a/docs/organization/integrations/notification-incidents/opsgenie/index.mdx b/docs/organization/integrations/notification-incidents/opsgenie/index.mdx index 67c42cf6f8371..259ca8121a562 100644 --- a/docs/organization/integrations/notification-incidents/opsgenie/index.mdx +++ b/docs/organization/integrations/notification-incidents/opsgenie/index.mdx @@ -1,7 +1,10 @@ --- -title: "Opsgenie Integration" +title: Opsgenie Integration sidebar_order: 1 -description: "Learn more about Sentry's Opsgenie integration, which allows you to send issue and metric alerts to Opsgenie teams." +description: >- + Learn more about Sentry's Opsgenie integration, which allows you to send issue + and metric alerts to Opsgenie teams. +og_image: /og-images/organization-integrations-notification-incidents-opsgenie.png --- The Opsgenie integration allows you to connect your Sentry organization with one or more Opsgenie accounts. Once your accounts have been connected, you'll be able to configure issue and metric alerts in Sentry to be sent to the Opsgenie teams of your choice. diff --git a/docs/organization/integrations/notification-incidents/pagerduty/index.mdx b/docs/organization/integrations/notification-incidents/pagerduty/index.mdx index 5cb9fb7c646af..079260e5438c5 100644 --- a/docs/organization/integrations/notification-incidents/pagerduty/index.mdx +++ b/docs/organization/integrations/notification-incidents/pagerduty/index.mdx @@ -1,7 +1,10 @@ --- title: PagerDuty sidebar_order: 1 -description: "Learn more about Sentry's PagerDuty integration and how you can trigger PagerDuty incidents with Sentry alerts." +description: >- + Learn more about Sentry's PagerDuty integration and how you can trigger + PagerDuty incidents with Sentry alerts. +og_image: /og-images/organization-integrations-notification-incidents-pagerduty.png --- The PagerDuty integration allows you to connect your Sentry organization with one or more PagerDuty accounts, and start getting incidents triggered by Sentry alerts. diff --git a/docs/organization/integrations/notification-incidents/slack/index.mdx b/docs/organization/integrations/notification-incidents/slack/index.mdx index 5a1cfc3862c56..0da702e0246b5 100644 --- a/docs/organization/integrations/notification-incidents/slack/index.mdx +++ b/docs/organization/integrations/notification-incidents/slack/index.mdx @@ -1,7 +1,10 @@ --- title: Slack sidebar_order: 1 -description: "Learn more about Sentry's Slack integration and how you can triage, resolve, and archive Sentry issues directly from Slack." +description: >- + Learn more about Sentry's Slack integration and how you can triage, resolve, + and archive Sentry issues directly from Slack. +og_image: /og-images/organization-integrations-notification-incidents-slack.png --- ## Install diff --git a/docs/organization/integrations/session-replay/atlas/index.mdx b/docs/organization/integrations/session-replay/atlas/index.mdx index 90ecf231b8709..f7646f6154389 100644 --- a/docs/organization/integrations/session-replay/atlas/index.mdx +++ b/docs/organization/integrations/session-replay/atlas/index.mdx @@ -1,7 +1,10 @@ --- title: Atlas sidebar_order: 1 -description: "Learn more about Sentry's Atlas integration and how you can connect Atlas sessions directly to Sentry issues" +description: >- + Learn more about Sentry's Atlas integration and how you can connect Atlas + sessions directly to Sentry issues +og_image: /og-images/organization-integrations-session-replay-atlas.png --- Atlas is all-in-one customer support software built to show your customers’ experience in a simple, timeline view. Easily link Atlas sessions to Sentry issues and link Sentry issues to existing Atlas sessions. diff --git a/docs/organization/integrations/source-code-mgmt/azure-devops/index.mdx b/docs/organization/integrations/source-code-mgmt/azure-devops/index.mdx index 9f476898d2e9e..503a6c47d5b95 100644 --- a/docs/organization/integrations/source-code-mgmt/azure-devops/index.mdx +++ b/docs/organization/integrations/source-code-mgmt/azure-devops/index.mdx @@ -1,7 +1,10 @@ --- title: Azure DevOps sidebar_order: 1 -description: "Learn more about Sentry's Azure DevOps integration and how it can track and resolve bugs faster by using data from your Azure DevOps commits." +description: >- + Learn more about Sentry's Azure DevOps integration and how it can track and + resolve bugs faster by using data from your Azure DevOps commits. +og_image: /og-images/organization-integrations-source-code-mgmt-azure-devops.png --- Azure DevOps was formerly known as Visual Studio Team Services (VSTS). diff --git a/docs/organization/integrations/source-code-mgmt/bitbucket/index.mdx b/docs/organization/integrations/source-code-mgmt/bitbucket/index.mdx index 907e1d6cd64da..f589bab2af166 100644 --- a/docs/organization/integrations/source-code-mgmt/bitbucket/index.mdx +++ b/docs/organization/integrations/source-code-mgmt/bitbucket/index.mdx @@ -1,7 +1,10 @@ --- title: Bitbucket sidebar_order: 1 -description: "Learn more about Sentry's Bitbucket integration and how it can track and resolve bugs faster by using data from your Bitbucket commits." +description: >- + Learn more about Sentry's Bitbucket integration and how it can track and + resolve bugs faster by using data from your Bitbucket commits. +og_image: /og-images/organization-integrations-source-code-mgmt-bitbucket.png --- ## Install diff --git a/docs/organization/integrations/source-code-mgmt/github/index.mdx b/docs/organization/integrations/source-code-mgmt/github/index.mdx index 1198254987189..8f6ba82fde94b 100644 --- a/docs/organization/integrations/source-code-mgmt/github/index.mdx +++ b/docs/organization/integrations/source-code-mgmt/github/index.mdx @@ -1,7 +1,11 @@ --- title: GitHub sidebar_order: 1 -description: "Learn more about Sentry's GitHub integration and how it can track and resolve bugs faster by using data from your GitHub commits, and streamline your triaging process by creating a GitHub issue directly from Sentry." +description: >- + Learn more about Sentry's GitHub integration and how it can track and resolve + bugs faster by using data from your GitHub commits, and streamline your + triaging process by creating a GitHub issue directly from Sentry. +og_image: /og-images/organization-integrations-source-code-mgmt-github.png --- There are three types of GitHub integrations, so make sure you're choosing the correct one: diff --git a/docs/organization/integrations/source-code-mgmt/gitlab/index.mdx b/docs/organization/integrations/source-code-mgmt/gitlab/index.mdx index 40eb160d60f24..2fc75334bf997 100644 --- a/docs/organization/integrations/source-code-mgmt/gitlab/index.mdx +++ b/docs/organization/integrations/source-code-mgmt/gitlab/index.mdx @@ -1,7 +1,10 @@ --- title: GitLab sidebar_order: 1 -description: "Learn more about Sentry’s GitLab integration and how it helps you track and resolve bugs faster by using data from your GitLab commits." +description: >- + Learn more about Sentry’s GitLab integration and how it helps you track and + resolve bugs faster by using data from your GitLab commits. +og_image: /og-images/organization-integrations-source-code-mgmt-gitlab.png --- ## Install diff --git a/docs/organization/membership/index.mdx b/docs/organization/membership/index.mdx index 3389394608ed8..d85b17bd79e8c 100644 --- a/docs/organization/membership/index.mdx +++ b/docs/organization/membership/index.mdx @@ -1,7 +1,10 @@ --- title: Organization and User Management sidebar_order: 10 -description: "Learn about the different organization-level and team-level roles and how they affect permissions in Sentry." +description: >- + Learn about the different organization-level and team-level roles and how they + affect permissions in Sentry. +og_image: /og-images/organization-membership.png --- ## Membership diff --git a/docs/platforms/android/configuration/app-not-respond.mdx b/docs/platforms/android/configuration/app-not-respond.mdx index 08e1c76cb2113..753d55041ebed 100644 --- a/docs/platforms/android/configuration/app-not-respond.mdx +++ b/docs/platforms/android/configuration/app-not-respond.mdx @@ -1,7 +1,8 @@ --- title: Application Not Responding (ANR) sidebar_order: 4 -description: "Learn how to turn off or specify ANR." +description: Learn how to turn off or specify ANR. +og_image: /og-images/platforms-android-configuration-app-not-respond.png --- Application Not Responding (ANR) errors are triggered when the main UI thread of an application is blocked for more than five seconds. The Android SDK reports ANR errors as Sentry events. In addition, Sentry calculates [ANR rate](#anr-rate) based on these events and user sessions. diff --git a/docs/platforms/android/data-management/debug-files/source-context/index.mdx b/docs/platforms/android/data-management/debug-files/source-context/index.mdx index 4cb76e20c496c..975b2277cf832 100644 --- a/docs/platforms/android/data-management/debug-files/source-context/index.mdx +++ b/docs/platforms/android/data-management/debug-files/source-context/index.mdx @@ -1,7 +1,10 @@ --- title: Source Context -description: "Learn about setting up source bundles to show source code in stack traces on the Issue Details page." +description: >- + Learn about setting up source bundles to show source code in stack traces on + the Issue Details page. sidebar_order: 5 +og_image: /og-images/platforms-android-data-management-debug-files-source-context.png --- If Sentry has access to your application's source code, it can show snippets of code (_source context_) around the location of stack frames, which helps to quickly pinpoint problematic code. diff --git a/docs/platforms/android/enriching-events/screenshots/index.mdx b/docs/platforms/android/enriching-events/screenshots/index.mdx index 21b747ce283f3..3b81a053e0de6 100644 --- a/docs/platforms/android/enriching-events/screenshots/index.mdx +++ b/docs/platforms/android/enriching-events/screenshots/index.mdx @@ -1,6 +1,9 @@ --- -title: "Screenshots" -description: "Learn more about taking screenshots when an error occurs. Sentry pairs the screenshot with the original event, giving you additional insight into issues." +title: Screenshots +description: >- + Learn more about taking screenshots when an error occurs. Sentry pairs the + screenshot with the original event, giving you additional insight into issues. +og_image: /og-images/platforms-android-enriching-events-screenshots.png --- Sentry makes it possible to automatically take a screenshot and include it as an attachment when a user experiences an error, an exception or a crash. diff --git a/docs/platforms/android/enriching-events/viewhierarchy/index.mdx b/docs/platforms/android/enriching-events/viewhierarchy/index.mdx index 72780cd02f980..8465bd6f30480 100644 --- a/docs/platforms/android/enriching-events/viewhierarchy/index.mdx +++ b/docs/platforms/android/enriching-events/viewhierarchy/index.mdx @@ -1,6 +1,10 @@ --- -title: "View Hierarchy" -description: "Learn more about debugging the view hierarchy when an error occurs. Sentry pairs the view hierarchy representation with the original event, giving you additional insight into issues." +title: View Hierarchy +description: >- + Learn more about debugging the view hierarchy when an error occurs. Sentry + pairs the view hierarchy representation with the original event, giving you + additional insight into issues. +og_image: /og-images/platforms-android-enriching-events-viewhierarchy.png --- Sentry makes it possible to render a JSON representation of the view hierarchy of an error and includes it as an attachment. diff --git a/docs/platforms/android/integrations/file-io/index.mdx b/docs/platforms/android/integrations/file-io/index.mdx index f7d2b09404224..f90cb5225990a 100644 --- a/docs/platforms/android/integrations/file-io/index.mdx +++ b/docs/platforms/android/integrations/file-io/index.mdx @@ -2,9 +2,10 @@ title: File I/O caseStyle: camelCase supportLevel: production -description: "Learn more about the Sentry file I/O integration for the Android SDK." +description: Learn more about the Sentry file I/O integration for the Android SDK. categories: - mobile +og_image: /og-images/platforms-android-integrations-file-io.png --- diff --git a/docs/platforms/android/integrations/jetpack-compose/index.mdx b/docs/platforms/android/integrations/jetpack-compose/index.mdx index b441c22f60099..62d93d609505a 100644 --- a/docs/platforms/android/integrations/jetpack-compose/index.mdx +++ b/docs/platforms/android/integrations/jetpack-compose/index.mdx @@ -3,9 +3,10 @@ title: Jetpack Compose caseStyle: camelCase supportLevel: production sdk: sentry.java.compose -description: "Learn more about the Sentry Compose integration." +description: Learn more about the Sentry Compose integration. categories: - mobile +og_image: /og-images/platforms-android-integrations-jetpack-compose.png --- The `sentry-compose-android` library provides [Jetpack Compose](https://developer.android.com/jetpack/androidx/releases/compose) support in the following areas: diff --git a/docs/platforms/android/integrations/logcat/index.mdx b/docs/platforms/android/integrations/logcat/index.mdx index 9c89a41948ec7..aeff37e80d0d6 100644 --- a/docs/platforms/android/integrations/logcat/index.mdx +++ b/docs/platforms/android/integrations/logcat/index.mdx @@ -2,9 +2,10 @@ title: Logcat caseStyle: canonical supportLevel: production -description: "Learn more about the Sentry Logcat integration for the Android SDK." +description: Learn more about the Sentry Logcat integration for the Android SDK. categories: - mobile +og_image: /og-images/platforms-android-integrations-logcat.png --- diff --git a/docs/platforms/android/integrations/room-and-sqlite/index.mdx b/docs/platforms/android/integrations/room-and-sqlite/index.mdx index eaea636f002c0..e4f52e00c1be9 100644 --- a/docs/platforms/android/integrations/room-and-sqlite/index.mdx +++ b/docs/platforms/android/integrations/room-and-sqlite/index.mdx @@ -3,9 +3,12 @@ title: Room and SQLite caseStyle: camelCase supportLevel: production sdk: sentry.java.android.sqlite -description: "Learn more about the Sentry Room and AndroidX SQLite integrations for the Android SDK." +description: >- + Learn more about the Sentry Room and AndroidX SQLite integrations for the + Android SDK. categories: - mobile +og_image: /og-images/platforms-android-integrations-room-and-sqlite.png --- diff --git a/docs/platforms/android/session-replay/privacy/index.mdx b/docs/platforms/android/session-replay/privacy/index.mdx index 627b909763e33..988bd62febeaa 100644 --- a/docs/platforms/android/session-replay/privacy/index.mdx +++ b/docs/platforms/android/session-replay/privacy/index.mdx @@ -1,8 +1,9 @@ --- title: Privacy sidebar_order: 5501 -notSupported: -description: "Learn how to mask parts of your app's data in Session Replay." +notSupported: null +description: Learn how to mask parts of your app's data in Session Replay. +og_image: /og-images/platforms-android-session-replay-privacy.jpg --- diff --git a/docs/platforms/android/tracing/instrumentation/automatic-instrumentation.mdx b/docs/platforms/android/tracing/instrumentation/automatic-instrumentation.mdx index 356f1254c0e8b..da33f188c9608 100644 --- a/docs/platforms/android/tracing/instrumentation/automatic-instrumentation.mdx +++ b/docs/platforms/android/tracing/instrumentation/automatic-instrumentation.mdx @@ -1,7 +1,9 @@ --- title: Automatic Instrumentation sidebar_order: 10 -description: "Learn what transactions are captured after tracing is enabled." +description: Learn what transactions are captured after tracing is enabled. +og_image: >- + /og-images/platforms-android-tracing-instrumentation-automatic-instrumentation.png --- diff --git a/docs/platforms/android/tracing/instrumentation/perf-v2.mdx b/docs/platforms/android/tracing/instrumentation/perf-v2.mdx index 83bc587a0dd14..d0d03e3a230ec 100644 --- a/docs/platforms/android/tracing/instrumentation/perf-v2.mdx +++ b/docs/platforms/android/tracing/instrumentation/perf-v2.mdx @@ -1,7 +1,8 @@ --- title: Performance V2 sidebar_order: 11 -description: "Learn how to get even more insights into Android app performance" +description: Learn how to get even more insights into Android app performance +og_image: /og-images/platforms-android-tracing-instrumentation-perf-v2.png --- Performance V2 contains a set of features that enrich performance instrumentation. It tightly integrates with the [Mobile Vitals](/product/insights/mobile/mobile-vitals/) Insights module, enabling App Start and Frames Delay reporting. diff --git a/docs/platforms/android/user-feedback/index.mdx b/docs/platforms/android/user-feedback/index.mdx index 0f67b9c5d113e..5ad382535dee9 100644 --- a/docs/platforms/android/user-feedback/index.mdx +++ b/docs/platforms/android/user-feedback/index.mdx @@ -1,8 +1,9 @@ --- title: Set Up User Feedback sidebar_title: User Feedback -description: "Learn how to enable User Feedback in your Android app." +description: Learn how to enable User Feedback in your Android app. sidebar_order: 6000 +og_image: /og-images/platforms-android-user-feedback.png --- The User Feedback feature allows you to collect user feedback from anywhere inside your application at any time, without needing an error event to occur first. diff --git a/docs/platforms/apple/common/configuration/app-hangs.mdx b/docs/platforms/apple/common/configuration/app-hangs.mdx index 6bff34793ce18..e5a95ce47f277 100644 --- a/docs/platforms/apple/common/configuration/app-hangs.mdx +++ b/docs/platforms/apple/common/configuration/app-hangs.mdx @@ -1,7 +1,8 @@ --- title: App Hangs sidebar_order: 11 -description: "Learn about how to add app hang detection reporting." +description: Learn about how to add app hang detection reporting. +og_image: /og-images/platforms-apple-common-configuration-app-hangs.png --- diff --git a/docs/platforms/apple/common/data-management/debug-files/source-context/index.mdx b/docs/platforms/apple/common/data-management/debug-files/source-context/index.mdx index 72ab6e575ff09..d3bea628c04bf 100644 --- a/docs/platforms/apple/common/data-management/debug-files/source-context/index.mdx +++ b/docs/platforms/apple/common/data-management/debug-files/source-context/index.mdx @@ -1,7 +1,11 @@ --- title: Source Context -description: "Learn about setting up source bundles to show source code in stack traces on the Issue Details page." +description: >- + Learn about setting up source bundles to show source code in stack traces on + the Issue Details page. sidebar_order: 5 +og_image: >- + /og-images/platforms-apple-common-data-management-debug-files-source-context.png --- If Sentry has access to your application's source code, it can show snippets of code (_source context_) around the location of stack frames, which helps to quickly pinpoint problematic code. diff --git a/docs/platforms/apple/common/enriching-events/screenshots/index.mdx b/docs/platforms/apple/common/enriching-events/screenshots/index.mdx index e1c710748c085..55d4f681db4aa 100644 --- a/docs/platforms/apple/common/enriching-events/screenshots/index.mdx +++ b/docs/platforms/apple/common/enriching-events/screenshots/index.mdx @@ -1,6 +1,8 @@ --- -title: "Screenshots" -description: "Learn more about taking screenshots when an error occurs. Sentry pairs the screenshot with the original event, giving you additional insight into issues." +title: Screenshots +description: >- + Learn more about taking screenshots when an error occurs. Sentry pairs the + screenshot with the original event, giving you additional insight into issues. supported: - apple.ios - apple.visionos @@ -8,6 +10,7 @@ notSupported: - apple.macos - apple.tvos - apple.watchos +og_image: /og-images/platforms-apple-common-enriching-events-screenshots.png --- Sentry makes it possible to automatically take a screenshot and include it as an attachment when a user experiences an error, an exception or a crash. When a crash occurs on Apple operating systems, there is no guarantee that the Cocoa SDK can still capture a screenshot since you're technically not allowed to call any async unsafe code. While it still works in most cases, we can't guarantee screenshots for all types of crashes. diff --git a/docs/platforms/apple/common/tracing/instrumentation/automatic-instrumentation.mdx b/docs/platforms/apple/common/tracing/instrumentation/automatic-instrumentation.mdx index 746c932a7d914..5ed1e3474ca51 100644 --- a/docs/platforms/apple/common/tracing/instrumentation/automatic-instrumentation.mdx +++ b/docs/platforms/apple/common/tracing/instrumentation/automatic-instrumentation.mdx @@ -1,7 +1,9 @@ --- title: Automatic Instrumentation sidebar_order: 10 -description: "Learn what transactions are captured after tracing is enabled." +description: Learn what transactions are captured after tracing is enabled. +og_image: >- + /og-images/platforms-apple-common-tracing-instrumentation-automatic-instrumentation.png --- diff --git a/docs/platforms/apple/common/tracing/instrumentation/swiftui-instrumentation.mdx b/docs/platforms/apple/common/tracing/instrumentation/swiftui-instrumentation.mdx index 08fce77d9e19a..c5cfb30af2912 100644 --- a/docs/platforms/apple/common/tracing/instrumentation/swiftui-instrumentation.mdx +++ b/docs/platforms/apple/common/tracing/instrumentation/swiftui-instrumentation.mdx @@ -1,7 +1,9 @@ --- title: SwiftUI Instrumentation sidebar_order: 12 -description: "Learn how to monitor the performance of your SwiftUI views." +description: Learn how to monitor the performance of your SwiftUI views. +og_image: >- + /og-images/platforms-apple-common-tracing-instrumentation-swiftui-instrumentation.png --- diff --git a/docs/platforms/apple/common/user-feedback/index.mdx b/docs/platforms/apple/common/user-feedback/index.mdx index 51a896d4467c3..36e174893ffb1 100644 --- a/docs/platforms/apple/common/user-feedback/index.mdx +++ b/docs/platforms/apple/common/user-feedback/index.mdx @@ -1,8 +1,9 @@ --- title: Set Up User Feedback sidebar_title: User Feedback -description: "Learn how to enable User Feedback in your Cocoa app." +description: Learn how to enable User Feedback in your Cocoa app. sidebar_order: 6000 +og_image: /og-images/platforms-apple-common-user-feedback.png --- diff --git a/docs/platforms/dart/guides/flutter/data-management/debug-files/source-context/index.mdx b/docs/platforms/dart/guides/flutter/data-management/debug-files/source-context/index.mdx index bf858d2c11b27..300cce4c9b2d5 100644 --- a/docs/platforms/dart/guides/flutter/data-management/debug-files/source-context/index.mdx +++ b/docs/platforms/dart/guides/flutter/data-management/debug-files/source-context/index.mdx @@ -1,7 +1,11 @@ --- title: Source Context -description: "Learn about setting up source bundles to show source code in stack traces on the Issue Details page." +description: >- + Learn about setting up source bundles to show source code in stack traces on + the Issue Details page. sidebar_order: 5 +og_image: >- + /og-images/platforms-dart-guides-flutter-data-management-debug-files-source-context.png --- If Sentry has access to your application's source code, it can show snippets of code (_source context_) around the location of stack frames, which helps to quickly pinpoint problematic code. diff --git a/docs/platforms/dart/guides/flutter/enriching-events/screenshots/index.mdx b/docs/platforms/dart/guides/flutter/enriching-events/screenshots/index.mdx index 95ef93f31c656..48401fbe1531c 100644 --- a/docs/platforms/dart/guides/flutter/enriching-events/screenshots/index.mdx +++ b/docs/platforms/dart/guides/flutter/enriching-events/screenshots/index.mdx @@ -1,6 +1,9 @@ --- -title: "Screenshots" -description: "Learn more about taking screenshots when an error occurs. Sentry pairs the screenshot with the original event, giving you additional insight into issues." +title: Screenshots +description: >- + Learn more about taking screenshots when an error occurs. Sentry pairs the + screenshot with the original event, giving you additional insight into issues. +og_image: /og-images/platforms-dart-guides-flutter-enriching-events-screenshots.png --- Sentry makes it possible to automatically take a screenshot and include it as an attachment when a user experiences an error, an exception or a crash. diff --git a/docs/platforms/dart/guides/flutter/user-feedback/index.mdx b/docs/platforms/dart/guides/flutter/user-feedback/index.mdx index 574c166b00fff..5b221df6ac2ab 100644 --- a/docs/platforms/dart/guides/flutter/user-feedback/index.mdx +++ b/docs/platforms/dart/guides/flutter/user-feedback/index.mdx @@ -1,8 +1,12 @@ --- title: Set Up User Feedback sidebar_title: User Feedback -description: "Learn more about collecting user feedback when an event occurs. Sentry pairs the feedback with the original event, giving you additional insight into issues." +description: >- + Learn more about collecting user feedback when an event occurs. Sentry pairs + the feedback with the original event, giving you additional insight into + issues. sidebar_order: 6000 +og_image: /og-images/platforms-dart-guides-flutter-user-feedback.png --- When a user experiences an error, Sentry provides the ability to collect additional feedback. You can collect feedback according to the method supported by the SDK. @@ -21,7 +25,7 @@ The user feedback API allows you to collect user feedback while utilizing your o Use the `SentryFeedbackWidget` to let users send feedback data to Sentry. -The widget requests and collects the user's name, email address, and a description of what occurred. When an event identifier is provided, Sentry pairs the feedback with the original event, giving you additional insights into issues. +The widget requests and collects the user's name, email address, and a description of what occurred. When an event identifier is provided, Sentry pairs the feedback with the original event, giving you additional insights into issues. Users can also take a screenshot of their app's UI. Additionally, you can provide a screenshot in code. Learn more about how to enable screenshots in our Screenshots documentation. @@ -47,7 +51,7 @@ Future main() async { options.navigatorKey = navigatorKey; // Needed so the widget can be presented. options.beforeSend = (event, hint) async { // Filter here what kind of events you want users to give you feedback. - + final screenshot = await SentryFlutter.captureScreenshot(); final context = navigatorKey.currentContext; 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 a9e733560b3be..5fdd103beea68 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 @@ -1,7 +1,11 @@ --- title: Source Context -description: "Learn about setting up source bundles to show source code in stack traces on the Issue Details page." +description: >- + Learn about setting up source bundles to show source code in stack traces on + the Issue Details page. sidebar_order: 5 +og_image: >- + /og-images/platforms-dotnet-common-data-management-debug-files-source-context.png --- If Sentry has access to your application's source code, it can show snippets of code (_source context_) around the location of stack frames, which helps to quickly pinpoint problematic code. diff --git a/docs/platforms/dotnet/guides/entityframework/index.mdx b/docs/platforms/dotnet/guides/entityframework/index.mdx index f93cdd60fd7ca..3649699b783d2 100644 --- a/docs/platforms/dotnet/guides/entityframework/index.mdx +++ b/docs/platforms/dotnet/guides/entityframework/index.mdx @@ -1,7 +1,8 @@ --- title: Entity Framework sdk: sentry.dotnet.entityframework -description: "Learn about Sentry's .NET integration with Entity Framework." +description: Learn about Sentry's .NET integration with Entity Framework. +og_image: /og-images/platforms-dotnet-guides-entityframework.png --- Sentry provides an integration with `EntityFramework` through the of the [Sentry.EntityFramework NuGet package](https://www.nuget.org/packages/Sentry.EntityFramework). diff --git a/docs/platforms/dotnet/guides/entityframework/troubleshooting.mdx b/docs/platforms/dotnet/guides/entityframework/troubleshooting.mdx index fb6708016446c..5a323f905ac23 100644 --- a/docs/platforms/dotnet/guides/entityframework/troubleshooting.mdx +++ b/docs/platforms/dotnet/guides/entityframework/troubleshooting.mdx @@ -1,7 +1,10 @@ --- title: Troubleshooting sidebar_order: 9000 -description: "Learn more about how to troubleshoot common issues with the EntityFramework SDK." +description: >- + Learn more about how to troubleshoot common issues with the EntityFramework + SDK. +og_image: /og-images/platforms-dotnet-guides-entityframework-troubleshooting.png --- ## Tracing Instrumentation Issues diff --git a/docs/platforms/dotnet/guides/log4net/index.mdx b/docs/platforms/dotnet/guides/log4net/index.mdx index bb169eb4f0243..70a05339ab3b4 100644 --- a/docs/platforms/dotnet/guides/log4net/index.mdx +++ b/docs/platforms/dotnet/guides/log4net/index.mdx @@ -1,7 +1,8 @@ --- title: log4net sdk: sentry.dotnet.log4net -description: "Learn about Sentry's .NET integration with log4net." +description: Learn about Sentry's .NET integration with log4net. +og_image: /og-images/platforms-dotnet-guides-log4net.gif --- Sentry provides an integration with log4net through the [Sentry.Log4Net NuGet package](https://www.nuget.org/packages/Sentry.Log4Net). diff --git a/docs/platforms/dotnet/guides/maui/enriching-events/screenshots/index.mdx b/docs/platforms/dotnet/guides/maui/enriching-events/screenshots/index.mdx index e1ef748b3d719..d9d117f5358f5 100644 --- a/docs/platforms/dotnet/guides/maui/enriching-events/screenshots/index.mdx +++ b/docs/platforms/dotnet/guides/maui/enriching-events/screenshots/index.mdx @@ -1,6 +1,9 @@ --- -title: "Screenshots" -description: "Learn more about taking screenshots when an error occurs. Sentry pairs the screenshot with the original event, giving you additional insight into issues." +title: Screenshots +description: >- + Learn more about taking screenshots when an error occurs. Sentry pairs the + screenshot with the original event, giving you additional insight into issues. +og_image: /og-images/platforms-dotnet-guides-maui-enriching-events-screenshots.png --- Sentry makes it possible to automatically take a screenshot and include it as an attachment when a user experiences an error, an exception or a crash. diff --git a/docs/platforms/dotnet/guides/winforms/index.mdx b/docs/platforms/dotnet/guides/winforms/index.mdx index 479355d6e8d4a..5f8fb7c72427b 100644 --- a/docs/platforms/dotnet/guides/winforms/index.mdx +++ b/docs/platforms/dotnet/guides/winforms/index.mdx @@ -1,6 +1,7 @@ --- title: Windows Forms -description: "Learn how Sentry's .NET SDK works with WinForms applications." +description: Learn how Sentry's .NET SDK works with WinForms applications. +og_image: /og-images/platforms-dotnet-guides-winforms.png --- Sentry's .NET SDK works with WinForms applications through the [Sentry NuGet package](https://www.nuget.org/packages/Sentry). It works with WinForms apps running on .NET Framework 4.6.2, .NET Core 3.0, or higher. diff --git a/docs/platforms/dotnet/guides/xamarin/enriching-events/screenshots/index.mdx b/docs/platforms/dotnet/guides/xamarin/enriching-events/screenshots/index.mdx index 21b747ce283f3..9dd4dab03f63a 100644 --- a/docs/platforms/dotnet/guides/xamarin/enriching-events/screenshots/index.mdx +++ b/docs/platforms/dotnet/guides/xamarin/enriching-events/screenshots/index.mdx @@ -1,6 +1,9 @@ --- -title: "Screenshots" -description: "Learn more about taking screenshots when an error occurs. Sentry pairs the screenshot with the original event, giving you additional insight into issues." +title: Screenshots +description: >- + Learn more about taking screenshots when an error occurs. Sentry pairs the + screenshot with the original event, giving you additional insight into issues. +og_image: /og-images/platforms-dotnet-guides-xamarin-enriching-events-screenshots.png --- Sentry makes it possible to automatically take a screenshot and include it as an attachment when a user experiences an error, an exception or a crash. diff --git a/docs/platforms/dotnet/guides/xamarin/troubleshooting.mdx b/docs/platforms/dotnet/guides/xamarin/troubleshooting.mdx index 7261a538b740c..f834450e42456 100644 --- a/docs/platforms/dotnet/guides/xamarin/troubleshooting.mdx +++ b/docs/platforms/dotnet/guides/xamarin/troubleshooting.mdx @@ -1,7 +1,8 @@ --- title: Troubleshooting sidebar_order: 9000 -description: "Learn more about how to troubleshoot common issues with the Xamarin SDK." +description: Learn more about how to troubleshoot common issues with the Xamarin SDK. +og_image: /og-images/platforms-dotnet-guides-xamarin-troubleshooting.png --- If you need help solving issues with Sentry's Xamarin SDK, you can read the edge cases documented here. If you need additional help, you can [ask on GitHub](https://github.com/getsentry/sentry-xamarin/issues/new/choose). Customers on a paid plan may also contact support. diff --git a/docs/platforms/godot/configuration/android.mdx b/docs/platforms/godot/configuration/android.mdx index 6b7676798f2fd..02bad8a47b6d4 100644 --- a/docs/platforms/godot/configuration/android.mdx +++ b/docs/platforms/godot/configuration/android.mdx @@ -1,7 +1,8 @@ --- title: Exporting for Android -description: "Learn how to set up Android Godot export with Sentry integration" +description: Learn how to set up Android Godot export with Sentry integration sidebar_order: 100 +og_image: /og-images/platforms-godot-configuration-android.png --- Additional steps are required to be able to export your game for Android with Sentry integration. diff --git a/docs/platforms/godot/configuration/stack-traces.mdx b/docs/platforms/godot/configuration/stack-traces.mdx index de79e098c737a..7c6349f3927a0 100644 --- a/docs/platforms/godot/configuration/stack-traces.mdx +++ b/docs/platforms/godot/configuration/stack-traces.mdx @@ -1,6 +1,9 @@ --- title: Readable Stack Traces -description: "Learn how to get traces with line numbers and file paths in Sentry with SDK for Godot Engine." +description: >- + Learn how to get traces with line numbers and file paths in Sentry with SDK + for Godot Engine. +og_image: /og-images/platforms-godot-configuration-stack-traces.png --- [The official Godot Engine builds only provide templates without debug information files](https://github.com/godotengine/godot-proposals/issues/1342). This guide covers how to create such templates and use them to export your project with full debug information available in Sentry. diff --git a/docs/platforms/godot/enriching-events/screenshots/index.mdx b/docs/platforms/godot/enriching-events/screenshots/index.mdx index 9e27834c7251e..804e5edab77bc 100644 --- a/docs/platforms/godot/enriching-events/screenshots/index.mdx +++ b/docs/platforms/godot/enriching-events/screenshots/index.mdx @@ -1,6 +1,9 @@ --- -title: "Screenshots" -description: "Learn more about taking screenshots when an error occurs. Sentry pairs the screenshot with the original event, giving you additional insight into issues." +title: Screenshots +description: >- + Learn more about taking screenshots when an error occurs. Sentry pairs the + screenshot with the original event, giving you additional insight into issues. +og_image: /og-images/platforms-godot-enriching-events-screenshots.png --- Sentry makes it possible to automatically take a screenshot and include it as an attachment when a user experiences an error, an exception or a crash. diff --git a/docs/platforms/godot/enriching-events/view-hierarchy/index.mdx b/docs/platforms/godot/enriching-events/view-hierarchy/index.mdx index 89c12d1024367..7b7c12dead457 100644 --- a/docs/platforms/godot/enriching-events/view-hierarchy/index.mdx +++ b/docs/platforms/godot/enriching-events/view-hierarchy/index.mdx @@ -1,6 +1,10 @@ --- -title: "Scene Tree" -description: "Learn more about capturing scene tree data during errors and crashes. Sentry provides a visual representation of your game's scene tree at the time of failure, giving you additional insight into issues." +title: Scene Tree +description: >- + Learn more about capturing scene tree data during errors and crashes. Sentry + provides a visual representation of your game's scene tree at the time of + failure, giving you additional insight into issues. +og_image: /og-images/platforms-godot-enriching-events-view-hierarchy.png --- Sentry captures a JSON representation of engine's scene tree during errors and crashes, adding it to the event as an attachment. This feature is also known as View Hierarchy in Sentry. diff --git a/docs/platforms/index.mdx b/docs/platforms/index.mdx index 80cc8ca4d4f54..1e6870a91a802 100644 --- a/docs/platforms/index.mdx +++ b/docs/platforms/index.mdx @@ -2,6 +2,7 @@ title: Platforms sidebar_order: 2 notoc: true +og_image: /og-images/platforms.png --- Sentry provides code-level observability that makes it easy to diagnose issues and learn continuously about your application code health. Data is captured by using an SDK within your application’s runtime. The Sentry team builds and maintains SDKs for most popular languages and frameworks, but there’s also a large ecosystem supported by the community. diff --git a/docs/platforms/java/common/gradle/index.mdx b/docs/platforms/java/common/gradle/index.mdx index 8311b483d83d7..20855d25575a4 100644 --- a/docs/platforms/java/common/gradle/index.mdx +++ b/docs/platforms/java/common/gradle/index.mdx @@ -1,7 +1,8 @@ --- title: Gradle -description: "Learn about using the Sentry Gradle Plugin." +description: Learn about using the Sentry Gradle Plugin. sidebar_order: 100 +og_image: /og-images/platforms-java-common-gradle.png --- The [Sentry Gradle Plugin](https://github.com/getsentry/sentry-android-gradle-plugin) is an addition to the main Java SDK and offers diff --git a/docs/platforms/java/common/source-context/index.mdx b/docs/platforms/java/common/source-context/index.mdx index 38007ab8e3077..af080f674ba5f 100644 --- a/docs/platforms/java/common/source-context/index.mdx +++ b/docs/platforms/java/common/source-context/index.mdx @@ -1,7 +1,8 @@ --- title: Source Context sidebar_order: 110 -description: "Learn about showing your source code as part of stack traces." +description: Learn about showing your source code as part of stack traces. +og_image: /og-images/platforms-java-common-source-context.png --- diff --git a/docs/platforms/javascript/common/configuration/event-loop-block.mdx b/docs/platforms/javascript/common/configuration/event-loop-block.mdx index e201c1f52be38..b51037a1a785d 100644 --- a/docs/platforms/javascript/common/configuration/event-loop-block.mdx +++ b/docs/platforms/javascript/common/configuration/event-loop-block.mdx @@ -1,7 +1,7 @@ --- title: Event Loop Block Detection sidebar_order: 70 -description: "Monitor for blocked event loops in Node.js applications" +description: Monitor for blocked event loops in Node.js applications supported: - javascript.node - javascript.aws-lambda @@ -24,13 +24,12 @@ supported: - javascript.astro - javascript.tanstackstart-react keywords: - [ - "event loop block", - "anr", - "Application Not Responding", - "Event Loop Blocked", - "Event Loop Stalls", - ] + - event loop block + - anr + - Application Not Responding + - Event Loop Blocked + - Event Loop Stalls +og_image: /og-images/platforms-javascript-common-configuration-event-loop-block.png --- Event Loop Block detection monitors when the Node.js main thread event loop is blocked for more than a specified threshold. The Node SDK reports these events to Sentry with automatically captured stack traces to help identify blocking code. diff --git a/docs/platforms/javascript/common/data-management/debug-files/source-context/index.mdx b/docs/platforms/javascript/common/data-management/debug-files/source-context/index.mdx index 14b697d6059e5..bbe0faacdf19c 100644 --- a/docs/platforms/javascript/common/data-management/debug-files/source-context/index.mdx +++ b/docs/platforms/javascript/common/data-management/debug-files/source-context/index.mdx @@ -1,10 +1,14 @@ --- title: Source Context -description: "Learn about setting up source bundles to show source code in stack traces on the Issue Details page." +description: >- + Learn about setting up source bundles to show source code in stack traces on + the Issue Details page. sidebar_order: 5 supported: - javascript.capacitor - javascript.electron +og_image: >- + /og-images/platforms-javascript-common-data-management-debug-files-source-context.png --- If Sentry has access to your application's source code, it can show snippets of code (_source context_) around the location of stack frames, which helps to quickly pinpoint problematic code. diff --git a/docs/platforms/javascript/common/enriching-events/attachments/index.mdx b/docs/platforms/javascript/common/enriching-events/attachments/index.mdx index 3a2ed2fd7cd61..553ab1a2514a1 100644 --- a/docs/platforms/javascript/common/enriching-events/attachments/index.mdx +++ b/docs/platforms/javascript/common/enriching-events/attachments/index.mdx @@ -1,6 +1,9 @@ --- title: Attachments -description: "Learn more about how Sentry can store additional files in the same request as event attachments." +description: >- + Learn more about how Sentry can store additional files in the same request as + event attachments. +og_image: /og-images/platforms-javascript-common-enriching-events-attachments.png --- Sentry can enrich your events for further investigation by storing additional files, such as config or log files, as attachments. diff --git a/docs/platforms/javascript/common/install/loader.mdx b/docs/platforms/javascript/common/install/loader.mdx index c67249f5a90fe..0c25b01940076 100644 --- a/docs/platforms/javascript/common/install/loader.mdx +++ b/docs/platforms/javascript/common/install/loader.mdx @@ -1,7 +1,7 @@ --- title: Loader Script sidebar_order: 10 -description: "Learn about the Sentry JavaScript Loader Script" +description: Learn about the Sentry JavaScript Loader Script notSupported: - javascript.angular - javascript.astro @@ -35,6 +35,7 @@ notSupported: - javascript.nestjs - javascript.cloudflare - javascript.tanstackstart-react +og_image: /og-images/platforms-javascript-common-install-loader.png --- The Loader Script is the easiest way to initialize the Sentry SDK. The Loader Script also automatically keeps your Sentry SDK up to date and offers configuration for different Sentry features. diff --git a/docs/platforms/javascript/common/session-replay/configuration.mdx b/docs/platforms/javascript/common/session-replay/configuration.mdx index 384a432cadb4c..94f6a6a445cdd 100644 --- a/docs/platforms/javascript/common/session-replay/configuration.mdx +++ b/docs/platforms/javascript/common/session-replay/configuration.mdx @@ -18,7 +18,8 @@ notSupported: - javascript.koa - javascript.nestjs - javascript.cloudflare -description: "Learn about the general Session Replay configuration fields." +description: Learn about the general Session Replay configuration fields. +og_image: /og-images/platforms-javascript-common-session-replay-configuration.png --- diff --git a/docs/platforms/javascript/common/session-replay/issue-types.mdx b/docs/platforms/javascript/common/session-replay/issue-types.mdx index 10e70841d4d27..0c36be8e4b7f2 100644 --- a/docs/platforms/javascript/common/session-replay/issue-types.mdx +++ b/docs/platforms/javascript/common/session-replay/issue-types.mdx @@ -18,7 +18,8 @@ notSupported: - javascript.koa - javascript.nestjs - javascript.cloudflare -description: "Learn about the Issue types that Session Replay can detect." +description: Learn about the Issue types that Session Replay can detect. +og_image: /og-images/platforms-javascript-common-session-replay-issue-types.png --- A _[replay issue](/product/issues/issue-details/replay-issues/)_ is an issue detected using captured Session Replay data. If your application is configured with [Session Replay](/product/session-replay/), problems will be detected on the server side during replay ingest, and grouped into issues. We group similar events into issues based on a fingerprint. For replay issues, a fingerprint is primarily based on the problem type and the url or transaction name where the problem occurred. diff --git a/docs/platforms/javascript/common/session-replay/privacy.mdx b/docs/platforms/javascript/common/session-replay/privacy.mdx index 1ae133f167050..92932b2ed3de6 100644 --- a/docs/platforms/javascript/common/session-replay/privacy.mdx +++ b/docs/platforms/javascript/common/session-replay/privacy.mdx @@ -18,8 +18,9 @@ notSupported: - javascript.koa - javascript.nestjs - javascript.cloudflare -description: "Configuring Session Replay to maintain user and data privacy." -customCanonicalTag: "/platforms/javascript/session-replay/privacy/" +description: Configuring Session Replay to maintain user and data privacy. +customCanonicalTag: /platforms/javascript/session-replay/privacy/ +og_image: /og-images/platforms-javascript-common-session-replay-privacy.png --- diff --git a/docs/platforms/javascript/common/troubleshooting/index.mdx b/docs/platforms/javascript/common/troubleshooting/index.mdx index b397cf4ed7e2c..53ea62af79b58 100644 --- a/docs/platforms/javascript/common/troubleshooting/index.mdx +++ b/docs/platforms/javascript/common/troubleshooting/index.mdx @@ -1,9 +1,18 @@ --- title: Troubleshooting -description: "If you need help solving issues with your Sentry JavaScript SDK integration, you can read the edge cases documented below." -keywords: ["adblocker", "blocked", "tunnel", "non-Error exception", "404"] -notSupported: ["javascript.capacitor"] +description: >- + If you need help solving issues with your Sentry JavaScript SDK integration, + you can read the edge cases documented below. +keywords: + - adblocker + - blocked + - tunnel + - non-Error exception + - '404' +notSupported: + - javascript.capacitor sidebar_order: 9000 +og_image: /og-images/platforms-javascript-common-troubleshooting.png --- @@ -670,10 +679,10 @@ shamefully-hoist=true ``` - + Seeing this warning in your dev build might be misleading due to Next.js dev server internals. - + In case you are using Session Replay and experience performance issues with the client instrumentation hook, you can try lazy-loading session replay as described [here](/platforms/javascript/guides/nextjs/session-replay/#lazy-loading-replay). If you want to init the SDK itself at a later point, this will result in tracing data loosing accuracy and errors could happen before the SDK is initialized. This should be a tradeoff you make based on your use case, although we recommend initializing the SDK as early as possible. diff --git a/docs/platforms/javascript/common/user-feedback/configuration/index.mdx b/docs/platforms/javascript/common/user-feedback/configuration/index.mdx index 9e1e74e7e612c..0dffbe6758b78 100644 --- a/docs/platforms/javascript/common/user-feedback/configuration/index.mdx +++ b/docs/platforms/javascript/common/user-feedback/configuration/index.mdx @@ -1,7 +1,8 @@ --- title: Configuration sidebar_order: 6100 -description: "Learn about general User Feedback configuration fields." +description: Learn about general User Feedback configuration fields. +og_image: /og-images/platforms-javascript-common-user-feedback-configuration.png --- diff --git a/docs/platforms/javascript/common/user-feedback/configuration/index__v7.x.mdx b/docs/platforms/javascript/common/user-feedback/configuration/index__v7.x.mdx index 62ad22c778313..d459699a6a4e4 100644 --- a/docs/platforms/javascript/common/user-feedback/configuration/index__v7.x.mdx +++ b/docs/platforms/javascript/common/user-feedback/configuration/index__v7.x.mdx @@ -1,7 +1,11 @@ --- title: Configuration sidebar_order: 6900 -description: "Learn about general User Feedback configuration fields for version 7 of the JavaScript SDK." +description: >- + Learn about general User Feedback configuration fields for version 7 of the + JavaScript SDK. +og_image: >- + /og-images/platforms-javascript-common-user-feedback-configuration-index__v7.x.png --- diff --git a/docs/platforms/javascript/common/user-feedback/index.mdx b/docs/platforms/javascript/common/user-feedback/index.mdx index bf30ee4646d4b..033750ca59a14 100644 --- a/docs/platforms/javascript/common/user-feedback/index.mdx +++ b/docs/platforms/javascript/common/user-feedback/index.mdx @@ -1,8 +1,9 @@ --- title: Set Up User Feedback sidebar_title: User Feedback -description: "Learn how to enable User Feedback in your app." +description: Learn how to enable User Feedback in your app. sidebar_order: 6000 +og_image: /og-images/platforms-javascript-common-user-feedback.png --- The User Feedback feature allows you to collect user feedback from anywhere inside your application at any time, without needing an error event to occur first. The [Crash-Report Modal](#crash-report-modal) feature, on the other hand, lets you prompt for user feedback when an error event occurs. diff --git a/docs/platforms/javascript/guides/aws-lambda/install/cjs-npm__v9.x.mdx b/docs/platforms/javascript/guides/aws-lambda/install/cjs-npm__v9.x.mdx index 3582c00f9481c..334a96bfd3356 100644 --- a/docs/platforms/javascript/guides/aws-lambda/install/cjs-npm__v9.x.mdx +++ b/docs/platforms/javascript/guides/aws-lambda/install/cjs-npm__v9.x.mdx @@ -1,7 +1,10 @@ --- title: NPM package - CJS -description: "Learn how to set up Sentry manually for Lambda functions running in CommonJS (CJS) using Sentry's AWS Serverless SDK NPM package" +description: >- + Learn how to set up Sentry manually for Lambda functions running in CommonJS + (CJS) using Sentry's AWS Serverless SDK NPM package sidebar_order: 2 +og_image: /og-images/platforms-javascript-guides-aws-lambda-install-cjs-npm__v9.x.png --- In this guide you will learn how to set up the `@sentry/aws-serverless` SDK for AWS Lambda functions running in CommonJS (CJS) mode. diff --git a/docs/platforms/javascript/guides/aws-lambda/install/esm-npm__v9.x.mdx b/docs/platforms/javascript/guides/aws-lambda/install/esm-npm__v9.x.mdx index 6c51c669d4749..fabdbc5de0d60 100644 --- a/docs/platforms/javascript/guides/aws-lambda/install/esm-npm__v9.x.mdx +++ b/docs/platforms/javascript/guides/aws-lambda/install/esm-npm__v9.x.mdx @@ -1,7 +1,10 @@ --- title: NPM Package - ESM -description: "Learn how to set up Sentry manually for Lambda functions running in EcmaScript Modules (ESM) using Sentry's AWS Serverless SDK NPM package" +description: >- + Learn how to set up Sentry manually for Lambda functions running in EcmaScript + Modules (ESM) using Sentry's AWS Serverless SDK NPM package sidebar_order: 3 +og_image: /og-images/platforms-javascript-guides-aws-lambda-install-esm-npm__v9.x.png --- In this guide you will learn how to set up the `@sentry/aws-serverless` SDK for AWS Lambda functions running in EcmaScript Modules (ESM) mode. diff --git a/docs/platforms/javascript/guides/aws-lambda/install/layer.mdx b/docs/platforms/javascript/guides/aws-lambda/install/layer.mdx index f5568accb30f4..d88a72a135ace 100644 --- a/docs/platforms/javascript/guides/aws-lambda/install/layer.mdx +++ b/docs/platforms/javascript/guides/aws-lambda/install/layer.mdx @@ -1,7 +1,10 @@ --- title: Lambda Layer -description: "Learn how to add the Sentry Node Lambda Layer to use Sentry in your Lambda functions" +description: >- + Learn how to add the Sentry Node Lambda Layer to use Sentry in your Lambda + functions sidebar_order: 1 +og_image: /og-images/platforms-javascript-guides-aws-lambda-install-layer.png --- The easiest way to get started with Sentry is to use the Sentry [Lambda Layer](https://docs.aws.amazon.com/lambda/latest/dg/adding-layers.html) instead of installing `@sentry/aws-serverless` with a package manager manually. diff --git a/docs/platforms/javascript/guides/aws-lambda/install/layer__v7.x.mdx b/docs/platforms/javascript/guides/aws-lambda/install/layer__v7.x.mdx index 7306ede792298..644a543016eef 100644 --- a/docs/platforms/javascript/guides/aws-lambda/install/layer__v7.x.mdx +++ b/docs/platforms/javascript/guides/aws-lambda/install/layer__v7.x.mdx @@ -1,8 +1,11 @@ --- title: Lambda Layer - CJS -description: "Learn how to add the Sentry Node Lambda Layer to use Sentry in your Lambda functions running in CommonJS (CJS)" +description: >- + Learn how to add the Sentry Node Lambda Layer to use Sentry in your Lambda + functions running in CommonJS (CJS) sidebar_order: 1 noindex: true +og_image: /og-images/platforms-javascript-guides-aws-lambda-install-layer__v7.x.png --- The easiest way to get started with Sentry is to use the Sentry [Lambda Layer](https://docs.aws.amazon.com/Lambda/latest/dg/configuration-layers.html) instead of adding `@sentry/serverless` with `npm` or `yarn` manually. diff --git a/docs/platforms/javascript/guides/aws-lambda/install/layer__v8.x.mdx b/docs/platforms/javascript/guides/aws-lambda/install/layer__v8.x.mdx index 865375d771885..5ca4f61757d35 100644 --- a/docs/platforms/javascript/guides/aws-lambda/install/layer__v8.x.mdx +++ b/docs/platforms/javascript/guides/aws-lambda/install/layer__v8.x.mdx @@ -1,8 +1,11 @@ --- title: Lambda Layer - CJS -description: "Learn how to add the Sentry Node Lambda Layer to use Sentry in your Lambda functions running in CommonJS (CJS)" +description: >- + Learn how to add the Sentry Node Lambda Layer to use Sentry in your Lambda + functions running in CommonJS (CJS) sidebar_order: 1 noindex: true +og_image: /og-images/platforms-javascript-guides-aws-lambda-install-layer__v8.x.png --- The easiest way to get started with Sentry is to use the Sentry [Lambda Layer](https://docs.aws.amazon.com/Lambda/latest/dg/configuration-layers.html) instead of adding `@sentry/aws-serverless` with `npm` or `yarn` [manually](../cjs-npm). diff --git a/docs/platforms/javascript/guides/aws-lambda/install/layer__v9.x.mdx b/docs/platforms/javascript/guides/aws-lambda/install/layer__v9.x.mdx index ed3a3dd1a2b45..de1c260cdf083 100644 --- a/docs/platforms/javascript/guides/aws-lambda/install/layer__v9.x.mdx +++ b/docs/platforms/javascript/guides/aws-lambda/install/layer__v9.x.mdx @@ -1,7 +1,10 @@ --- title: Lambda Layer - CJS -description: "Learn how to add the Sentry Node Lambda Layer to use Sentry in your Lambda functions running in CommonJS (CJS)" +description: >- + Learn how to add the Sentry Node Lambda Layer to use Sentry in your Lambda + functions running in CommonJS (CJS) sidebar_order: 1 +og_image: /og-images/platforms-javascript-guides-aws-lambda-install-layer__v9.x.png --- The easiest way to get started with Sentry is to use the Sentry [Lambda Layer](https://docs.aws.amazon.com/lambda/latest/dg/adding-layers.html) instead of adding `@sentry/aws-serverless` with `npm` or `yarn` [manually](../cjs-npm). diff --git a/docs/platforms/javascript/guides/aws-lambda/install/npm.mdx b/docs/platforms/javascript/guides/aws-lambda/install/npm.mdx index 4de0cc30465d4..6e4faeca5a935 100644 --- a/docs/platforms/javascript/guides/aws-lambda/install/npm.mdx +++ b/docs/platforms/javascript/guides/aws-lambda/install/npm.mdx @@ -1,7 +1,10 @@ --- title: NPM Package -description: "Learn how to install the Sentry AWS NPM package to use Sentry in your Lambda functions" +description: >- + Learn how to install the Sentry AWS NPM package to use Sentry in your Lambda + functions sidebar_order: 2 +og_image: /og-images/platforms-javascript-guides-aws-lambda-install-npm.png --- In this guide you will learn how to set up the `@sentry/aws-serverless` SDK for AWS Lambda functions using NPM. diff --git a/docs/platforms/javascript/guides/electron/enriching-events/screenshots/index.mdx b/docs/platforms/javascript/guides/electron/enriching-events/screenshots/index.mdx index 21b747ce283f3..bb26de77d823b 100644 --- a/docs/platforms/javascript/guides/electron/enriching-events/screenshots/index.mdx +++ b/docs/platforms/javascript/guides/electron/enriching-events/screenshots/index.mdx @@ -1,6 +1,10 @@ --- -title: "Screenshots" -description: "Learn more about taking screenshots when an error occurs. Sentry pairs the screenshot with the original event, giving you additional insight into issues." +title: Screenshots +description: >- + Learn more about taking screenshots when an error occurs. Sentry pairs the + screenshot with the original event, giving you additional insight into issues. +og_image: >- + /og-images/platforms-javascript-guides-electron-enriching-events-screenshots.png --- Sentry makes it possible to automatically take a screenshot and include it as an attachment when a user experiences an error, an exception or a crash. diff --git a/docs/platforms/javascript/guides/react/features/error-boundary.mdx b/docs/platforms/javascript/guides/react/features/error-boundary.mdx index 3557fbdeb5afd..e774616c3d4b8 100644 --- a/docs/platforms/javascript/guides/react/features/error-boundary.mdx +++ b/docs/platforms/javascript/guides/react/features/error-boundary.mdx @@ -1,7 +1,10 @@ --- title: React Error Boundary -excerpt: "" -description: "Learn how the React SDK exports an error boundary component that leverages React component APIs." +excerpt: '' +description: >- + Learn how the React SDK exports an error boundary component that leverages + React component APIs. +og_image: /og-images/platforms-javascript-guides-react-features-error-boundary.png --- The React SDK exports an error boundary component that leverages [React component APIs](https://reactjs.org/docs/error-boundaries.html) to automatically catch and send JavaScript errors from inside a React component tree to Sentry. diff --git a/docs/platforms/kotlin/guides/kotlin-multiplatform/enriching-events/screenshots/index.mdx b/docs/platforms/kotlin/guides/kotlin-multiplatform/enriching-events/screenshots/index.mdx index f1462165f0c54..eef5886824708 100644 --- a/docs/platforms/kotlin/guides/kotlin-multiplatform/enriching-events/screenshots/index.mdx +++ b/docs/platforms/kotlin/guides/kotlin-multiplatform/enriching-events/screenshots/index.mdx @@ -1,6 +1,10 @@ --- -title: "Screenshots" -description: "Learn more about taking screenshots when an error occurs. Sentry pairs the screenshot with the original event, giving you additional insight into issues." +title: Screenshots +description: >- + Learn more about taking screenshots when an error occurs. Sentry pairs the + screenshot with the original event, giving you additional insight into issues. +og_image: >- + /og-images/platforms-kotlin-guides-kotlin-multiplatform-enriching-events-screenshots.png --- Sentry makes it possible to automatically take a screenshot and include it as an attachment when a user experiences an error, an exception or a crash. diff --git a/docs/platforms/native/common/data-management/debug-files/source-context/index.mdx b/docs/platforms/native/common/data-management/debug-files/source-context/index.mdx index 1c63560f80572..c572948505dbb 100644 --- a/docs/platforms/native/common/data-management/debug-files/source-context/index.mdx +++ b/docs/platforms/native/common/data-management/debug-files/source-context/index.mdx @@ -1,7 +1,11 @@ --- title: Source Context -description: "Learn about setting up source bundles to show source code in stack traces on the Issue Details page." +description: >- + Learn about setting up source bundles to show source code in stack traces on + the Issue Details page. sidebar_order: 5 +og_image: >- + /og-images/platforms-native-common-data-management-debug-files-source-context.png --- If Sentry has access to your application's source code, it can show snippets of code (_source context_) around the location of stack frames, which helps to quickly pinpoint problematic code. diff --git a/docs/platforms/native/common/enriching-events/screenshots/index.mdx b/docs/platforms/native/common/enriching-events/screenshots/index.mdx index 709d6e8701fc4..55431b7b56fb3 100644 --- a/docs/platforms/native/common/enriching-events/screenshots/index.mdx +++ b/docs/platforms/native/common/enriching-events/screenshots/index.mdx @@ -1,6 +1,9 @@ --- -title: "Screenshots" -description: "Learn more about taking screenshots when an error occurs. Sentry pairs the screenshot with the original event, giving you additional insight into issues." +title: Screenshots +description: >- + Learn more about taking screenshots when an error occurs. Sentry pairs the + screenshot with the original event, giving you additional insight into issues. +og_image: /og-images/platforms-native-common-enriching-events-screenshots.png --- Sentry makes it possible to automatically take a screenshot and include it as an attachment when a user experiences an error, an exception, or a crash. diff --git a/docs/platforms/php/guides/laravel/index.mdx b/docs/platforms/php/guides/laravel/index.mdx index ddc6aa04da449..ce7e7a57e2407 100644 --- a/docs/platforms/php/guides/laravel/index.mdx +++ b/docs/platforms/php/guides/laravel/index.mdx @@ -2,7 +2,10 @@ title: Laravel sdk: sentry.php.laravel sidebar_order: 0 -description: "Laravel is a PHP web application framework with expressive, elegant syntax. Learn how to set it up with Sentry." +description: >- + Laravel is a PHP web application framework with expressive, elegant syntax. + Learn how to set it up with Sentry. +og_image: /og-images/platforms-php-guides-laravel.png --- ## Prerequisites diff --git a/docs/platforms/php/index.mdx b/docs/platforms/php/index.mdx index 2a52b5edeb1da..4c6c7eae3787a 100644 --- a/docs/platforms/php/index.mdx +++ b/docs/platforms/php/index.mdx @@ -6,6 +6,7 @@ supportLevel: production description: Learn how to set up Sentry in your PHP application. categories: - server +og_image: /og-images/platforms-php.png --- ## Prerequisites diff --git a/docs/platforms/python/integrations/aws-lambda/manual-layer/index.mdx b/docs/platforms/python/integrations/aws-lambda/manual-layer/index.mdx index f0e8ba87ce91b..6cd8ac123d635 100644 --- a/docs/platforms/python/integrations/aws-lambda/manual-layer/index.mdx +++ b/docs/platforms/python/integrations/aws-lambda/manual-layer/index.mdx @@ -1,7 +1,8 @@ --- title: AWS Lambda Layer -description: "Learn how to manually set up Sentry with a Layer" +description: Learn how to manually set up Sentry with a Layer sidebar_order: 1000 +og_image: /og-images/platforms-python-integrations-aws-lambda-manual-layer.png --- This guide walks you through how to add Sentry to your AWS Lambda function by adding the Sentry AWS Lambda layer. This method can be instrumented from the Sentry product by those who have access to the AWS infrastructure and doesn't require that you make any direct updates to the code. diff --git a/docs/platforms/python/integrations/cloudresourcecontext/index.mdx b/docs/platforms/python/integrations/cloudresourcecontext/index.mdx index 955e60218b046..578a8bead6fca 100644 --- a/docs/platforms/python/integrations/cloudresourcecontext/index.mdx +++ b/docs/platforms/python/integrations/cloudresourcecontext/index.mdx @@ -1,6 +1,9 @@ --- title: Cloud Resource Context -description: "Learn about the Cloud Resource Context integration and how it adds information about the Cloud environment the project runs in." +description: >- + Learn about the Cloud Resource Context integration and how it adds information + about the Cloud environment the project runs in. +og_image: /og-images/platforms-python-integrations-cloudresourcecontext.png --- The Cloud Resource Context integration adds information about the cloud platform your app runs to errors and performance events. Currently [Amazon EC2](https://aws.amazon.com/ec2/) and [Google Compute Engine](https://cloud.google.com/compute) are supported. diff --git a/docs/platforms/python/integrations/fastapi/index.mdx b/docs/platforms/python/integrations/fastapi/index.mdx index 993f0f91d578c..a4d2a57ce15ee 100644 --- a/docs/platforms/python/integrations/fastapi/index.mdx +++ b/docs/platforms/python/integrations/fastapi/index.mdx @@ -1,6 +1,7 @@ --- title: FastAPI -description: "Learn about using Sentry with FastAPI." +description: Learn about using Sentry with FastAPI. +og_image: /og-images/platforms-python-integrations-fastapi.png --- The FastAPI integration adds support for the [FastAPI Framework](https://fastapi.tiangolo.com/). diff --git a/docs/platforms/python/integrations/pymongo/index.mdx b/docs/platforms/python/integrations/pymongo/index.mdx index b6e0b92832ec4..02853cec5146d 100644 --- a/docs/platforms/python/integrations/pymongo/index.mdx +++ b/docs/platforms/python/integrations/pymongo/index.mdx @@ -1,6 +1,9 @@ --- title: PyMongo -description: "Learn about the PyMongo integration and how it adds support for connections to MongoDB databases." +description: >- + Learn about the PyMongo integration and how it adds support for connections to + MongoDB databases. +og_image: /og-images/platforms-python-integrations-pymongo.png --- The PyMongo integration adds support for [PyMongo](https://www.mongodb.com/docs/drivers/pymongo/), the official MongoDB driver. diff --git a/docs/platforms/react-native/data-management/debug-files/source-context/index.mdx b/docs/platforms/react-native/data-management/debug-files/source-context/index.mdx index 54e5343bf41bf..1c306bbde6378 100644 --- a/docs/platforms/react-native/data-management/debug-files/source-context/index.mdx +++ b/docs/platforms/react-native/data-management/debug-files/source-context/index.mdx @@ -1,7 +1,11 @@ --- title: Source Context -description: "Learn about setting up source bundles to show source code in stack traces on the Issue Details page." +description: >- + Learn about setting up source bundles to show source code in stack traces on + the Issue Details page. sidebar_order: 5 +og_image: >- + /og-images/platforms-react-native-data-management-debug-files-source-context.png --- If Sentry has access to your application's source code, it can show snippets of code (_source context_) around the location of stack frames, which helps to quickly pinpoint problematic code. diff --git a/docs/platforms/react-native/enriching-events/screenshots/index.mdx b/docs/platforms/react-native/enriching-events/screenshots/index.mdx index 6a4add125e8f6..2e5e48a56f89c 100644 --- a/docs/platforms/react-native/enriching-events/screenshots/index.mdx +++ b/docs/platforms/react-native/enriching-events/screenshots/index.mdx @@ -1,6 +1,9 @@ --- -title: "Screenshots" -description: "Learn more about taking screenshots when an error occurs. Sentry pairs the screenshot with the original event, giving you additional insight into issues." +title: Screenshots +description: >- + Learn more about taking screenshots when an error occurs. Sentry pairs the + screenshot with the original event, giving you additional insight into issues. +og_image: /og-images/platforms-react-native-enriching-events-screenshots.png --- Sentry makes it possible to automatically take a screenshot and include it as an attachment when a user experiences an error, an exception or a crash. diff --git a/docs/platforms/react-native/integrations/error-boundary.mdx b/docs/platforms/react-native/integrations/error-boundary.mdx index dd197a9be1023..d03b822c1ff4c 100644 --- a/docs/platforms/react-native/integrations/error-boundary.mdx +++ b/docs/platforms/react-native/integrations/error-boundary.mdx @@ -1,8 +1,11 @@ --- title: React Error Boundary -excerpt: "" -description: "Learn how the React Native SDK exports an error boundary component that leverages React component APIs." +excerpt: '' +description: >- + Learn how the React Native SDK exports an error boundary component that + leverages React component APIs. sidebar_order: 60 +og_image: /og-images/platforms-react-native-integrations-error-boundary.png --- The React Native SDK exports an error boundary component that uses [React component APIs](https://react.dev/reference/react/Component#catching-rendering-errors-with-an-error-boundary) to automatically catch and send JavaScript errors from inside a React component tree to Sentry. diff --git a/docs/platforms/react-native/sourcemaps/troubleshooting/index.mdx b/docs/platforms/react-native/sourcemaps/troubleshooting/index.mdx index 1c9c097085d75..4451dc93ab076 100644 --- a/docs/platforms/react-native/sourcemaps/troubleshooting/index.mdx +++ b/docs/platforms/react-native/sourcemaps/troubleshooting/index.mdx @@ -1,7 +1,8 @@ --- title: Troubleshooting Source Maps -description: "Troubleshooting for source maps." +description: Troubleshooting for source maps. sidebar_order: 9000 +og_image: /og-images/platforms-react-native-sourcemaps-troubleshooting.png --- If source maps are not recognized, check for warnings similar to: diff --git a/docs/platforms/react-native/user-feedback/configuration/index.mdx b/docs/platforms/react-native/user-feedback/configuration/index.mdx index 1d781e0a4b226..54058c62e597a 100644 --- a/docs/platforms/react-native/user-feedback/configuration/index.mdx +++ b/docs/platforms/react-native/user-feedback/configuration/index.mdx @@ -1,7 +1,8 @@ --- title: Configuration sidebar_order: 6100 -description: "Learn about the User Feedback Widget configuration options." +description: Learn about the User Feedback Widget configuration options. +og_image: /og-images/platforms-react-native-user-feedback-configuration.png --- The User Feedback Widget offers many customization options, and if the available options are insufficient, you can [use your own UI](/platforms/react-native/user-feedback/#user-feedback-api). @@ -196,7 +197,7 @@ The following callbacks can be configured for the integration in `feedbackIntegr The screenshot functionality is disabled by default. To enable it, pass an `imagePicker` integration library or set the `enableScreenshot` option to `true` and implement the `onAddScreenshot` callback. -### Integrating with an Image Picker Library +### Integrating with an Image Picker Library Currently the supported libraries are: - [expo-image-picker](https://docs.expo.dev/versions/latest/sdk/imagepicker/) (tested with version `16.0`) @@ -338,7 +339,7 @@ The available theme options are: For each theme you can set the following colors: | Key | Description | -| ------------------ | ----------------------------------------| +| ------------------ | ----------------------------------------| | `background` | Background color for surfaces. | | `foreground` | Foreground color (i.e. text color). | | `accentForeground` | Foreground color for accented elements. | diff --git a/docs/platforms/react-native/user-feedback/index.mdx b/docs/platforms/react-native/user-feedback/index.mdx index ff3608b2e0a4c..67b176729fc4b 100644 --- a/docs/platforms/react-native/user-feedback/index.mdx +++ b/docs/platforms/react-native/user-feedback/index.mdx @@ -1,8 +1,9 @@ --- title: Set Up User Feedback sidebar_title: User Feedback -description: "Learn how to enable User Feedback in your app." +description: Learn how to enable User Feedback in your app. sidebar_order: 6000 +og_image: /og-images/platforms-react-native-user-feedback.png --- The User Feedback feature allows you to collect user feedback from anywhere inside your application at any time, without needing an error event to occur first. diff --git a/docs/platforms/unity/configuration/app-not-responding/index.mdx b/docs/platforms/unity/configuration/app-not-responding/index.mdx index 986abe6280155..55ebc58ab885c 100644 --- a/docs/platforms/unity/configuration/app-not-responding/index.mdx +++ b/docs/platforms/unity/configuration/app-not-responding/index.mdx @@ -1,7 +1,8 @@ --- title: App Not Responding (ANR) sidebar_order: 20 -description: "Learn how to turn off or specify ANR." +description: Learn how to turn off or specify ANR. +og_image: /og-images/platforms-unity-configuration-app-not-responding.png --- Application Not Responding (ANR) errors are triggered when the Unity thread of the game is blocked for more than five seconds. The Unity SDK reports ANR errors as Sentry events. diff --git a/docs/platforms/unity/configuration/options/cli-options/index.mdx b/docs/platforms/unity/configuration/options/cli-options/index.mdx index cb85c76d97b28..fd38bc862cc82 100644 --- a/docs/platforms/unity/configuration/options/cli-options/index.mdx +++ b/docs/platforms/unity/configuration/options/cli-options/index.mdx @@ -1,7 +1,8 @@ --- title: Sentry CLI Options -description: "Learn more about how to configure the options used by Sentry CLI." +description: Learn more about how to configure the options used by Sentry CLI. sidebar_order: 30 +og_image: /og-images/platforms-unity-configuration-options-cli-options.png --- The Unity SDK includes [Sentry CLI](/product/cli/) as a tool to upload debug symbols to Sentry. These debug symbols are used in processing events sent to Sentry to provide stacktraces and linenumbers. This page describes the options available to configure the Sentry CLI. diff --git a/docs/platforms/unity/configuration/options/programmatic-configuration/index.mdx b/docs/platforms/unity/configuration/options/programmatic-configuration/index.mdx index a816b20f4cc31..a8d1b082f95bf 100644 --- a/docs/platforms/unity/configuration/options/programmatic-configuration/index.mdx +++ b/docs/platforms/unity/configuration/options/programmatic-configuration/index.mdx @@ -1,7 +1,9 @@ --- title: Programmatic Configuration -description: "Learn more about how to configure the Unity SDK programmatically." +description: Learn more about how to configure the Unity SDK programmatically. sidebar_order: 20 +og_image: >- + /og-images/platforms-unity-configuration-options-programmatic-configuration.png --- We've added `Sentry Options Configuration` to the `Options Config` tab in the Sentry editor window to provide a way to modify options programmatically. diff --git a/docs/platforms/unity/data-management/debug-files/source-context/index.mdx b/docs/platforms/unity/data-management/debug-files/source-context/index.mdx index 48427d9db7ebb..b5a19b824ccd0 100644 --- a/docs/platforms/unity/data-management/debug-files/source-context/index.mdx +++ b/docs/platforms/unity/data-management/debug-files/source-context/index.mdx @@ -1,7 +1,10 @@ --- title: Source Context -description: "Learn about setting up source bundles to show source code in stack traces on the Issue Details page." +description: >- + Learn about setting up source bundles to show source code in stack traces on + the Issue Details page. sidebar_order: 5 +og_image: /og-images/platforms-unity-data-management-debug-files-source-context.png --- If Sentry has access to your application's source code, it can show snippets of code (_source context_) around the location of stack frames, which helps to quickly pinpoint problematic code. diff --git a/docs/platforms/unity/enriching-events/screenshots/index.mdx b/docs/platforms/unity/enriching-events/screenshots/index.mdx index 17b7dabc729b3..6d620bf5ccb33 100644 --- a/docs/platforms/unity/enriching-events/screenshots/index.mdx +++ b/docs/platforms/unity/enriching-events/screenshots/index.mdx @@ -1,6 +1,9 @@ --- -title: "Screenshots" -description: "Learn more about taking screenshots when an error occurs. Sentry pairs the screenshot with the original event, giving you additional insight into issues." +title: Screenshots +description: >- + Learn more about taking screenshots when an error occurs. Sentry pairs the + screenshot with the original event, giving you additional insight into issues. +og_image: /og-images/platforms-unity-enriching-events-screenshots.png --- Sentry makes it possible to automatically take a screenshot and include it as an attachment when a user experiences an error, an exception or a crash. diff --git a/docs/platforms/unity/enriching-events/view-hierarchy/index.mdx b/docs/platforms/unity/enriching-events/view-hierarchy/index.mdx index 9d39d2f696aa5..fefbb88d686a8 100644 --- a/docs/platforms/unity/enriching-events/view-hierarchy/index.mdx +++ b/docs/platforms/unity/enriching-events/view-hierarchy/index.mdx @@ -1,6 +1,10 @@ --- -title: "View Hierarchy" -description: "Learn more about debugging the view hierarchy when an error occurs. Sentry pairs the view hierarchy representation with the original event, giving you additional insight into issues." +title: View Hierarchy +description: >- + Learn more about debugging the view hierarchy when an error occurs. Sentry + pairs the view hierarchy representation with the original event, giving you + additional insight into issues. +og_image: /og-images/platforms-unity-enriching-events-view-hierarchy.png --- Sentry makes it possible to render a JSON representation of the scene of an error and includes it as an attachment. diff --git a/docs/platforms/unity/index.mdx b/docs/platforms/unity/index.mdx index 9e2dae2a99122..88348f266af4a 100644 --- a/docs/platforms/unity/index.mdx +++ b/docs/platforms/unity/index.mdx @@ -10,6 +10,7 @@ categories: - desktop - console - gaming +og_image: /og-images/platforms-unity.png --- Our Unity SDK builds on top of the [.NET SDK](/platforms/dotnet/) and extends it with Unity-specific features. It gives you helpful hints for where and why an error or performance issue might have occurred. diff --git a/docs/platforms/unity/tracing/instrumentation/automatic-instrumentation.mdx b/docs/platforms/unity/tracing/instrumentation/automatic-instrumentation.mdx index 11dfce5741dfc..12536f37b72c7 100644 --- a/docs/platforms/unity/tracing/instrumentation/automatic-instrumentation.mdx +++ b/docs/platforms/unity/tracing/instrumentation/automatic-instrumentation.mdx @@ -1,7 +1,9 @@ --- title: Automatic Instrumentation -description: "Learn what transactions are captured after tracing is enabled." +description: Learn what transactions are captured after tracing is enabled. sidebar_order: 20 +og_image: >- + /og-images/platforms-unity-tracing-instrumentation-automatic-instrumentation.png --- ## Automatically Captured Transactions diff --git a/docs/platforms/unity/troubleshooting/known-limitations.mdx b/docs/platforms/unity/troubleshooting/known-limitations.mdx index 48e7c36ea0b34..4fa209a3a451f 100644 --- a/docs/platforms/unity/troubleshooting/known-limitations.mdx +++ b/docs/platforms/unity/troubleshooting/known-limitations.mdx @@ -1,7 +1,8 @@ --- title: Known Limitations sidebar_order: 9000 -description: "Learn more about the Unity SDK's known limitations. " +description: 'Learn more about the Unity SDK''s known limitations. ' +og_image: /og-images/platforms-unity-troubleshooting-known-limitations.png --- ## File System Access Permissions diff --git a/docs/platforms/unity/usage/automatic-error-capture/index.mdx b/docs/platforms/unity/usage/automatic-error-capture/index.mdx index a5ee3ac0d757d..b0a865ac0804b 100644 --- a/docs/platforms/unity/usage/automatic-error-capture/index.mdx +++ b/docs/platforms/unity/usage/automatic-error-capture/index.mdx @@ -1,7 +1,10 @@ --- title: Automatic Error Capture sidebar_order: 10 -description: "Learn more about how the SDK automatically captures errors and sends them to Sentry." +description: >- + Learn more about how the SDK automatically captures errors and sends them to + Sentry. +og_image: /og-images/platforms-unity-usage-automatic-error-capture.png --- The Sentry SDK for Unity provides both automatic and manual error capturing capabilities on all layers of your application. This page focuses on the **automatic error capture**. For information on manually capturing errors and messages, see the [Usage documentation](/platforms/unity/usage/). diff --git a/docs/platforms/unity/user-feedback/index.mdx b/docs/platforms/unity/user-feedback/index.mdx index 149381dd7c7e8..a84d0f6852b67 100644 --- a/docs/platforms/unity/user-feedback/index.mdx +++ b/docs/platforms/unity/user-feedback/index.mdx @@ -1,8 +1,12 @@ --- title: Set Up User Feedback sidebar_title: User Feedback -description: "Learn more about collecting user feedback when an event occurs. Sentry pairs the feedback with the original event, giving you additional insight into issues." +description: >- + Learn more about collecting user feedback when an event occurs. Sentry pairs + the feedback with the original event, giving you additional insight into + issues. sidebar_order: 6000 +og_image: /og-images/platforms-unity-user-feedback.png --- diff --git a/docs/platforms/unreal/configuration/debug-symbols/index.mdx b/docs/platforms/unreal/configuration/debug-symbols/index.mdx index 23acb350e77b9..62489bee38928 100644 --- a/docs/platforms/unreal/configuration/debug-symbols/index.mdx +++ b/docs/platforms/unreal/configuration/debug-symbols/index.mdx @@ -1,6 +1,7 @@ --- title: Debug Symbols Uploading -description: "Learn how the Unreal Engine SDK handles debug symbols upload." +description: Learn how the Unreal Engine SDK handles debug symbols upload. +og_image: /og-images/platforms-unreal-configuration-debug-symbols.png --- Sentry requires [debug information files](/platforms/unreal/data-management/debug-files/) to symbolicate crashes. The Unreal Engine SDK provides an automated upload functionality for those symbol files that rely on the [sentry-cli](/cli/). This is done automatically, so running the `sentry-cli` manually isn't required. The symbol upload happens during the execution of `PostBuildSteps`, as specified in the `Sentry.uplugin` file. The `sentry-cli` executables for Windows, macOS, and Linux are included as part of the Unreal Engine SDK package. They can also be downloaded manually via the settings menu if the plugin was installed from the UE Marketplace. diff --git a/docs/platforms/unreal/configuration/setup-crashreporter/index.mdx b/docs/platforms/unreal/configuration/setup-crashreporter/index.mdx index a3c2d670d758a..dc265d992984a 100644 --- a/docs/platforms/unreal/configuration/setup-crashreporter/index.mdx +++ b/docs/platforms/unreal/configuration/setup-crashreporter/index.mdx @@ -1,6 +1,7 @@ --- title: Crash Reporter Client -description: "Learn about Sentry's Unreal Engine integration with Crash Reporter Client." +description: Learn about Sentry's Unreal Engine integration with Crash Reporter Client. +og_image: /og-images/platforms-unreal-configuration-setup-crashreporter.png --- Installation of a Sentry SDK is not required in order to capture the crashes of your diff --git a/docs/platforms/unreal/enriching-events/attachments/index.mdx b/docs/platforms/unreal/enriching-events/attachments/index.mdx index e8b9d24a0e5d8..3757a3bfdfa00 100644 --- a/docs/platforms/unreal/enriching-events/attachments/index.mdx +++ b/docs/platforms/unreal/enriching-events/attachments/index.mdx @@ -1,6 +1,9 @@ --- title: Attachments -description: "Learn more about how Sentry can store additional files in the same request as event attachments." +description: >- + Learn more about how Sentry can store additional files in the same request as + event attachments. +og_image: /og-images/platforms-unreal-enriching-events-attachments.png --- diff --git a/docs/platforms/unreal/enriching-events/breadcrumbs/index.mdx b/docs/platforms/unreal/enriching-events/breadcrumbs/index.mdx index 27dc79ac58f9e..452c5e044e0d4 100644 --- a/docs/platforms/unreal/enriching-events/breadcrumbs/index.mdx +++ b/docs/platforms/unreal/enriching-events/breadcrumbs/index.mdx @@ -1,6 +1,9 @@ --- title: Breadcrumbs -description: "Learn more about what Sentry uses to create a trail of events (breadcrumbs) that happened prior to an issue." +description: >- + Learn more about what Sentry uses to create a trail of events (breadcrumbs) + that happened prior to an issue. +og_image: /og-images/platforms-unreal-enriching-events-breadcrumbs.png --- Sentry uses _breadcrumbs_ to create a trail of events that happened prior to an issue. These events are very similar to traditional logs, but can record more rich structured data. diff --git a/docs/platforms/unreal/enriching-events/context/index.mdx b/docs/platforms/unreal/enriching-events/context/index.mdx index abcb7144d057a..046d19092e9e4 100644 --- a/docs/platforms/unreal/enriching-events/context/index.mdx +++ b/docs/platforms/unreal/enriching-events/context/index.mdx @@ -1,6 +1,9 @@ --- title: Context -description: "Custom contexts allow you to attach arbitrary data (strings, lists, dictionaries) to an event." +description: >- + Custom contexts allow you to attach arbitrary data (strings, lists, + dictionaries) to an event. +og_image: /og-images/platforms-unreal-enriching-events-context.png --- Custom contexts allow you to attach arbitrary data to an event. Often, this context is shared among any issue captured in its lifecycle. You cannot search these, but they are viewable on the issue page: diff --git a/docs/platforms/unreal/enriching-events/identify-user/index.mdx b/docs/platforms/unreal/enriching-events/identify-user/index.mdx index 3e9e3d3b67c35..4f37c9b1c28eb 100644 --- a/docs/platforms/unreal/enriching-events/identify-user/index.mdx +++ b/docs/platforms/unreal/enriching-events/identify-user/index.mdx @@ -1,6 +1,9 @@ --- title: Users -description: "Learn how to configure the SDK to capture the user and gain critical pieces of information that construct a unique identity in Sentry." +description: >- + Learn how to configure the SDK to capture the user and gain critical pieces of + information that construct a unique identity in Sentry. +og_image: /og-images/platforms-unreal-enriching-events-identify-user.png --- Users consist of a few critical pieces of information that construct a unique identity in Sentry. Each of these is optional, but one **must** be present for the Sentry SDK to capture the user: diff --git a/docs/platforms/unreal/enriching-events/screenshots/index.mdx b/docs/platforms/unreal/enriching-events/screenshots/index.mdx index d6b80300d816a..13387fd89d6b8 100644 --- a/docs/platforms/unreal/enriching-events/screenshots/index.mdx +++ b/docs/platforms/unreal/enriching-events/screenshots/index.mdx @@ -1,6 +1,10 @@ --- -title: "Screenshots" -description: "Learn more about how to set up Sentry to take screenshots when an error occurs. The screenshot will be paired with the original event, giving you additional insight into issues." +title: Screenshots +description: >- + Learn more about how to set up Sentry to take screenshots when an error + occurs. The screenshot will be paired with the original event, giving you + additional insight into issues. +og_image: /og-images/platforms-unreal-enriching-events-screenshots.png --- Sentry makes it possible to automatically take a screenshot and include it as an attachment when a user experiences an error, an exception or a crash. diff --git a/docs/platforms/unreal/index.mdx b/docs/platforms/unreal/index.mdx index cc31c562fac29..b6b08e7c09030 100644 --- a/docs/platforms/unreal/index.mdx +++ b/docs/platforms/unreal/index.mdx @@ -8,6 +8,7 @@ categories: - desktop - console - gaming +og_image: /og-images/platforms-unreal.png --- Unreal Engine SDK builds on top of other Sentry SDKs and extends them with Unreal Engine specific features. It gives developers helpful hints for where and why an error or performance issue might have occurred. diff --git a/docs/platforms/unreal/install/index.mdx b/docs/platforms/unreal/install/index.mdx index b5e48f3eae02c..42d4915c21d9c 100644 --- a/docs/platforms/unreal/install/index.mdx +++ b/docs/platforms/unreal/install/index.mdx @@ -1,7 +1,8 @@ --- title: Installation Methods -description: "All the installation methods for the Unreal Engine SDK." +description: All the installation methods for the Unreal Engine SDK. sidebar_order: 2 +og_image: /og-images/platforms-unreal-install.png --- There are three common ways to install an SDK to use with Unreal Engine: diff --git a/docs/pricing/index.mdx b/docs/pricing/index.mdx index 60b3d195b855c..67b9171d8c93d 100644 --- a/docs/pricing/index.mdx +++ b/docs/pricing/index.mdx @@ -1,7 +1,8 @@ --- title: Pricing & Billing sidebar_order: 40 -description: "Learn about pricing, managing volume, and the different Sentry plans." +description: 'Learn about pricing, managing volume, and the different Sentry plans.' +og_image: /og-images/pricing.png --- @@ -118,7 +119,7 @@ All Sentry plans include one cron monitor and one uptime monitor. Additional mon More details on how to activate, deactivate, and manage your monitors quota is - available under: + available under: - [Billing Quota Management: Manage Your Cron and Uptime Monitors](/pricing/quotas/manage-cron-monitors/) @@ -152,11 +153,11 @@ Seer is Sentry's AI agent that triages, debugs, and fixes application issues aut Issue Scan automatically classifies and triages issues to determine which are the most likely to be fixable with a code change. Issue Scans are billed per run. | Issue Scan Volume | Team PAYG | Business PAYG | -| ----------------- | ------------- | ------------- | +| ----------------- | ------------- | ------------- | | >0-10k | $0.0030000 | $0.0030000 | | >10k-100k | $0.0027000 | $0.0027000 | -| >100k-500k | $0.0024300 | $0.0024300 | -| >500k | $0.0021870 | $0.0021870 | +| >100k-500k | $0.0024300 | $0.0024300 | +| >500k | $0.0021870 | $0.0021870 | #### Issue Fixes diff --git a/docs/pricing/legacy-pricing.mdx b/docs/pricing/legacy-pricing.mdx index 2f3c3f2b0cf98..4d353d13843e0 100644 --- a/docs/pricing/legacy-pricing.mdx +++ b/docs/pricing/legacy-pricing.mdx @@ -1,8 +1,11 @@ --- -title: Pricing & Billing (before June 11, 2024) +title: 'Pricing & Billing (before June 11, 2024)' sidebar_hidden: true sidebar_order: 1 -description: "Learn about our pricing structure, how to manage your spend, and the different Sentry plans." +description: >- + Learn about our pricing structure, how to manage your spend, and the different + Sentry plans. +og_image: /og-images/pricing-legacy-pricing.png --- diff --git a/docs/pricing/quotas/index.mdx b/docs/pricing/quotas/index.mdx index 076e498fd5cbb..1d9af33732ab4 100644 --- a/docs/pricing/quotas/index.mdx +++ b/docs/pricing/quotas/index.mdx @@ -1,7 +1,8 @@ --- -title: "Billing Quota Management" +title: Billing Quota Management sidebar_order: 70 -description: "Learn about what counts towards your quota and how to manage your quota." +description: Learn about what counts towards your quota and how to manage your quota. +og_image: /og-images/pricing-quotas.png --- Data and quotas are interconnected in Sentry. When you [subscribe to Sentry](https://sentry.io/pricing/), you pay for the amount of data - events (errors, replays, spans or transactions, and profiles), logs, and attachments - to be tracked. Each data category has its own quota that you can adjust. When Sentry tracks an event, log, or attachment, it counts toward your quota for that type of data. diff --git a/docs/pricing/quotas/legacy-manage-transaction-quota.mdx b/docs/pricing/quotas/legacy-manage-transaction-quota.mdx index 5a3c68e81bbae..c460231ed9612 100644 --- a/docs/pricing/quotas/legacy-manage-transaction-quota.mdx +++ b/docs/pricing/quotas/legacy-manage-transaction-quota.mdx @@ -1,8 +1,11 @@ --- -title: Manage Your Performance Units Quota (before June 11, 2024) +title: 'Manage Your Performance Units Quota (before June 11, 2024)' sidebar_hidden: true sidebar_order: 40 -description: "Learn how to use the tools Sentry provides to control the type and amount of performance units that you pay for." +description: >- + Learn how to use the tools Sentry provides to control the type and amount of + performance units that you pay for. +og_image: /og-images/pricing-quotas-legacy-manage-transaction-quota.png --- diff --git a/docs/pricing/quotas/manage-attachments-quota.mdx b/docs/pricing/quotas/manage-attachments-quota.mdx index 65befc6540f45..da217df023aaa 100644 --- a/docs/pricing/quotas/manage-attachments-quota.mdx +++ b/docs/pricing/quotas/manage-attachments-quota.mdx @@ -1,8 +1,12 @@ --- title: Manage Your Attachments Quota -keywords: ["best practices"] +keywords: + - best practices sidebar_order: 60 -description: "Learn how to use the tools Sentry provides to control the type and amount of attachments that you pay for." +description: >- + Learn how to use the tools Sentry provides to control the type and amount of + attachments that you pay for. +og_image: /og-images/pricing-quotas-manage-attachments-quota.png --- Sending all your error attachments to Sentry may consume your quota too rapidly, so we provide tools to control the _type_ and _amount_ of attachments that are stored. diff --git a/docs/pricing/quotas/manage-event-stream-guide.mdx b/docs/pricing/quotas/manage-event-stream-guide.mdx index fcda3cfb7d705..9eb4b9b77028e 100644 --- a/docs/pricing/quotas/manage-event-stream-guide.mdx +++ b/docs/pricing/quotas/manage-event-stream-guide.mdx @@ -1,8 +1,12 @@ --- title: Manage Your Error Quota -keywords: ["best practices"] +keywords: + - best practices sidebar_order: 30 -description: "Learn how to use the tools Sentry provides to control the type and amount of errors that you pay for." +description: >- + Learn how to use the tools Sentry provides to control the type and amount of + errors that you pay for. +og_image: /og-images/pricing-quotas-manage-event-stream-guide.png --- Sending all your application errors to Sentry ensures you'll be notified in real-time when errors occur in your code. However, with a basic setup, you may consume your error quota too rapidly and trigger more notifications than you can use. Sentry provides tools to control the _type_ and _amount_ of errors that are monitored. These tools allow you to: diff --git a/docs/pricing/quotas/manage-logs-quota.mdx b/docs/pricing/quotas/manage-logs-quota.mdx index 059e9f1570602..464d56b546516 100644 --- a/docs/pricing/quotas/manage-logs-quota.mdx +++ b/docs/pricing/quotas/manage-logs-quota.mdx @@ -1,7 +1,10 @@ --- title: Manage Your Logs Quota sidebar_order: 45 -description: "Understand where and how to manage your Logs quota, see how much each project is consuming, and learn how to increase or decrease your spend." +description: >- + Understand where and how to manage your Logs quota, see how much each project + is consuming, and learn how to increase or decrease your spend. +og_image: /og-images/pricing-quotas-manage-logs-quota.png --- diff --git a/docs/pricing/quotas/manage-replay-quota.mdx b/docs/pricing/quotas/manage-replay-quota.mdx index 352e967f377dc..d367f2c403bce 100644 --- a/docs/pricing/quotas/manage-replay-quota.mdx +++ b/docs/pricing/quotas/manage-replay-quota.mdx @@ -1,8 +1,12 @@ --- title: Manage Your Replay Quota -keywords: ["best practices"] +keywords: + - best practices sidebar_order: 50 -description: Learn how to use Sentry's tools to manage the amount of session replays you pay for. +description: >- + Learn how to use Sentry's tools to manage the amount of session replays you + pay for. +og_image: /og-images/pricing-quotas-manage-replay-quota.png --- The below will help you understand where and how to manage your Replay quota, how to check which projects are consuming more than others, and what to expect if you need to increase or decrease your spend. diff --git a/docs/pricing/quotas/manage-seer-budget.mdx b/docs/pricing/quotas/manage-seer-budget.mdx index 340dc67b14813..f26be17781885 100644 --- a/docs/pricing/quotas/manage-seer-budget.mdx +++ b/docs/pricing/quotas/manage-seer-budget.mdx @@ -1,7 +1,10 @@ --- title: Manage Your Seer Budget sidebar_order: 40 -description: "Understand where and how to manage your Seer budget, see which projects are consuming more than others, and how to increase or decrease your spend." +description: >- + Understand where and how to manage your Seer budget, see which projects are + consuming more than others, and how to increase or decrease your spend. +og_image: /og-images/pricing-quotas-manage-seer-budget.png --- @@ -81,7 +84,7 @@ Let's illustrate how this works: 2. **Issue Scans:** - Automatic issue scans is enabled, meaning every new issue created triggers a scan automatically. - In this billing cycle, let's suppose 1,000 new issues are created, which means 1,000 scans are run. - - The total issue scan cost is $3. + - The total issue scan cost is $3. 3. **Issue Fixes:** - Your issue fix automation is set to "Highly Actionable and Above". - Of the 1,000 issues scanned, 50 are identified as "Highly Actionable and Above". As soon as the issue is classified, Seer automatically creates RCAs and suggested fixes for these 50 issues so that they are immediately available for your review. diff --git a/docs/pricing/quotas/manage-transaction-quota.mdx b/docs/pricing/quotas/manage-transaction-quota.mdx index 2a2a9aebd762f..64c6cc9d2955d 100644 --- a/docs/pricing/quotas/manage-transaction-quota.mdx +++ b/docs/pricing/quotas/manage-transaction-quota.mdx @@ -1,8 +1,10 @@ --- title: Manage Your Span Quota -keywords: ["best practices"] +keywords: + - best practices sidebar_order: 40 -description: "Learn how to use the tools Sentry provides to control your span quota." +description: Learn how to use the tools Sentry provides to control your span quota. +og_image: /og-images/pricing-quotas-manage-transaction-quota.png --- In most cases, sending all span events to Sentry could generate more data than you'd find useful and might use up your spans too quickly. Sentry provides tools to control the _type_ and _amount_ of spans that are monitored. This allows you to have tracing data that's actionable and meaningful. diff --git a/docs/pricing/quotas/spend-allocation.mdx b/docs/pricing/quotas/spend-allocation.mdx index 530db88932053..a1787a0af8cce 100644 --- a/docs/pricing/quotas/spend-allocation.mdx +++ b/docs/pricing/quotas/spend-allocation.mdx @@ -1,8 +1,11 @@ --- -title: "Spend Allocation" +title: Spend Allocation sidebar_hidden: true sidebar_order: 20 -description: "Learn how to allocate reserved volume to specific projects so that the most important projects are always monitored." +description: >- + Learn how to allocate reserved volume to specific projects so that the most + important projects are always monitored. +og_image: /og-images/pricing-quotas-spend-allocation.png --- diff --git a/docs/product/ai-in-sentry/ai-code-review/index.mdx b/docs/product/ai-in-sentry/ai-code-review/index.mdx index a323217596df2..62fe832a55282 100644 --- a/docs/product/ai-in-sentry/ai-code-review/index.mdx +++ b/docs/product/ai-in-sentry/ai-code-review/index.mdx @@ -1,7 +1,10 @@ --- title: AI Code Review sidebar_order: 30 -description: "Get error predictions, code reviews and new tests for better code and coverage." +description: >- + Get error predictions, code reviews and new tests for better code and + coverage. +og_image: /og-images/product-ai-in-sentry-ai-code-review.png --- AI Code Review helps you generate new tests for uncovered code and reviews your code changes, predicting errors and offering suggestions for improvement before merging pull requests. @@ -28,7 +31,7 @@ If you're not an admin, share the Seer by Sentry GitHub App Integration link wit After installing the app, AI Code Review can help you in three ways: -1. **Error Prediction** - When you create a pull request and set it to `Ready for Review`, AI Code Review will check for errors in your code. If no error is found, you will see a 🎉 emoji as a reaction to your PR description. Otherwise, AI Code Review will add comments to your PR. **Note:** We skip review if you set your PR to `draft` on creation. +1. **Error Prediction** - When you create a pull request and set it to `Ready for Review`, AI Code Review will check for errors in your code. If no error is found, you will see a 🎉 emoji as a reaction to your PR description. Otherwise, AI Code Review will add comments to your PR. **Note:** We skip review if you set your PR to `draft` on creation. 2. **`@sentry review`** - Use this command in a PR comment, and the assistant will review the PR and predict errors, as well as make suggestions. @@ -64,4 +67,4 @@ Error Prediction is automatically triggered by the following GitHub pull_request - `opened`: when you open a new pull request (we skip those opened in `draft` state) - `ready_for_review`: when a draft pull request is marked as “Ready for review” - To manually run error prediction and get a general review, comment `@sentry review` in the PR. \ No newline at end of file + To manually run error prediction and get a general review, comment `@sentry review` in the PR. diff --git a/docs/product/ai-in-sentry/seer/issue-fix/index.mdx b/docs/product/ai-in-sentry/seer/issue-fix/index.mdx index 141aa15412573..380b1a01c6fc2 100644 --- a/docs/product/ai-in-sentry/seer/issue-fix/index.mdx +++ b/docs/product/ai-in-sentry/seer/issue-fix/index.mdx @@ -1,7 +1,10 @@ --- title: Issue Fix -description: "Use Seer's issue fix to automatically find the root cause of issues and generate code fixes." +description: >- + Use Seer's issue fix to automatically find the root cause of issues and + generate code fixes. sidebar_order: 20 +og_image: /og-images/product-ai-in-sentry-seer-issue-fix.png --- **Issue fix** is Seer's collaborative workflow to find the root cause of and solution to issues. It uses Sentry's context (issue details, tracing data, logs, and profiles), your codebases (integrated through GitHub), and its interactions with you to identify and reason through problems in your code. @@ -43,11 +46,11 @@ When it's finished, you will see the recommended solution. From here, you can: 1. Remove any steps or actions that you disagree with 2. Add any additional steps or instructions, for example request additional unit tests to prevent regressions of the original error -Once you are ready to proceed, you can select "Code It Up" to generate code resolving the bug. +Once you are ready to proceed, you can select "Code It Up" to generate code resolving the bug. ### Code Generation -During the coding step, Seer will identify the code patch(or patches) needed to implement the solution. When it's done, you'll see a preview showing the suggested diffs across your codebase. If the fix involves service dependencies, you may see edits spanning across multiple repositories. +During the coding step, Seer will identify the code patch(or patches) needed to implement the solution. When it's done, you'll see a preview showing the suggested diffs across your codebase. If the fix involves service dependencies, you may see edits spanning across multiple repositories. From here, you can choose to draft a PR, or checkout the code changes locally for further iteration. If you choose to checkout the code locally, Seer will make a new branch for you. @@ -64,7 +67,7 @@ Seer is a powerful debugging agent, with access to a wide variety of data source - **Performance data**: Profiles and performance metrics - **Interactive feedback**: Your input and guidance during the process -This context is crucial to Seer's capabilities, and it allows it to do things like investigate a backend service that may be the true root cause for a frontend bug you are trying to troubleshoot. +This context is crucial to Seer's capabilities, and it allows it to do things like investigate a backend service that may be the true root cause for a frontend bug you are trying to troubleshoot. ## Settings @@ -88,6 +91,5 @@ Seer already automatically parses rules files from [Cursor](https://docs.cursor. - For JavaScript / TypeScript projects that are minified in production, upload [source maps](/platforms/javascript/sourcemaps/) to Sentry for the best results -Currently, GitHub is the only SCM supported by Seer. We are currently working to add support for other services including GitLab and Bitbucket. +Currently, GitHub is the only SCM supported by Seer. We are currently working to add support for other services including GitLab and Bitbucket. - diff --git a/docs/product/alerts/alert-types.mdx b/docs/product/alerts/alert-types.mdx index 3be6c19780e28..0cfe5ea1f507c 100644 --- a/docs/product/alerts/alert-types.mdx +++ b/docs/product/alerts/alert-types.mdx @@ -1,7 +1,10 @@ --- title: Alert Types sidebar_order: 10 -description: "Learn about the three types of alerts Sentry provides: issue alerts, metric alerts, and uptime monitoring alerts." +description: >- + Learn about the three types of alerts Sentry provides: issue alerts, metric + alerts, and uptime monitoring alerts. +og_image: /og-images/product-alerts-alert-types.png --- You can create three types of alerts: diff --git a/docs/product/alerts/create-alerts/index.mdx b/docs/product/alerts/create-alerts/index.mdx index 2be75521d9272..b8bd954e96844 100644 --- a/docs/product/alerts/create-alerts/index.mdx +++ b/docs/product/alerts/create-alerts/index.mdx @@ -1,7 +1,10 @@ --- title: Create Alerts sidebar_order: 20 -description: "Learn how to create alerts that keep you informed about errors and performance issues in your application." +description: >- + Learn how to create alerts that keep you informed about errors and performance + issues in your application. +og_image: /og-images/product-alerts-create-alerts.png --- diff --git a/docs/product/alerts/create-alerts/issue-alert-config.mdx b/docs/product/alerts/create-alerts/issue-alert-config.mdx index 00ccd89b46526..b336a4deec5bc 100644 --- a/docs/product/alerts/create-alerts/issue-alert-config.mdx +++ b/docs/product/alerts/create-alerts/issue-alert-config.mdx @@ -1,7 +1,8 @@ --- title: Issue Alert Configuration sidebar_order: 10 -description: "Learn more about the options for configuring an issue alert." +description: Learn more about the options for configuring an issue alert. +og_image: /og-images/product-alerts-create-alerts-issue-alert-config.png --- Sentry provides several configuration options to create an issue alert based on your organization's needs. diff --git a/docs/product/alerts/create-alerts/metric-alert-config.mdx b/docs/product/alerts/create-alerts/metric-alert-config.mdx index 2bbb78281f5fc..bb07bbf14c1e0 100644 --- a/docs/product/alerts/create-alerts/metric-alert-config.mdx +++ b/docs/product/alerts/create-alerts/metric-alert-config.mdx @@ -1,7 +1,8 @@ --- title: Metric Alert Configuration sidebar_order: 20 -description: "Learn more about the options for configuring a metric alert." +description: Learn more about the options for configuring a metric alert. +og_image: /og-images/product-alerts-create-alerts-metric-alert-config.png --- Sentry provides several configuration options to create a metric alert based on your organization's needs. diff --git a/docs/product/alerts/create-alerts/routing-alerts.mdx b/docs/product/alerts/create-alerts/routing-alerts.mdx index 0545d0b9b4b94..c11c7dc875142 100644 --- a/docs/product/alerts/create-alerts/routing-alerts.mdx +++ b/docs/product/alerts/create-alerts/routing-alerts.mdx @@ -1,7 +1,8 @@ --- title: Alert Routing With Integrations sidebar_order: 40 -description: "Learn more about routing alerts using Sentry integrations." +description: Learn more about routing alerts using Sentry integrations. +og_image: /og-images/product-alerts-create-alerts-routing-alerts.png --- By customizing [alert](/product/alerts/) rules and integrating the tools you already use, you can receive alerts when, where (and if) you want them, without disruption. Alert notifications can be routed to [Slack](/organization/integrations/notification-incidents/slack/), multiple [supported integrations](/organization/integrations/), and custom integrations through [webhooks](/organization/integrations/integration-platform/webhooks/). When creating alert rules, you can use these integrations to configure who to notify and how. diff --git a/docs/product/alerts/create-alerts/uptime-alert-config.mdx b/docs/product/alerts/create-alerts/uptime-alert-config.mdx index 14a313b12541d..1f27d94658afc 100644 --- a/docs/product/alerts/create-alerts/uptime-alert-config.mdx +++ b/docs/product/alerts/create-alerts/uptime-alert-config.mdx @@ -1,7 +1,8 @@ --- title: Uptime Alert Configuration sidebar_order: 30 -description: "Learn more about the options for configuring an uptime alert." +description: Learn more about the options for configuring an uptime alert. +og_image: /og-images/product-alerts-create-alerts-uptime-alert-config.png --- Sentry provides several configuration options for creating an uptime alert based on your organization's needs as explained below. diff --git a/docs/product/alerts/index.mdx b/docs/product/alerts/index.mdx index d413de785bc16..42bd87fc4285a 100644 --- a/docs/product/alerts/index.mdx +++ b/docs/product/alerts/index.mdx @@ -1,7 +1,12 @@ --- title: Alerts sidebar_order: 80 -description: "With Sentry Alerts, you can get real-time visibility into your code to quickly resolve errors & update personal notifications to enhance the error and performance monitoring experience for you and your team. Learn how to get started here." +description: >- + With Sentry Alerts, you can get real-time visibility into your code to quickly + resolve errors & update personal notifications to enhance the error and + performance monitoring experience for you and your team. Learn how to get + started here. +og_image: /og-images/product-alerts.png --- Alerts provide real-time visibility into problems with your code and the impact on your users. There are several types of alerts available with customizable thresholds and integrations. diff --git a/docs/product/alerts/notifications/index.mdx b/docs/product/alerts/notifications/index.mdx index bc55bde7b14ef..c2feec1a91bed 100644 --- a/docs/product/alerts/notifications/index.mdx +++ b/docs/product/alerts/notifications/index.mdx @@ -1,7 +1,10 @@ --- title: Notifications sidebar_order: 40 -description: "Learn about the types of notifications that Sentry sends you, and how to manage them." +description: >- + Learn about the types of notifications that Sentry sends you, and how to + manage them. +og_image: /og-images/product-alerts-notifications.png --- Sentry sends you notifications regarding workflow activities, [release deploys](/product/releases/), and [quota usage](/pricing/quotas/), as well as weekly reports. These notifications let you know about: diff --git a/docs/product/alerts/notifications/notification-settings.mdx b/docs/product/alerts/notifications/notification-settings.mdx index 4c5c6f5b66b5a..0cd4aec2f53a7 100644 --- a/docs/product/alerts/notifications/notification-settings.mdx +++ b/docs/product/alerts/notifications/notification-settings.mdx @@ -1,7 +1,8 @@ --- title: Personal Notification Settings -sidebar_order: -description: "Learn how to manage your personal notifications settings." +sidebar_order: null +description: Learn how to manage your personal notifications settings. +og_image: /og-images/product-alerts-notifications-notification-settings.png --- You can update your personal notification settings for things like [workflow](/product/alerts/notifications/), deploy, issue alert, and [spike protection](/pricing/quotas/spike-protection/) by turning them on or off, specifying how you'd like to be notified (via email, Slack, or both), and more. Users who **aren't** on an [Enterprise](https://sentry.io/pricing/) plan can also configure their quota notifications. @@ -33,7 +34,7 @@ Here's a list of all the personal notification types you can update: - **Issue Workflow:** Changes in issue assignment, resolution status, and comments. - **Deploys:** Release, environment, and commit overviews. - **Nudges:** Notifications that require review or approval. -- **Spend:** Notifications alerting you about your organization's spend and billing quota. +- **Spend:** Notifications alerting you about your organization's spend and billing quota. - **Weekly Reports:** A summary of the past week for an organization. - **Email Routing:** Changes to the email address that receives notifications. - **Spike Protection:** Notifications about spikes on a per project basis. diff --git a/docs/product/codecov/how-it-works.mdx b/docs/product/codecov/how-it-works.mdx index 53709e9705a6a..79955bcd37bf8 100644 --- a/docs/product/codecov/how-it-works.mdx +++ b/docs/product/codecov/how-it-works.mdx @@ -1,6 +1,7 @@ --- title: How It Works sidebar_order: 0 +og_image: /og-images/product-codecov-how-it-works.png --- Sentry uses code-mappings to determine the repository and default branch for the stack trace frame to query Codecov's coverage report endpoint. The endpoint gives Sentry the coverage state for each line so that it can be applied to the stack trace in the UI. This makes it possible for users to see the untested code that's causing errors, including whether it's partially or fully covered directly in the stack trace. This helps you avoid similar errors in the future. diff --git a/docs/product/codecov/set-up.mdx b/docs/product/codecov/set-up.mdx index 67439241e4a95..522501727f2ed 100644 --- a/docs/product/codecov/set-up.mdx +++ b/docs/product/codecov/set-up.mdx @@ -1,6 +1,7 @@ --- title: Set Up sidebar_order: 1 +og_image: /og-images/product-codecov-set-up.png --- If you're a user of both Codecov and Sentry, you can enable the Codecov integration with 1 click in your **Organization Settings** page in the Sentry app. You'll be able to see whether you have partial or full test coverage for the line of code that's causing an error, directly in your stack trace in Sentry. diff --git a/docs/product/crons/alerts-backend-insights-migration.mdx b/docs/product/crons/alerts-backend-insights-migration.mdx index 05087deffbd8a..45ab3258daad7 100644 --- a/docs/product/crons/alerts-backend-insights-migration.mdx +++ b/docs/product/crons/alerts-backend-insights-migration.mdx @@ -3,6 +3,7 @@ title: Cron Monitoring Updates for Developers noindex: true draft: true sidebar_hidden: true +og_image: /og-images/product-crons-alerts-backend-insights-migration.png --- The **Cron Monitoring** feature has been relocated and restructured to improve accessibility and functionality. Previously, it was found in the sidebar under **"Crons"**, but it has now been split into two different locations: diff --git a/docs/product/dashboards/custom-dashboards/index.mdx b/docs/product/dashboards/custom-dashboards/index.mdx index 2782fa52c2c73..c9ca2c353cbb1 100644 --- a/docs/product/dashboards/custom-dashboards/index.mdx +++ b/docs/product/dashboards/custom-dashboards/index.mdx @@ -1,7 +1,10 @@ --- title: Custom Dashboards sidebar_order: 10 -description: "Learn how to edit or create additional dashboards to suit your organization's needs." +description: >- + Learn how to edit or create additional dashboards to suit your organization's + needs. +og_image: /og-images/product-dashboards-custom-dashboards.png --- diff --git a/docs/product/dashboards/index.mdx b/docs/product/dashboards/index.mdx index b6c17fe8a078b..c7e89551804ab 100644 --- a/docs/product/dashboards/index.mdx +++ b/docs/product/dashboards/index.mdx @@ -1,7 +1,10 @@ --- title: Dashboards sidebar_order: 100 -description: "With Sentry’s Dashboards, you can get a focused view of your application’s health, while being able to easily navigate across multiple projects." +description: >- + With Sentry’s Dashboards, you can get a focused view of your application’s + health, while being able to easily navigate across multiple projects. +og_image: /og-images/product-dashboards.png --- Sentry's Dashboards provide you with a broad overview of your application’s health by allowing you to navigate through error and performance data across multiple projects. Dashboards are made up of one or more widgets, and each widget visualizes one or more [dataset](/product/dashboards/widget-builder/#choose-your-dataset). diff --git a/docs/product/dashboards/widget-builder/index.mdx b/docs/product/dashboards/widget-builder/index.mdx index d9c59da949a7b..5c50c75433ddd 100644 --- a/docs/product/dashboards/widget-builder/index.mdx +++ b/docs/product/dashboards/widget-builder/index.mdx @@ -1,7 +1,8 @@ --- title: Widget Builder sidebar_order: 15 -description: "Learn how to create widgets for your dashboards or edit existing ones." +description: Learn how to create widgets for your dashboards or edit existing ones. +og_image: /og-images/product-dashboards-widget-builder.png --- diff --git a/docs/product/dashboards/widget-library/index.mdx b/docs/product/dashboards/widget-library/index.mdx index 0b1820bf99f59..a381266928505 100644 --- a/docs/product/dashboards/widget-library/index.mdx +++ b/docs/product/dashboards/widget-library/index.mdx @@ -1,7 +1,10 @@ --- title: Widget Library sidebar_order: 20 -description: "Learn about Sentry's library of prebuilt widgets that you can use in your custom dashboards." +description: >- + Learn about Sentry's library of prebuilt widgets that you can use in your + custom dashboards. +og_image: /og-images/product-dashboards-widget-library.png --- diff --git a/docs/product/explore/discover-queries/index.mdx b/docs/product/explore/discover-queries/index.mdx index ce1dd37bce2f7..260635bd2baf8 100644 --- a/docs/product/explore/discover-queries/index.mdx +++ b/docs/product/explore/discover-queries/index.mdx @@ -1,7 +1,10 @@ --- -title: "Discover" +title: Discover sidebar_order: 90 -description: "Discover is a powerful query engine that allows you to query all your metadata across projects and environments to unlock insights." +description: >- + Discover is a powerful query engine that allows you to query all your metadata + across projects and environments to unlock insights. +og_image: /og-images/product-explore-discover-queries.png --- diff --git a/docs/product/explore/discover-queries/query-builder.mdx b/docs/product/explore/discover-queries/query-builder.mdx index 8bef4826c3435..2fe00f804dc43 100644 --- a/docs/product/explore/discover-queries/query-builder.mdx +++ b/docs/product/explore/discover-queries/query-builder.mdx @@ -1,7 +1,10 @@ --- -title: "Query Builder" +title: Query Builder sidebar_order: 10 -description: "Learn how to use Discover to build a query, filter your data, and group results." +description: >- + Learn how to use Discover to build a query, filter your data, and group + results. +og_image: /og-images/product-explore-discover-queries-query-builder.png --- diff --git a/docs/product/explore/discover-queries/query-builder/query-equations.mdx b/docs/product/explore/discover-queries/query-builder/query-equations.mdx index f881618cb83d0..7aa10fc11bcf2 100644 --- a/docs/product/explore/discover-queries/query-builder/query-equations.mdx +++ b/docs/product/explore/discover-queries/query-builder/query-equations.mdx @@ -1,7 +1,10 @@ --- -title: "Adding Query Equations" +title: Adding Query Equations sidebar_order: 10 -description: "Learn how to write query equations that perform operations using your query columns." +description: >- + Learn how to write query equations that perform operations using your query + columns. +og_image: /og-images/product-explore-discover-queries-query-builder-query-equations.gif --- diff --git a/docs/product/explore/discover-queries/uncover-trends.mdx b/docs/product/explore/discover-queries/uncover-trends.mdx index bcfab6b78d020..42d16313bac62 100644 --- a/docs/product/explore/discover-queries/uncover-trends.mdx +++ b/docs/product/explore/discover-queries/uncover-trends.mdx @@ -1,7 +1,10 @@ --- title: Uncover Trends With Discover sidebar_order: 20 -description: "Learn how to work with the data in Discover to gain useful insights into the health and stability of your applications." +description: >- + Learn how to work with the data in Discover to gain useful insights into the + health and stability of your applications. +og_image: /og-images/product-explore-discover-queries-uncover-trends.png --- diff --git a/docs/product/explore/logs/index.mdx b/docs/product/explore/logs/index.mdx index 5d537bb712254..88b150a8bc493 100644 --- a/docs/product/explore/logs/index.mdx +++ b/docs/product/explore/logs/index.mdx @@ -1,7 +1,10 @@ --- -title: "Logs" +title: Logs sidebar_order: 70 -description: "Structured logs allow you to send, view and query logs and parameters sent from your applications within Sentry." +description: >- + Structured logs allow you to send, view and query logs and parameters sent + from your applications within Sentry. +og_image: /og-images/product-explore-logs.png --- diff --git a/docs/product/explore/profiling/differential-flamegraphs.mdx b/docs/product/explore/profiling/differential-flamegraphs.mdx index e38a652bfd5f8..e57d08e4acc71 100644 --- a/docs/product/explore/profiling/differential-flamegraphs.mdx +++ b/docs/product/explore/profiling/differential-flamegraphs.mdx @@ -1,7 +1,8 @@ --- title: Differential Flame Graphs sidebar_order: 110 -description: "Learn how to use and interpret differential flame graphs." +description: Learn how to use and interpret differential flame graphs. +og_image: /og-images/product-explore-profiling-differential-flamegraphs.png --- There are multiple ways to visualize and use profiling data, including differential flame graphs, which can help easily identify function regressions or changes in the execution context. diff --git a/docs/product/explore/profiling/flame-charts-graphs.mdx b/docs/product/explore/profiling/flame-charts-graphs.mdx index 0b853c12c9a1a..1313f16486e86 100644 --- a/docs/product/explore/profiling/flame-charts-graphs.mdx +++ b/docs/product/explore/profiling/flame-charts-graphs.mdx @@ -1,7 +1,8 @@ --- title: Flame Graphs and Aggregated Flame Graphs sidebar_order: 100 -description: "Learn more about how to interpret flame graphs and aggregated flame graphs." +description: Learn more about how to interpret flame graphs and aggregated flame graphs. +og_image: /og-images/product-explore-profiling-flame-charts-graphs.png --- Profiling data can be used to gain insight into what methods and lines of your code are slow. But getting this type of insight requires an understanding of how profiling data is represented and visualized. Sentry uses both flame graphs and aggregated flame graphs to visualize profile data. We'll explain how to read them below. diff --git a/docs/product/explore/profiling/index.mdx b/docs/product/explore/profiling/index.mdx index 246fe78aa6ccc..80ddda78a02f6 100644 --- a/docs/product/explore/profiling/index.mdx +++ b/docs/product/explore/profiling/index.mdx @@ -1,7 +1,11 @@ --- -title: "Profiling" +title: Profiling sidebar_order: 50 -description: "Profiling offers a deeper level of visibility on top of traditional tracing, removing the need for custom instrumentation and enabling precise code-level visibility into your application in a production environment." +description: >- + Profiling offers a deeper level of visibility on top of traditional tracing, + removing the need for custom instrumentation and enabling precise code-level + visibility into your application in a production environment. +og_image: /og-images/product-explore-profiling.png --- Sentry’s Profiling products provide precise, code-level visibility into application execution in a production environment. @@ -10,7 +14,7 @@ Sentry’s Profiling products provide precise, code-level visibility into applic Profiling helps you understand where time is being spent in your application at a **function level**. While [tracing](/concepts/key-terms/tracing/) can help you capture information about the higher level operations (HTTP requests, database queries, UI rendering, etc.) that consume time in your application, profiling helps you debug performance by visualizing the call stacks on every thread, throughout the execution of your application. -This is especially helpful in situations where you are missing explicit instrumentation (spans and logs) that might help you narrow in on where an issue is occurring. Profiling requires *no additional instrumentation* and will automatically capture information on the functions and lines of code that take the most time as your application runs. +This is especially helpful in situations where you are missing explicit instrumentation (spans and logs) that might help you narrow in on where an issue is occurring. Profiling requires *no additional instrumentation* and will automatically capture information on the functions and lines of code that take the most time as your application runs. Profiling helps you quickly identify performance bottlenecks, enabling you to build in [performance as a feature](https://blog.codinghorror.com/performance-is-a-feature/) from day one. @@ -46,7 +50,7 @@ On the [**Profiling**](https://sentry.io/orgredirect/organizations/:orgslug/prof On the **Slowest Functions** widget, you can click on the ellipses button (...) on each function to see a list of example profiles containing that function. On the **Most Regressed/Improved Functions** widget, you can click on the function duration before & after the change to see before & after example profiles containing that function. -Below the function metrics, you’ll find two tabs: **Transactions** and **Aggregate Flamegraph**. +Below the function metrics, you’ll find two tabs: **Transactions** and **Aggregate Flamegraph**. If [tracing](/concepts/key-terms/tracing/) is enabled, **Transactions** shows a list of all of the transactions instrumented in the selected projects, allowing you to break down profiling data by endpoints, routes, user flows, etc. It gives you a more focused view of application performance within a *specific* part of the application. @@ -68,11 +72,11 @@ Click the name of a transaction to navigate to the **Transaction Summary** page, ### Aggregate Flamegraph Tab -The **Aggregate Flamegraph** tab shows a [flame graph](/product/explore/profiling/flame-charts-graphs) with aggregated information on the frequency of code paths within the selected projects. +The **Aggregate Flamegraph** tab shows a [flame graph](/product/explore/profiling/flame-charts-graphs) with aggregated information on the frequency of code paths within the selected projects. ![Aggregate Flamegraph tab on the Profiling page](./img/profiling-page-aggregate-flamegraph.png) -The wider frames represent more **frequent** code paths, which are likely more relevant optimization opportunities. You can click on a frame to select it, which will populate the sidebar on the right with links to example profiles containing the selected function. +The wider frames represent more **frequent** code paths, which are likely more relevant optimization opportunities. You can click on a frame to select it, which will populate the sidebar on the right with links to example profiles containing the selected function. ## Zooming Into Traces Using Profiling diff --git a/docs/product/explore/profiling/mobile-app-profiling/metrics.mdx b/docs/product/explore/profiling/mobile-app-profiling/metrics.mdx index 3af1ac1d49dd1..b5679ea3e8146 100644 --- a/docs/product/explore/profiling/mobile-app-profiling/metrics.mdx +++ b/docs/product/explore/profiling/mobile-app-profiling/metrics.mdx @@ -1,7 +1,11 @@ --- title: Profiling Metrics sidebar_order: 50 -description: "Learn about the measurements taken by the Sentry profiler that help us contextualize the work your mobile app does and detect possible issues impacting performance." +description: >- + Learn about the measurements taken by the Sentry profiler that help us + contextualize the work your mobile app does and detect possible issues + impacting performance. +og_image: /og-images/product-explore-profiling-mobile-app-profiling-metrics.png --- The Sentry profiler records several system measurements to help analyze the backtraces it gathers. Some, like CPU and heap usage, are taken on a regular sampling interval using functions from `mach/mach.h`, albeit with a lower frequency than backtrace sampling. Others, like GPU information, are taken from `CADisplayLink` callback invocations, as they're received. diff --git a/docs/product/explore/profiling/profile-details.mdx b/docs/product/explore/profiling/profile-details.mdx index 5085722d80786..3f5e007d08b76 100644 --- a/docs/product/explore/profiling/profile-details.mdx +++ b/docs/product/explore/profiling/profile-details.mdx @@ -1,7 +1,8 @@ --- title: Profile Details sidebar_order: 50 -description: "Learn how to explore your profile data using the Profile Details page." +description: Learn how to explore your profile data using the Profile Details page. +og_image: /og-images/product-explore-profiling-profile-details.png --- Profiling can be used to gain insight into the exact functions and lines of code that are impacting performance. Each profile has a detailed view that illustrates the code that was running in your application and service while the profile was collected, with different ways to filter and visualize the data. To learn how to set up profiling and access profiling data, see the [**Profiling**](/product/explore/profiling/) documentation. diff --git a/docs/product/explore/session-replay/mobile/index.mdx b/docs/product/explore/session-replay/mobile/index.mdx index e0d2872f6a62d..91b1101d22707 100644 --- a/docs/product/explore/session-replay/mobile/index.mdx +++ b/docs/product/explore/session-replay/mobile/index.mdx @@ -1,7 +1,10 @@ --- -title: "Session Replay for Mobile" +title: Session Replay for Mobile sidebar_order: 20 -description: "Use Session Replay for Mobile to get reproductions of user sessions. You'll be able to repro issues faster and get a better understanding of user impact." +description: >- + Use Session Replay for Mobile to get reproductions of user sessions. You'll be + able to repro issues faster and get a better understanding of user impact. +og_image: /og-images/product-explore-session-replay-mobile.png --- Session Replay allows you to see reproductions of user sessions, which can help you understand what happened before, during, and after an error or performance issue occurred. As you play back each session, you'll be able to see every user interaction in relation to network requests, frontend and backend errors, backend spans, and more. diff --git a/docs/product/explore/session-replay/replay-details.mdx b/docs/product/explore/session-replay/replay-details.mdx index bbac6018f6bc8..1174bc86cfade 100644 --- a/docs/product/explore/session-replay/replay-details.mdx +++ b/docs/product/explore/session-replay/replay-details.mdx @@ -1,7 +1,10 @@ --- -title: "Replay Details" +title: Replay Details sidebar_order: 72 -description: "Learn more about how information is organized on the Replay Details page and how to share and delete replays." +description: >- + Learn more about how information is organized on the Replay Details page and + how to share and delete replays. +og_image: /og-images/product-explore-session-replay-replay-details.png --- diff --git a/docs/product/explore/session-replay/replay-page-and-filters.mdx b/docs/product/explore/session-replay/replay-page-and-filters.mdx index 4ca54fbdc41aa..73c17b1943dc9 100644 --- a/docs/product/explore/session-replay/replay-page-and-filters.mdx +++ b/docs/product/explore/session-replay/replay-page-and-filters.mdx @@ -1,7 +1,10 @@ --- -title: "Replays Page and Filters" +title: Replays Page and Filters sidebar_order: 71 -description: "Learn how to navigate the Replays page and filter user sessions that meet specific conditions." +description: >- + Learn how to navigate the Replays page and filter user sessions that meet + specific conditions. +og_image: /og-images/product-explore-session-replay-replay-page-and-filters.png --- diff --git a/docs/product/explore/session-replay/web/index.mdx b/docs/product/explore/session-replay/web/index.mdx index 57d911ed1ad82..369a0abef7610 100644 --- a/docs/product/explore/session-replay/web/index.mdx +++ b/docs/product/explore/session-replay/web/index.mdx @@ -1,10 +1,14 @@ --- -title: "Session Replay for Web" +title: Session Replay for Web sidebar_order: 10 -description: "Learn about Session Replay and its video-like reproductions of user interactions, which can help you see when users are frustrated and build a better web experience." +description: >- + Learn about Session Replay and its video-like reproductions of user + interactions, which can help you see when users are frustrated and build a + better web experience. +og_image: /og-images/product-explore-session-replay-web.png --- -Session Replay allows you to see video-like reproductions of user sessions which can help you understand what happened before, during, and after an error or performance issue occurred. You'll be able to gain deeper debugging context into issues so that you can reproduce and resolve problems faster without the guesswork. As you play back each session, you'll be able to see every user interaction in relation to network requests, DOM events, and console messages. It’s effectively like having [DevTools](https://developer.chrome.com/docs/devtools/overview/) active in your production user sessions. +Session Replay allows you to see video-like reproductions of user sessions which can help you understand what happened before, during, and after an error or performance issue occurred. You'll be able to gain deeper debugging context into issues so that you can reproduce and resolve problems faster without the guesswork. As you play back each session, you'll be able to see every user interaction in relation to network requests, DOM events, and console messages. It’s effectively like having [DevTools](https://developer.chrome.com/docs/devtools/overview/) active in your production user sessions. Session Replay for web now includes an AI-powered replay summary that automatically analyzes what happened during a user session, and gives a short play-by-play to help debug issues faster. Rather than watch an entire replay, you can now get a quick overview of what happened and focus on the specific interactions that led to the issue. **Note: This feature is currently in Beta, which means that this feature is still in-progress and may have bugs. We recognize the irony.** @@ -76,4 +80,4 @@ Sentry.init({ }); ``` - \ No newline at end of file + diff --git a/docs/product/explore/trace-explorer/index.mdx b/docs/product/explore/trace-explorer/index.mdx index 5d7a014537a5f..054007064c8c7 100644 --- a/docs/product/explore/trace-explorer/index.mdx +++ b/docs/product/explore/trace-explorer/index.mdx @@ -1,7 +1,10 @@ --- -title: "Trace Explorer With Span Metrics" +title: Trace Explorer With Span Metrics sidebar_order: 31 -description: "Learn how to use Sentry's Trace Explorer to search span data, find distributed traces, and debug performance issues across your entire application stack." +description: >- + Learn how to use Sentry's Trace Explorer to search span data, find distributed + traces, and debug performance issues across your entire application stack. +og_image: /og-images/product-explore-trace-explorer.png --- The [**Trace Explorer**](https://sentry.io/orgredirect/organizations/:orgslug/traces/) in Sentry is designed to make performance investigation easier and more intuitive. You can now explore span samples, visualize span attributes, and aggregate your data with flexible queries and filters. This guide will walk you through the key concepts and features of the Trace Explorer. @@ -208,4 +211,3 @@ Even if you sample your spans, **Trace Explorer's extrapolation gives you reason Note: In case you want to see unextrapolated aggregates for a query you can disable extrapolation using the settings icon above the chart. With these tools, the new Trace Explorer gives you powerful ways to understand your application’s performance, identify bottlenecks, and make informed optimizations. - diff --git a/docs/product/insights/ai/agents/dashboard.mdx b/docs/product/insights/ai/agents/dashboard.mdx index 04d6815d5f198..ca064a55cbaec 100644 --- a/docs/product/insights/ai/agents/dashboard.mdx +++ b/docs/product/insights/ai/agents/dashboard.mdx @@ -1,7 +1,8 @@ --- title: AI Agents Dashboard sidebar_order: 10 -description: "Learn how to use Sentry's AI Agents Dashboard." +description: Learn how to use Sentry's AI Agents Dashboard. +og_image: /og-images/product-insights-ai-agents-dashboard.png --- Once you've [configured the Sentry SDK](/product/insights/ai/agents/getting-started/) for your AI agent project, you'll start receiving data in the Sentry [AI Agents Insights](https://sentry.io/orgredirect/organizations/:orgslug/insights/agents/) dashboard. diff --git a/docs/product/insights/ai/agents/index.mdx b/docs/product/insights/ai/agents/index.mdx index d5d8e114c8496..3d8aac8def691 100644 --- a/docs/product/insights/ai/agents/index.mdx +++ b/docs/product/insights/ai/agents/index.mdx @@ -1,7 +1,10 @@ --- -title: "AI Agents" +title: AI Agents sidebar_order: 10 -description: "Learn how to use Sentry's AI Agent monitoring tools to trace and debug your AI agent workflows, including agent runs, tool calls, and model interactions." +description: >- + Learn how to use Sentry's AI Agent monitoring tools to trace and debug your AI + agent workflows, including agent runs, tool calls, and model interactions. +og_image: /og-images/product-insights-ai-agents.png --- Sentry's AI Agent monitoring tools help you understand what's going on with your AI agent workflows. They automatically collect information about agent runs, tool calls, model interactions, and errors across your entire AI pipeline—from user interaction to final response. diff --git a/docs/product/insights/ai/agents/privacy.mdx b/docs/product/insights/ai/agents/privacy.mdx index 3298ff49c2118..54eb137160b2f 100644 --- a/docs/product/insights/ai/agents/privacy.mdx +++ b/docs/product/insights/ai/agents/privacy.mdx @@ -1,7 +1,10 @@ --- title: Data Privacy sidebar_order: 20 -description: "Learn how to control data collection and protect sensitive information in AI agent monitoring." +description: >- + Learn how to control data collection and protect sensitive information in AI + agent monitoring. +og_image: /og-images/product-insights-ai-agents-privacy.png --- ## SDK PII Settings diff --git a/docs/product/insights/ai/mcp/dashboard.mdx b/docs/product/insights/ai/mcp/dashboard.mdx index 74604c49b56d5..829adea4e9272 100644 --- a/docs/product/insights/ai/mcp/dashboard.mdx +++ b/docs/product/insights/ai/mcp/dashboard.mdx @@ -1,7 +1,8 @@ --- title: MCP Dashboard sidebar_order: 10 -description: "Learn how to use Sentry's MCP Dashboard." +description: Learn how to use Sentry's MCP Dashboard. +og_image: /og-images/product-insights-ai-mcp-dashboard.png --- Once you've [configured the Sentry SDK](/product/insights/ai/mcp/getting-started/) for your MCP project, you'll start receiving data in the Sentry [MCP Insights](https://sentry.io/orgredirect/organizations/:orgslug/insights/ai/mcp/) dashboard. diff --git a/docs/product/insights/ai/mcp/index.mdx b/docs/product/insights/ai/mcp/index.mdx index 786d293f2089c..a5656442adff5 100644 --- a/docs/product/insights/ai/mcp/index.mdx +++ b/docs/product/insights/ai/mcp/index.mdx @@ -1,7 +1,11 @@ --- -title: "MCP" +title: MCP sidebar_order: 20 -description: "Learn how to use Sentry's MCP monitoring tools to trace and debug your Model Context Protocol implementations, including server connections, resource access, and tool executions." +description: >- + Learn how to use Sentry's MCP monitoring tools to trace and debug your Model + Context Protocol implementations, including server connections, resource + access, and tool executions. +og_image: /og-images/product-insights-ai-mcp.png --- Sentry's MCP (Model Context Protocol) monitoring tools help you understand what's happening in your MCP implementations. They automatically collect information about MCP server connections, resource access, tool executions, and errors across your entire MCP pipeline—from client requests to server responses. diff --git a/docs/product/insights/backend/index.mdx b/docs/product/insights/backend/index.mdx index bf62fe00f172f..2aa8eda8a9454 100644 --- a/docs/product/insights/backend/index.mdx +++ b/docs/product/insights/backend/index.mdx @@ -1,14 +1,17 @@ --- -title: "Backend Performance" +title: Backend Performance sidebar_order: 20 -description: "Learn how to use Sentry's Backend Performance tool to monitor things like queries, outbound API requests, caches, and queues." +description: >- + Learn how to use Sentry's Backend Performance tool to monitor things like + queries, outbound API requests, caches, and queues. +og_image: /og-images/product-insights-backend.png --- Sentry's [**Backend Performance**](https://sentry.io/orgredirect/organizations/:orgslug/insights/backend/) page gives you an overview of the health of your application. You'll be able to see things like the **Most Time-Consuming Queries**, **Most Time-Consuming Domains**, **p50** and **p75 Duration**, and so on. ![Backend performance overview page.](../img/backend-performance-overview.png) -You can also dive deeper into Queries, Outbound API Requests, Caches, and Queues to get detailed information about potential issues affecting your application's health. In addition to having a dedicated space to monitor backend performance, you can also look at Sentry's **Insights** tab to monitor frontend, mobile, and AI performance. +You can also dive deeper into Queries, Outbound API Requests, Caches, and Queues to get detailed information about potential issues affecting your application's health. In addition to having a dedicated space to monitor backend performance, you can also look at Sentry's **Insights** tab to monitor frontend, mobile, and AI performance. ## Learn More diff --git a/docs/product/insights/backend/queries.mdx b/docs/product/insights/backend/queries.mdx index 4aa7cd6b86f02..e53ab0502693a 100644 --- a/docs/product/insights/backend/queries.mdx +++ b/docs/product/insights/backend/queries.mdx @@ -1,7 +1,10 @@ --- title: Queries sidebar_order: 0 -description: "With Queries in Sentry, you can easily see database queries, remediate performance errors & monitor query performance." +description: >- + With Queries in Sentry, you can easily see database queries, remediate + performance errors & monitor query performance. +og_image: /og-images/product-insights-backend-queries.png --- If you have [Insights](/product/insights/) enabled and your application queries a database, you can see how your queries are performing in Sentry. diff --git a/docs/product/insights/frontend/assets.mdx b/docs/product/insights/frontend/assets.mdx index 25a00d878d329..914e2299d7c59 100644 --- a/docs/product/insights/frontend/assets.mdx +++ b/docs/product/insights/frontend/assets.mdx @@ -1,7 +1,10 @@ --- title: Assets sidebar_order: 20 -description: "Learn more about browser asset performance monitoring, which allows you to debug the performance of loading JavaScript and CSS on your frontend." +description: >- + Learn more about browser asset performance monitoring, which allows you to + debug the performance of loading JavaScript and CSS on your frontend. +og_image: /og-images/product-insights-frontend-assets.png --- If you have performance monitoring enabled for your frontend, you can see how your browser assets are performing in Sentry. diff --git a/docs/product/insights/frontend/index.mdx b/docs/product/insights/frontend/index.mdx index 5575bfedf7837..1b9dfdba2fc81 100644 --- a/docs/product/insights/frontend/index.mdx +++ b/docs/product/insights/frontend/index.mdx @@ -1,14 +1,17 @@ --- -title: "Frontend Performance" +title: Frontend Performance sidebar_order: 10 -description: "Learn how to use Sentry's Frontend Performance tool to monitor things like web vitals and network requests." +description: >- + Learn how to use Sentry's Frontend Performance tool to monitor things like web + vitals and network requests. +og_image: /og-images/product-insights-frontend.png --- -Sentry's [**Frontend Performance**](https://sentry.io/orgredirect/organizations/:orgslug/insights/frontend/) page gives you an overview of the health of your application. You'll be able to see things like **Best Page Opportunities** (the improvements that would most help increase your performance score), your **Most Time-Consuming Assets**, **p50** and **p75 Duration**, and so on. +Sentry's [**Frontend Performance**](https://sentry.io/orgredirect/organizations/:orgslug/insights/frontend/) page gives you an overview of the health of your application. You'll be able to see things like **Best Page Opportunities** (the improvements that would most help increase your performance score), your **Most Time-Consuming Assets**, **p50** and **p75 Duration**, and so on. ![Frontend performance overview page.](../img/frontend-performance-overview.png) -You can also dive deeper into Web Vitals, Network Requests, and Assets to get detailed information about potential issues affecting your application's health. In addition to having a dedicated space to monitor frontend performance, you can also look at Sentry's **Insights** tab to monitor backend, mobile, and AI performance. +You can also dive deeper into Web Vitals, Network Requests, and Assets to get detailed information about potential issues affecting your application's health. In addition to having a dedicated space to monitor frontend performance, you can also look at Sentry's **Insights** tab to monitor backend, mobile, and AI performance. ## Learn More diff --git a/docs/product/insights/frontend/web-vitals/web-vitals-concepts.mdx b/docs/product/insights/frontend/web-vitals/web-vitals-concepts.mdx index 687e6e39960ff..d5254507733b5 100644 --- a/docs/product/insights/frontend/web-vitals/web-vitals-concepts.mdx +++ b/docs/product/insights/frontend/web-vitals/web-vitals-concepts.mdx @@ -1,7 +1,10 @@ --- -title: "Web Vitals Concepts" +title: Web Vitals Concepts sidebar_order: 10 -description: "Learn more about web vitals and how each metric relates to your application's performance." +description: >- + Learn more about web vitals and how each metric relates to your application's + performance. +og_image: /og-images/product-insights-frontend-web-vitals-web-vitals-concepts.png --- [Web Vitals](https://web.dev/vitals/) are a set of metrics defined by Google to measure render time, response time, and layout shift. Each data point provides insights about the overall [performance](/product/insights/overview/) of your application. diff --git a/docs/product/insights/mobile/index.mdx b/docs/product/insights/mobile/index.mdx index 135dfcab8a319..0573674ff09b5 100644 --- a/docs/product/insights/mobile/index.mdx +++ b/docs/product/insights/mobile/index.mdx @@ -1,7 +1,10 @@ --- -title: "Mobile Performance" +title: Mobile Performance sidebar_order: 30 -description: "Learn how to use Sentry's Mobile Performance tool to monitor the health of your mobile app, including app starts, screen loads, and screen rendering." +description: >- + Learn how to use Sentry's Mobile Performance tool to monitor the health of + your mobile app, including app starts, screen loads, and screen rendering. +og_image: /og-images/product-insights-mobile.png --- The [**Mobile Performance**](https://sentry.io/orgredirect/organizations/:orgslug/insights/mobile/) page gives an overview of the metrics that let you know how fast your app starts, including the number of slow and frozen frames your users may be experiencing. Each metric provides insights into the overall performance health of your mobile application. Digging into the details helps prioritize critical performance issues and allows you to identify and troubleshoot the root cause faster. diff --git a/docs/product/insights/mobile/mobile-vitals/app-starts.mdx b/docs/product/insights/mobile/mobile-vitals/app-starts.mdx index 136aa057d0471..fb06fa38eca54 100644 --- a/docs/product/insights/mobile/mobile-vitals/app-starts.mdx +++ b/docs/product/insights/mobile/mobile-vitals/app-starts.mdx @@ -1,7 +1,10 @@ --- -title: "App Starts" +title: App Starts sidebar_order: 20 -description: "Learn how to monitor your mobile application's performance by using App Starts to identify slow or regressed screens." +description: >- + Learn how to monitor your mobile application's performance by using App Starts + to identify slow or regressed screens. +og_image: /og-images/product-insights-mobile-mobile-vitals-app-starts.png --- ![Example of App Starts](./img/app-starts.png) diff --git a/docs/product/insights/mobile/mobile-vitals/index.mdx b/docs/product/insights/mobile/mobile-vitals/index.mdx index 81318940cdb8d..cd7ef48dd8e6f 100644 --- a/docs/product/insights/mobile/mobile-vitals/index.mdx +++ b/docs/product/insights/mobile/mobile-vitals/index.mdx @@ -1,7 +1,8 @@ --- -title: "Mobile Vitals" +title: Mobile Vitals sidebar_order: 0 -description: "Track the performance of your app." +description: Track the performance of your app. +og_image: /og-images/product-insights-mobile-mobile-vitals.png --- The Mobile Vitals insights module provides a high-level overview of the performance of your screens, and allows you to drill down into the performance metrics of individual screens. diff --git a/docs/product/insights/mobile/mobile-vitals/screen-loads.mdx b/docs/product/insights/mobile/mobile-vitals/screen-loads.mdx index ea731614b9ce7..ab24a77d34cdd 100644 --- a/docs/product/insights/mobile/mobile-vitals/screen-loads.mdx +++ b/docs/product/insights/mobile/mobile-vitals/screen-loads.mdx @@ -1,7 +1,11 @@ --- -title: "Screen Loads" +title: Screen Loads sidebar_order: 30 -description: "Learn how to monitor your mobile application's performance by using Screen Loads to get better visibility on your application's TTID and TTFD performance." +description: >- + Learn how to monitor your mobile application's performance by using Screen + Loads to get better visibility on your application's TTID and TTFD + performance. +og_image: /og-images/product-insights-mobile-mobile-vitals-screen-loads.png --- ![Example of Screen Loads](./img/screen-loads.png) diff --git a/docs/product/insights/overview/filters-display/index.mdx b/docs/product/insights/overview/filters-display/index.mdx index dd3b7987f9ce0..72418b1b90257 100644 --- a/docs/product/insights/overview/filters-display/index.mdx +++ b/docs/product/insights/overview/filters-display/index.mdx @@ -1,7 +1,10 @@ --- -title: "Filters & Display" +title: Filters & Display sidebar_order: 20 -description: "Manage the information on the Insight Overview page using search or page-level display filters to quickly identify performance issues." +description: >- + Manage the information on the Insight Overview page using search or page-level + display filters to quickly identify performance issues. +og_image: /og-images/product-insights-overview-filters-display.png --- You can filter the information displayed on the **Performance** page by searching or using page-level display filters. diff --git a/docs/product/insights/overview/filters-display/widgets.mdx b/docs/product/insights/overview/filters-display/widgets.mdx index ff83a8fa1ceee..b8e4d2ea0f693 100644 --- a/docs/product/insights/overview/filters-display/widgets.mdx +++ b/docs/product/insights/overview/filters-display/widgets.mdx @@ -1,7 +1,11 @@ --- -title: "Widgets" +title: Widgets sidebar_order: 10 -description: "Learn more about Sentry's Insights widgets such as Most Slow Frames, Most Time-Consuming Queries, and Slow HTTP Ops, and how they can be used to surface performance insights in your applications." +description: >- + Learn more about Sentry's Insights widgets such as Most Slow Frames, Most + Time-Consuming Queries, and Slow HTTP Ops, and how they can be used to surface + performance insights in your applications. +og_image: /og-images/product-insights-overview-filters-display-widgets.png --- Insights widgets offer visualizations that you can change to best match your workflow. They provide performance-specific views that allow you to see and act on transaction data across your organization. diff --git a/docs/product/insights/overview/index.mdx b/docs/product/insights/overview/index.mdx index f0c6cbcb64e75..524ed6ed31eb5 100644 --- a/docs/product/insights/overview/index.mdx +++ b/docs/product/insights/overview/index.mdx @@ -1,7 +1,11 @@ --- -title: "Overview" +title: Overview sidebar_order: 50 -description: "With insights, you can track, analyze, and debug your application's performance. Sentry helps you identify performance opportunities and trace issues back to poorly performing code." +description: >- + With insights, you can track, analyze, and debug your application's + performance. Sentry helps you identify performance opportunities and trace + issues back to poorly performing code. +og_image: /og-images/product-insights-overview.png --- Sentry tracks application performance, measuring metrics like throughput and latency, and displaying the impact of errors across multiple services. Sentry captures [distributed traces](/product/sentry-basics/tracing/distributed-tracing/) consisting of multiple [spans](/product/explore/trace-explorer/#spans) to measure individual services and operations within those services. diff --git a/docs/product/insights/overview/metrics.mdx b/docs/product/insights/overview/metrics.mdx index f083a1710ee48..e13108e9b4070 100644 --- a/docs/product/insights/overview/metrics.mdx +++ b/docs/product/insights/overview/metrics.mdx @@ -1,7 +1,11 @@ --- -title: "Performance Metrics" +title: Performance Metrics sidebar_order: 110 -description: "Learn more about Sentry's Performance metrics such as Apdex, failure rate, throughput, and latency, and the user experience insights about your application that they provide." +description: >- + Learn more about Sentry's Performance metrics such as Apdex, failure rate, + throughput, and latency, and the user experience insights about your + application that they provide. +og_image: /og-images/product-insights-overview-metrics.png --- Metrics provide insight about how users are experiencing your application. In [Insights](/product/insights/overview/), we'll set you up with a few of the basic metrics to get you started. For further customizations on target thresholds, feel free to build out a query using the Discover [Query Builder](/product/explore/discover-queries/query-builder/). By identifying useful thresholds to measure your application, you have a quantifiable measurement of your application's health. This means you can more easily identify when errors occur or if performance issues are emerging. diff --git a/docs/product/insights/overview/transaction-summary.mdx b/docs/product/insights/overview/transaction-summary.mdx index a1d3c2962aea0..9006f3ffc04ce 100644 --- a/docs/product/insights/overview/transaction-summary.mdx +++ b/docs/product/insights/overview/transaction-summary.mdx @@ -1,7 +1,11 @@ --- -title: "Transaction Summary" +title: Transaction Summary sidebar_order: 40 -description: "Learn more about the transaction summary, which helps you evaluate the transaction's overall health. This view includes graphs, instances of these events, stats, facet maps, and related errors." +description: >- + Learn more about the transaction summary, which helps you evaluate the + transaction's overall health. This view includes graphs, instances of these + events, stats, facet maps, and related errors. +og_image: /og-images/product-insights-overview-transaction-summary.png --- Every transaction has a summary view that gives you a better understanding of its overall health. With this view, you'll find graphs, instances of these events, stats, facet maps, related errors, and more. diff --git a/docs/product/issues/grouping-and-fingerprints/index.mdx b/docs/product/issues/grouping-and-fingerprints/index.mdx index 14bb353faba26..affb44a47f6b4 100644 --- a/docs/product/issues/grouping-and-fingerprints/index.mdx +++ b/docs/product/issues/grouping-and-fingerprints/index.mdx @@ -1,8 +1,11 @@ --- -title: "Grouping Issues" +title: Grouping Issues sidebar_order: 60 noindex: true -description: "Learn more about how Sentry groups issues together as well as different ways to change how events are grouped." +description: >- + Learn more about how Sentry groups issues together as well as different ways + to change how events are grouped. +og_image: /og-images/product-issues-grouping-and-fingerprints.png --- Have you ever had a set of similar-looking issues like this? diff --git a/docs/product/issues/index.mdx b/docs/product/issues/index.mdx index 98c614efe01be..edc620d033a12 100644 --- a/docs/product/issues/index.mdx +++ b/docs/product/issues/index.mdx @@ -1,7 +1,10 @@ --- title: Issues sidebar_order: 20 -description: "Learn how to use Sentry’s Issues page, where you can see and start to debug errors and performance problems that are affecting your application." +description: >- + Learn how to use Sentry’s Issues page, where you can see and start to debug + errors and performance problems that are affecting your application. +og_image: /og-images/product-issues.png --- The [**Issues**](https://sentry.io/orgredirect/organizations/:orgslug/issues/) page in Sentry displays information about problems in your application. This page allows you to filter by properties such as browser, device, impacted users, or whether an error is unhandled. You can then inspect issue details to better understand the problem and [triage](/product/issues/states-triage/) effectively. diff --git a/docs/product/issues/issue-details/breadcrumbs/index.mdx b/docs/product/issues/issue-details/breadcrumbs/index.mdx index b65fb04e94a1e..2ffe7bb7eee1f 100644 --- a/docs/product/issues/issue-details/breadcrumbs/index.mdx +++ b/docs/product/issues/issue-details/breadcrumbs/index.mdx @@ -1,7 +1,8 @@ --- title: Using Breadcrumbs -description: "Learn about using breadcrumbs on the Issue Details page to help debug faster." +description: Learn about using breadcrumbs on the Issue Details page to help debug faster. sidebar_order: 60 +og_image: /og-images/product-issues-issue-details-breadcrumbs.png --- Sentry uses _breadcrumbs_ to create a trail of events that happened prior to an issue. These events are very similar to traditional logs, but can record more rich structured data. diff --git a/docs/product/issues/issue-details/error-issues/index.mdx b/docs/product/issues/issue-details/error-issues/index.mdx index a6ff9f2ebde01..bd0dd74ae051b 100644 --- a/docs/product/issues/issue-details/error-issues/index.mdx +++ b/docs/product/issues/issue-details/error-issues/index.mdx @@ -1,7 +1,10 @@ --- title: Error Issues sidebar_order: 10 -description: "Learn how to use the information on the Issue Details page to debug an error issue." +description: >- + Learn how to use the information on the Issue Details page to debug an error + issue. +og_image: /og-images/product-issues-issue-details-error-issues.png --- An _error issue_ is a grouping of error events. What counts as an error varies by platform, but in general, if there's something that looks like an exception, it can be captured as an error in Sentry. Sentry automatically captures errors, uncaught exceptions, and unhandled rejections, as well as other types of errors, depending on platform. We group similar error events into issues based on a fingerprint. For error issues, a fingerprint is primarily defined by the event stack trace. @@ -9,7 +12,7 @@ An _error issue_ is a grouping of error events. What counts as an error varies b ![Issue details](../img/issue-details-page.png) ## Subscribe to Issue Alerts -To subscribe to an error issue and receive alerts about it, click the bell icon, then fine tune [workflow notifications](/product/alerts/notifications/#workflow-notifications) related to the issue in **User Settings > Notifications**. +To subscribe to an error issue and receive alerts about it, click the bell icon, then fine tune [workflow notifications](/product/alerts/notifications/#workflow-notifications) related to the issue in **User Settings > Notifications**. ## Error Levels The event description is displayed just below the issue title along with an icon representing the error level of the event: diff --git a/docs/product/issues/issue-details/feature-flags/index.mdx b/docs/product/issues/issue-details/feature-flags/index.mdx index 1c144ea907ca5..3eb0e9d3364f6 100644 --- a/docs/product/issues/issue-details/feature-flags/index.mdx +++ b/docs/product/issues/issue-details/feature-flags/index.mdx @@ -1,7 +1,10 @@ --- -title: "Feature Flags" +title: Feature Flags sidebar_order: 100 -description: "Learn how to set up and interact with Sentry's feature flag evaluation tracking and feature flag change tracking." +description: >- + Learn how to set up and interact with Sentry's feature flag evaluation + tracking and feature flag change tracking. +og_image: /og-images/product-issues-issue-details-feature-flags.png --- @@ -48,7 +51,7 @@ Change tracking enables Sentry to listen for additions, removals, and modificati ![Flag Change Tracking](./img/FlagChangeTracking.png) -Within an issue, the audit log is represented in the "event" chart and presents itself as a "release" line. The lines will only appear for flags that were evaluated before the error event occurred; however, feature flag definition changes from the audit log can still occur after an error. This feature requires evaluation tracking to be enabled. +Within an issue, the audit log is represented in the "event" chart and presents itself as a "release" line. The lines will only appear for flags that were evaluated before the error event occurred; however, feature flag definition changes from the audit log can still occur after an error. This feature requires evaluation tracking to be enabled. ![Flag Change Issue](./img/FlagChangeIssue.png) diff --git a/docs/product/issues/issue-details/index.mdx b/docs/product/issues/issue-details/index.mdx index cb524911c96b0..dc169ca6ad513 100644 --- a/docs/product/issues/issue-details/index.mdx +++ b/docs/product/issues/issue-details/index.mdx @@ -1,7 +1,10 @@ --- title: Issue Details sidebar_order: 10 -description: "Learn how to navigate the Issue Details page to help you efficiently triage an issue." +description: >- + Learn how to navigate the Issue Details page to help you efficiently triage an + issue. +og_image: /og-images/product-issues-issue-details.png --- The **Issue Details** page helps you gain further insight into the source of the issue and the impact it has on your application's users. diff --git a/docs/product/issues/issue-details/performance-issues/consecutive-db-queries/index.mdx b/docs/product/issues/issue-details/performance-issues/consecutive-db-queries/index.mdx index e624ea9faa194..c2716aa6cb8e9 100644 --- a/docs/product/issues/issue-details/performance-issues/consecutive-db-queries/index.mdx +++ b/docs/product/issues/issue-details/performance-issues/consecutive-db-queries/index.mdx @@ -1,7 +1,9 @@ --- -title: "Consecutive DB Queries" +title: Consecutive DB Queries sidebar_order: 30 -description: "Learn more about Consecutive DB Queries and how to diagnose and fix them." +description: Learn more about Consecutive DB Queries and how to diagnose and fix them. +og_image: >- + /og-images/product-issues-issue-details-performance-issues-consecutive-db-queries.png --- Consecutive DB Queries are a sequence of database spans where one or more have been identified as parallelizable, in other words, spans that can be shifted to the start of the sequence. This often occurs when a DB query performs no filtering on the data, for example a query without a WHERE clause. diff --git a/docs/product/issues/issue-details/performance-issues/consecutive-http/index.mdx b/docs/product/issues/issue-details/performance-issues/consecutive-http/index.mdx index 685fe88c8fd43..78b31ac70acf4 100644 --- a/docs/product/issues/issue-details/performance-issues/consecutive-http/index.mdx +++ b/docs/product/issues/issue-details/performance-issues/consecutive-http/index.mdx @@ -1,7 +1,9 @@ --- -title: "Consecutive HTTP" +title: Consecutive HTTP sidebar_order: 30 -description: "Learn more about Consecutive HTTP issues and how to diagnose and fix them." +description: Learn more about Consecutive HTTP issues and how to diagnose and fix them. +og_image: >- + /og-images/product-issues-issue-details-performance-issues-consecutive-http.png --- Consecutive HTTP issues are created when a at least 2000ms of time can be saved by parallelizing a minimum of 3 consecutive HTTP calls occuring sequentially. diff --git a/docs/product/issues/issue-details/performance-issues/db-main-thread-io.mdx b/docs/product/issues/issue-details/performance-issues/db-main-thread-io.mdx index 7ef3a649674f7..09dd7eea22f9f 100644 --- a/docs/product/issues/issue-details/performance-issues/db-main-thread-io.mdx +++ b/docs/product/issues/issue-details/performance-issues/db-main-thread-io.mdx @@ -1,7 +1,11 @@ --- -title: "Database on Main Thread" +title: Database on Main Thread sidebar_order: 20 -description: "Learn more about Database on Main Thread issues and how to diagnose and fix them." +description: >- + Learn more about Database on Main Thread issues and how to diagnose and fix + them. +og_image: >- + /og-images/product-issues-issue-details-performance-issues-db-main-thread-io.png --- The main UI thread in a mobile application handles user interface events such as button presses and page scrolls. To prevent App Hangs and Application Not Responding errors, the main UI thread shouldn't be used for performing long-running operations like database queries. These kinds of operations block the whole UI until they finish running and get in the way of the user interacting with the app. diff --git a/docs/product/issues/issue-details/performance-issues/endpoint-regressions/index.mdx b/docs/product/issues/issue-details/performance-issues/endpoint-regressions/index.mdx index 5778a575b3984..d244f4ea893bc 100644 --- a/docs/product/issues/issue-details/performance-issues/endpoint-regressions/index.mdx +++ b/docs/product/issues/issue-details/performance-issues/endpoint-regressions/index.mdx @@ -1,7 +1,9 @@ --- -title: "Endpoint Regression" +title: Endpoint Regression sidebar_order: 41 -description: "Learn more about Endpoint Regression issues and how to diagnose and fix them." +description: Learn more about Endpoint Regression issues and how to diagnose and fix them. +og_image: >- + /og-images/product-issues-issue-details-performance-issues-endpoint-regressions.png --- Endpoint Regression issues are a generic class of problems where the duration of a transaction increases over time and degrades application performance. Sentry proactively monitors common endpoints out of the box and reports any possible regressions, grouping them as Endpoint Regression issue types. diff --git a/docs/product/issues/issue-details/performance-issues/file-main-thread-io.mdx b/docs/product/issues/issue-details/performance-issues/file-main-thread-io.mdx index 4111f0aa58a9f..a798433c02947 100644 --- a/docs/product/issues/issue-details/performance-issues/file-main-thread-io.mdx +++ b/docs/product/issues/issue-details/performance-issues/file-main-thread-io.mdx @@ -1,7 +1,11 @@ --- -title: "File I/O on Main Thread" +title: File I/O on Main Thread sidebar_order: 20 -description: "Learn more about File I/O on Main Thread and how to diagnose and fix these issues." +description: >- + Learn more about File I/O on Main Thread and how to diagnose and fix these + issues. +og_image: >- + /og-images/product-issues-issue-details-performance-issues-file-main-thread-io.png --- The main UI thread in a mobile application handles user interface events such as button presses and page scrolls. To prevent App Hangs and Application Not Responding errors, the main UI thread should not be used for performing long-running operations like file I/O. These kinds of operations block the whole UI until they finish running and get in the way of the user interacting with the app. diff --git a/docs/product/issues/issue-details/performance-issues/frame-drop/index.mdx b/docs/product/issues/issue-details/performance-issues/frame-drop/index.mdx index 61ae08868b9f6..42e09508355e2 100644 --- a/docs/product/issues/issue-details/performance-issues/frame-drop/index.mdx +++ b/docs/product/issues/issue-details/performance-issues/frame-drop/index.mdx @@ -1,7 +1,10 @@ --- -title: "Frame Drop" -description: "Learn more about how we detect Frame Drop issues and what you can do to fix them." +title: Frame Drop +description: >- + Learn more about how we detect Frame Drop issues and what you can do to fix + them. sidebar_order: 30 +og_image: /og-images/product-issues-issue-details-performance-issues-frame-drop.png --- The main (or UI) thread in a mobile app is responsible for handling all user interaction and needs to be able to respond to gestures and taps in real time. If a long-running operation blocks the main thread, the app becomes unresponsive, impacting the quality of the user experience. diff --git a/docs/product/issues/issue-details/performance-issues/http-overhead/index.mdx b/docs/product/issues/issue-details/performance-issues/http-overhead/index.mdx index 1e89ccd4e2f35..891e285ffe22e 100644 --- a/docs/product/issues/issue-details/performance-issues/http-overhead/index.mdx +++ b/docs/product/issues/issue-details/performance-issues/http-overhead/index.mdx @@ -1,7 +1,8 @@ --- -title: "HTTP/1.1 Overhead" +title: HTTP/1.1 Overhead sidebar_order: 30 -description: "Learn more about HTTP/1.1 Overhead issues and how to diagnose and fix them." +description: Learn more about HTTP/1.1 Overhead issues and how to diagnose and fix them. +og_image: /og-images/product-issues-issue-details-performance-issues-http-overhead.png --- HTTP/1.1 overhead issues are created when a set of overlapping HTTP spans for the same host are queued by the browser and have a queue time that consistently exceeds 500ms. diff --git a/docs/product/issues/issue-details/performance-issues/image-decoding-main-thread/index.mdx b/docs/product/issues/issue-details/performance-issues/image-decoding-main-thread/index.mdx index 2cbab908cacde..7bf0f853c3f79 100644 --- a/docs/product/issues/issue-details/performance-issues/image-decoding-main-thread/index.mdx +++ b/docs/product/issues/issue-details/performance-issues/image-decoding-main-thread/index.mdx @@ -1,7 +1,11 @@ --- -title: "Image Decoding on Main Thread" +title: Image Decoding on Main Thread sidebar_order: 30 -description: "Learn more about Image Decoding on Main Thread issues and how to diagnose and fix them." +description: >- + Learn more about Image Decoding on Main Thread issues and how to diagnose and + fix them. +og_image: >- + /og-images/product-issues-issue-details-performance-issues-image-decoding-main-thread.png --- The main (or UI) thread in a mobile app is responsible for handling all user interaction and needs to be able to respond to gestures and taps in real time. If a long-running operation blocks the main thread, the app becomes unresponsive, impacting the quality of the user experience. diff --git a/docs/product/issues/issue-details/performance-issues/index.mdx b/docs/product/issues/issue-details/performance-issues/index.mdx index 8122e1cd9e014..8999b2ebc3e93 100644 --- a/docs/product/issues/issue-details/performance-issues/index.mdx +++ b/docs/product/issues/issue-details/performance-issues/index.mdx @@ -1,7 +1,10 @@ --- -title: "Performance Issues" +title: Performance Issues sidebar_order: 20 -description: "Learn more about which performance issues Sentry detects and how to use the Issue Details page to debug them." +description: >- + Learn more about which performance issues Sentry detects and how to use the + Issue Details page to debug them. +og_image: /og-images/product-issues-issue-details-performance-issues.png --- A _performance issue_ is a grouping of transaction events that are performing poorly. If your application is configured for [Insights and Tracing](/product/insights/), Sentry will detect common performance problems, and group them into issues. We group similar transaction events into issues based on a fingerprint. For performance issues, a fingerprint is primarily based on the problem type and the spans involved in the problem. diff --git a/docs/product/issues/issue-details/performance-issues/json-decoding-main-thread/index.mdx b/docs/product/issues/issue-details/performance-issues/json-decoding-main-thread/index.mdx index fb4384951e1ff..858fe95c2b69d 100644 --- a/docs/product/issues/issue-details/performance-issues/json-decoding-main-thread/index.mdx +++ b/docs/product/issues/issue-details/performance-issues/json-decoding-main-thread/index.mdx @@ -1,7 +1,11 @@ --- -title: "JSON Decoding on Main Thread" +title: JSON Decoding on Main Thread sidebar_order: 30 -description: "Learn more about JSON Decoding on Main Thread issues and how to diagnose and fix them." +description: >- + Learn more about JSON Decoding on Main Thread issues and how to diagnose and + fix them. +og_image: >- + /og-images/product-issues-issue-details-performance-issues-json-decoding-main-thread.png --- The main (or UI) thread in a mobile app is responsible for handling all user interaction and needs to be able to respond to gestures and taps in real time. If a long-running operation blocks the main thread, the app becomes unresponsive, impacting the quality of the user experience. diff --git a/docs/product/issues/issue-details/performance-issues/large-http-payload/index.mdx b/docs/product/issues/issue-details/performance-issues/large-http-payload/index.mdx index 2347aefc6cf36..0841076682253 100644 --- a/docs/product/issues/issue-details/performance-issues/large-http-payload/index.mdx +++ b/docs/product/issues/issue-details/performance-issues/large-http-payload/index.mdx @@ -1,7 +1,9 @@ --- -title: "Large HTTP Payload" -description: "Learn more about Large HTTP Payload issues, how to diagnose and fix them." +title: Large HTTP Payload +description: 'Learn more about Large HTTP Payload issues, how to diagnose and fix them.' sidebar_order: 30 +og_image: >- + /og-images/product-issues-issue-details-performance-issues-large-http-payload.png --- Large HTTP Payload issues are created when an http span has an encoded body size that exceeds a threshold. diff --git a/docs/product/issues/issue-details/performance-issues/large-render-blocking-asset/index.mdx b/docs/product/issues/issue-details/performance-issues/large-render-blocking-asset/index.mdx index 05d4d0e7fb9e6..d0ee2a68efe08 100644 --- a/docs/product/issues/issue-details/performance-issues/large-render-blocking-asset/index.mdx +++ b/docs/product/issues/issue-details/performance-issues/large-render-blocking-asset/index.mdx @@ -1,7 +1,11 @@ --- -title: "Large Render Blocking Asset" +title: Large Render Blocking Asset sidebar_order: 30 -description: "Learn more about Large Render Blocking Assets and how to diagnose and fix them." +description: >- + Learn more about Large Render Blocking Assets and how to diagnose and fix + them. +og_image: >- + /og-images/product-issues-issue-details-performance-issues-large-render-blocking-asset.png --- A _Large Render Blocking Asset_ is a performance problem that happens when a large asset causes a delay in displaying the page content. For example, if a page includes a stylesheet, and the browser pauses page rendering until the entire stylesheet downloads and processes. If that stylesheet is large, the user may see a blank or unstyled screen for a long time. This problem occurs when applications don't split up asset files, load non-essential assets synchronously, or load assets too early. diff --git a/docs/product/issues/issue-details/performance-issues/n-one-api-calls.mdx b/docs/product/issues/issue-details/performance-issues/n-one-api-calls.mdx index ebe5ed7991d8e..c84a9f509e479 100644 --- a/docs/product/issues/issue-details/performance-issues/n-one-api-calls.mdx +++ b/docs/product/issues/issue-details/performance-issues/n-one-api-calls.mdx @@ -1,7 +1,8 @@ --- -title: "N+1 API Calls" +title: N+1 API Calls sidebar_order: 15 -description: "Learn more about N+1 API Calls and how to diagnose and fix them." +description: Learn more about N+1 API Calls and how to diagnose and fix them. +og_image: /og-images/product-issues-issue-details-performance-issues-n-one-api-calls.png --- _N+1 API Calls_ are a performance problem that happens when an application makes many simultaneous network requests to fetch a given type of resource. For example, when an application makes one network request for each item on a list instead of fetching all the information at once in a single combined network call. Each call to the server incurs performance overhead, and if the number of calls is high, it can lead to significant performance problems. This problem commonly occurs when rendering lists or grids of items, where each item needs to fetch additional information from the server. diff --git a/docs/product/issues/issue-details/performance-issues/n-one-queries.mdx b/docs/product/issues/issue-details/performance-issues/n-one-queries.mdx index 9a7c451faafaf..1e5f9c3cd2f2e 100644 --- a/docs/product/issues/issue-details/performance-issues/n-one-queries.mdx +++ b/docs/product/issues/issue-details/performance-issues/n-one-queries.mdx @@ -1,7 +1,8 @@ --- -title: "N+1 Queries" +title: N+1 Queries sidebar_order: 10 -description: "Learn more about N+1 Queries and how to diagnose and fix them." +description: Learn more about N+1 Queries and how to diagnose and fix them. +og_image: /og-images/product-issues-issue-details-performance-issues-n-one-queries.png --- _N+1 Queries_ are a performance problem in which the application makes database queries in a loop, instead of making a single query that returns or modifies all the information at once. Each database connection takes some amount of time, so querying the database in a loop can be many times slower than doing it just once. This problem often occurs when you use an object-relational mapping (ORM) tool in web frameworks like Django or Ruby on Rails. diff --git a/docs/product/issues/issue-details/performance-issues/regex-main-thread/index.mdx b/docs/product/issues/issue-details/performance-issues/regex-main-thread/index.mdx index d1fdfec67e641..815b1583fd9f8 100644 --- a/docs/product/issues/issue-details/performance-issues/regex-main-thread/index.mdx +++ b/docs/product/issues/issue-details/performance-issues/regex-main-thread/index.mdx @@ -1,7 +1,9 @@ --- -title: "Regex on Main Thread" +title: Regex on Main Thread sidebar_order: 30 -description: "Learn more about Regex on Main Thread issues and how to diagnose and fix them." +description: Learn more about Regex on Main Thread issues and how to diagnose and fix them. +og_image: >- + /og-images/product-issues-issue-details-performance-issues-regex-main-thread.png --- The main (or UI) thread in a mobile app is responsible for handling all user interaction and needs to be able to respond to gestures and taps in real time. If a long-running operation blocks the main thread, the app becomes unresponsive, impacting the quality of the user experience. diff --git a/docs/product/issues/issue-details/performance-issues/slow-db-queries/index.mdx b/docs/product/issues/issue-details/performance-issues/slow-db-queries/index.mdx index 810275e7452b0..6597be509f893 100644 --- a/docs/product/issues/issue-details/performance-issues/slow-db-queries/index.mdx +++ b/docs/product/issues/issue-details/performance-issues/slow-db-queries/index.mdx @@ -1,7 +1,8 @@ --- -title: "Slow DB Queries" +title: Slow DB Queries sidebar_order: 30 -description: "Learn more about Slow DB Query issues and how to diagnose and fix them." +description: Learn more about Slow DB Query issues and how to diagnose and fix them. +og_image: /og-images/product-issues-issue-details-performance-issues-slow-db-queries.png --- Slow DB Query issues are created when a particular `SELECT` SQL query in your application consistently takes longer than `500ms` to resolve. diff --git a/docs/product/issues/issue-details/performance-issues/uncompressed-asset/index.mdx b/docs/product/issues/issue-details/performance-issues/uncompressed-asset/index.mdx index 12d268052b653..e6d9389f5f892 100644 --- a/docs/product/issues/issue-details/performance-issues/uncompressed-asset/index.mdx +++ b/docs/product/issues/issue-details/performance-issues/uncompressed-asset/index.mdx @@ -1,7 +1,9 @@ --- -title: "Uncompressed Asset" +title: Uncompressed Asset sidebar_order: 30 -description: "Learn more about Uncompressed Asset issues and how to diagnose and fix them." +description: Learn more about Uncompressed Asset issues and how to diagnose and fix them. +og_image: >- + /og-images/product-issues-issue-details-performance-issues-uncompressed-asset.png --- Uncompressed Asset issues happen when a file that needs to be downloaded in order to load a browser page, doesn’t get compressed while being transferred. This may indicate a misconfiguration of the server or CDN (content delivery network) that’s serving the asset file. diff --git a/docs/product/issues/issue-details/replay-issues/hydration-error.mdx b/docs/product/issues/issue-details/replay-issues/hydration-error.mdx index c303c890800bf..2bfa537a93e31 100644 --- a/docs/product/issues/issue-details/replay-issues/hydration-error.mdx +++ b/docs/product/issues/issue-details/replay-issues/hydration-error.mdx @@ -1,7 +1,8 @@ --- title: Hydration Error sidebar_order: 50 -description: "Learn about Session Replay hydration errors." +description: Learn about Session Replay hydration errors. +og_image: /og-images/product-issues-issue-details-replay-issues-hydration-error.gif --- Hydration errors are a React-specific problem that happen when the initial client UI does not match what was rendered on the server. They can result in extra work for the browser, and a slower pageload experience for users. diff --git a/docs/product/issues/issue-details/replay-issues/rage-clicks.mdx b/docs/product/issues/issue-details/replay-issues/rage-clicks.mdx index 2b397cb6ffc16..a7c61ed5746fd 100644 --- a/docs/product/issues/issue-details/replay-issues/rage-clicks.mdx +++ b/docs/product/issues/issue-details/replay-issues/rage-clicks.mdx @@ -1,7 +1,8 @@ --- title: Rage Click Issues sidebar_order: 40 -description: "Learn about Session Replay rage click issues." +description: Learn about Session Replay rage click issues. +og_image: /og-images/product-issues-issue-details-replay-issues-rage-clicks.png --- If you've enabled [Session Replay](/product/explore/session-replay/), you'll be able to see rage click issues on the [**Issues**](https://sentry.io/orgredirect/organizations/:orgslug/issues/) page in Sentry. Rage clicks are a series of consecutive clicks on the same unresponsive page element. They are a strong signal of user frustration and most likely deserve your attention. diff --git a/docs/product/issues/issue-details/uptime-issues/index.mdx b/docs/product/issues/issue-details/uptime-issues/index.mdx index 3b7e116bf53de..dd92ff837a4fd 100644 --- a/docs/product/issues/issue-details/uptime-issues/index.mdx +++ b/docs/product/issues/issue-details/uptime-issues/index.mdx @@ -1,7 +1,10 @@ --- title: Uptime Issues sidebar_order: 40 -description: "Learn how to use the information on the Issue Details page to debug an error issue." +description: >- + Learn how to use the information on the Issue Details page to debug an error + issue. +og_image: /og-images/product-issues-issue-details-uptime-issues.png --- An uptime issue is a grouping of detected downtime events for a specific URL. A downtime event is generated by diff --git a/docs/product/issues/issue-priority/index.mdx b/docs/product/issues/issue-priority/index.mdx index 00de14a6ccde2..9abca8cd6b877 100644 --- a/docs/product/issues/issue-priority/index.mdx +++ b/docs/product/issues/issue-priority/index.mdx @@ -1,7 +1,8 @@ --- title: Issue Priority sidebar_order: 31 -description: "Learn how Sentry prioritizes issue actionability." +description: Learn how Sentry prioritizes issue actionability. +og_image: /og-images/product-issues-issue-priority.png --- Issue priority sorts the issues Sentry receives into **High**, **Medium** and **Low** priority buckets. This helps you identify and address critical, high-priority errors that may be impacting your application's functionality and user experience first. diff --git a/docs/product/issues/issue-views/index.mdx b/docs/product/issues/issue-views/index.mdx index 6c6b1202fb40b..6a08b1be388b8 100644 --- a/docs/product/issues/issue-views/index.mdx +++ b/docs/product/issues/issue-views/index.mdx @@ -1,7 +1,8 @@ --- title: Issue Views sidebar_order: 9 -description: "Learn how to create, customize, and share your Issues experience in Sentry." +description: 'Learn how to create, customize, and share your Issues experience in Sentry.' +og_image: /og-images/product-issues-issue-views.png --- Issue views let you customize and share your issue stream, so you and your teammates can quickly see the issues that are most relevant to you. diff --git a/docs/product/issues/ownership-rules/index.mdx b/docs/product/issues/ownership-rules/index.mdx index 63b91119abd74..79ca87269aa1d 100644 --- a/docs/product/issues/ownership-rules/index.mdx +++ b/docs/product/issues/ownership-rules/index.mdx @@ -1,7 +1,10 @@ --- -title: "Ownership Rules" +title: Ownership Rules sidebar_order: 40 -description: "Learn how to set up ownership rules to automatically assign issues to the right owners." +description: >- + Learn how to set up ownership rules to automatically assign issues to the + right owners. +og_image: /og-images/product-issues-ownership-rules.png --- @@ -143,7 +146,7 @@ The matches, in order, are: ] ``` -Sentry will return the last matching rule, which in this case is `path:backend/endpoints/auth/* #auth-team #enterprise-team`. Although there are two owners in the last matching rule, Sentry will assign the issue to the first owner, `#auth-team`. +Sentry will return the last matching rule, which in this case is `path:backend/endpoints/auth/* #auth-team #enterprise-team`. Although there are two owners in the last matching rule, Sentry will assign the issue to the first owner, `#auth-team`. ## Where It's Applied diff --git a/docs/product/issues/reprocessing/index.mdx b/docs/product/issues/reprocessing/index.mdx index 8be34751b7ce3..7b03a870efad7 100644 --- a/docs/product/issues/reprocessing/index.mdx +++ b/docs/product/issues/reprocessing/index.mdx @@ -2,6 +2,7 @@ title: Reprocessing sidebar_order: 50 description: Learn about reprocessing errors with new debug files. +og_image: /og-images/product-issues-reprocessing.png --- Sentry uses [debug information diff --git a/docs/product/issues/states-triage/escalating-issues/index.mdx b/docs/product/issues/states-triage/escalating-issues/index.mdx index a7a277c400360..14715076215fd 100644 --- a/docs/product/issues/states-triage/escalating-issues/index.mdx +++ b/docs/product/issues/states-triage/escalating-issues/index.mdx @@ -1,7 +1,8 @@ --- title: Escalating Issues Algorithm sidebar_order: 40 -description: "Learn how the escalating issues algorithm works." +description: Learn how the escalating issues algorithm works. +og_image: /og-images/product-issues-states-triage-escalating-issues.png --- diff --git a/docs/product/issues/states-triage/index.mdx b/docs/product/issues/states-triage/index.mdx index ef7f2bbd1c970..0b45154c9b3c8 100644 --- a/docs/product/issues/states-triage/index.mdx +++ b/docs/product/issues/states-triage/index.mdx @@ -1,7 +1,8 @@ --- title: Issue Status sidebar_order: 30 -description: "Learn how issue status works and and how to triage issues." +description: Learn how issue status works and and how to triage issues. +og_image: /og-images/product-issues-states-triage.png --- Use the status tags attached to issues on the [**Issues** page](https://sentry.io/issues/) in Sentry to help you triage and prioritize problems with your application that are important to you. Keep in mind that an issue can only have **one status at a time.** diff --git a/docs/product/issues/suspect-commits/index.mdx b/docs/product/issues/suspect-commits/index.mdx index 12dfa8205960b..8bc6e0ddf5bbe 100644 --- a/docs/product/issues/suspect-commits/index.mdx +++ b/docs/product/issues/suspect-commits/index.mdx @@ -1,7 +1,10 @@ --- title: Suspect Commits sidebar_order: 32 -description: "With suspect commits, you can see the most recent commit to your code in the stack trace. Learn more about how integrations enable suspect commits here." +description: >- + With suspect commits, you can see the most recent commit to your code in the + stack trace. Learn more about how integrations enable suspect commits here. +og_image: /og-images/product-issues-suspect-commits.png --- diff --git a/docs/product/onboarding/index.mdx b/docs/product/onboarding/index.mdx index 359c8e5222cbf..19628958792b7 100644 --- a/docs/product/onboarding/index.mdx +++ b/docs/product/onboarding/index.mdx @@ -1,14 +1,15 @@ --- title: Quick-Start Guide -description: "An easy onboarding guide for Sentry." +description: An easy onboarding guide for Sentry. sidebar_order: 4000 +og_image: /og-images/product-onboarding.png --- By the end of this guide, you'll be able to create and configure projects in Sentry to gain detailed insights into issues, including the exact lines of code affected, the environment in which they occurred, and the releases they originated from. Additionally, we'll walk you through Sentry's most essential integrations and SSO/SCIM configuration. If you get stuck anywhere, please [Ask Sentry AI](https://sentry.zendesk.com/hc/en-us?askAI=true) or join our [Discord](https://discord.gg/sentry) community. ## Step 1: Initial Project Creation and Configuration -By the end of this step, you'll have enabled a few features, mapped data into Sentry, and added important metadata like environments and releases to help you filter. +By the end of this step, you'll have enabled a few features, mapped data into Sentry, and added important metadata like environments and releases to help you filter. 1. Sentry's in-app project creation workflow allows you to enable Tracing and Session Replay. Check out this [step-by-step walkthrough](https://sentry.io/orgredirect/projects/new/) on creating and configuring a Sentry project within your environment. At a minimum, this will allow you to take advantage of the free allocated Tracing and Session replay quota. @@ -16,13 +17,13 @@ By the end of this step, you'll have enabled a few features, mapped data into Se - Source Maps (JS) and Debug Symbols are crucial for translating minified or obfuscated code back into a human-readable format, allowing you to pinpoint the exact lines of code causing your issues. Here you can find instructions for [JavaScript](/platforms/javascript/sourcemaps/uploading/) as well as [Android](/platforms/android/enhance-errors/source-context/) and [iOS](/platforms/apple/guides/ios/sourcecontext/). - + 3. Add [Environments](/concepts/key-terms/environments/#creating-environments) and [Releases](/platform-redirect/?next=/configuration/releases/) to Your Sentry init. - Set up environments (production, staging, etc.) and releases in Sentry to streamline error tracking. Environments filter issues by context, while releasing link errors to code versions for easier debugging. - + @@ -40,7 +41,7 @@ SCM (GitHub) integration highlights include: - [Stack trace linking](/organization/integrations/source-code-mgmt/github/#stack-trace-linking) - [Highlight suspect commits within an issue detail](/organization/integrations/source-code-mgmt/github/#suspect-commits-and-suggested-assignees) - [Automatically link code owners](/organization/integrations/source-code-mgmt/github/#code-owners) - + diff --git a/docs/product/relay/getting-started.mdx b/docs/product/relay/getting-started.mdx index bc18dfc095a85..dfb50909562fa 100644 --- a/docs/product/relay/getting-started.mdx +++ b/docs/product/relay/getting-started.mdx @@ -1,7 +1,8 @@ --- title: Getting Started -description: "Learn how to get started with Relay, Sentry's data security solution." +description: 'Learn how to get started with Relay, Sentry''s data security solution.' sidebar_order: 1 +og_image: /og-images/product-relay-getting-started.png --- Getting started with [Relay](/product/relay/) is as simple as using the default settings. You can also configure Relay to suit your organization's needs. Check the [Configuration Options](../options/) page for a detailed discussion of operating scenarios. diff --git a/docs/product/releases/health/index.mdx b/docs/product/releases/health/index.mdx index 96a25646ef514..39ed4b48be48f 100644 --- a/docs/product/releases/health/index.mdx +++ b/docs/product/releases/health/index.mdx @@ -1,7 +1,10 @@ --- title: Release Health sidebar_order: 50 -description: "Monitor the health of releases by observing user adoption, usage of the application, percentage of crashes, and session data." +description: >- + Monitor the health of releases by observing user adoption, usage of the + application, percentage of crashes, and session data. +og_image: /og-images/product-releases-health.png --- diff --git a/docs/product/releases/index.mdx b/docs/product/releases/index.mdx index 672249bb01585..392413df750c8 100644 --- a/docs/product/releases/index.mdx +++ b/docs/product/releases/index.mdx @@ -1,7 +1,11 @@ --- title: Releases sidebar_order: 110 -description: "Learn how to provide Sentry with important information about your releases, such as release health and release details, to determine regressions and resolve issues faster." +description: >- + Learn how to provide Sentry with important information about your releases, + such as release health and release details, to determine regressions and + resolve issues faster. +og_image: /og-images/product-releases.png --- diff --git a/docs/product/releases/release-details.mdx b/docs/product/releases/release-details.mdx index f72716e953223..f731097de44d7 100644 --- a/docs/product/releases/release-details.mdx +++ b/docs/product/releases/release-details.mdx @@ -1,7 +1,8 @@ --- title: Release Details sidebar_order: 40 -description: "Learn more about the details of individual releases." +description: Learn more about the details of individual releases. +og_image: /og-images/product-releases-release-details.png --- The **Release Details** page focuses on an individual release. Elements of the release are displayed, such as visualized trends for crashes and sessions, specifics regarding each issue, adoption graphs, and commit author breakdowns. diff --git a/docs/product/releases/releases-throughout-sentry/index.mdx b/docs/product/releases/releases-throughout-sentry/index.mdx index 523ad4f964e4d..e6f179242c9d7 100644 --- a/docs/product/releases/releases-throughout-sentry/index.mdx +++ b/docs/product/releases/releases-throughout-sentry/index.mdx @@ -1,7 +1,8 @@ --- title: Using Releases Across Sentry sidebar_order: 60 -description: "Learn how to use releases throughout Sentry's product." +description: Learn how to use releases throughout Sentry's product. +og_image: /og-images/product-releases-releases-throughout-sentry.png --- ## Charts diff --git a/docs/product/releases/setup/release-automation/circleci/index.mdx b/docs/product/releases/setup/release-automation/circleci/index.mdx index a447d9fb7d351..ce52289359117 100644 --- a/docs/product/releases/setup/release-automation/circleci/index.mdx +++ b/docs/product/releases/setup/release-automation/circleci/index.mdx @@ -1,6 +1,9 @@ --- title: CircleCI -description: "Learn how Sentry and CircleCI automate release management and help identify suspect commits." +description: >- + Learn how Sentry and CircleCI automate release management and help identify + suspect commits. +og_image: /og-images/product-releases-setup-release-automation-circleci.png --- This guide walks you through the process of automating Sentry release management and deploy notifications in CircleCI. After deploying in CircleCI, you’ll be able to associate commits with releases. You'll also be able to apply source maps to see the original code in Sentry. diff --git a/docs/product/releases/setup/release-automation/github-actions/index.mdx b/docs/product/releases/setup/release-automation/github-actions/index.mdx index 23701844d0929..74b1d52b0be3f 100644 --- a/docs/product/releases/setup/release-automation/github-actions/index.mdx +++ b/docs/product/releases/setup/release-automation/github-actions/index.mdx @@ -1,6 +1,9 @@ --- title: GitHub Actions -description: "Learn how Sentry and GitHub Actions automate release management, upload source maps and help identify suspect commits." +description: >- + Learn how Sentry and GitHub Actions automate release management, upload source + maps and help identify suspect commits. +og_image: /og-images/product-releases-setup-release-automation-github-actions.png --- The [Sentry Release GitHub Action](https://github.com/marketplace/actions/sentry-release) automates Sentry release management in GitHub with just one step. After sending Sentry release information, you’ll be able to associate commits with releases. Additionally, you can upload source maps to view original, un-minified source code. diff --git a/docs/product/releases/setup/release-automation/index.mdx b/docs/product/releases/setup/release-automation/index.mdx index e2d8b53830c13..5dc80621283cb 100644 --- a/docs/product/releases/setup/release-automation/index.mdx +++ b/docs/product/releases/setup/release-automation/index.mdx @@ -1,7 +1,10 @@ --- title: Automatic Release Management sidebar_order: 10 -description: "Learn how Sentry release management can be automated using any continuous integration and delivery (CI/CD) platform or automation server." +description: >- + Learn how Sentry release management can be automated using any continuous + integration and delivery (CI/CD) platform or automation server. +og_image: /og-images/product-releases-setup-release-automation.png --- Sentry release management can be automated using any continuous integration and delivery (CI/CD) platform or automation server. diff --git a/docs/product/releases/setup/release-automation/jenkins/index.mdx b/docs/product/releases/setup/release-automation/jenkins/index.mdx index 2f6c30cddb7c2..7399828923267 100644 --- a/docs/product/releases/setup/release-automation/jenkins/index.mdx +++ b/docs/product/releases/setup/release-automation/jenkins/index.mdx @@ -1,6 +1,9 @@ --- title: Jenkins -description: "Learn how Sentry and Jenkins automate release management and help identify suspect commits." +description: >- + Learn how Sentry and Jenkins automate release management and help identify + suspect commits. +og_image: /og-images/product-releases-setup-release-automation-jenkins.png --- This guide walks you through the process of automating Sentry release management and deploy notifications in Jenkins. After deploying in Jenkins, you’ll be able to associate commits with releases. You'll also be able to apply source maps to see the original code in Sentry. diff --git a/docs/product/releases/setup/release-automation/travis-ci/index.mdx b/docs/product/releases/setup/release-automation/travis-ci/index.mdx index d607837f0e72b..e0626be70542b 100644 --- a/docs/product/releases/setup/release-automation/travis-ci/index.mdx +++ b/docs/product/releases/setup/release-automation/travis-ci/index.mdx @@ -1,6 +1,9 @@ --- title: Travis CI -description: "Learn how Sentry and Travis CI automate release management and help identify suspect commits." +description: >- + Learn how Sentry and Travis CI automate release management and help identify + suspect commits. +og_image: /og-images/product-releases-setup-release-automation-travis-ci.png --- This guide walks you through the process of automating Sentry release management and deploy notifications in Travis CI. After deploying in Travis CI, you’ll be able to identify suspect commits that are likely the culprit for new errors. You’ll also be able to apply source maps to see the original code in Sentry. diff --git a/docs/product/releases/usage/archive-release.mdx b/docs/product/releases/usage/archive-release.mdx index b93f9906d80d5..a05e8d694ec5c 100644 --- a/docs/product/releases/usage/archive-release.mdx +++ b/docs/product/releases/usage/archive-release.mdx @@ -1,7 +1,8 @@ --- title: Archive a Release sidebar_order: 30 -description: "Learn how to permanently hide or archive a release." +description: Learn how to permanently hide or archive a release. +og_image: /og-images/product-releases-usage-archive-release.png --- Since an event received from a deleted release automatically recreates it, Sentry has an option to hide, or archive, releases. Archiving can also be useful if you're no longer interested in viewing a release or if you've accidentally created a release you no longer want to track. diff --git a/docs/product/releases/usage/restore-release.mdx b/docs/product/releases/usage/restore-release.mdx index 502f113870e0a..f8e8c3b4ca21b 100644 --- a/docs/product/releases/usage/restore-release.mdx +++ b/docs/product/releases/usage/restore-release.mdx @@ -1,7 +1,8 @@ --- title: Restore a Release sidebar_order: 40 -description: "Learn how to restore an archived release." +description: Learn how to restore an archived release. +og_image: /og-images/product-releases-usage-restore-release.png --- You can restore archived releases using either [sentry.io](https://sentry.io) or the Sentry CLI. diff --git a/docs/product/sentry-basics/distributed-tracing/initialize-sentry-sdk-frontend.mdx b/docs/product/sentry-basics/distributed-tracing/initialize-sentry-sdk-frontend.mdx index 8bb3a4517745a..0a8cd85c66df9 100644 --- a/docs/product/sentry-basics/distributed-tracing/initialize-sentry-sdk-frontend.mdx +++ b/docs/product/sentry-basics/distributed-tracing/initialize-sentry-sdk-frontend.mdx @@ -1,7 +1,9 @@ --- title: Add the Sentry SDK to Your Frontend Project sidebar_order: 3 -description: "Learn how to add the Sentry SDK to your frontend codebase." +description: Learn how to add the Sentry SDK to your frontend codebase. +og_image: >- + /og-images/product-sentry-basics-distributed-tracing-initialize-sentry-sdk-frontend.png --- This section walks you through how to import the sample application into your local development environment, add the Sentry SDK, and initialize it. diff --git a/docs/product/sentry-basics/integrate-backend/capturing-errors.mdx b/docs/product/sentry-basics/integrate-backend/capturing-errors.mdx index 3b5547ba8ff5b..993be01a3c9a7 100644 --- a/docs/product/sentry-basics/integrate-backend/capturing-errors.mdx +++ b/docs/product/sentry-basics/integrate-backend/capturing-errors.mdx @@ -1,7 +1,10 @@ --- title: Capturing Errors sidebar_order: 3 -description: "Learn how Sentry captures unhandled errors and handled errors to enrich your event data." +description: >- + Learn how Sentry captures unhandled errors and handled errors to enrich your + event data. +og_image: /og-images/product-sentry-basics-integrate-backend-capturing-errors.png --- Once initialized in your code, the Sentry SDK will capture errors and various types of events to notify you about them in real-time, depending on the alert rules you've configured. With the Django app already running on your [localhost](http://localhost:8000/), let's try them out. diff --git a/docs/product/sentry-basics/integrate-backend/configuration-options.mdx b/docs/product/sentry-basics/integrate-backend/configuration-options.mdx index 832e0f805818b..4e73e17a1ccd8 100644 --- a/docs/product/sentry-basics/integrate-backend/configuration-options.mdx +++ b/docs/product/sentry-basics/integrate-backend/configuration-options.mdx @@ -1,7 +1,10 @@ --- title: Configuration Options sidebar_order: 2 -description: "Learn how to configure releases, breadcrumbs, and environments to enhance the SDK's functionality." +description: >- + Learn how to configure releases, breadcrumbs, and environments to enhance the + SDK's functionality. +og_image: /og-images/product-sentry-basics-integrate-backend-configuration-options.png --- Sentry has various configuration options to help enhance the SDK functionality. The options can help provide additional data needed to debug issues even faster or to help control what's sent to Sentry by filtering. Learn more in [Configuration](/platforms/python/configuration/). diff --git a/docs/product/sentry-basics/integrate-backend/getting-started.mdx b/docs/product/sentry-basics/integrate-backend/getting-started.mdx index 4c61b0a626228..35a0898a7b3a7 100644 --- a/docs/product/sentry-basics/integrate-backend/getting-started.mdx +++ b/docs/product/sentry-basics/integrate-backend/getting-started.mdx @@ -1,7 +1,10 @@ --- title: Getting Started sidebar_order: 1 -description: "Learn how to add and initialize the Sentry SDK for a sample backend application." +description: >- + Learn how to add and initialize the Sentry SDK for a sample backend + application. +og_image: /og-images/product-sentry-basics-integrate-backend-getting-started.png --- In this tutorial, you'll import the backend app source code into your local development environment, add the Sentry SDK, and initialize it. diff --git a/docs/product/sentry-basics/integrate-frontend/configure-scms.mdx b/docs/product/sentry-basics/integrate-frontend/configure-scms.mdx index 8f66e3de8177f..e8fad0919b760 100644 --- a/docs/product/sentry-basics/integrate-frontend/configure-scms.mdx +++ b/docs/product/sentry-basics/integrate-frontend/configure-scms.mdx @@ -1,7 +1,11 @@ --- title: Enable Suspect Commits & Stack Trace Linking sidebar_order: 5 -description: "Learn how to integrate your source code with Sentry, so that Sentry can track commits and surface suspect commits and suggested assignees to help you resolve issues faster." +description: >- + Learn how to integrate your source code with Sentry, so that Sentry can track + commits and surface suspect commits and suggested assignees to help you + resolve issues faster. +og_image: /og-images/product-sentry-basics-integrate-frontend-configure-scms.png --- diff --git a/docs/product/sentry-basics/integrate-frontend/generate-first-error.mdx b/docs/product/sentry-basics/integrate-frontend/generate-first-error.mdx index 437feeaf3e502..3370bce69490d 100644 --- a/docs/product/sentry-basics/integrate-frontend/generate-first-error.mdx +++ b/docs/product/sentry-basics/integrate-frontend/generate-first-error.mdx @@ -1,7 +1,8 @@ --- title: Capture Your First Error sidebar_order: 3 -description: "Learn how to capture your first error and view it in Sentry." +description: Learn how to capture your first error and view it in Sentry. +og_image: /og-images/product-sentry-basics-integrate-frontend-generate-first-error.png --- Now that the sample app is up and running on your local environment integrated with the Sentry SDK, you're ready to generate the first error. diff --git a/docs/product/sentry-basics/integrate-frontend/initialize-sentry-sdk.mdx b/docs/product/sentry-basics/integrate-frontend/initialize-sentry-sdk.mdx index b8b2226f4190e..639c70dc6e9f7 100644 --- a/docs/product/sentry-basics/integrate-frontend/initialize-sentry-sdk.mdx +++ b/docs/product/sentry-basics/integrate-frontend/initialize-sentry-sdk.mdx @@ -1,7 +1,8 @@ --- title: Add the Sentry SDK to Your Project sidebar_order: 2 -description: "Learn how to add the Sentry SDK to your frontend codebase." +description: Learn how to add the Sentry SDK to your frontend codebase. +og_image: /og-images/product-sentry-basics-integrate-frontend-initialize-sentry-sdk.png --- This section walks you through how to import the sample application into your local development environment, add the Sentry SDK, and initialize it. diff --git a/docs/product/sentry-basics/integrate-frontend/upload-source-maps.mdx b/docs/product/sentry-basics/integrate-frontend/upload-source-maps.mdx index 8d7a52f4c7511..0ac41cc54fe34 100644 --- a/docs/product/sentry-basics/integrate-frontend/upload-source-maps.mdx +++ b/docs/product/sentry-basics/integrate-frontend/upload-source-maps.mdx @@ -1,7 +1,10 @@ --- title: Enable Readable Stack Traces in Your Errors sidebar_order: 4 -description: "Learn how to upload source maps to enable readable stack traces in your errors." +description: >- + Learn how to upload source maps to enable readable stack traces in your + errors. +og_image: /og-images/product-sentry-basics-integrate-frontend-upload-source-maps.png --- When creating web applications, most development workflows involve transforming your JavaScript code via transpilation and minification to make it run more efficiently in the browser. Source map files serve as a guide for tools like Sentry to convert the transformed version of your JavaScript back to the code that you wrote. Source map files can be generated by your JavaScript build tool. diff --git a/docs/product/sentry-basics/user-feedback-basics.mdx b/docs/product/sentry-basics/user-feedback-basics.mdx index 66d6b329c4a76..57176534cafcd 100644 --- a/docs/product/sentry-basics/user-feedback-basics.mdx +++ b/docs/product/sentry-basics/user-feedback-basics.mdx @@ -1,10 +1,13 @@ --- -title: "User Feedback Basics" +title: User Feedback Basics sidebar_order: 2 -description: "Learn how to configure and deploy Sentry's User Feedback widget to capture qualitative insights from your users." +description: >- + Learn how to configure and deploy Sentry's User Feedback widget to capture + qualitative insights from your users. +og_image: /og-images/product-sentry-basics-user-feedback-basics.png --- -Sentry's [User Feedback Widget](/product/user-feedback/) is a powerful tool for capturing qualitative insights from real users, and is especially valuable during the rollout of new or beta features. It can also be used to collect feedback from your fellow team members during an internal release. +Sentry's [User Feedback Widget](/product/user-feedback/) is a powerful tool for capturing qualitative insights from real users, and is especially valuable during the rollout of new or beta features. It can also be used to collect feedback from your fellow team members during an internal release. If you treat user feedback as a core signal in product development, especially for betas and early adopter programs, your final product will result in a better user experience. Once you've configured feedback, we recommend adding feedback reviews into planning, stand-ups, or retros to help inform product direction and roadmap decisions. @@ -30,7 +33,7 @@ import * as Sentry from "@sentry/react"; function FeedbackButton() { const feedback = Sentry.getFeedback(); - + if (!feedback) { return null; } @@ -69,7 +72,7 @@ Here are examples of placeholder text to guide users: > How was your experience with [your feature's name]? -> How can we make your experience better? +> How can we make your experience better? > We're still building out [your feature's name] - how can we make it better? @@ -133,7 +136,7 @@ import { Fragment } from "react"; export default function ThumbsUpDownButtons({source}: {source: string) { const feedback = Sentry.getFeedback(); - + return ( Was this helpful? diff --git a/docs/product/sentry-mcp/index.mdx b/docs/product/sentry-mcp/index.mdx index ce6f0d39bacee..434c439abff91 100644 --- a/docs/product/sentry-mcp/index.mdx +++ b/docs/product/sentry-mcp/index.mdx @@ -1,7 +1,10 @@ --- title: Sentry MCP Server sidebar_order: 120 -description: "Enable secure connectivity between Sentry issues and debugging data, and LLM clients, using a Model Context Protocol (MCP) server." +description: >- + Enable secure connectivity between Sentry issues and debugging data, and LLM + clients, using a Model Context Protocol (MCP) server. +og_image: /og-images/product-sentry-mcp.png --- diff --git a/docs/product/sentry-toolbar/index.mdx b/docs/product/sentry-toolbar/index.mdx index d54662f3eac7d..d10c58736b7fe 100644 --- a/docs/product/sentry-toolbar/index.mdx +++ b/docs/product/sentry-toolbar/index.mdx @@ -1,7 +1,10 @@ --- title: Sentry Toolbar sidebar_order: 110 -description: "Bring critical Sentry insights and tools directly into your web app for easier troubleshooting with the Sentry Toolbar." +description: >- + Bring critical Sentry insights and tools directly into your web app for easier + troubleshooting with the Sentry Toolbar. +og_image: /og-images/product-sentry-toolbar.png --- diff --git a/docs/product/sentry-toolbar/setup.mdx b/docs/product/sentry-toolbar/setup.mdx index 78757b21a8ce0..2b4e58e126970 100644 --- a/docs/product/sentry-toolbar/setup.mdx +++ b/docs/product/sentry-toolbar/setup.mdx @@ -1,7 +1,10 @@ --- -title: "Set Up Sentry Toolbar" +title: Set Up Sentry Toolbar sidebar_order: 10 -description: "Get started with Sentry's Toolbar, bringing critical Sentry insights and tools into your web app to help your team troubleshoot more effectively." +description: >- + Get started with Sentry's Toolbar, bringing critical Sentry insights and tools + into your web app to help your team troubleshoot more effectively. +og_image: /og-images/product-sentry-toolbar-setup.png --- diff --git a/docs/product/stats/index.mdx b/docs/product/stats/index.mdx index 793a5d1bd6f98..91454f4c1d978 100644 --- a/docs/product/stats/index.mdx +++ b/docs/product/stats/index.mdx @@ -1,7 +1,10 @@ --- title: Stats -description: "The Sentry Stats page displays important metrics such as Usage, and Issues that help teams track project health. Learn how to get started here." +description: >- + The Sentry Stats page displays important metrics such as Usage, and Issues + that help teams track project health. Learn how to get started here. sidebar_order: 130 +og_image: /og-images/product-stats.png --- The [**Stats**](https://sentry.io/orgredirect/organizations/:orgslug/stats/) page is an overview of the usage data that Sentry receives across your entire organization. It allows you to spot projects that have experienced recent spikes in activity or are showing more errors than others and may require a closer look. You can also adjust the displayed date range, enabling you to narrow down to a specific time period or zoom out for a broader view. @@ -165,4 +168,4 @@ The "Number of Releases" chart and table show the releases that were created for #### Dropped Profile Hours -[Relay](/product/relay/) calculates profile durations for accepted outcomes rather than for every profile chunk received. Both profile hours and UI profile hours stats are derived from these accepted profile chunks or UI profile chunks, respectively, with no duration data stored for dropped outcomes (which are simply counted). Each profile chunk has a maximum duration of 66 seconds. Based on internal testing data the 10th and 25th percentiles of accepted profile chunk durations are approximately 9.9 seconds. This metric was used to select 9.0 seconds as the estimation multiplier for each dropped profile chunk. \ No newline at end of file +[Relay](/product/relay/) calculates profile durations for accepted outcomes rather than for every profile chunk received. Both profile hours and UI profile hours stats are derived from these accepted profile chunks or UI profile chunks, respectively, with no duration data stored for dropped outcomes (which are simply counted). Each profile chunk has a maximum duration of 66 seconds. Based on internal testing data the 10th and 25th percentiles of accepted profile chunk durations are approximately 9.9 seconds. This metric was used to select 9.0 seconds as the estimation multiplier for each dropped profile chunk. diff --git a/docs/product/test-analytics/index.mdx b/docs/product/test-analytics/index.mdx index 4490b6873cfab..17b1b2ea0fd1a 100644 --- a/docs/product/test-analytics/index.mdx +++ b/docs/product/test-analytics/index.mdx @@ -2,9 +2,10 @@ title: Test Analytics sidebar_order: 135 description: Learn how Sentry's Test Analytics tools can help you improve your code. +og_image: /og-images/product-test-analytics.png --- -Sentry Test Analytics provides actionable insights into your CI test runs, helping you identify flaky tests, track failures, and optimize your test suite for faster, more reliable deployments. +Sentry Test Analytics provides actionable insights into your CI test runs, helping you identify flaky tests, track failures, and optimize your test suite for faster, more reliable deployments. ## Why Use Test Analytics? @@ -16,7 +17,7 @@ Sentry Test Analytics provides actionable insights into your CI test runs, helpi ## Getting Started - Sentry Test Analytics is currently in beta. Beta features are still a work in progress and may have bugs. + Sentry Test Analytics is currently in beta. Beta features are still a work in progress and may have bugs. ![Test Analytics Dashboard](./img/TA-dash.png) @@ -83,7 +84,7 @@ sentry-prevent-cli upload --report-type test-results --token ``` ### Run Your Test Suite -Now that you've configured your CI to upload your test results, you can inspect the workflow logs to see if the call to Sentry succeeded. You need to have some failed tests to view the failed tests report. +Now that you've configured your CI to upload your test results, you can inspect the workflow logs to see if the call to Sentry succeeded. You need to have some failed tests to view the failed tests report. ## Viewing Test Analytics @@ -91,10 +92,10 @@ After your workflow runs, view failed tests in the [failed tests dashboard](http ![Test Analytics comment](./img/TA-comment.png) -You can see a complete overview of your test analytics in the [test analytics dashboard](https://sentry.io/prevent/tests/). **Note**: The `All Branches`dashboard refreshes every 24 hours. +You can see a complete overview of your test analytics in the [test analytics dashboard](https://sentry.io/prevent/tests/). **Note**: The `All Branches`dashboard refreshes every 24 hours. ## Permissions and Repository Tokens -When configuring Test Analytics, you'll be asked to choose your upload permissions. For GitHub Actions, you can use [OpenID Connect](https://docs.github.com/en/actions/security-for-github-actions/security-hardening-your-deployments/about-security-hardening-with-openid-connect), or generate a repository token. Using the CLI, generate a repository token. +When configuring Test Analytics, you'll be asked to choose your upload permissions. For GitHub Actions, you can use [OpenID Connect](https://docs.github.com/en/actions/security-for-github-actions/security-hardening-your-deployments/about-security-hardening-with-openid-connect), or generate a repository token. Using the CLI, generate a repository token. You can find a list of repository tokens on the Sentry Prevent [tokens page](https://sentry.io/prevent/tokens/). diff --git a/docs/product/uptime-monitoring/index.mdx b/docs/product/uptime-monitoring/index.mdx index 1871eb9da8820..f329380dba80e 100644 --- a/docs/product/uptime-monitoring/index.mdx +++ b/docs/product/uptime-monitoring/index.mdx @@ -1,7 +1,10 @@ --- title: Uptime Monitoring sidebar_order: 50 -description: "Learn how to help maintain uptime for your web services by monitoring relevant URLs with Sentry's Uptime Monitoring." +description: >- + Learn how to help maintain uptime for your web services by monitoring relevant + URLs with Sentry's Uptime Monitoring. +og_image: /og-images/product-uptime-monitoring.png --- Sentry's Uptime Monitoring lets you monitor the availability and reliability of your web services effortlessly. Once enabled, it continuously tracks configured URLs, delivering instant alerts and insights to quickly identify downtime and troubleshoot issues. @@ -39,7 +42,7 @@ _In rare cases where Sentry is unable to perform a scheduled uptime check—such ## Uptime Request Spans -Uptime checks include spans called _uptime request spans_ that Sentry automatically creates for the request. The `uptime.request` span acts as a root span for traces related to uptime checks. +Uptime checks include spans called _uptime request spans_ that Sentry automatically creates for the request. The `uptime.request` span acts as a root span for traces related to uptime checks. ![Uptime request span](./img/uptime-request-span.png) @@ -50,7 +53,7 @@ Uptime checks include spans called _uptime request spans_ that Sentry automatica - Enhanced debugging: You can see more details about exactly where and why the failure occurred to distinguish between uptime-related issues and other application problems -Uptime request spans are free and will not count against your [span quota](/pricing/quotas/manage-transaction-quota/). These spans are always created, even if you have sampling disabled. +Uptime request spans are free and will not count against your [span quota](/pricing/quotas/manage-transaction-quota/). These spans are always created, even if you have sampling disabled. ## Notifications diff --git a/docs/product/uptime-monitoring/uptime-tracing.mdx b/docs/product/uptime-monitoring/uptime-tracing.mdx index ae3c5756de383..8cf4b361b9eda 100644 --- a/docs/product/uptime-monitoring/uptime-tracing.mdx +++ b/docs/product/uptime-monitoring/uptime-tracing.mdx @@ -1,10 +1,11 @@ --- title: Distributed Tracing with Uptime sidebar_order: 52 -description: "Learn how to use distributed tracing to troubleshoot downtime." +description: Learn how to use distributed tracing to troubleshoot downtime. +og_image: /og-images/product-uptime-monitoring-uptime-tracing.png --- -Sentry's Uptime Monitoring uses [distributed tracing](/product/tracing/#whats-distributed-tracing) to track the flow and timing of requests and operations during uptime checks. This helps you quickly find the root cause of downtime by connecting related errors and performance data. +Sentry's Uptime Monitoring uses [distributed tracing](/product/tracing/#whats-distributed-tracing) to track the flow and timing of requests and operations during uptime checks. This helps you quickly find the root cause of downtime by connecting related errors and performance data. When uptime checks are performed, Sentry creates a **trace** that shows the complete request lifecycle. This trace contains: @@ -62,10 +63,10 @@ Sentry.init({ ## Tracing Spans -There are two sets of spans avaialble for uptime checks: +There are two sets of spans avaialble for uptime checks: 1. **Uptime request spans**. These are automatically created by Sentry for every uptime check request. You can find them as the root of any uptime issue's trace. 2. **Application spans**. These are spans that are configured through distributed tracing. You can find them as the children of uptime request spans. - + Unlike error tracing, span tracing that you configure is **disabled** by default for uptime checks, but can be enabled by allowing sampling in your [Uptime Alert settings](/product/alerts/create-alerts/uptime-alert-config/). Enabling span tracing can be helpful because it provides a detailed view of the timing and flow of requests and operations during uptime checks, which is especially useful for diagnosing timeouts or performance issues. ### Enabling Uptime Tracing for Spans @@ -77,7 +78,7 @@ Because uptime requests won't override your SDK’s error sampling rate, some er ![Uptime Alert Allow Sampling Configuration](./img/allow-sampling-new.png) - Uptime request spans will always be on, even if sampling is disabled. Uptime request spans are free and will not count against your [span quota](/pricing/quotas/manage-transaction-quota/). + Uptime request spans will always be on, even if sampling is disabled. Uptime request spans are free and will not count against your [span quota](/pricing/quotas/manage-transaction-quota/). ### Custom Sampling diff --git a/docs/product/user-feedback/index.mdx b/docs/product/user-feedback/index.mdx index 99e5c577d9f3a..24222a21faacf 100644 --- a/docs/product/user-feedback/index.mdx +++ b/docs/product/user-feedback/index.mdx @@ -1,7 +1,8 @@ --- title: User Feedback sidebar_order: 65 -description: "Learn how you can view and triage user feedback submissions." +description: Learn how you can view and triage user feedback submissions. +og_image: /og-images/product-user-feedback.png --- Sentry automatically detects errors thrown by your application, such as performance issues and user experience problems like rage clicks. But there are other frustrations your users may encounter (broken permission flows, broken links, typos, misleading UX, business logic flaws, and so on). @@ -51,13 +52,13 @@ You can narrow down the results in the feedback list by using the project, envir ![User Feedback List.](./img/user-feedback-list.png) -## AI-Powered User Feedback Summaries +## AI-Powered User Feedback Summaries Sentry now provides **AI-powered user feedback summaries** that automatically analyze your feedback to give you actionable insights at a glance. This at-a-glance summary can help you understand large amounts of user feedback without having to manually triage every piece of feedback, transforming overwhelming volume into actionable insights, and helping you prioritize user experience improvements. ### How It Works -At the top of the User Feedback index, you'll see a summary highlighting your users' most common sentiments across the project(s) and date range you've selected. The summary provides a concise overview of what users are saying about your product. The summary also provides AI-generated categories that you can click to filter the feedback. The filtered list will then show contextually relevant feedback; for example, feedback related to your app's "performance". +At the top of the User Feedback index, you'll see a summary highlighting your users' most common sentiments across the project(s) and date range you've selected. The summary provides a concise overview of what users are saying about your product. The summary also provides AI-generated categories that you can click to filter the feedback. The filtered list will then show contextually relevant feedback; for example, feedback related to your app's "performance".
![AI User Feedback Summary.](./img/ai-feedback-summary.png) diff --git a/docs/security-legal-pii/scrubbing/advanced-datascrubbing.mdx b/docs/security-legal-pii/scrubbing/advanced-datascrubbing.mdx index 1d9440f0776ce..1e76ed54f766f 100644 --- a/docs/security-legal-pii/scrubbing/advanced-datascrubbing.mdx +++ b/docs/security-legal-pii/scrubbing/advanced-datascrubbing.mdx @@ -1,8 +1,15 @@ --- -title: "Advanced Data Scrubbing" +title: Advanced Data Scrubbing sidebar_order: 2 -keywords: ["pii", "gdpr", "personally identifiable data", "compliance"] -description: "Learn about using Advanced Data Scrubbing as an alternative way to redact sensitive information just before it is saved in Sentry." +keywords: + - pii + - gdpr + - personally identifiable data + - compliance +description: >- + Learn about using Advanced Data Scrubbing as an alternative way to redact + sensitive information just before it is saved in Sentry. +og_image: /og-images/security-legal-pii-scrubbing-advanced-datascrubbing.png --- In addition to using hooks in your SDK or our [server-side data scrubbing features](/security-legal-pii/scrubbing//server-side-scrubbing/) to redact sensitive data, Advanced Data Scrubbing is an alternative way to redact sensitive information just before it is saved in Sentry. It allows you to: diff --git a/docs/security-legal-pii/scrubbing/protecting-user-privacy.mdx b/docs/security-legal-pii/scrubbing/protecting-user-privacy.mdx index d032bb06226f1..43c416da84c63 100644 --- a/docs/security-legal-pii/scrubbing/protecting-user-privacy.mdx +++ b/docs/security-legal-pii/scrubbing/protecting-user-privacy.mdx @@ -1,7 +1,8 @@ --- -title: "Protecting User Privacy in Session Replay" +title: Protecting User Privacy in Session Replay sidebar_order: 96 -description: "Learn about how Session Replay captures data while protecting user privacy." +description: Learn about how Session Replay captures data while protecting user privacy. +og_image: /og-images/security-legal-pii-scrubbing-protecting-user-privacy.png --- diff --git a/docs/security-legal-pii/security/soc2.mdx b/docs/security-legal-pii/security/soc2.mdx index af64486957632..1b185df9156cb 100644 --- a/docs/security-legal-pii/security/soc2.mdx +++ b/docs/security-legal-pii/security/soc2.mdx @@ -1,9 +1,12 @@ --- -title: "SOC2 Report & ISO 27001 Certificate" +title: SOC2 Report & ISO 27001 Certificate sidebar_order: 2 -description: "Learn about where you can access Sentry's latest SOC2 report and ISO 27001 certificate." +description: >- + Learn about where you can access Sentry's latest SOC2 report and ISO 27001 + certificate. +og_image: /og-images/security-legal-pii-security-soc2.png --- -You can find a copy of Sentry's latest SOC2 report and ISO 27001 certificate by visiting [_Your Organization's Settings_ > Legal & Compliance](https://sentry.io//orgredirect/organizations/:orgslug/settings/legal/). +You can find a copy of Sentry's latest SOC2 report and ISO 27001 certificate by visiting [_Your Organization's Settings_ > Legal & Compliance](https://sentry.io//orgredirect/organizations/:orgslug/settings/legal/). ![SOC2](./img/soc2.png) diff --git a/docs/security-legal-pii/security/terms.mdx b/docs/security-legal-pii/security/terms.mdx index 5c89779afb613..4a60119e5fc6c 100644 --- a/docs/security-legal-pii/security/terms.mdx +++ b/docs/security-legal-pii/security/terms.mdx @@ -1,7 +1,10 @@ --- -title: "Legal and Compliance Documents" +title: Legal and Compliance Documents sidebar_order: 1 -description: "Learn about Sentry's Terms of Service, Privacy Policy, Data Processing Addendum, and Business Associate Amendment." +description: >- + Learn about Sentry's Terms of Service, Privacy Policy, Data Processing + Addendum, and Business Associate Amendment. +og_image: /og-images/security-legal-pii-security-terms.png --- You can self-serve most legal and compliance documentation for your organization by navigating to _Your Organization's Settings_ > Legal & Compliance. When you're logged into your Sentry account, you'll be able to review or accept these agreements as an authorized individual on behalf of your organization. diff --git a/next.config.ts b/next.config.ts index bef182894633d..c5a9d9ad67acc 100644 --- a/next.config.ts +++ b/next.config.ts @@ -25,15 +25,22 @@ const outputFileTracingExcludes = process.env.NEXT_PUBLIC_DEVELOPER_DOCS 'develop-docs/**/*', 'node_modules/@esbuild/*', ], - '/platform-redirect': ['**/*.gif', 'public/mdx-images/**/*', '**/*.pdf'], + '/platform-redirect': [ + '**/*.gif', + 'public/mdx-images/**/*', + 'public/og-images/**/*', + '**/*.pdf', + ], '\\[\\[\\.\\.\\.path\\]\\]': [ 'docs/**/*', 'node_modules/prettier/plugins', 'node_modules/rollup/dist', + 'public/og-images/**/*', ], 'sitemap.xml': [ 'docs/**/*', 'public/mdx-images/**/*', + 'public/og-images/**/*', '**/*.gif', '**/*.pdf', '**/*.png', diff --git a/package.json b/package.json index 569c864a9fb9e..be2d3acfd3faf 100644 --- a/package.json +++ b/package.json @@ -16,8 +16,9 @@ "dev": "yarn enforce-redirects && concurrently \"yarn sidecar\" \"node ./src/hotReloadWatcher.mjs\" \"next dev\"", "dev:developer-docs": "yarn enforce-redirects && NEXT_PUBLIC_DEVELOPER_DOCS=1 yarn dev", "build:developer-docs": "yarn enforce-redirects && git submodule init && git submodule update && NEXT_PUBLIC_DEVELOPER_DOCS=1 yarn build", - "build": "yarn enforce-redirects && next build && yarn generate-md-exports", + "build": "yarn enforce-redirects && yarn generate-og-images && next build && yarn generate-md-exports", "generate-md-exports": "node scripts/generate-md-exports.mjs", + "generate-og-images": "ts-node scripts/add-og-images.ts", "vercel:build:developer-docs": "yarn enforce-redirects && git submodule init && git submodule update && NEXT_PUBLIC_DEVELOPER_DOCS=1 yarn build", "start:dev": "NODE_ENV=development yarn build && yarn start", "start": "next start", diff --git a/public/og-images/README.md b/public/og-images/README.md new file mode 100644 index 0000000000000..94a6c384a0665 --- /dev/null +++ b/public/og-images/README.md @@ -0,0 +1,25 @@ +# OG Images + +This directory contains Open Graph images for documentation pages. + +## Generation + +Images in this directory are automatically generated during the build process by running: + +```bash +yarn generate-og-images +``` + +This script: +1. Scans all MDX files in `docs/` and `develop-docs/` +2. Finds the first image in each file +3. Copies it here with a predictable name based on the page slug +4. Updates the frontmatter with `og_image: /og-images/[name].ext` + +## Local Development + +These files are gitignored to keep the repository clean. Run `yarn generate-og-images` or `yarn build` to generate them locally. + +## Production + +On Vercel, these images are generated during the build process and deployed with the site. diff --git a/scripts/add-og-images.ts b/scripts/add-og-images.ts new file mode 100644 index 0000000000000..e48068b0cb684 --- /dev/null +++ b/scripts/add-og-images.ts @@ -0,0 +1,170 @@ +#!/usr/bin/env node +/** + * Script to automatically add og_image frontmatter to all MDX files that contain images. + * This script: + * 1. Finds the first image in each MDX file + * 2. Copies it to public/og-images/ with a predictable name + * 3. Adds og_image: /og-images/[name].ext to the frontmatter + */ + +import {copyFile, mkdir, readFile, writeFile} from 'fs/promises'; +import path from 'path'; + +import matter from 'gray-matter'; + +import getAllFilesRecursively from '../src/files'; + +const root = process.cwd(); +const OG_IMAGES_DIR = path.join(root, 'public', 'og-images'); + +// Simple regex to find markdown images ![alt](path) +const IMAGE_REGEX = /!\[([^\]]*)\]\(([^)]+)\)/; + +async function addOgImageToFile(filePath: string, fileSlug: string): Promise { + try { + const content = await readFile(filePath, 'utf8'); + const {data: frontmatter, content: markdownContent} = matter(content); + + // Find the first image in the content + const imageMatch = markdownContent.match(IMAGE_REGEX); + + if (!imageMatch) { + // No images found + return false; + } + + const imagePath = imageMatch[2]; + + // Skip external images (we only want local images) + if (imagePath.startsWith('http://') || imagePath.startsWith('https://')) { + return false; + } + + // Resolve the source image path relative to the MDX file + const mdxDir = path.dirname(filePath); + let sourceImagePath: string; + + if (imagePath.startsWith('./')) { + // Relative to MDX file + sourceImagePath = path.join(mdxDir, imagePath); + } else if (imagePath.startsWith('/')) { + // Absolute from project root (public folder) + sourceImagePath = path.join(root, 'public', imagePath); + } else { + // Relative without ./ + sourceImagePath = path.join(mdxDir, imagePath); + } + + // Create OG images directory if it doesn't exist + await mkdir(OG_IMAGES_DIR, {recursive: true}); + + // Create a predictable OG image filename based on the page slug + const imageExt = path.extname(sourceImagePath); + const ogImageName = `${fileSlug.replace(/\//g, '-')}${imageExt}`; + const ogImagePath = path.join(OG_IMAGES_DIR, ogImageName); + const ogImageUrl = `/og-images/${ogImageName}`; + + // Always copy the source image (even if frontmatter exists) + // This is important because og-images/ is gitignored and needs to be regenerated on each build + try { + await copyFile(sourceImagePath, ogImagePath); + } catch (copyError) { + console.error( + `❌ Could not copy image for ${path.relative(root, filePath)}:`, + (copyError as Error).message + ); + return false; + } + + // Check if frontmatter needs updating + if (frontmatter.og_image === ogImageUrl) { + // Already correct, just return true (image was copied successfully) + return true; + } + + // Add or update og_image in frontmatter with absolute path + frontmatter.og_image = ogImageUrl; + + // Reconstruct the file with updated frontmatter + const newContent = matter.stringify(markdownContent, frontmatter); + await writeFile(filePath, newContent, 'utf8'); + + console.log(`✅ Added og_image to ${path.relative(root, filePath)}: ${ogImageUrl}`); + return true; + } catch (error) { + console.error(`❌ Error processing ${filePath}:`, error); + return false; + } +} + +async function main() { + const docsFolders = ['docs', 'develop-docs']; + let totalUpdated = 0; + let totalScanned = 0; + let copyErrors = 0; + + // Create og-images directory + await mkdir(OG_IMAGES_DIR, {recursive: true}); + console.log(`📁 Created ${path.relative(root, OG_IMAGES_DIR)} directory\n`); + + for (const folder of docsFolders) { + const folderPath = path.join(root, folder); + + try { + const files = await getAllFilesRecursively(folderPath); + + const mdxFiles = files.filter( + file => path.extname(file) === '.mdx' || path.extname(file) === '.md' + ); + + console.log(`Scanning ${mdxFiles.length} files in ${folder}/...`); + + for (const file of mdxFiles) { + totalScanned++; + // Generate slug from file path (relative to folder, without extension) + const relativePath = path.relative(folderPath, file); + const fileSlug = relativePath + .replace(/\.(mdx|md)$/, '') + .replace(/\/index$/, '') + .replace(/\\/g, '/'); // Normalize Windows paths + + const result = await addOgImageToFile(file, fileSlug); + if (result === true) { + totalUpdated++; + } else if (result === false) { + // This could be from copy errors, count them + const content = await readFile(file, 'utf8'); + const {content: markdownContent} = matter(content); + const imageMatch = markdownContent.match(IMAGE_REGEX); + + if (imageMatch && !imageMatch[2].startsWith('http')) { + // Had an image but failed to process + copyErrors++; + } + } + } + } catch (error) { + console.error(`❌ Error processing folder ${folder}:`, error); + process.exit(1); + } + } + + console.log(`\n📊 Summary:`); + console.log(` Scanned: ${totalScanned} files`); + console.log(` Updated: ${totalUpdated} files`); + console.log(` Copied: ${totalUpdated} images to public/og-images/`); + console.log(` Errors: ${copyErrors} files failed to copy`); + console.log( + ` Skipped: ${totalScanned - totalUpdated - copyErrors} files (no images or og_image already set)` + ); + + if (copyErrors > 0) { + console.log(`\n⚠️ Warning: ${copyErrors} files had image copy errors`); + console.log(' These files will use the default OG image.'); + } +} + +main().catch(error => { + console.error('Script failed:', error); + process.exit(1); +}); diff --git a/src/mdx.ts b/src/mdx.ts index 169bd8492cbb5..459caea86d37f 100644 --- a/src/mdx.ts +++ b/src/mdx.ts @@ -50,6 +50,7 @@ type SlugFile = { }; mdxSource: string; toc: TocNode[]; + firstImage?: string; }; const root = process.cwd(); @@ -528,8 +529,17 @@ export async function getFileBySlug(slug: string): Promise { let cacheKey: string | null = null; let cacheFile: string | null = null; let assetsCacheDir: string | null = null; + + // Always use public/mdx-images during build + // During runtime (Lambda), this directory is read-only but images are already there from build const outdir = path.join(root, 'public', 'mdx-images'); - await mkdir(outdir, {recursive: true}); + + try { + await mkdir(outdir, {recursive: true}); + } catch (e) { + // If we can't create the directory (e.g., read-only filesystem), + // continue anyway - images should already exist from build time + } // If the file contains content that depends on the Release Registry (such as an SDK's latest version), avoid using the cache for that file, i.e. always rebuild it. // This is because the content from the registry might have changed since the last time the file was cached. @@ -539,6 +549,7 @@ export async function getFileBySlug(slug: string): Promise { source.includes(' { }; if (assetsCacheDir && cacheFile && !skipCache) { - await cp(assetsCacheDir, outdir, {recursive: true}); + try { + await cp(assetsCacheDir, outdir, {recursive: true}); + } catch (e) { + // If copy fails (e.g., on read-only filesystem), continue anyway + // Images should already exist from build time + } writeCacheFile(cacheFile, JSON.stringify(resultObj)).catch(e => { // eslint-disable-next-line no-console console.warn(`Failed to write MDX cache: ${cacheFile}`, e); diff --git a/src/types/frontmatter.ts b/src/types/frontmatter.ts index d7158297a0d0c..37c2801cce7d6 100644 --- a/src/types/frontmatter.ts +++ b/src/types/frontmatter.ts @@ -56,6 +56,14 @@ export interface FrontMatter { */ notoc?: boolean; + /** + * Custom Open Graph image for social sharing. + * Can be a relative path (e.g., './img/my-image.png'), absolute path (e.g., '/images/og.png'), + * or external URL. If not specified, the first image in the page content will be used, + * or falls back to the default OG image. + */ + og_image?: string; + /** * The previous page in the bottom pagination navigation. */