Skip to content

COS Tool is a small Go application used within the Canonical Observability Stack for validating and manipulating telemetry and alert rules.

License

Notifications You must be signed in to change notification settings

canonical/cos-tool

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

17 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

cos-tool

Release Discourse Status

Transforms PromQL/LogQL expressions on the fly, and validates that Alert rules can be loaded successfully by either Prometheus or Loki.

Usage

Given the expression

job:request_latency_seconds:mean5m{job=\"myjob\"} > 0.5

PromQL

Running:

$ ./cos-tool transform \
    --label-matcher juju_model=lma \
    --label-matcher juju_model_uuid=12345 \
    --label-matcher juju_application=proxy \
    --label-matcher juju_unit=proxy/1 \
    "job:request_latency_seconds:mean5m{job=\"myjob\"} > 0.5"

Would output

job:request_latency_seconds:mean5m{job="myjob",juju_application="proxy",juju_model="lma",juju_model_uuid="12345",juju_unit="proxy/1"} > 0.5

LogQL

Running:

$ ./cos-tool transform \
    --format logql \
    --label-matcher juju_model=lma \
    --label-matcher juju_model_uuid=12345 \
    --label-matcher juju_application=proxy \
    --label-matcher juju_unit=proxy/1 \
    'rate({filename="myfile"}[1m])'

Would output

rate({filename="myfile",juju_application="proxy",juju_model="lma",juju_model_uuid="12345",juju_unit="proxy/1"}[1m])

Alert Rule validation

Alert rules in either Loki or Prometheus syntax can be validated directly by running:

$ ./cos-tool [-f logql] validate rule_file.yaml [rule_file2.yaml ...]

If it's valid, no output will occur, and the return code will be zero.

If there are validation failures, they will be printed, and you will get a nonzero recdoe.