Sentry Platforms

https://docs.sentry.io/platforms
Admin
Sentry Platforms provides code-level observability by offering SDKs for various languages and...
Tokens:5,950,004
Snippets:44,988
Trust Score:10
Update:1 week ago
Show doc for...
Tokens:
Raw
### Install Sentry with the wizard

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

Run this command in your project to install Sentry. The wizard guides you through setup and asks you to enable optional features. It creates or updates entry files, adds a build plugin auth token, and updates your build configuration.

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

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

### Install sentry-go and sentrysql packages

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

Use these go get commands to install the Sentry Go SDK and the sentrysql package for SQL instrumentation.

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

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

### Run your app

Source: https://docs.sentry.io/platforms/javascript/guides/express/install/bundler

Start your application as usual. No --import flag is required because the instrumentation is already part of your bundle.

```bash
node app.mjs
```

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

### Start the dev server

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

Run this command to start the Next.js development server so you can visit the example page and test your Sentry setup.

```bash
npm run dev
```

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

### sentry-go configuration options

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

Example of sentry.Init with various client options like Debug, Environment, Release, and SampleRate.

```go
sentry.Init(sentry.ClientOptions{
	Dsn: "https://<key>@o<orgId>.ingest.sentry.io/<projectId>",
	DebugWriter: os.Stderr,
	Debug: true,
	Environment: "environment",
	Release: "my-project-name@1.0.0",
	SampleRate: 0.5,
	// IgnoreErrors: TBD,
	// IncludePaths: TBD
})
```

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

### Verify SQL spans with a complete example using sqlite

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

This example shows a full setup with sentrysql.Open using sqlite, including starting a transaction, executing queries, and committing. It demonstrates that SQL spans are created only when a parent span is active in the context.

```go
import (
    "context"
    "time"

    "github.com/getsentry/sentry-go"
    sentrysql "github.com/getsentry/sentry-go/sql"
    _ "modernc.org/sqlite"
)

func main() {
    if err := sentry.Init(sentry.ClientOptions{
        Dsn:              "https://<key>@o<orgId>.ingest.sentry.io/<projectId>",
        EnableTracing:    true,
        TracesSampleRate: 1.0,
    }); err != nil {
        panic(err)
    }
    defer sentry.Flush(2 * time.Second)

    db, err := sentrysql.Open("sqlite", ":memory:",
        sentrysql.WithDatabaseSystem(sentrysql.SystemSQLite),
        sentrysql.WithDatabaseName("main"),
    )
    if err != nil {
        panic(err)
    }
    defer db.Close()

    txn := sentry.StartTransaction(context.Background(), "sql-demo")
    defer txn.Finish()

    ctx := txn.Context()

    sqlTx, err := db.BeginTx(ctx, nil)
    if err != nil {
        panic(err)
    }

    if _, err := sqlTx.ExecContext(ctx, "CREATE TABLE users (id INTEGER, name TEXT)"); err != nil {
        panic(err)
    }

    if _, err := sqlTx.ExecContext(ctx, "INSERT INTO users (id, name) VALUES (?, ?)", 1, "alice"); err != nil {
        panic(err)
    }

    rows, err := sqlTx.QueryContext(ctx, "SELECT id, name FROM users WHERE id = ?", 1)
    if err != nil {
        panic(err)
    }
    _ = rows.Close()

    if err := sqlTx.Commit(); err != nil {
        panic(err)
    }
}
```

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

### Basic Sentry Gin middleware setup

Source: https://docs.sentry.io/platforms/go/guides/gin

Initializes a Gin engine and attaches the sentrygin middleware. Captures a message and returns a simple response. Run with app.Run(":3000").

```go
app := gin.Default()

// you can attach the handler as one of your middleware
app.Use(sentrygin.New(sentrygin.Options{
// specify options here...
}))

// Set up routes
app.GET("/", func(ctx *gin.Context) {
	// capturing an error intentionally to simulate usage
	sentry.CaptureMessage("It works!")
	
	ctx.String(http.StatusOK, "Hello world!")
})

// And run it
app.Run(":3000")
```

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

