Skip to content
@syntheticopenschema

Synthetic Open Schema

Synthetic Open Schema

Open, vendor-neutral specification for portable synthetic monitoring checks

License Version Status


What is Synthetic Open Schema?

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.

🎯 Key Features

βœ… 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


πŸš€ Quick Example

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

πŸ“¦ Repositories

Core

Repository Description Status
spec Normative specification (RFC-style docs) βœ… v1.0.0 Stable
schemas JSON Schema definitions βœ… Stable

Reference Implementations

Repository Description Language Status
model Python Pydantic models Python βœ… Stable
runner Python execution engine Python βœ… Stable

πŸŽ“ Supported Check Types

Core Checks (apiVersion: v1)

  • HttpCheck β€” HTTP/HTTPS endpoint monitoring
  • TcpCheck β€” TCP port connectivity
  • DnsCheck β€” DNS resolution validation
  • TlsCheck β€” TLS/SSL certificate monitoring
  • DomainCheck β€” Domain registration checks

Browser Checks (apiVersion: browser/v1)

  • LoadCheck β€” Page load performance monitoring
  • ScriptedCheck β€” Browser automation scripts

View complete specification β†’


🀝 Contributing

We welcome contributions from the community!

Before contributing, please read:


🌟 Community Implementations

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!


πŸ“˜ Resources


πŸ” Security

Found a security issue? Please review our Security Policy for responsible disclosure.

DO NOT open public issues for security vulnerabilities. Instead:


πŸ“œ License

All repositories in this organization are licensed under Apache License 2.0 unless otherwise stated.

See individual repository LICENSE files for details.


πŸ›οΈ Governance

Synthetic Open Schema is stewarded by Ideatives Inc. and developed as an open specification.


πŸ’‘ Why Synthetic Open Schema?

The Problem

Monitoring platforms use proprietary check formats, creating vendor lock-in. Migrating between platforms means rewriting all your checks.

The Solution

Synthetic Open Schema provides a common contract β€” define your checks once in a standard format, run them on any compatible platform or runner.

Benefits

  • πŸ”„ 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

πŸ“£ Stay Connected

Popular repositories Loading

  1. spec spec Public

    Open, vendor-neutral specification for portable synthetic monitoring checks. Define checks once, run anywhere. Supports HTTP, TCP, DNS, TLS, domain, and browser automation checks. Apache 2.0 licen…

    16 1

  2. .github .github Public

  3. syntheticopenschema.org syntheticopenschema.org Public

Repositories

Showing 3 of 3 repositories

People

This organization has no public members. You must be a member to see who’s a part of this organization.

Top languages

Loading…

Most used topics

Loading…