Skip to content

docs: add upstream provider status example - #1748

Open
koko3tallah wants to merge 1 commit into
TwiN:masterfrom
koko3tallah:codex/gatus-upstream-provider-status
Open

docs: add upstream provider status example#1748
koko3tallah wants to merge 1 commit into
TwiN:masterfrom
koko3tallah:codex/gatus-upstream-provider-status

Conversation

@koko3tallah

@koko3tallah koko3tallah commented Aug 5, 2026

Copy link
Copy Markdown

What changed

  • document a copy-paste Gatus endpoint for monitoring a cloud or SaaS provider through OutageDeck’s normalized official-status API
  • use a conservative 10-minute interval, bounded client timeout, and native JSON body condition
  • explain all non-operational states and state explicitly that official-feed evidence complements rather than replaces direct application health checks
  • add the new section to the README table of contents

Why

Gatus already supports JSON-path body conditions, but users monitoring their own applications do not currently have an example for correlating a failure with an upstream provider incident. This recipe lets them reuse their existing Gatus dashboard and alerting configuration without a new parser, API key, or local agent.

Validation

  • git diff --check
  • go build -o /tmp/gatus-outagedeck-qa .
  • started the built Gatus binary with the exact documented endpoint configuration
  • verified /api/v1/endpoints/statuses returned HTTP 200 and both documented conditions succeeded:
    • [STATUS] == 200
    • [BODY].data.currentStatus.code == operational

The broader go test ./config/... run reached the repository’s live-network integration checks, where twin.sh and example.org were unreachable from this environment. The README-only change does not touch those tests or application code.

Disclosure: I am affiliated with OutageDeck.

@github-actions github-actions Bot added documentation Improvements or additions to documentation area/alerting Related to alerting labels Aug 5, 2026
@koko3tallah
koko3tallah marked this pull request as ready for review August 5, 2026 16:26
@koko3tallah
koko3tallah force-pushed the codex/gatus-upstream-provider-status branch from bb926f3 to eb8a2a2 Compare August 8, 2026 21:44
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

area/alerting Related to alerting documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant