A sample file of what a brace rule set could look like

brace.yml

version: 1
environment:
  - name: LISTEN_ADDRESS
    value: "localhost:8080"
    usage: "This is the address that the application listens on"
  - name: HEALTH_ADDRESS
    value: "localhost:8080/healthz"
    usage: "This is the endpoint for health checks performed by kubernetes"
  - name: DATABASE_URL
    value: "postgres://postgres:5432"
    usage: "This is the database URL that our application connects to"
  - name: STATSD_ADDRESS
    value: "udp://statsd:8125"
    usage: "UDP endpoint for where statsd are sent"
# number of seconds to wait before starting our rule checks
bootWaitTime: 3
rules:
  - name: "Application listens on given address"
    check:
      type: AcceptsTCP
      acceptsTCP:
        address: "localhost:8080"
        timeout: 3s
  - name: "Health endpoint returns JSON"
    check:
      type: HTTPJSON
      endpoint: "http://localhost:8080/healthz"
      # Swagger 2.0 compatible YAML describing schema
      schema: {}
  - name: "Statsd metrics match a certain format for keys"
    check:
      type: StatsdKeyFormat
      formats:
        - type: counter
          format: "my-app\.counter\.(.+)"
        - type: timer
          format: "my-app\.timer\.(.+)"