monitoring-plugins/lib/output.h
Lorenz Kästle 72fd885f4f Transform output format to a global state
This commit removes the format parameter from the mp_check
object and creates a module global variable instead.
This prevents thread safe usage of different mp_check objects
which should likely not present a big problem for now.
The reason for this change is effectively the very same,
the format was lost if an exit was triggered by a signal
handler (timeout in this example).
2025-03-07 23:38:50 +01:00

90 lines
2.5 KiB
C

#pragma once
#include "../config.h"
#include "./perfdata.h"
#include "./states.h"
/*
* A partial check result
*/
typedef struct {
mp_state_enum state; // OK, Warning, Critical ... set explicitly
mp_state_enum default_state; // OK, Warning, Critical .. if not set explicitly
bool state_set_explicitly; // was the state set explicitly (or should it be derived from subchecks)
char *output; // Text output for humans ("Filesystem xyz is fine", "Could not create TCP connection to..")
pd_list *perfdata; // Performance data for this check
struct subcheck_list *subchecks; // subchecks deeper in the hierarchy
} mp_subcheck;
/*
* A list of subchecks, used in subchecks and the main check
*/
typedef struct subcheck_list {
mp_subcheck subcheck;
struct subcheck_list *next;
} mp_subcheck_list;
/*
* Possible output formats
*/
typedef enum output_format {
MP_FORMAT_MULTI_LINE,
MP_FORMAT_TEST_JSON,
} mp_output_format;
#define MP_FORMAT_DEFAULT MP_FORMAT_MULTI_LINE
/*
* Format related functions
*/
void mp_set_format(mp_output_format format);
mp_output_format mp_get_format(void);
/*
* The main state object of a plugin. Exists only ONCE per plugin.
* This is the "root" of a tree of singular checks.
* The final result is always derived from the children and the "worst" state
* in the first layer of subchecks
*/
typedef struct {
char *summary; // Overall summary, if not set a summary will be automatically generated
mp_subcheck_list *subchecks;
} mp_check;
mp_check mp_check_init(void);
mp_subcheck mp_subcheck_init(void);
mp_subcheck mp_set_subcheck_state(mp_subcheck, mp_state_enum);
mp_subcheck mp_set_subcheck_default_state(mp_subcheck, mp_state_enum);
int mp_add_subcheck_to_check(mp_check check[static 1], mp_subcheck);
int mp_add_subcheck_to_subcheck(mp_subcheck check[static 1], mp_subcheck);
void mp_add_perfdata_to_subcheck(mp_subcheck check[static 1], mp_perfdata);
void mp_add_summary(mp_check check[static 1], char *summary);
mp_state_enum mp_compute_check_state(mp_check);
mp_state_enum mp_compute_subcheck_state(mp_subcheck);
typedef struct {
bool parsing_success;
mp_output_format output_format;
} parsed_output_format;
parsed_output_format mp_parse_output_format(char *format_string);
// TODO free and stuff
// void mp_cleanup_check(mp_check check[static 1]);
char *mp_fmt_output(mp_check);
void mp_print_output(mp_check);
/*
* ==================
* Exit functionality
* ==================
*/
void mp_exit(mp_check) __attribute__((noreturn));