Get Index Rate Alert

GET

https://api.mezmo.com/v1/config/index-rate

GET

/v1/config/index-rate

curl https://api.mezmo.com/v1/config/index-rate \
     -H "Authorization: <apiKey>" \
     -H "Content-Type: application/json"

200Retrieved

{
  "max_lines": 500,
  "max_z_score": 3,
  "threshold_alert": "both",
  "frequency": "hourly",
  "channels": {
    "email": [
      "alerts@acme-corp.io",
      "sre-team@acme-corp.io"
    ],
    "pagerduty": [
      "PD1234567890abcdef"
    ],
    "slack": [
      "https://hooks.slack.com/services/T00000000/B00000000/XXXXXXXXXXXXXXXXXXXXXXXX"
    ],
    "webhook": [
      {
        "url": "https://telemetry.acme-corp.io/api/v1/alerts",
        "method": "POST",
        "headers": {
          "timestamp": "X-Alert-Timestamp"
        },
        "bodyTemplate": "{\"service\":\"payment-service\",\"alert\":\"index_rate_threshold_exceeded\",\"level\":\"ERROR\",\"metric\":\"request_latency_ms\"}"
      }
    ]
  },
  "enabled": true
}

Gets the configuration for an Index Rate Alert

Authentication

Authorizationstring

This key is used for all apis with the exception of ingest. You can obtain it following these instructions and placing the key in the header of your call in the format of Authorization: Token {accesstoken} For example:

curl -H 'Authorization: Token <ACCESS TOKEN>'

servicekeystring

(Deprecated) This key is used for v1 and v2 apis with the exception of ingest. Service keys can be used by placing your service key in the Authorization header of your api call. NOTE Usage of the service key auth mechanism has been deprecated in favor of IAM Access Tokens. Service keys can no longer be created, but can still be used for v1 and v2 apis while the transition takes place

Response

max_linesintegerOptional

The number of lines required in order to trigger the alert.

max_z_scoreintegerOptional

The number of standard deviations above the 30 day average lines in order to trigger the alert.

threshold_alertenumOptional

Determines if you want alerts to be triggered if both the max lines and standard deviation have been triggered, or if one of the thresholds has been reached.

Allowed values:

frequencyenumOptional

Notify recipients once per hour, or once per day, (starting when the threshold is passed the first time) until the index rate drops below the thresholds. When the index rate drops below the thresholds, alerting stops.

Allowed values:

channelsobjectOptional

enabledbooleanOptional