summary.h

Go to the documentation of this file.

/*
 * Copyright (c) 2024 Mustafa Abdullah Kus, Sparse Technology
 * Copyright (c) 2024 Nordic Semiconductor
 *
 * SPDX-License-Identifier: Apache-2.0
 */
 
#ifndef ZEPHYR_INCLUDE_PROMETHEUS_SUMMARY_H_
#define ZEPHYR_INCLUDE_PROMETHEUS_SUMMARY_H_
 
#include <zephyr/sys/iterable_sections.h>
#include <zephyr/net/prometheus/metric.h>
 
#include <stddef.h>
 
struct prometheus_summary_quantile {
        double quantile;
        double value;
        void *user_data;
};
 
struct prometheus_summary {
        struct prometheus_metric base;
        struct prometheus_summary_quantile *quantiles;
        size_t num_quantiles;
        double sum;
        unsigned long count;
        void *user_data;
};
 
#define PROMETHEUS_SUMMARY_DEFINE(_name, _desc, _label, _collector, ...) \
        STRUCT_SECTION_ITERABLE(prometheus_summary, _name) = {          \
                .base.name = STRINGIFY(_name),                          \
                .base.type = PROMETHEUS_SUMMARY,                        \
                .base.description = _desc,                              \
                .base.labels[0] = __DEBRACKET _label,                   \
                .base.num_labels = 1,                                   \
                .base.collector = _collector,                           \
                .quantiles = NULL,                                      \
                .num_quantiles = 0,                                     \
                .sum = 0.0,                                             \
                .count = 0U,                                            \
                .user_data = COND_CODE_0(                               \
                        NUM_VA_ARGS_LESS_1(LIST_DROP_EMPTY(__VA_ARGS__, _)), \
                        (NULL),                                         \
                        (GET_ARG_N(1, __VA_ARGS__))),                   \
        }
 
int prometheus_summary_observe(struct prometheus_summary *summary, double value);
 
int prometheus_summary_observe_set(struct prometheus_summary *summary,
                                   double value, unsigned long count);
 
#endif /* ZEPHYR_INCLUDE_PROMETHEUS_SUMMARY_H_ */