tencent cloud



Last updated: 2024-01-29 16:01:55
    A recording rule allows you to calculate some commonly used or complex metrics in advance and then store the calculated data in new data metrics. In this way, querying the calculated data will be faster and easier than querying the original data. This is very suitable for dashboard scenarios and can solve the problems of complicated user configuration and slow query.
    Recording rules exist in the form of rule group, and rules in the same group are executed sequentially at a certain interval. Rule names must conform to the corresponding Prometheus specification.
    Generally, a rule file is as follows:
    [ - <rule_group> ]
    Below is a simple example of recording rule:
    - name: example
    - record: job:http_inprogress_requests:sum
    expr: sum by (job) (http_inprogress_requests)

    Rule Group

    # A rule group name must be unique in the same file
    name: <string>
    # Rule detection interval
    [ interval: <duration> | default = global.evaluation_interval ]
    [ - <rule> ... ]


    The recording rule syntax is as follows:
    # The generated new metric name, which must be valid
    record: <string>
    # PromQL expression. Each calculated data entry will be stored in the new metric name `record`
    expr: <string>
    # The label to be added or overwritten in the data to be stored
    [ <labelname>: <labelvalue> ]
    The recommended format for naming recording rules is level:metric:operations.
    level: indicates the recording level and the output label of the rule.
    metric: indicates the metric name.
    operations: indicates the list of operations applied to the metric.
    - record: instance_path:requests:rate5m
    expr: rate(requests_total{job="myjob"}[5m])
    - record: path:requests:rate5m
    expr: sum without (instance)(instance_path:requests:rate5m{job="myjob"})
    Contact Us

    Contact our sales team or business advisors to help your business.

    Technical Support

    Open a ticket if you're looking for further assistance. Our Ticket is 7x24 avaliable.

    7x24 Phone Support