Integrations

The smith-api includes several pre-built integrations that can be easily configured to enhance your application.

Available Integrations

These integrations are optional and can be enabled by setting specific environment variables in your deployment configuration.

Sentry API Error Reporting

Purpose: Provides real-time error tracking and monitoring for your API.

Configuration:

  • Set the SENTRY_URL environment variable with your Sentry DSN (Data Source Name)
  • Example: SENTRY_URL=https://abc123@sentry.io/123456

Benefits:

  • Automatically captures and reports API exceptions
  • Tracks performance issues
  • Provides detailed error context for faster debugging

Slack Notifications

Purpose: Sends automated notifications to your Slack workspace when important events occur.

Configuration:

  • Set the SLACK_HOOK_URL environment variable with your Slack Incoming Webhook URL
  • Example: SLACK_HOOK_URL=https://hooks.slack.com/services/T00000000/B00000000/XXXXXXXXXXXXXXXXXXXXXXXX

Benefits:

  • Real-time alerts when new devices register with the API
  • Keep your team informed of system activity
  • Customize notification content in Slack's webhook settings

Victoria Metrics

Purpose: Time-series database and monitoring solution for collecting and visualizing API metrics.

Configuration:

  • Set the VICTORIA_METRICS_URL environment variable with your Victoria Metrics instance URL
  • Set the VICTORIA_METRICS_AUTH_TOKEN environment variable with your authentication token
  • Example: 
    VICTORIA_METRICS_URL=https://your-vm-instance.example.com
VICTORIA_METRICS_AUTH_TOKEN=your-auth-token

Benefits:

  • High-performance metrics collection
  • Long-term storage of monitoring data
  • Compatible with Prometheus querying and visualization tools

Implementation Example

Add these environment variables to your deployment configuration:

# Error Reporting
SENTRY_URL=https://your-sentry-dsn

# Event Notifications
SLACK_HOOK_URL=https://hooks.slack.com/services/your-webhook-url

# Metrics and Monitoring
VICTORIA_METRICS_URL=https://your-vm-instance.example.com
VICTORIA_METRICS_AUTH_TOKEN=your-auth-token

Additional Information

For more details on configuring these integrations or for troubleshooting, refer to each provider's documentation linked above.