### Import Sentry SDK for Browser JavaScript

Source: https://docs.sentry.io/platforms/javascript/performance/instrumentation/performance-metrics

Import the Sentry SDK to get started with tracing. The first example uses the @sentry/browser package, while the second uses a placeholder package name that you can replace with your personal config.

```javascript
import * as Sentry from "@sentry/browser";
```

```javascript
import * as Sentry from "___SDK_PACKAGE___";
```

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

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

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

Use these commands to install the Sentry Go SDK and the Zerolog integration package.

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

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

### Install Sentry Angular SDK with wizard

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

Run the Sentry wizard to automatically configure Sentry in your Angular application. The wizard guides you through the setup process and asks you to enable additional optional features. Requires Angular version 17.0.0 or above.

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

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

### Configure Sentry and wrap SQL driver with sentrysql.Open

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

Initialize Sentry with tracing enabled and wrap a SQL driver using sentrysql.Open. WithDatabaseName and WithServerAddress are optional but recommended for richer metadata.

```go
import (
    "github.com/getsentry/sentry-go"
    sentrysql "github.com/getsentry/sentry-go/sql"
)

if err := sentry.Init(sentry.ClientOptions{
    Dsn:              "https://<key>@o<orgId>.ingest.sentry.io/<projectId>",
    EnableTracing:    true,
    TracesSampleRate: 1.0,
}); err != nil {
    panic(err)
}

// With well-known driver names, db.system can usually be inferred.
db, err := sentrysql.Open("postgres", dsn,
    sentrysql.WithDatabaseName("appdb"),
    sentrysql.WithServerAddress("localhost", 5432),
)
if err != nil {
    panic(err)
}
```

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

### Stream Mode: SentryHttpClient with Sentry.startSpan

Source: https://docs.sentry.io/platforms/dart/guides/flutter/integrations/http-integration

Use this snippet to trace HTTP requests in stream mode, the default. It starts a root span with Sentry.startSpan and attaches a span for each HTTP request made by SentryHttpClient. The example posts to an endpoint and then gets the returned URI.

```dart
import 'package:sentry/sentry.dart';

// Start a root span — a span is attached for each HTTP request
await Sentry.startSpan('webrequest', (span) async {
  var client = SentryHttpClient();
  try {
    var uriResponse = await client.post('https://example.com/whatsit/create',
      body: {'name': 'doodle', 'color': 'blue'});
    print(await client.get(uriResponse.bodyFields['uri']));
  } finally {
    client.close();
  }
}, parentSpan: null);
```

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

### Install @sentry/node-native

Source: https://docs.sentry.io/platforms/javascript/guides/tanstackstart-react/configuration/integrations/event-loop-block

Install the Sentry Node native package for TanStack Start React.

```bash
npm install @sentry/node-native

```

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

### Start the application with node main.mjs

Source: https://docs.sentry.io/platforms/javascript/guides/pi-durable/install/esm-without-import

Start the application as usual with the command node main.mjs.

```bash
node main.mjs
```

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

### Install Sentry SDK for Remix with wizard

Source: https://docs.sentry.io/platforms/javascript/guides/remix/session-replay

Run this command to install the Sentry SDK for Remix. The wizard will prompt you to log in to Sentry and then automatically configure your project, including creating entry.client.tsx and entry.server.tsx, adding Sentry.init() calls, creating .sentryclirc, adjusting the build script, and adding an example page.

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

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

### Install Sentry Go SDK

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

Install the Sentry Go SDK version 0.42.0 or above using go get.

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

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

### Start the Strawberry server

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

Run the Strawberry server with the schema module to start the GraphQL server.

```bash
strawberry server schema
```

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

### Install raven-go and sentry-go

Source: https://docs.sentry.io/platforms/go/guides/gin/migration

Install the deprecated Raven SDK or the new Sentry Go SDK using go get.

```bash
go get github.com/getsentry/raven-go
```

```bash
go get github.com/getsentry/sentry-go
```
Tokens:
Raw