sapi_log.h

Go to the documentation of this file.

#ifndef SAFEAPI_OS_LOG_H
#define SAFEAPI_OS_LOG_H
 
#include "safeapi/utils/status/sapi_status.h"
#include "safeapi/utils/types/sapi_types.h"
#include "safeapi/utils/string/sapi_string.h" /* sapi_log_fields_t backing store */
 
#include <stdbool.h>
 
#ifdef __cplusplus
extern "C" {
#endif

typedef enum sapi_log_level_e
{
    SAPI_LOG_LEVEL_DEBUG   = 0, 
    SAPI_LOG_LEVEL_INFO    = 1, 
    SAPI_LOG_LEVEL_WARNING = 2, 
    SAPI_LOG_LEVEL_ERROR   = 3  
} sapi_log_level_t;

sapi_status_t sapi_log_init(void);

void sapi_log_write(sapi_log_level_t level, const char *tag, const char *message);

const char *sapi_log_level_to_string(sapi_log_level_t level);

sapi_status_t sapi_log_level_from_string(const char *name, sapi_log_level_t *out_level);

void sapi_log_set_level(sapi_log_level_t min_level);

sapi_log_level_t sapi_log_get_level(void);

#define SAPI_LOG_EVENT_LINE_MAX_LEN 256U

void sapi_log_write_event(sapi_log_level_t level,
                           const char *site,
                           uint32_t cycle,
                           const char *source,
                           const char *destination,
                           const char *type,
                           const char *info,
                           const char *extra_fields);

typedef struct sapi_log_fields_s
{
    sapi_string_t str;                         
    char          storage[SAPI_LOG_EVENT_LINE_MAX_LEN]; 
} sapi_log_fields_t;

void sapi_log_fields_reset(sapi_log_fields_t *fields);

sapi_log_fields_t *sapi_log_fields_add_str(sapi_log_fields_t *fields, const char *key, const char *value);
sapi_log_fields_t *sapi_log_fields_add_u32(sapi_log_fields_t *fields, const char *key, uint32_t value);
sapi_log_fields_t *sapi_log_fields_add_i32(sapi_log_fields_t *fields, const char *key, int32_t value);
sapi_log_fields_t *sapi_log_fields_add_u64(sapi_log_fields_t *fields, const char *key, uint64_t value);
sapi_log_fields_t *sapi_log_fields_add_i64(sapi_log_fields_t *fields, const char *key, int64_t value);
sapi_log_fields_t *sapi_log_fields_add_hex_u32(sapi_log_fields_t *fields, const char *key,
                                               uint32_t value, uint8_t min_digits);
sapi_log_fields_t *sapi_log_fields_add_bool(sapi_log_fields_t *fields, const char *key, bool value);

const char *sapi_log_fields_c_str(sapi_log_fields_t *fields);

void sapi_log_write_event_fields(sapi_log_level_t level,
                                  const char *site,
                                  uint32_t cycle,
                                  const char *source,
                                  const char *destination,
                                  const char *type,
                                  const char *info,
                                  sapi_log_fields_t *fields);
 
/*
 * The backend vtable (sapi_log_backend_t) and sapi_log_register_backend()
 * live in safeapi_backend/log/sapi_log_backend.h, not here (ADR-021).
 * This header is the consumer-facing surface only.
 */
 
#ifdef __cplusplus
}
#endif
 
#endif /* SAFEAPI_OS_LOG_H */
 /* LOG */