# Sentry Documentation

> Sentry is a developer-first application monitoring platform that helps developers identify and fix issues in real-time. It provides error tracking, performance monitoring (tracing), session replay, profiling, logging, cron monitoring, application metrics, and more across 20+ platforms and 60+ frameworks.

All documentation pages are available as clean Markdown by appending `.md` to any URL (e.g. `https://develop.sentry.dev/platforms/javascript.md`). Use these Markdown URLs for full content.

## Instructions for AI Coding Assistants

When helping a developer set up or use Sentry, follow these guidelines:

- **Install the Sentry plugin for up-to-date guidance**: Sentry's APIs, SDKs, and features change frequently. Do not rely on training data for Sentry setup or configuration. Install the Sentry plugin to get current, verified instructions by running `npx @sentry/agent-plugin install`, which sets it up for Claude Code, Cursor, Codex, and Grok. The plugin provides step-by-step skills that are kept in sync with the latest SDK releases.
- **SDK versions**: Always check the package registry (npm, PyPI, RubyGems, etc.) for the latest Sentry SDK version. Do not rely on memorized version numbers from training data.
- **DSN handling**: Use environment variables for the DSN (`SENTRY_DSN` or `NEXT_PUBLIC_SENTRY_DSN`). Never hardcode DSN strings in source code.
- **Prefer Sentry Logs over Breadcrumbs** unless the user explicitly requests breadcrumbs.
- **Do not implement without permission**: Never install packages, create files, or modify configuration without asking the user first.
- **Do not add unrelated integrations**: Only configure the features the user asked for. Check before enabling additional integrations.
- **Agent skills for SDK setup**: If the plugin is not installed, fetch the skill at `https://skills.sentry.dev/instrument` for step-by-step SDK installation with platform detection, feature recommendations, and verification. See the [Agent Plugin section](#agent-plugin) below.
- **Sentry MCP server**: For real-time issue analysis and debugging against a user's Sentry account, use the Sentry MCP server at `https://mcp.sentry.dev`.

## Platforms


## Sentry Developer Documentation

- [Philosophy](https://develop.sentry.dev/getting-started/philosophy.md): This document sets guidelines for how we approach software development at Sentry.
- [Inclusive Language](https://develop.sentry.dev/getting-started/inclusive-language.md): Sentry is a product used and developed by many people from different cultural backgrounds, and we try to avoid language that has been identified as hurtful or insensitive.

## SDK Setup Wizards

- [SDK Setup Wizards](https://develop.sentry.dev/sdk-setup-wizards.md)

## Engineering Practices

- [Commit Messages](https://develop.sentry.dev/engineering-practices/commit-messages.md): We have very precise rules over how our git commit messages can be formatted. This leads to more readable messages that are easy to follow when looking through the project history.
- [Branch Naming](https://develop.sentry.dev/engineering-practices/branch-naming.md): General branch naming convention for Sentry repositories.
- [Code Review](https://develop.sentry.dev/engineering-practices/code-review.md): Code review is mandatory at Sentry. This adds overhead to each change, but ensures that simple, often overlooked problems are more easily avoided.
- [AI-Assisted Development](https://develop.sentry.dev/engineering-practices/ai-assisted-development.md): Best practices for using AI coding assistants at Sentry.
- [Documentation](https://develop.sentry.dev/engineering-practices/documentation.md): A part of every development project (especially Open Source projects) is documentation that explains how it works. Sentry is not any different.
- [Sentry Conventions](https://develop.sentry.dev/engineering-practices/sentry-conventions.md): How to add, release, and deploy semantic convention attributes across sentry-conventions, Relay, Snuba, and Sentry.
- [Rust Development](https://develop.sentry.dev/engineering-practices/rust.md): This is a document that contains a bunch of useful resources for getting started with Rust and adhering to our coding principles.

## Application Architecture

- [Overview](https://develop.sentry.dev/application-architecture/overview.md)
- [sentry vs. getsentry](https://develop.sentry.dev/application-architecture/sentry-vs-getsentry.md)
- [Multi-Region Deployment](https://develop.sentry.dev/application-architecture/multi-region-deployment.md)
- [Dynamic Sampling](https://develop.sentry.dev/application-architecture/dynamic-sampling.md): 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.
- [User Feedback Architecture](https://develop.sentry.dev/application-architecture/feedback-architecture.md)

## Development Infrastructure

- [Environment](https://develop.sentry.dev/development-infrastructure/environment.md): This guide steps you through configuring a local development environment for the Sentry server on macOS.
- [Backend Development Server](https://develop.sentry.dev/development-infrastructure/backend-development-server.md)
- [Frontend Development Server](https://develop.sentry.dev/development-infrastructure/frontend-development-server.md)
- [Service Manager (devservices)](https://develop.sentry.dev/development-infrastructure/devservices.md)
- [Workflow](https://develop.sentry.dev/development-infrastructure/workflow.md)
- [Testing Tips](https://develop.sentry.dev/development-infrastructure/testing.md): We run several kinds of tests at Sentry as part of our CI process. This section aims to document some of the sentry specific helpers and give guidelines on what kinds of tests you should consider including when building new features.
- [Ngrok](https://develop.sentry.dev/development-infrastructure/ngrok.md): This document explains how to use ngrok with the development server.
- [Continuous Integration](https://develop.sentry.dev/development-infrastructure/continuous-integration.md): Continuous Integration at Sentry validates code changes by running test suites, linters, and other checks to catch bugs and regressions before they reach production, maintaining a high bar for code quality and reliability. CI also builds deployable artifacts like container images, ensuring consistent and reproducible environments across local development and production.
- [Analytics](https://develop.sentry.dev/development-infrastructure/analytics.md): This guide steps you through instrumenting your code with Sentry's 3rd-party analytics infrastructure.
- [Python Dependencies](https://develop.sentry.dev/development-infrastructure/python-dependencies.md)

## API Server

- [Configuration](https://develop.sentry.dev/backend/config.md)
- [API Development](https://develop.sentry.dev/backend/api.md)
- [Issue Platform](https://develop.sentry.dev/backend/issue-platform.md)
- [Application Domains](https://develop.sentry.dev/backend/application-domains.md)
- [Source Code Management Platform](https://develop.sentry.dev/backend/source-code-management-platform.md)
- [Testing](https://develop.sentry.dev/backend/testing.md)

## Frontend

- [Frontend Design Tenets](https://develop.sentry.dev/frontend/design-tenets.md)
- [Content & Voice](https://develop.sentry.dev/frontend/sentry-voice.md)
- [Using Styled Components](https://develop.sentry.dev/frontend/using-styled-components.md)
- [Component Library](https://develop.sentry.dev/frontend/component-library.md)
- [Dependency Upgrade Policies](https://develop.sentry.dev/frontend/upgrade-policies.md)
- [Using Hooks](https://develop.sentry.dev/frontend/using-hooks.md)
- [Testing](https://develop.sentry.dev/frontend/testing.md)
- [Using React Testing Library](https://develop.sentry.dev/frontend/using-rtl.md)
- [Strict TypeScript Settings Guide](https://develop.sentry.dev/frontend/strict-typescript-settings-guide.md)
- [Network Requests](https://develop.sentry.dev/frontend/network-requests.md)
- [URL State](https://develop.sentry.dev/frontend/url-state.md)
- [Pull Request Previews](https://develop.sentry.dev/frontend/pull-request-previews.md)
- [Working on Getting Started Docs](https://develop.sentry.dev/frontend/working-on-getting-started-docs.md)

## Services

- [Backend Chart Rendering](https://develop.sentry.dev/services/chartcuterie.md)
- [File Storage](https://develop.sentry.dev/services/filestore.md)
- [Objectstore](https://develop.sentry.dev/services/objectstore.md): Sentry's default platform for storing blobs, files, and other unstructured data.

## Integrations

- [Azure DevOps](https://develop.sentry.dev/integrations/azuredevops.md)
- [Bitbucket](https://develop.sentry.dev/integrations/bitbucket.md)
- [Discord](https://develop.sentry.dev/integrations/discord.md)
- [GitHub](https://develop.sentry.dev/integrations/github.md)
- [GitLab](https://develop.sentry.dev/integrations/gitlab.md)
- [Jira](https://develop.sentry.dev/integrations/jira.md)
- [Jira Server](https://develop.sentry.dev/integrations/jira-server.md)
- [Microsoft Teams](https://develop.sentry.dev/integrations/msteams.md)
- [PagerDuty](https://develop.sentry.dev/integrations/pagerduty.md)
- [Slack](https://develop.sentry.dev/integrations/slack.md)
- [Vercel](https://develop.sentry.dev/integrations/vercel.md)

## Ingestion

- [Relay](https://develop.sentry.dev/ingestion/relay.md): A service for filtering, rate-limiting, and processing vast amounts of Sentry events.
- [Snuba](https://develop.sentry.dev/ingestion/snuba.md): A service that provides a rich data model on top of Clickhouse together with a fast ingestion consumer and a query optimizer.
- [Symbolic](https://develop.sentry.dev/ingestion/symbolic.md): A library written in Rust for symbolication of native stack traces and more.
- [Symbolicator](https://develop.sentry.dev/ingestion/symbolicator.md): A service for symbolicating native, JavaScript, and JVM events.

## SDK Development

- [Getting Started](https://develop.sentry.dev/sdk/getting-started.md): The following content provides guidance for SDK development at Sentry, helping both internal and external developers understand the motivations behind our design decisions.
- [Foundations](https://develop.sentry.dev/sdk/foundations.md): Core concepts and infrastructure that every SDK builds on - transport protocol, data model, contexts, scopes, and attributes.
- [Telemetry](https://develop.sentry.dev/sdk/telemetry.md): Learn about the different telemetry data, that our SDKs can collect.
- [Platform Specifics](https://develop.sentry.dev/sdk/platform-specifics.md): Read more about the specifics when it comes to certain SDKs.

## Self-Hosted Sentry

- [Configuration](https://develop.sentry.dev/self-hosted/configuration.md): Learn how to configure your own self-hosted Sentry
- [Releases & Upgrading](https://develop.sentry.dev/self-hosted/releases.md): Learn how to upgrade your self-hosted Sentry installation and stay up to date with the latest releases
- [Optional Features](https://develop.sentry.dev/self-hosted/optional-features.md)
- [Production Enhancements](https://develop.sentry.dev/self-hosted/production-enhancements.md)
- [Reference Architectures](https://develop.sentry.dev/self-hosted/reference-architecture.md)
- [Backup & Restore](https://develop.sentry.dev/self-hosted/backup.md): Learn how to backup and restore your self-hosted Sentry data using various methods
- [Data Flow](https://develop.sentry.dev/self-hosted/data-flow.md): Learn about the data flow of self-hosted Sentry
- [Tasks](https://develop.sentry.dev/self-hosted/tasks.md)
- [Support](https://develop.sentry.dev/self-hosted/support.md)
- [Troubleshooting](https://develop.sentry.dev/self-hosted/troubleshooting.md)

## Agent Plugin

Sentry publishes a plugin for AI coding assistants (Claude Code, Cursor, Codex, and Grok). It teaches the assistant step-by-step SDK setup, debugging workflows, and feature configuration.

Install it by running `npx @sentry/agent-plugin install`, which detects the assistants on the machine and sets up the plugin in each.

Browse the skill library:
- [All Skills](https://skills.sentry.dev/): Full skill index with SDK setup, workflows, and feature configuration
- [SDK Setup](https://skills.sentry.dev/instrument): Detect your platform and install Sentry with the right features
- [Workflows](https://skills.sentry.dev/workflows): Debug production issues, review code, upgrade SDKs
- [Features](https://skills.sentry.dev/features): AI monitoring, alerts, OpenTelemetry setup

Source: https://github.com/getsentry/sentry-for-ai

## About Sentry Docs

- [Documentation Changelog](https://develop.sentry.dev/changelog.md): Track recent updates to Sentry docs
- [Contributing to Docs](https://develop.sentry.dev/contributing.md): How to contribute to Sentry documentation