Documentation
Everything you need to get started with Overcast
Quick Start
1. Create an Account
Sign up for Overcast and choose the plan that fits your team size and needs.
2. Install the SDK
Add Overcast to your project with a single command: npm install @overcast/sdk
3. Configure Agents
Set up monitoring agents for your services and infrastructure.
4. Start Monitoring
Let Overcast automatically detect and analyze incidents in real-time.
Installation
Install the Overcast SDK using your preferred package manager:
# npm
npm install @overcast/sdk
# yarn
yarn add @overcast/sdk
# pnpm
pnpm add @overcast/sdk
// Initialize in your application
import { Overcast } from '@overcast/sdk'
const overcast = new Overcast({
apiKey: process.env.OVERCAST_API_KEY,
})
Explore the Docs
Getting Started
Quick Start Guide
Get up and running in 5 minutes
Installation
Install and configure the Overcast SDK
Authentication
API keys and authentication methods
Basic Configuration
Configure your first monitoring agent
Core Features
Distributed Tracing
Set up cross-service tracing
Incident Detection
Automatic incident detection and alerting
Root Cause Analysis
AI-powered RCA configuration
GitHub Integration
Connect your repositories for git blame
MCP Commands
list_incidents
Query and filter incidents
root_cause
Get RCA for specific incidents
analyze_logs
Analyze log patterns and anomalies
safe_rollback
Automated rollback procedures
Integrations
Jira & Confluence
Automated postmortem documentation
Slack & PagerDuty
Alert routing and notifications
GitHub & GitLab
Source control integration
Datadog & New Relic
Existing observability tools
API Reference
REST API
Complete REST API documentation
WebSocket API
Real-time streaming API
SDK Reference
Language-specific SDK documentation
Rate Limits
API rate limits and quotas
Advanced Topics
Custom Runbooks
Create automated incident response runbooks
Alert Rules
Advanced alert configuration
Data Retention
Configure retention policies
Security & Compliance
HIPAA, FedRAMP, and custom compliance
Need Help?
Can't find what you're looking for? Our support team is here to help.
📚 Full interactive documentation launching soon. Current plan subscribers get early access.