Sentry

https://docs.sentry.io/
Admin
Sentry is an application monitoring and debugging platform that provides end-to-end distributed...
Tokens:5,416,996
Snippets:39,285
Trust Score:10
Update:2 weeks ago
Show doc for...
Tokens:
Raw
### Install Sentry SDK with Wizard

Source: https://docs.sentry.io/platforms/javascript/guides/sveltekit/user-feedback

Run the Sentry installation wizard in the root directory of your project to set up the SDK. The wizard prompts you to log in to Sentry and automatically creates or updates SvelteKit files, adds a .sentryclirc file with an auth token, and adds an example page to verify your setup.

```bash
npx @sentry/wizard@latest -i sveltekit
```

--------------------------------

### Install sentry-go and sentry-go/zerolog

Source: https://docs.sentry.io/platforms/go/guides/echo/logs/zerolog

Install the Sentry Go SDK and the Zerolog integration using go get.

```bash
go get github.com/getsentry/sentry-go
go get github.com/getsentry/sentry-go/zerolog
```

--------------------------------

### Install sentry-go and sentrysql packages

Source: https://docs.sentry.io/platforms/go/guides/fiberv3/tracing/instrumentation/sql

Use go get to install the sentry-go and sentrysql packages.

```bash
go get github.com/getsentry/sentry-go
go get github.com/getsentry/sentry-go/sql
```

--------------------------------

### Example agents.toml

Source: https://docs.sentry.io/ai/dotagents

Example agents.toml created by the install command. Declares version, gitignore, agents, and a skill with name and source.

```toml
version = 1
gitignore = false
agents = ["claude"]

[[skills]]
name = "find-bugs"
source = "getsentry/skills"
```

--------------------------------

### GET /api/0/organizations/{organization_id_or_slug}/sentry-app-installations/

Source: https://docs.sentry.io/api/integration/list-an-organizations-integration-platform-installations

This snippet documents the GET endpoint for listing integration platform installations for an organization, including path and query parameters, required scopes, and a response example.

```APIDOC
## GET /api/0/organizations/{organization_id_or_slug}/sentry-app-installations/

### Description
Return a list of integration platform installations for a given organization.

### Method
GET

### Endpoint
/api/0/organizations/{organization_id_or_slug}/sentry-app-installations/

### Parameters
#### Path Parameters
- **organization_id_or_slug** (string) - Required - The organization short name.

#### Query Parameters
- **cursor** (string) - Optional - A pointer to the last object fetched and its sort order; used to retrieve the next or previous results.

### Scopes
Requires authentication via bearer auth token. The token requires one of the following scopes:
- `org:read`
- `org:integrations`

### Request Example
```
curl https://sentry.io/api/0/organizations/{organization_id_or_slug}/sentry-app-installations/ \
 -H 'Authorization: Bearer <auth_token>'
```

### Response
#### Success Response (200)
Returns a list of integration platform installations. Each installation contains:
- **app** (object) - The integration platform app details.
  - **uuid** (string) - The app's UUID.
  - **slug** (string) - The app's slug.
  - **sentryAppId** (integer) - The Sentry app ID.
- **organization** (object) - The organization details.
  - **slug** (string) - The organization slug.
- **uuid** (string) - The installation's UUID.
- **status** (string) - The installation status (e.g., "installed").

#### Response Example
```
[
  {
    "app": {
      "uuid": "a9988ad6-meow-4905-bb93-f7cbf4c96bbb",
      "slug": "cat-75c19a",
      "sentryAppId": 1
    },
    "organization": {
      "slug": "sentry"
    },
    "uuid": "01635075-m30w-4f96-8fc8-ff9680780a13",
    "status": "installed"
  }
]
```
```

--------------------------------

### setup(client)

Source: https://docs.sentry.io/platforms/react-native/guides/expo/integrations/custom

Documents the `setup` hook of a custom integration, which is called when the SDK is initialized.

```APIDOC
## setup(client)

### Description
The `setup` hook is called when the SDK is initialized. It receives the client instance as an argument. Use this to run code upon initialization.

### Parameters
- **client** (Client) - Required - The client instance being set up.

### Example
```javascript
const integration = {
  name: "MyAwesomeIntegration",
  setup(client) {
    setupCustomSentryListener(client);
  },
};
```
```

--------------------------------

### Use the setup hook

Source: https://docs.sentry.io/platforms/javascript/guides/cordova/configuration/integrations/custom

