sentry-api-client

Sentry API Client PowerShell Module

A PowerShell module that provides a client interface for interacting with Sentry's REST APIs.

Installation

# Import the module
Import-Module ./SentryApiClient.psd1

Quick Start

# Connect to Sentry API
Connect-SentryApi -ApiToken "your-api-token" -Organization "your-org" -Project "your-project"

# Get specific event
Get-SentryEvent -EventId "123456"

# Get event attachments
Get-SentryEventAttachments -EventId "123456"

# Find events by tag
Get-SentryEventsByTag -TagName 'environment' -TagValue 'production'

# Find issues and events by tag
Find-SentryEventByTag -TagName 'release' -TagValue 'v1.0.0'

# Get structured logs
Get-SentryLogs -Query 'severity:error' -StatsPeriod '24h'

# Get logs by attribute
Get-SentryLogsByAttribute -AttributeName 'test_id' -AttributeValue 'abc123'

# Get metrics
Get-SentryMetrics -Query 'metric.name:my.counter'

# Get metrics by attribute
Get-SentryMetricsByAttribute -MetricName 'my.counter' -AttributeName 'test_id' -AttributeValue 'abc123'

# Get spans by trace ID
Get-SentrySpans -TraceId 'abc123def456789012345678901234ab'

# Download Sentry CLI
Get-SentryCLI -Version 'latest' -DownloadDirectory './bin'

# Use Sentry CLI with auto-configured org/project
Invoke-SentryCLI debug-files upload ./symbols

# Disconnect
Disconnect-SentryApi

Functions

Connect-SentryApi

Establishes connection to Sentry API with authentication and organization/project configuration.

# Connect with organization and project
Connect-SentryApi -ApiToken "your-api-token" -Organization "your-org" -Project "your-project"

# Connect using DSN (automatically extracts org/project)
Connect-SentryApi -ApiToken "your-api-token" -DSN "https://PUBLIC_KEY@o123456.ingest.sentry.io/789"

# Uses $env:SENTRY_AUTH_TOKEN if ApiToken not specified
Connect-SentryApi -Organization "your-org" -Project "your-project"

Disconnect-SentryApi

Clears the current Sentry API connection and configuration.

Get-SentryEvent

Retrieves a specific event from Sentry by its ID.

Get-SentryEventAttachments

Retrieves attachment metadata (name, size, type, content type) for a specific event. Does not download attachment content. Returns an array of attachment metadata objects.

# Get attachments for an event
Get-SentryEventAttachments -EventId "123456"

Get-SentryEventsByTag

Retrieves events filtered by a specific tag name and value.

# Basic usage
Get-SentryEventsByTag -TagName 'environment' -TagValue 'production'

# With full event details
Get-SentryEventsByTag -TagName 'user.email' -TagValue 'user@example.com' -Full

# With pagination
Get-SentryEventsByTag -TagName 'release' -TagValue '1.0.0' -Limit 50 -Cursor 'next123'

Find-SentryEventByTag

Finds issues and their associated events filtered by a tag. Returns structured data with both issues and events.

# Basic usage
Find-SentryEventByTag -TagName 'environment' -TagValue 'production'

# With custom sorting
Find-SentryEventByTag -TagName 'browser' -TagValue 'Chrome' -Sort 'date' -Limit 50

Returns an object with:

• Issues: Array of issue objects with tag information
• Events: Array of the latest events for each issue
• NextCursor: Cursor for pagination

Get-SentryLogs

Retrieves structured logs from Sentry using the ourlogs dataset.

# Query logs by severity
Get-SentryLogs -Query 'severity:error' -StatsPeriod '24h'

# Filter by trace ID
Get-SentryLogs -TraceId 'abc123def456' -Limit 50

# Custom fields
Get-SentryLogs -Query 'test_id:integration-test-001' -Fields @('id', 'message', 'severity', 'test_id')

Parameters:

