This header defines the types and functions your application uses to be notified of Azure SDK client library log messages. More...

#include <azure/core/az_result.h>
#include <azure/core/az_span.h>
#include <stdint.h>
#include <azure/core/_az_cfg_prefix.h>
#include <azure/core/_az_cfg_suffix.h>

Typedefs
typedef int32_t	az_log_classification
	Identifies the classifications of log messages produced by the SDK. More...

typedef void(*	az_log_message_fn) (az_log_classification classification, az_span message)
	Defines the signature of the callback function that application developers must write in order to receive Azure SDK log messages. More...

Enumerations
enum	az_log_classification_core { AZ_LOG_HTTP_REQUEST = _az_LOG_MAKE_CLASSIFICATION(_az_FACILITY_HTTP, 1), AZ_LOG_HTTP_RESPONSE = _az_LOG_MAKE_CLASSIFICATION(_az_FACILITY_HTTP, 2), AZ_LOG_HTTP_RETRY }
	Identifies the az_log_classification produced by the SDK Core. More...

Functions
void	az_log_set_message_callback (az_log_message_fn log_message_callback)
	Sets the function that will be invoked to report an SDK log message. More...

Detailed Description

This header defines the types and functions your application uses to be notified of Azure SDK client library log messages.

If you define the AZ_NO_LOGGING symbol when compiling the SDK code (or adding option -DLOGGING=OFF with cmake), all of the Azure SDK logging functionality will be excluded, making the resulting compiled code smaller and faster.

Note: You MUST NOT use any symbols (macros, functions, structures, enums, etc.) prefixed with an underscore ('_') directly in your application code. These symbols are part of Azure SDK's internal implementation; we do not document these symbols and they are subject to change in future versions of the SDK which would break your code.

Typedef Documentation

◆ az_log_classification

typedef int32_t az_log_classification

Identifies the classifications of log messages produced by the SDK.

Note

See the following az_log_classification values from various headers:

◆ az_log_message_fn

typedef void(* az_log_message_fn) (az_log_classification classification, az_span message)

Defines the signature of the callback function that application developers must write in order to receive Azure SDK log messages.

Parameters

[in]	classification	The log message's az_log_classification.
[in]	message	The log message.

Enumeration Type Documentation

◆ az_log_classification_core

enum az_log_classification_core

Identifies the az_log_classification produced by the SDK Core.

Enumerator
AZ_LOG_HTTP_REQUEST	HTTP request is about to be sent.
AZ_LOG_HTTP_RESPONSE	HTTP response was received.
AZ_LOG_HTTP_RETRY	First HTTP request did not succeed and will be retried.

Function Documentation

◆ az_log_set_message_callback()

void az_log_set_message_callback ( az_log_message_fn log_message_callback )

Sets the function that will be invoked to report an SDK log message.

Parameters

[in] log_message_callback [nullable] A pointer to the function that will be invoked when the SDK reports a log message. If NULL, no function will be invoked.

Typedefs

Enumerations

Functions