Module org.elasticsearch.security

Package org.elasticsearch.xpack.security.metric

Class SecurityMetrics<C>

java.lang.Object

org.elasticsearch.xpack.security.metric.SecurityMetrics<C>

Type Parameters:

C - The type of context object which is used to attach additional attributes to collected metrics.

public final class SecurityMetrics<C>
extends Object

This class provides a common way for registering and collecting different types of security metrics. It allows for recoding the number of successful and failed executions as well as to record the execution time.

Constructor Summary

Constructors

Constructor	Description
SecurityMetrics(SecurityMetricType metricType, MeterRegistry meterRegistry, SecurityMetricAttributesBuilder<C> attributesBuilder, LongSupplier nanoTimeSupplier)

Method Summary

Modifier and Type	Method	Description
void	recordFailure(C context)	Records a single failed execution.
void	recordSuccess(C context)	Records a single success execution.
void	recordTime(C context, long startTimeNano)	Records the elapsed execution time in milliseconds.
long	relativeTimeInNanos()	Returns a value of nanoseconds that may be used for relative time calculations.
SecurityMetricType	type()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

SecurityMetrics

public SecurityMetrics(SecurityMetricType metricType,
 MeterRegistry meterRegistry,
 SecurityMetricAttributesBuilder<C> attributesBuilder,
 LongSupplier nanoTimeSupplier)

Method Details

type

public SecurityMetricType type()

relativeTimeInNanos

public long relativeTimeInNanos()

Returns a value of nanoseconds that may be used for relative time calculations. This method should only be used for calculating time deltas.

recordSuccess

public void recordSuccess(C context)

Records a single success execution.

Parameters:

context - The context object which is used to attach additional attributes to success metric.

recordFailure

public void recordFailure(C context)

Records a single failed execution.

Parameters:

context - The context object which is used to attach additional attributes to failed metric.

recordTime

public void recordTime(C context,
 long startTimeNano)

Records the elapsed execution time in milliseconds. The start time is captured in nanoseconds (via relativeTimeInNanos()) for precision, but the recorded value is converted to milliseconds so that it falls within the finite bucket range.

Parameters:

context - The context object which is used to attach additional attributes to collected metric.

startTimeNano - The start time (in nanoseconds) before the execution.