Core-tel module
Files
- file level.hpp
- Telemetry levels.
- file logging.hpp
- Logging and assertion macros.
- file metrics.hpp
- Metrics and profiling utilities and macros.
- file tracing.hpp
- Tracing macros.
Classes
- class cubos::core::tel::Logger
- Singleton which holds the logging state.
Enums
Functions
Defines
- #define CUBOS_TEL_LEVEL_TRACE
- Trace telemetry level, lowest telemetry level. Very verbose.
- #define CUBOS_TEL_LEVEL_DEBUG
- Debug telemetry level. Contains logs and tracing useful for debugging, but which are not necessary in release builds.
- #define CUBOS_TEL_LEVEL_INFO
- Information telemetry level. Contains important events that are not errors.
- #define CUBOS_TEL_LEVEL_WARN
- Warn telemetry level. Contains events that are not errors, but which are unexpected and may be problematic.
- #define CUBOS_TEL_LEVEL_ERROR
- Error telemetry level. Contains errors which are recoverable from.
- #define CUBOS_TEL_LEVEL_CRITICAL
- Critical telemetry level, highest log level. Contains errors which are unrecoverable from.
- #define CUBOS_TEL_LEVEL_OFF
- Off telemetry level, disables all logging/tracing.
- #define CUBOS_TEL_LEVEL
- Telemetry level to compile in.
- #define CUBOS_SPAN(name, level)
- Constructs a new span with a specified level.
- #define CUBOS_SPAN_INFO(name)
- Constructs a new info span.
- #define CUBOS_SPAN_DEBUG(name)
- Constructs a new debug span.
- #define CUBOS_SPAN_TRACE(name)
- Constructs a new trace span.
Enum documentation
enum class Level
#include <core/tel/level.hpp>
Represents a telemetry level.
Enumerators | |
---|---|
Trace |
Trace telemetry level, lowest telemetry level. Very verbose. |
Debug |
Debug telemetry level. Contains logs and tracing useful for debugging, but which are not necessary in release builds. |
Info |
Information telemetry level. Contains important events that are not errors. |
Warn |
Warn telemetry level. Contains events that are not errors, but which are unexpected and may be problematic. |
Error |
Error telemetry level. Contains errors which are recoverable from. |
Critical |
Critical telemetry level, highest log level. Contains errors which are unrecoverable from. |
Off |
Off telemetry level, disables all logging/tracing. |
Function documentation
Define documentation
#define CUBOS_TEL_LEVEL_TRACE
#include <core/tel/level.hpp>
Trace telemetry level, lowest telemetry level. Very verbose.
#define CUBOS_TEL_LEVEL_DEBUG
#include <core/tel/level.hpp>
Debug telemetry level. Contains logs and tracing useful for debugging, but which are not necessary in release builds.
#define CUBOS_TEL_LEVEL_INFO
#include <core/tel/level.hpp>
Information telemetry level. Contains important events that are not errors.
#define CUBOS_TEL_LEVEL_WARN
#include <core/tel/level.hpp>
Warn telemetry level. Contains events that are not errors, but which are unexpected and may be problematic.
#define CUBOS_TEL_LEVEL_ERROR
#include <core/tel/level.hpp>
Error telemetry level. Contains errors which are recoverable from.
#define CUBOS_TEL_LEVEL_CRITICAL
#include <core/tel/level.hpp>
Critical telemetry level, highest log level. Contains errors which are unrecoverable from.
#define CUBOS_TEL_LEVEL_OFF
#include <core/tel/level.hpp>
Off telemetry level, disables all logging/tracing.
#define CUBOS_TEL_LEVEL
#include <core/tel/level.hpp>
Telemetry level to compile in.
This macro essentially controls the minimum Telemetry level that will be compiled into the binary.
Should be set to one of the following:
- CUBOS_
TEL_ LEVEL_ TRACE - CUBOS_
TEL_ LEVEL_ DEBUG - CUBOS_
TEL_ LEVEL_ INFO - CUBOS_
TEL_ LEVEL_ WARN - CUBOS_
TEL_ LEVEL_ ERROR - CUBOS_
TEL_ LEVEL_ CRITICAL - CUBOS_
TEL_ LEVEL_ OFF
By default, on debug builds, this is set to CUBOS_
#define CUBOS_SPAN(name,
level)
#include <core/tel/tracing.hpp>
Constructs a new span with a specified level.
Parameters | |
---|---|
name | Span name. |
level | Span level. |
#define CUBOS_SPAN_INFO(name)
#include <core/tel/tracing.hpp>
Constructs a new info span.
Parameters | |
---|---|
name | Span name. |
#define CUBOS_SPAN_DEBUG(name)
#include <core/tel/tracing.hpp>
Constructs a new debug span.
Parameters | |
---|---|
name | Span name. |
#define CUBOS_SPAN_TRACE(name)
#include <core/tel/tracing.hpp>
Constructs a new trace span.
Parameters | |
---|---|
name | Span name. |