Uses the `setup` hook to run code when the SDK is initialized. The hook receives the client instance as an argument, which can be used to set up a custom listener.

```javascript
const integration = {
  name: "MyAwesomeIntegration",
  setupOnce() {},
  setup(client) {
    setupCustomSentryListener(client);
  },
};
```

--------------------------------

### Koa app with Sentry setup (ESM)

Source: https://docs.sentry.io/platforms/javascript/guides/koa/migration/v7-to-v8

Example of instrumenting a Koa application with Sentry Node SDK 8.x using ESM. Imports './instrument' first, then sets up the error handler and starts the server.

```javascript
import "./instrument";
import Koa from "koa";
import * as Sentry from "@sentry/node";
const app = new Koa();

Sentry.setupKoaErrorHandler(app);

// Add your routes, etc.

app.listen(3030);

```

--------------------------------

### Go: Set up Sentry Zerolog writer with example DSN

Source: https://docs.sentry.io/platforms/go/guides/grpc/logs/zerolog

Initializes Sentry with an example DSN, creates a Sentry writer using sentryzerolog.NewWithHub, and configures Zerolog to output to both console and Sentry. Logs Info, Error, and Fatal levels to demonstrate which are sent to Sentry.

```go
import (
	"errors"
	"time"
	"os"

	"github.com/getsentry/sentry-go"
	sentryzerolog "github.com/getsentry/sentry-go/zerolog"
	"github.com/rs/zerolog"
	"github.com/rs/zerolog/log"
)

func main() {
	// Initialize Sentry
	err := sentry.Init(sentry.ClientOptions{
		Dsn: "https://examplePublicKey@o0.ingest.sentry.io/0",
		// Adds request headers and IP for users,
		// visit: https://docs.sentry.io/platforms/go/data-management/data-collected/ for more info
		SendDefaultPII: true,
		BeforeSend: func(event *sentry.Event, hint *sentry.EventHint) *sentry.Event {
			// Modify or filter events before sending them to Sentry
			return event
		},
		Debug:            true,
		AttachStacktrace: true,
	})
	if err != nil {
		log.Fatal().Err(err).Msg("sentry initialization failed")
	}
	defer sentry.Flush(2 * time.Second)

	// Configure Zerolog to use Sentry as a writer,
	// reusing the already existing client.
	sentryWriter, err := sentryzerolog.NewWithHub(sentry.CurrentHub(), sentryzerolog.Options{
		Levels:          []zerolog.Level{zerolog.ErrorLevel, zerolog.FatalLevel, zerolog.PanicLevel},
		WithBreadcrumbs: true,
		FlushTimeout:    3 * time.Second,
	})
	if err != nil {
		log.Fatal().Err(err).Msg("failed to create sentry writer")
	}
	defer sentryWriter.Close()

	// Use Sentry writer in Zerolog
	log.Logger = log.Output(zerolog.MultiLevelWriter(zerolog.ConsoleWriter{Out: os.Stderr}, sentryWriter))

	// Log an InfoLevel entry to STDERR (not sent to Sentry)
	log.Info().Msg("Application has started")

	// Log an ErrorLevel entry to STDERR and send as error event to Sentry
	log.Error().Msg("oh no!")

	// Log a FatalLevel entry to STDERR, send as error event to Sentry, and terminate the application
	log.Fatal().Err(errors.New("can't continue")).Msg("fatal error occurred")
}

```

--------------------------------

### Example credentials.json file

Source: https://docs.sentry.io/product/relay/getting-started

Example of a credentials.json file created by the init command. Contains secret_key, public_key, and id. Must be protected from unauthorized access.

```json
{
  "secret_key": "5gkTAfwOrJ0lMy9aOAOmHKO1k6gd8ApYkAInmg5VfWk",
  "public_key": "nDJI79SbEYH9-8NEJAI7ezrgYfoIPW3Bnkg00k1z0fA",
  "id": "cde0d72e-0c4e-4550-a934-c1867d8a177c"
}
```

--------------------------------

### Koa app with Sentry setup (CommonJS)

Source: https://docs.sentry.io/platforms/javascript/guides/koa/migration/v7-to-v8

Example of instrumenting a Koa application with Sentry Node SDK 8.x using CommonJS. Requires './instrument' first, then sets up the error handler and starts the server.

