Open, vendor-neutral specification for portable synthetic monitoring checks
Synthetic Open Schema (SOS) is an open specification that defines a vendor-neutral format for synthetic monitoring checks. Write your checks once, run them anywhere.
β Portable β Define checks once, execute on any compatible runner β Vendor-Neutral β Break free from platform lock-in β Declarative β YAML-based, Kubernetes-style configuration β Production-Ready β Stable v1.0.0 specification released β Open Source β Apache 2.0 licensed, community-driven
apiVersion: v1
kind: HttpCheck
metadata:
name: api-health-check
spec:
url: https://api.example.com/health
interval: 1m
checks:
- type: statusCode
value: 200
- type: responseTime
operator: lessThan
value: 500ms| Repository | Description | Status |
|---|---|---|
| spec | Normative specification (RFC-style docs) | β v1.0.0 Stable |
| schemas | JSON Schema definitions | β Stable |
| Repository | Description | Language | Status |
|---|---|---|---|
| model | Python Pydantic models | Python | β Stable |
| runner | Python execution engine | Python | β Stable |
- HttpCheck β HTTP/HTTPS endpoint monitoring
- TcpCheck β TCP port connectivity
- DnsCheck β DNS resolution validation
- TlsCheck β TLS/SSL certificate monitoring
- DomainCheck β Domain registration checks
- LoadCheck β Page load performance monitoring
- ScriptedCheck β Browser automation scripts
View complete specification β
We welcome contributions from the community!
- π Spec Issues: syntheticopenschema/spec/issues
- π¬ Discussions: syntheticopenschema/spec/discussions
- π§ Implementation: Contribute to model or runner
- π Documentation: Help improve docs and examples
Before contributing, please read:
Building your own runner or client library? We'd love to feature it!
Criteria for listing:
- Implements the base Resource model
- Supports at least one check kind completely
- Documents which features are supported
- Clearly marks conformance level
Open an issue to add your implementation!
- π Website: syntheticopenschema.org
- π Specification: github.com/syntheticopenschema/spec
- π Python Package: PyPI - synthetic-open-schema-model
- π Python Runner: PyPI - synthetic-open-schema-runner
- π JSON Schemas: github.com/syntheticopenschema/schemas
Found a security issue? Please review our Security Policy for responsible disclosure.
DO NOT open public issues for security vulnerabilities. Instead:
All repositories in this organization are licensed under Apache License 2.0 unless otherwise stated.
See individual repository LICENSE files for details.
Synthetic Open Schema is stewarded by Ideatives Inc. and developed as an open specification.
- Maintainer: @dmonroy
- Decision Process: Governance Model
- RFC Process: New check types require 14-day community review
Monitoring platforms use proprietary check formats, creating vendor lock-in. Migrating between platforms means rewriting all your checks.
Synthetic Open Schema provides a common contract β define your checks once in a standard format, run them on any compatible platform or runner.
- π Portability: Switch monitoring platforms without rewriting checks
- π€ Interoperability: Share check definitions across teams and tools
- π Consistency: Same format for HTTP, DNS, TCP, TLS, browser checks
- π Flexibility: Build custom runners for your specific needs
- π Open: No vendor control, community-driven evolution
- π¬ GitHub Discussions
- π Report Issues
- π Star the Spec Repo