metrics.h

Go to the documentation of this file.

 
#ifndef METRICS_H
#define METRICS_H
 
#include "esp_err.h"
#include "stdint.h"
 
#define METRICS_TABLE(ENTRY)                                                                                 \
    ENTRY (METRICS_STAT_RS485_DRIVER_OVERFLOW_ERRORS, "RS485_DRIVER_OVERFLOW_ERRORS")                        \
    ENTRY (METRICS_STAT_RS485_DRIVER_PARITY_ERRORS, "RS485_DRIVER_PARITY_ERRORS")                            \
    ENTRY (METRICS_STAT_MODBUS_CRC_ERRORS, "MODBUS_CRC_ERRORS")                                              \
    ENTRY (METRICS_STAT_MODBUS_OVERFLOW_ERRORS, "MODBUS_OVERFLOW_ERRORS")                                    \
    ENTRY (METRICS_STAT_MODBUS_NO_MEM_ERRORS, "MODBUS_NO_MEM_ERRORS")                                        \
    ENTRY (METRICS_STAT_TELEMETRY_PUBLISH_ERRORS, "TELEMETRY_PUBLISH_ERRORS")                                \
    ENTRY (METRICS_STAT_LOGGER_WRITE_ERRORS, "LOGGER_WRITE_ERRORS")
 
typedef enum {
#define AS_ENUM(id, str) id,
    METRICS_TABLE (AS_ENUM)
#undef AS_ENUM
        METRICS_STAT_MAX
} metrics_stat_t;
 
esp_err_t metrics_init (void);
 
esp_err_t metrics_get_snapshot (uint32_t *buf_ptr, size_t buf_length, uint16_t *copied_length);
 
void metrics_log_all (void);
 
void metrics_reset_all (void);
 
const char *metrics_stat_to_string (metrics_stat_t stat);
 
#endif