Timer.Builder (micrometer-core 1.0.4 API)

java.lang.Object
- io.micrometer.core.instrument.Timer.Builder

Enclosing interface:: Timer

public static class Timer.Builder
extends java.lang.Object

Fluent builder for timers.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Timer.Builder`	`description(java.lang.String description)`
`Timer.Builder`	`distributionStatisticBufferLength(java.lang.Integer bufferLength)` Statistics emanating from a timer like max, percentiles, and histogram counts decay over time to give greater weight to recent samples (exception: histogram counts are cumulative for those systems that expect cumulative histogram buckets).
`Timer.Builder`	`distributionStatisticExpiry(java.time.Duration expiry)` Statistics emanating from a timer like max, percentiles, and histogram counts decay over time to give greater weight to recent samples (exception: histogram counts are cumulative for those systems that expect cumulative histogram buckets).
`Timer.Builder`	`maximumExpectedValue(java.time.Duration max)` Sets the maximum value that this timer is expected to observe.
`Timer.Builder`	`minimumExpectedValue(java.time.Duration min)` Sets the minimum value that this timer is expected to observe.
`Timer.Builder`	`pauseDetector(PauseDetector pauseDetector)` Sets the pause detector implementation to use for this timer.
`Timer.Builder`	`percentilePrecision(java.lang.Integer digitsOfPrecision)` Determines the number of digits of precision to maintain on the dynamic range histogram used to compute percentile approximations.
`Timer.Builder`	`publishPercentileHistogram()` Adds histogram buckets used to generate aggregable percentile approximations in monitoring systems that have query facilities to do so (e.g.
`Timer.Builder`	`publishPercentileHistogram(java.lang.Boolean enabled)` Adds histogram buckets used to generate aggregable percentile approximations in monitoring systems that have query facilities to do so (e.g.
`Timer.Builder`	`publishPercentiles(double... percentiles)` Produces an additional time series for each requested percentile.
`Timer`	`register(MeterRegistry registry)` Add the timer to a single registry, or return an existing timer in that registry.
`Timer.Builder`	`sla(java.time.Duration... sla)` Publish at a minimum a histogram containing your defined SLA boundaries.
`Timer.Builder`	`tag(java.lang.String key, java.lang.String value)`
`Timer.Builder`	`tags(java.lang.Iterable<Tag> tags)`
`Timer.Builder`	`tags(java.lang.String... tags)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - tags
```
public Timer.Builder tags(java.lang.String... tags)
```
    Parameters:
    
    tags - Must be an even number of arguments representing key/value pairs of tags.
    
    Returns:
    
    This builder.
  - tags
```
public Timer.Builder tags(java.lang.Iterable<Tag> tags)
```
    Parameters:
    
    tags - Tags to add to the eventual meter.
    
    Returns:
    
    The timer builder with added tags.
  - tag
```
public Timer.Builder tag(java.lang.String key,
                         java.lang.String value)
```
    Parameters:
    
    key - The tag key.
    
    value - The tag value.
    
    Returns:
    
    This builder.
  - publishPercentiles
```
public Timer.Builder publishPercentiles(@Nullable
                                        double... percentiles)
```
    Produces an additional time series for each requested percentile. This percentile is computed locally, and so can't be aggregated with percentiles computed across other dimensions (e.g. in a different instance). Use publishPercentileHistogram() to publish a histogram that can be used to generate aggregable percentile approximations.
    
    Parameters:
    
    percentiles - Percentiles to compute and publish. The 95th percentile should be expressed as 0.95.
    
    Returns:
    
    This builder.
  - percentilePrecision
```
public Timer.Builder percentilePrecision(@Nullable
                                         java.lang.Integer digitsOfPrecision)
```
    Determines the number of digits of precision to maintain on the dynamic range histogram used to compute percentile approximations. The higher the degrees of precision, the more accurate the approximation is at the cost of more memory.
    
    Parameters:
    
    digitsOfPrecision - The digits of precision to maintain for percentile approximations.
    
    Returns:
    
    This builder.
  - publishPercentileHistogram
```
public Timer.Builder publishPercentileHistogram()
```
    Adds histogram buckets used to generate aggregable percentile approximations in monitoring systems that have query facilities to do so (e.g. Prometheus' histogram_quantile, Atlas' :percentiles).
    
    Returns:
    
    This builder.
  - publishPercentileHistogram
