Fetch pipeline health metrics

GET

https://api.mezmo.com/v3/pipeline/metric/health

GET

/v3/pipeline/metric/health

curl -G https://api.mezmo.com/v3/pipeline/metric/health \
     -H "Authorization: Token <pipeline-service-key>" \
     -H "Content-Type: application/json" \
     -d pipeline_id=3fa85f64-5717-4562-b3fc-2c963f66afa6 \
     -d include_logs=true

200Retrieved

{
  "pipelines": [
    {
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "name": "payment-service",
      "status": "healthy",
      "metrics": {
        "request_latency_ms": 120,
        "error_rate_5xx": 0.02,
        "throughput_rps": 350
      },
      "logs": [
        {
          "timestamp": "2024-06-10T14:22:35Z",
          "level": "INFO",
          "message": "Processed batch 42 successfully",
          "host": "logs.acme-corp.io"
        },
        {
          "timestamp": "2024-06-10T14:23:01Z",
          "level": "WARN",
          "message": "Retrying failed request to auth-gateway",
          "host": "logs.acme-corp.io"
        }
      ]
    },
    {
      "id": "7b9e1f2a-8c4d-4d3a-9f1e-2a7b8c9d0e1f",
      "name": "order-processor",
      "status": "degraded",
      "metrics": {
        "request_latency_ms": 250,
        "error_rate_5xx": 0.1,
        "throughput_rps": 180
      },
      "logs": [
        {
          "timestamp": "2024-06-10T14:21:10Z",
          "level": "ERROR",
          "message": "Failed to connect to telemetry.acme-corp.io",
          "host": "logs.acme-corp.io"
        },
        {
          "timestamp": "2024-06-10T14:22:45Z",
          "level": "INFO",
          "message": "Recovered connection to telemetry.acme-corp.io",
          "host": "logs.acme-corp.io"
        }
      ]
    }
  ]
}

Query and fetch health information for the current account.

Authentication

AuthorizationToken

Header authentication of the form Token <token>

Query parameters

pipeline_idstringOptionalformat: "uuid"

Limit health metrics to the given pipeline id. If not defined, the metrics will include all pipelines for the account.

include_logsbooleanOptionalDefaults to true

Fetch previous log messages for transforms.

Response

Default Response