Metrics#

Enumerations#

OmniClientMetricsEvent: Types of metrics events that are supported.
OmniClientMetricsTransferType: Values for transferType

Functions#

uint32_t omniClientRegisterMetricsCallback(void *userData, OmniClientMetricsCallback callback): Register a callback function to receive events intended to provide metrics to a system such as open telemetry or prometheus.

Structs#

OmniClientMetricsDelete: Extra metrics about a delete request.
OmniClientMetricsEnumerateVersions: Extra metrics about an enumerate versions request.
OmniClientMetricsGetMetadata: Extra metrics about a get metadata request.
OmniClientMetricsList: Extra metrics about a list request.
OmniClientMetricsListServices: Extra metrics about a list services request.
OmniClientMetricsRead: Extra metrics about a read request.
OmniClientMetricsStat: Extra metrics about a stat request.
OmniClientMetricsWrite: Extra metrics about a write request.

Typedefs#

OmniClientMetricsCallback: Called with information about a metrics event.

Enumerations#

enum OmniClientMetricsEvent#

Types of metrics events that are supported.

Also used by OmniMetricsErrorEvent to note operation type that generated an error - see OmniMetricsErrorEvent.h for details.

Values:

enumerator eOmniClientMetricsEvent_StatComplete#

enumerator eOmniClientMetricsEvent_ReadComplete#

enumerator eOmniClientMetricsEvent_WriteComplete#

enumerator eOmniClientMetricsEvent_ListComplete#

enumerator eOmniClientMetricsEvent_EnumerateVersionsComplete#

enumerator eOmniClientMetricsEvent_ListServicesComplete#

enumerator eOmniClientMetricsEvent_GetMetadataComplete#

enumerator eOmniClientMetricsEvent_DeleteComplete#

enum OmniClientMetricsTransferType#

Values for transferType

Values:

enumerator eOmniClientMetricsTransferType_None#: Error.

enumerator eOmniClientMetricsTransferType_Inline#: Data was sent in the gRPC channel.

enumerator eOmniClientMetricsTransferType_Redirect#: Received redirect to an HTTP transfer.

enumerator eOmniClientMetricsTransferType_Multipart#: Received redirect to a multi-part HTTP transfer.

Functions#

uint32_t omniClientRegisterMetricsCallback( void *userData, OmniClientMetricsCallback callback, )#

Register a callback function to receive events intended to provide metrics to a system such as open telemetry or prometheus.

Note this is currently only implemented for the omni storage provider.

The callback is called every time the library wants to emit a metric. See OmniClientMetricsCallback for more information about the exact type of events that are emitted.

Parameters:

userData – User data passed to the callback
callback – The callback function to register

Returns:

A handle that you can pass to omniClientUnregisterCallback to stop receiving events

Typedefs#

typedef void (*OmniClientMetricsCallback)(void *userData, OmniClientMetricsEvent ev, void *extraInfo)#

Called with information about a metrics event.

Param userData:: is the same value passed to omniClientRegisterMetricsCallback.
Param ev:: is the type of metrics event.
Param extraInfo:: depends on the type of event. See comments about each event type to determine the exact type of extraInfo.