```
public Timer.Builder publishPercentileHistogram(@Nullable
                                                java.lang.Boolean enabled)
```
    Adds histogram buckets used to generate aggregable percentile approximations in monitoring systems that have query facilities to do so (e.g. Prometheus' histogram_quantile, Atlas' :percentiles).
    
    Parameters:
    
    enabled - Determines whether percentile histograms should be published.
    
    Returns:
    
    This builder.
  - sla
```
public Timer.Builder sla(@Nullable
                         java.time.Duration... sla)
```
    Publish at a minimum a histogram containing your defined SLA boundaries. When used in conjunction with publishPercentileHistogram(), the boundaries defined here are included alongside other buckets used to generate aggregable percentile approximations.
    
    Parameters:
    
    sla - Publish SLA boundaries in the set of histogram buckets shipped to the monitoring system.
    
    Returns:
    
    This builder.
  - minimumExpectedValue
```
public Timer.Builder minimumExpectedValue(@Nullable
                                          java.time.Duration min)
```
    Sets the minimum value that this timer is expected to observe. Sets a lower bound on histogram buckets that are shipped to monitoring systems that support aggregable percentile approximations.
    
    Parameters:
    
    min - The minimum value that this timer is expected to observe.
    
    Returns:
    
    This builder.
  - maximumExpectedValue
```
public Timer.Builder maximumExpectedValue(@Nullable
                                          java.time.Duration max)
```
    Sets the maximum value that this timer is expected to observe. Sets an upper bound on histogram buckets that are shipped to monitoring systems that support aggregable percentile approximations.
    
    Parameters:
    
    max - The maximum value that this timer is expected to observe.
    
    Returns:
    
    This builder.
  - distributionStatisticExpiry
```
public Timer.Builder distributionStatisticExpiry(@Nullable
                                                 java.time.Duration expiry)
```
    Statistics emanating from a timer like max, percentiles, and histogram counts decay over time to give greater weight to recent samples (exception: histogram counts are cumulative for those systems that expect cumulative histogram buckets). Samples are accumulated to such statistics in ring buffers which rotate after this expiry, with a buffer length of distributionStatisticBufferLength(Integer).
    
    Parameters:
    
    expiry - The amount of time samples are accumulated to a histogram before it is reset and rotated.
    
    Returns:
    
    This builder.
  - distributionStatisticBufferLength
```
public Timer.Builder distributionStatisticBufferLength(@Nullable
                                                       java.lang.Integer bufferLength)
```
    Statistics emanating from a timer like max, percentiles, and histogram counts decay over time to give greater weight to recent samples (exception: histogram counts are cumulative for those systems that expect cumulative histogram buckets). Samples are accumulated to such statistics in ring buffers which rotate after distributionStatisticExpiry(Duration), with this buffer length.
    
    Parameters:
    
    bufferLength - The number of histograms to keep in the ring buffer.
    
    Returns:
    
    This builder.
  - pauseDetector
```
public Timer.Builder pauseDetector(@Nullable
                                   PauseDetector pauseDetector)
```
    Sets the pause detector implementation to use for this timer. Can also be configured on a registry-level with MeterRegistry.Config.pauseDetector(PauseDetector).
    
    Parameters:
    
    pauseDetector - The pause detector implementation to use.
    
    Returns:
    
    This builder.
    
    See Also:
    
    NoPauseDetector, ClockDriftPauseDetector
  - description
```
public Timer.Builder description(@Nullable
                                 java.lang.String description)
```
    Parameters:
    
    description - Description text of the eventual timer.
    
    Returns:
    
    This builder.
  - register
```
public Timer register(MeterRegistry registry)
```
    Add the timer to a single registry, or return an existing timer in that registry. The returned timer will be unique for each registry, but each registry is guaranteed to only create one timer for the same combination of name and tags.
    
    Parameters:
    
    registry - A registry to add the timer to, if it doesn't already exist.
    
    Returns:
    
    A new or existing timer.

Class Timer.Builder

Method Summary

Methods inherited from class java.lang.Object

Method Detail

tags

tags

tag

publishPercentiles

percentilePrecision

publishPercentileHistogram

publishPercentileHistogram

sla

minimumExpectedValue

maximumExpectedValue

distributionStatisticExpiry

distributionStatisticBufferLength

pauseDetector

description

register