```javascript
require("./instrument");
const Koa = require("koa");
const Sentry = require("@sentry/node");
const app = new Koa();

Sentry.setupKoaErrorHandler(app);

// Add your routes, etc.

app.listen(3030);

```

--------------------------------

### Use the setupOnce hook

Source: https://docs.sentry.io/platforms/javascript/guides/gcp-functions/configuration/integrations/custom

Shows a custom integration using the `setupOnce` hook, which runs only once even if the SDK is re-initialized. It receives no arguments and is useful for ensuring code runs only once, such as wrapping a library.

```JavaScript
const integration = {
  name: "MyAwesomeIntegration",
  setupOnce() {
    wrapLibrary();
  },
};

```

--------------------------------

### Verify JCache integration with Kotlin transaction

Source: https://docs.sentry.io/platforms/java/guides/jul/integrations/jcache

Kotlin example that starts a Sentry transaction, performs cache put and get operations, and finishes the transaction. Use this to verify the integration by checking the Caches dashboard or trace view.

```kotlin
import io.sentry.Sentry

val tx = Sentry.startTransaction("test-cache", "task")
try {
    tx.makeCurrent().use {
        sentryCache.put("greeting", "hello")
        val value = sentryCache.get("greeting")
    }
} finally {
    tx.finish()
}

```

--------------------------------

### Verify JCache integration with Java transaction

Source: https://docs.sentry.io/platforms/java/guides/jul/integrations/jcache

Java example that starts a Sentry transaction, performs cache put and get operations, and finishes the transaction. Use this to verify the integration by checking the Caches dashboard or trace view.

```java
import io.sentry.ISentryLifecycleToken;
import io.sentry.ITransaction;
import io.sentry.Sentry;

ITransaction tx = Sentry.startTransaction("test-cache", "task");
try (ISentryLifecycleToken ignored = tx.makeCurrent()) {
    sentryCache.put("greeting", "hello");
    String value = sentryCache.get("greeting");
} finally {
    tx.finish();
}

```

--------------------------------

### setupOnce Hook

Source: https://docs.sentry.io/platforms/javascript/configuration/integrations/custom

The setupOnce hook is similar to setup but is only run once, even if the SDK is re-initialized. It does not receive any arguments.

```APIDOC
## setupOnce Hook

### Description
This hook is similar to `setup`, but it is only run once, even if the SDK is re-initialized. It does not receive any arguments. You should probably not use this, but use `setup` instead. The only reason to use `setupOnce` is e.g. when you may be calling `Sentry.init()` multiple times and you want to ensure a certain piece of code is only run once.

### Method
N/A (SDK hook)

### Endpoint
N/A

### Parameters
None.

### Request Example
```javascript
const integration = {
  name: "MyAwesomeIntegration",
  setupOnce() {
    wrapLibrary();
  },
};
```

### Response
No return value.
```

--------------------------------

### Enable OpenTelemetry Setup in Sentry for Hono

Source: https://docs.sentry.io/platforms/javascript/guides/hono/opentelemetry/using-opentelemetry-apis

Configure Sentry with enableOpenTelemetrySetup: true to capture spans from @opentelemetry/api. The example creates a tracer and starts a span named 'process-order'. Sentry registers its own OpenTelemetry-compatible provider, so it does not replace an existing provider.

```JavaScript
import * as Sentry from "@sentry/hono";
import { trace } from "@opentelemetry/api";

Sentry.init({
  dsn: "https://examplePublicKey@o0.ingest.sentry.io/0",
  enableOpenTelemetrySetup: true,
  tracesSampleRate: 1.0,
});

const tracer = trace.getTracer("my-app");

tracer.startActiveSpan("process-order", (span) => {
  try {
    // Your synchronous work here.
  } finally {
    span.end();
  }
});

```

```JavaScript
import * as Sentry from "___SDK_PACKAGE___";
import { trace } from "@opentelemetry/api";

Sentry.init({
  dsn: "___PUBLIC_DSN___",
  enableOpenTelemetrySetup: true,
  tracesSampleRate: 1.0,
});

const tracer = trace.getTracer("my-app");

tracer.startActiveSpan("process-order", (span) => {
  try {
    // Your synchronous work here.
  } finally {
    span.end();
  }
});

```

--------------------------------

### Prompts for Setting Up Sentry

Source: https://docs.sentry.io/ai/agent-plugin

Example prompts for setting up Sentry in any project. The plugin detects your stack, recommends the right features, and walks through the whole installation.

