Skip to content

syntheticopenschema/.github

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

2 Commits
 
 
 
 

Repository files navigation

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

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published