Skip to main content
CheckUpstreamCheckUpstreamDocs
Sign In

Getting Started with CheckUpstream

CheckUpstream monitors the health of the upstream services your application depends on. When Stripe goes down, your payment flow breaks. When OpenAI has an outage, your AI features stop working. CheckUpstream detects these issues before your users do.

How It Works

  1. Scan your dependencies: Upload your dependency manifest (package.json, Cargo.toml, go.mod, Gemfile, pom.xml, requirements.txt, and more), and CheckUpstream identifies which upstream services you rely on.
  2. Monitor status pages: We continuously poll the status pages of your upstream services (Stripe, OpenAI, AWS, Supabase, and 220+ others).
  3. Alert your team: When an upstream service degrades, you get notified via email, Slack, Discord, Microsoft Teams, PagerDuty, OpsGenie, Google Chat, Telegram, SMS, webhook, Rootly, or Incident.io.
  4. SDK telemetry (optional): Install the SDK to capture real-time latency and error rates for your outbound API calls.

Quick Start

1. Create an Account

Sign up at checkupstream.com/sign-in. You can start with the free plan (2 projects, 5 monitored services).

2. Create a Project

From the dashboard, click New Project and give it a name (e.g., "my-saas-app").

3. Upload Your Dependencies

Upload your dependency file. CheckUpstream will parse it and automatically map your packages to upstream services. For example:

  • stripe → Stripe (status.stripe.com)
  • openai → OpenAI (status.openai.com)
  • @supabase/supabase-js → Supabase (status.supabase.com)

4. Configure Alerts

Go to Settings → Alerts and set up your preferred notification channels. See the Alert Channels guide for details on each channel.

5. Install the SDK (Optional)

For real-time telemetry, install the SDK in your application. See the SDK Reference for the full API.

npm install @checkupstream/sdk
import { checkupstream } from "@checkupstream/sdk";

checkupstream.init({ apiKey: "cup_your_api_key" });

The SDK automatically detects outbound HTTP calls to supported services and reports latency and error data.

Supported Ecosystems

CheckUpstream parses dependency files from 32 ecosystems:

Language ecosystems: npm, PyPI, Go, Cargo (Rust), RubyGems, Maven (Java), Composer (PHP), NuGet (.NET), Swift (SPM), Pub (Dart), Hex (Elixir), Deno, Conan (C++), CRAN (R), Hackage (Haskell), Julia, LuaRocks, Zig, Nimble (Nim), opam (OCaml), CPAN (Perl), Conda, Bun, Elm, Shards (Crystal), Dub (D)

Infrastructure ecosystems: Docker, Terraform, GitHub Actions, Helm, Bazel, Nix

See Supported Services for the full list of monitored services and their package mappings.

Next Steps