```text
> Add Sentry to my Next.js app
> Set up Sentry in my Rails project
> Add error monitoring to my iOS app
```

--------------------------------

### Install Sentry with the wizard

Source: https://docs.sentry.io/platforms/javascript/guides/angular

Run the Sentry wizard to automatically configure Sentry in your Angular application. The wizard will guide you through the setup process, asking you to enable additional optional features beyond error monitoring. Requires Angular 17.0.0 or above.

```bash
npx @sentry/wizard@latest -i angular
```

--------------------------------

### Properties file configuration example

Source: https://docs.sentry.io/platforms/java/guides/log4j2//configuration

Example of a property file entry. Option names in the property file exactly match the examples given below, such as environment=production.

```properties
environment=production

```

--------------------------------

### Report a level-load transaction with custom timestamps using USentrySubsystem::StartTransactionWithContextAndTimestamp

Source: https://docs.sentry.io/platforms/unreal/tracing/instrumentation/custom-instrumentation

Use the explicitly timed variants of the Sentry tracing functions to record timestamps captured during a loading phase that occurred before tracing started. The example defines a helper to get the current Unix timestamp in microseconds and a function that reports a level-load transaction with start, asset-loaded, and end timestamps. Ensure timestamps are consistent: a span should not start before its parent or finish after it.

```C++
int64 GetUnixTimestampMicros()
{
    return (FDateTime::UtcNow() - FDateTime(1970, 1, 1)).GetTicks() / ETimespan::TicksPerMicrosecond;
}

// LoadStart, AssetsLoaded and LoadEnd were captured with GetUnixTimestampMicros() during loading
void ReportLevelLoad(int64 LoadStart, int64 AssetsLoaded, int64 LoadEnd)
{
    USentrySubsystem* SentrySubsystem = GEngine->GetEngineSubsystem<USentrySubsystem>();

    USentryTransactionContext* TransactionContext = NewObject<USentryTransactionContext>();
    TransactionContext->Initialize(TEXT("level-load"), TEXT("game.load"));

    USentryTransaction* Transaction =
        SentrySubsystem->StartTransactionWithContextAndTimestamp(TransactionContext, LoadStart);

    USentrySpan* AssetsSpan = Transaction->StartChildSpanWithTimestamp(
        TEXT("game.load.assets"), TEXT("Loading level assets"), LoadStart);
    AssetsSpan->FinishWithTimestamp(AssetsLoaded);

    Transaction->FinishWithTimestamp(LoadEnd);
}
```

--------------------------------

### Initialize the plugin environment

Source: https://docs.sentry.io/platforms/unreal/configuration/building-plugin-dependencies

Run the initialization script for your platform. Use init-win.ps1 on Windows and init.sh on macOS/Linux.

```bash
# Windows
./scripts/init-win.ps1

# macOS/Linux
./scripts/init.sh

```

--------------------------------

### Install sentry-apollo-4 dependency

Source: https://docs.sentry.io/platforms/java/guides/spring/tracing/instrumentation/apollo4

Install the Sentry Apollo 4 integration. The Maven and Gradle examples are shown in tabs, and the SBT example is shown separately. The version is 8.59.0.

```xml
<dependency>
    <groupId>io.sentry</groupId>
    <artifactId>sentry-apollo-4</artifactId>
    <version>8.59.0</version>
</dependency>
```

```groovy
implementation 'io.sentry:sentry-apollo-4:8.59.0'
```

```scala
libraryDependencies += "io.sentry" % "sentry-apollo-4" % "8.59.0"
```

--------------------------------

### Send start and end check-ins to Sentry Crons

Source: https://docs.sentry.io/platforms/javascript/guides/mastra/crons

Sends check-ins to Sentry Crons for a scheduled job: one at the start (status=in_progress) and one at the end (status=ok). The first bash block uses the example ingest domain and public key; the second uses placeholders for your organization, project, and public key. The HTTP block shows the equivalent raw GET requests.

```bash
SENTRY_INGEST="https://o0.ingest.sentry.io"
SENTRY_CRONS="${SENTRY_INGEST}/api/0/cron/<monitor_slug>/examplePublicKey/"

# 🟡 Notify Sentry your job is running:
curl "${SENTRY_CRONS}?status=in_progress"

# Execute your scheduled task here...

# 🟢 Notify Sentry your job has completed successfully:
curl "${SENTRY_CRONS}?status=ok"
```

