Skip to main content

Alerts

Alerts configuration allows Inigo's users to configure custom alerts that will be triggered as Inigo events when configured conditions are met.

Example of an alert which is triggered when:

  • service receives at least 5 requests
  • within 2 minutes time window
  • with operation name Login
  • with errors

Sample Config

alerts.yaml

kind: Alerts
name: demo
label: starwars

spec:
alerts:
- name: "login_errors"
metric: calls
window: 2m
threshold : 5
filters:
operation_name: Login
has_errors: true

Spec

This section defines the format of Inigo's Alerts type configuration files. Fields marked as required must be specified if the parent is defined.

FieldTypeDescription
alerts[AlertsConfig]List of alerts configurations

AlertsConfig

FieldTypeDescription
namestring requiredName of the Alert
windowstring requiredTime window in which given amount of requests should occur
String represents the duration in the form "72h3m0.5s".
thresholdintSets how many requests will trigger an alert
filtersAlertsFilter
immediatebooleanTriggers an immediate alert as soon as the specified threshold within a time window is reached. A subsequent alert is then dispatched at the conclusion of the window, provided the threshold is still met.

AlertsFilter

FieldTypeDescription
hashstringHash of the request query
statusstring default:NONERequest status
One of:
- PASSED
- BLOCKED
- EXCEPTION
- NONE
operation_typestring default:UNKNOWNRequest operation type
One of:
- QUERY
- MUTATION
- SUBSCRIPTION
- UNKNOWN
operation_namestringRequest operation name
clientstringRequest client version
has_errorsbooleanWhether request has errors or not
errorstringRequest error message
tagstringRequest with a tag