service-config.docker-compose.json

{
  "alerting": {
    "receivers": [
      {
        "name": "dev-receiver",
        "type": "Email",
        "options": {
          "address": "dev-receiver@mailserver.local"
        }
      }
    ]
  },
  "services": [
    {
      "name": "test-metric-app-child",
      "displayName": "Test Application Child",
      "description": "A test application that generates arbitrary metrics for testing purpose",
      "url": "http://test-metric-app:2020/metrics",
      "children": null,
      "healthChecks": [
        {
          "name": "example-child",
          "description": "Degraded and Offline periodically based on an example metric.",
          "definition": {
            "duration": "0.00:00:10",
            "expression": "example_saw_wave",
            "conditions": [
              {
                "operator": "GreaterThan",
                "threshold": 60,
                "status": "Offline"
              },
              {
                "operator": "GreaterThan",
                "threshold": 20,
                "status": "Degraded"
              }
            ]
          },
          "type": "prometheusMetric"
        }
      ]
    },
    {
      "name": "test-metric-app",
      "displayName": "Test Application",
      "description": "A test application that generates arbitrary metrics for testing purpose",
      "url": "http://test-metric-app:2020/metrics",
      "children": ["test-metric-app-child"],
      "healthChecks": [
        {
          "name": "example",
          "description": "Degraded and Offline periodically based on an example metric.",
          "definition": {
            "duration": "0.00:00:10",
            "expression": "example_saw_wave",
            "conditions": [
              {
                "operator": "GreaterThan",
                "threshold": 60,
                "status": "Offline"
              },
              {
                "operator": "GreaterThan",
                "threshold": 20,
                "status": "Degraded"
              }
            ]
          },
          "type": "prometheusMetric"
        },
        {
          "name": "example-loki",
          "description": "Example Loki Metric",
          "definition": {
            "duration": "0.00:00:30",
            "expression": "sum by (job) (count_over_time({job=\"Example.LokiLogMessage\", level=\"Error\"}[30s]))",
            "conditions": [
              {
                "operator": "GreaterThan",
                "threshold": 4,
                "status": "Offline"
              },
              {
                "operator": "GreaterThan",
                "threshold": 3,
                "status": "Degraded"
              },
              {
                "operator": "GreaterThan",
                "threshold": 2,
                "status": "AtRisk"
              }
            ]
          },
          "type": "lokiMetric"
        }
      ]
    },
    {
      "name": "http-metric-test-app",
      "displayName": "Test Application for HTTP Health Check",
      "description": "A test application that has endpoints to simulate different HTTP status codes.",
      "url": "http://http-metric-test-app:8082/api/ready",
      "children": null,
      "versionChecks": [
        {
          "versionCheckType": "HttpResponseBody",
          "definition": {
            "url": "http://http-metric-test-app:8082/api/version",
            "path": "$.version",
            "bodyType": "json"
          }
        }
      ],
      "healthChecks": [
        {
          "name": "exampleHttpTest",
          "description": "Check to see if request contains failed status code and/or request duration greater than specified threshold.",
          "definition": {
            "url": "http://http-metric-test-app:8082/api/ready",
            "followRedirects": true,
            "authorizationHeader": "test-header",
            "conditions": [
              {
                "status": "Online",
                "statusCodes": [200, 201],
                "type": "HttpStatusCode"
              },
              {
                "status": "Degraded",
                "responseTime": "00:00:02",
                "type": "HttpResponseTime"
              }
            ]
          },
          "type": "httpRequest"
        }
      ]
    },
    {
      "name": "alerting-test-app",
      "displayName": "Test application for alerting",
      "description": "An application with alerting configuration. Rules and receivers have been manually configured in the docker-compose environment.",
      "alertingRules": [
        {
          "name": "alerting-test-app-is-offline",
          "threshold": "Offline",
          "receiverName": "dev-receiver"
        }
      ],
      "healthChecks": [
        {
          "name": "succeedfail-http-health-check",
          "description": "Request the succeedfail endpoint from the http-metric-test-app to alternate between an online and offline state.",
          "type": "HttpRequest",
          "definition": {
            "url": "http://http-metric-test-app:8082/api/succeedfail?period=00:03:00",
            "conditions": [
              {
                "status": "Online",
                "statusCodes": [ 200 ],
                "type": "HttpStatusCode"
              }
            ]
          }
        }
      ]
    }
  ],
  "rootServices": [
    "test-metric-app",
    "http-metric-test-app",
    "alerting-test-app"
  ]
}