```bash
SENTRY_INGEST="https://___ORG_INGEST_DOMAIN___"
SENTRY_CRONS="${SENTRY_INGEST}/api/___PROJECT_ID___/cron/<monitor_slug>/___PUBLIC_KEY___/"

# 🟡 Notify Sentry your job is running:
curl "${SENTRY_CRONS}?status=in_progress"

# Execute your scheduled task here...

# 🟢 Notify Sentry your job has completed successfully:
curl "${SENTRY_CRONS}?status=ok"
```

```http
GET /api/___PROJECT_ID___/cron/<monitor_slug>/___PUBLIC_KEY___/?status=in_progress HTTP/1.1

GET /api/___PROJECT_ID___/cron/<monitor_slug>/___PUBLIC_KEY___/?status=ok HTTP/1.1
```

--------------------------------

### setup Hook

Source: https://docs.sentry.io/platforms/javascript/configuration/integrations/custom

The setup hook is called when the SDK is initialized. It receives the client instance as an argument.

```APIDOC
## setup Hook

### Description
The `setup` hook is called when the SDK is initialized. It receives the client instance as an argument. Use it to run code on initialization.

### Method
N/A (SDK hook)

### Endpoint
N/A

### Parameters
- **client** (Client) - Required - The client instance being set up.

### Request Example
```javascript
const integration = {
  name: "MyAwesomeIntegration",
  setup(client) {
    setupCustomSentryListener(client);
  },
};
```

### Response
No return value.
```

--------------------------------

### Install dependencies and start the Sentry sample app with npm

Source: https://docs.sentry.io/product/sentry-basics/getting-started-tutorial/initialize-sentry-sdk-backend

Install project dependencies and start the application. The start script runs `node --import ./instrument.js server.js`, which initializes Sentry before the app loads, required for ESM apps. If the app fails to start, ensure Node 18+ and reinstall dependencies.

```bash
npm install
```

```bash
npm start
```

--------------------------------

### Installation: raven.Client vs sentry_sdk.init

Source: https://docs.sentry.io/platforms/python/migration/raven-to-sentry-sdk

Shows the old raven client initialization and the new sentry_sdk.init call. The new SDK uses a single initialization routine regardless of framework.

```python
import raven
client = raven.Client("___PUBLIC_DSN___", release="1.3.0")

```

```python
import sentry_sdk
sentry_sdk.init(
    dsn="___PUBLIC_DSN___",
    release="1.3.0",
)

```

--------------------------------

### Configure Sentry.statsigIntegration in Remix

Source: https://docs.sentry.io/platforms/javascript/guides/remix/configuration/integrations/statsig

Initializes Sentry with the Statsig integration in a Remix app, after creating a StatsigClient with your SDK key. The example shows two DSN placeholders as alternatives; both use the same setup. Must be used in a browser environment and requires installing and instrumenting Statsig first.

```JavaScript
import * as Sentry from "@sentry/remix";
import { StatsigClient } from "@statsig/js-client";

const statsigClient = new StatsigClient(
  YOUR_SDK_KEY,
  { userID: "my-user-id" },
  {},
); // see Statsig SDK reference.

Sentry.init({
  dsn: "https://examplePublicKey@o0.ingest.sentry.io/0",
  integrations: [
    Sentry.statsigIntegration({ featureFlagClient: statsigClient }),
  ],
});

await statsigClient.initializeAsync(); // or statsigClient.initializeSync();

const result = statsigClient.checkGate("my-feature-gate");
Sentry.captureException(new Error("something went wrong"));
```

```JavaScript
import * as Sentry from "@sentry/remix";
import { StatsigClient } from "@statsig/js-client";

const statsigClient = new StatsigClient(
  YOUR_SDK_KEY,
  { userID: "my-user-id" },
  {},
); // see Statsig SDK reference.

Sentry.init({
  dsn: "___PUBLIC_DSN___",
  integrations: [
    Sentry.statsigIntegration({ featureFlagClient: statsigClient }),
  ],
});

await statsigClient.initializeAsync(); // or statsigClient.initializeSync();

const result = statsigClient.checkGate("my-feature-gate");
Sentry.captureException(new Error("something went wrong"));
```

--------------------------------

### Install sentry-sdk and uvicorn with uv

Source: https://docs.sentry.io/platforms/python/integrations/litestar

Install the Sentry SDK and Uvicorn using uv.

```bash
uv add sentry-sdk uvicorn

```
Tokens:
Raw