Metrics#
Enumerations#
- OmniClientMetricsEvent
Types of metrics events that are supported.
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#
- OmniClientMetricsGrpc
Extra metrics about a gRPC call.
- OmniClientMetricsHttp
Extra metrics about an HTTP call.
Typedefs#
- OmniClientMetricsCallback
Called with information about a metrics event.
Enumerations#
-
enum OmniClientMetricsEvent#
Types of metrics events that are supported.
Note the metrics start at 100 because we removed some older metrics that are no longer supported
Values:
-
enumerator eOmniClientMetricsEvent_Grpc#
-
enumerator eOmniClientMetricsEvent_Http#
-
enumerator Count_eOmniClientMetricsEvent#
-
enumerator eOmniClientMetricsEvent_Grpc#
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.