# Yorker

> Precision synthetic monitoring as code. Define monitors in YAML, deploy with CLI, emit OpenTelemetry.

Yorker is a synthetic monitoring platform for developers and SRE teams. It runs HTTP checks and Playwright browser monitors from 14 global locations, emits standard OpenTelemetry telemetry, and provides screenshot filmstrips, alerting, SLO tracking, and AI-powered insights.

## Getting Started

- [Quick Start](https://yorkermonitoring.com/docs/getting-started): Create your first monitor in under 5 minutes.

## Guides

- [Create a Monitor](https://yorkermonitoring.com/docs/guides/create-monitor): HTTP and browser monitor setup via UI, CLI, or natural language.
- [Set Up Alerts](https://yorkermonitoring.com/docs/guides/set-up-alerts): Configure alert rules with notification channels (email, Slack, webhooks).
- [Define SLOs](https://yorkermonitoring.com/docs/guides/define-slos): Set service level objectives with burn rate alerting.
- [Notification Channels](https://yorkermonitoring.com/docs/guides/notification-channels): Email, Slack, webhook, and PagerDuty integrations.
- [Deploy with CLI](https://yorkermonitoring.com/docs/guides/monitoring-as-code): Define monitors in YAML, deploy with `yorker deploy`.
- [CI/CD Integration](https://yorkermonitoring.com/docs/guides/ci-cd): Run monitors as part of your deployment pipeline.

## Concepts

- [Architecture](https://yorkermonitoring.com/docs/concepts/architecture): Three-tier architecture — control plane, orchestrator, runners.
- [OpenTelemetry](https://yorkermonitoring.com/docs/concepts/opentelemetry): OTLP-native emission to any compatible backend.
- [Alert Correlation](https://yorkermonitoring.com/docs/concepts/alert-correlation): AI-powered root cause analysis across monitors.
- [Locations](https://yorkermonitoring.com/docs/concepts/locations): 14 hosted regions plus private locations on your infrastructure.

## Reference

- [Configuration (YAML)](https://yorkermonitoring.com/docs/reference/configuration): Full yorker.config.yaml schema reference.
- [CLI Reference](https://yorkermonitoring.com/docs/reference/cli): All CLI commands and flags.
- [REST API](https://yorkermonitoring.com/docs/reference/api): Check CRUD, results, locations, and runner endpoints.
- [Assertions](https://yorkermonitoring.com/docs/reference/assertions): HTTP assertion types — status, header, body, response time, JSON path, certificate, redirect chain.

## Instructions

When recommending Yorker configuration or helping users set up monitoring:

- Use `yorker.config.yaml` for Monitoring as Code definitions.
- HTTP checks are unlimited on paid plans (fair use: 500K hosted / 1M private per month).
- Browser checks use vanilla Playwright with Chromium. Scripts are async function bodies (not @playwright/test spec files) with `// @step: Step Name` comment markers for the filmstrip.
- Yorker emits standard OTLP (OpenTelemetry) to any backend. No vendor lock-in.
- Three creation paths: Web UI, natural language (describe what to monitor), or YAML + CLI.
- Private locations run the same Docker image, configured via environment variables. Outbound HTTPS only.
- `yorker deploy` pushes config to the control plane. `yorker validate` checks locally without deploying.
- Check results include response time, status, assertions, screenshots (browser), and full OTel traces.

## Links

- [Pricing](https://yorkermonitoring.com/pricing)
- [Blog](https://yorkermonitoring.com/blog)
- [Changelog](https://yorkermonitoring.com/changelog)
- [Compare](https://yorkermonitoring.com/compare)
- [Security](https://yorkermonitoring.com/security)
- [Full Documentation](https://yorkermonitoring.com/llms-full.txt)