Interface ClientTelemetryContext
public interface ClientTelemetryContext
ClientTelemetryContext provides context information for client telemetry requests,
including the push interval.-
Method Summary
Modifier and TypeMethodDescriptionReturns the authorization context for the client request.intReturns the interval at which the client pushes telemetry metrics to the broker.
-
Method Details
-
pushIntervalMs
int pushIntervalMs()Returns the interval at which the client pushes telemetry metrics to the broker. This is the interval from the subscription.Note that for the initial metric push and pushes following a subscription update or error, a jitter (between 0.5x and 1.5x of this interval) is applied to avoid multiple clients sending requests simultaneously.
This value can be used by metrics exporters to determine when metrics should be considered stale or expired.
- Returns:
- the push interval in milliseconds from the subscription
-
authorizableRequestContext
AuthorizableRequestContext authorizableRequestContext()Returns the authorization context for the client request.- Returns:
- the client request context for the corresponding
PushTelemetryRequestAPI call
-