• Query: Search query using Sentry search syntax
• TraceId: Filter logs by specific trace ID
• StatsPeriod: Time period (default: '24h')
• Limit: Maximum logs to return (default: 100)
• Fields: Fields to include in response (default: id, trace, severity, timestamp, message)

Get-SentryLogsByAttribute

Convenience wrapper for filtering logs by a specific attribute. Automatically includes the attribute in response fields.

# Filter by test ID
Get-SentryLogsByAttribute -AttributeName 'test_id' -AttributeValue 'integration-test-001'

# With custom time period
Get-SentryLogsByAttribute -AttributeName 'user_id' -AttributeValue '12345' -StatsPeriod '7d'

Get-SentryMetrics

Retrieves metrics from Sentry using the tracemetrics dataset.

# Query metrics by name
Get-SentryMetrics -Query 'metric.name:my.counter'

# With custom time period and fields
Get-SentryMetrics -Query 'metric.name:my.counter' -StatsPeriod '7d' -Fields @('id', 'metric.name', 'value')

Parameters:

• Query: Search query using Sentry search syntax
• StatsPeriod: Time period (default: '24h')
• Limit: Maximum metrics to return (default: 100)
• Fields: Fields to include in response (default: id, metric.name, metric.type, value, timestamp)

Get-SentryMetricsByAttribute

Convenience wrapper for filtering metrics by metric name and a specific attribute.

# Filter by metric name and test ID
Get-SentryMetricsByAttribute -MetricName 'test.integration.counter' -AttributeName 'test_id' -AttributeValue 'abc-123'

Get-SentrySpans

Retrieves spans from Sentry using the spans dataset. Transactions are spans with is_transaction=true.

# Get all spans for a trace
Get-SentrySpans -TraceId 'abc123def456789012345678901234ab'

# Get only transactions for a trace
Get-SentrySpans -TraceId 'abc123def456' -Query 'is_transaction:true'

# Query by span operation
Get-SentrySpans -Query 'span.op:http.client' -StatsPeriod '7d'

Parameters:

• Query: Search query using Sentry search syntax
• TraceId: Filter spans by specific trace ID
• StatsPeriod: Time period (default: '24h')
• Limit: Maximum spans to return (default: 100)
• Fields: Fields to include in response (default: id, trace, span.op, span.description, span.duration, is_transaction, timestamp, transaction.event_id)

Get-SentryCLI

Downloads the Sentry CLI executable for the current platform.

# Download latest version to current directory
Get-SentryCLI

# Download specific version to custom directory
Get-SentryCLI -Version '2.50.1' -DownloadDirectory './bin'

# Download and verify
$cliPath = Get-SentryCLI -Version 'latest' -DownloadDirectory "$HOME/.local/bin"
& $cliPath --version

Parameters:

• Version: Version to download (default: 'latest')
• DownloadDirectory: Directory to save the executable (default: current directory)

Returns the full path to the downloaded executable.

Invoke-SentryCLI

Wrapper for executing Sentry CLI commands with automatic organization and project configuration.

# Use system-installed sentry-cli (default)
Invoke-SentryCLI debug-files upload ./symbols

# Use latest version (downloads if needed, caches as sentry-cli-latest)
Invoke-SentryCLI -Version latest releases list

# Use specific version (downloads if needed, caches as sentry-cli-2.50.1)
Invoke-SentryCLI -Version 2.50.1 projects list

# Cached versions are reused automatically
Invoke-SentryCLI -Version 2.50.1 --version  # Uses cached sentry-cli-2.50.1

Parameters:

• Version: Version of sentry-cli to use (default: 'system')
  • 'system': Use sentry-cli from PATH
  • 'latest': Download/use latest version
  • Semantic version (e.g., '2.50.1'): Download/use specific version
• Arguments: Command line arguments to pass to sentry-cli

The function automatically adds --org and --project parameters when running debug-files upload command.

Testing

Run tests before committing (needs to run in a new shell to avoid caching the module):

pwsh -c 'Invoke-Pester ./Tests/'

API Reference

Based on Sentry API Documentation