Documentation
ScoutSentinel docs
Everything you need to define a Watch, read an Event and integrate the API. Versioned with the product; the current version is v1.
Getting started
Concepts
Reference
- Step DSL referenceThe deterministic step language every Watch compiles to, the Watch definition that wraps it, and JSON examples that validate against the published schema.
- Assertions referenceOutcome, behaviour, change, exposure and coverage assertions, every definition type, severity, results and how an Event is derived from them.
- API overviewAuthentication, scopes, conventions, errors, pagination, filters and the resource map for the ScoutSentinel REST API.
- Webhooks and signaturesEvent delivery, the payload, request headers, HMAC-SHA256 signature verification in Node and Python, the replay window and the retry schedule.
Operations
- Exporting metrics to Grafana and OpenTelemetryPush journey, Event, certificate and exposure metrics to Grafana Cloud, Grafana Alloy, an OpenTelemetry Collector, Datadog or New Relic over OTLP/HTTP.
- Jira Service ManagementOpen a request, issue or Operations alert in Jira Service Management for every Event, comment on updates and close it when the Event resolves.
- Runner locationsLocation classes, what each can and cannot tell you, the runner identity on every Observation, location keys and how region comparison works.
- Synthetic traffic identification and allowlistingHow ScoutSentinel probes identify themselves, how to allowlist them and how to keep them out of analytics, fraud and revenue systems.