com.hcl.domino.keep.metrics

Interface KeepStatistics

All Known Implementing Classes:

KeepStatisticsHolder

public interface KeepStatistics

This holds statistics about the current Keep session

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	KeepStatistics.StatisticAction For statistic actions: add or remove to make it less confusing than a boolean
static class	KeepStatistics.TagKey

Method Summary

Modifier and Type	Method and Description
KeepStatistics	adjustConfiguredForms(KeepDbInfo dbInfo, KeepStatistics.StatisticAction action) Adjusts number of configured forms
KeepStatistics	adjustConfiguredForms(KeepStatistics.StatisticAction action) Adjusts number of configured forms by 1, up or down
io.micrometer.core.instrument.Meter	createMetricForRegistry(java.lang.String key, java.util.List<io.micrometer.core.instrument.Tag> metricsTags, io.micrometer.core.instrument.Meter.Type type, io.micrometer.core.instrument.MeterRegistry registry) Creates a counter or timer for a specific registry.
java.util.Map<java.lang.String,io.micrometer.core.instrument.Meter>	getMetricsMap()
io.micrometer.core.instrument.Counter	getOrCreateCounter(java.lang.String key, java.util.List<io.micrometer.core.instrument.Tag> metricsTags) Gets or creates a counter.
io.micrometer.core.instrument.Timer	getOrCreateTimer(java.lang.String key, java.util.List<io.micrometer.core.instrument.Tag> metricsTags) Gets or creates a counter.
KeepStatistics	reset() Resets the statistics to start over.

Method Detail

adjustConfiguredForms

KeepStatistics adjustConfiguredForms(KeepDbInfo dbInfo,
                                     KeepStatistics.StatisticAction action)

Adjusts number of configured forms

Parameters:

dbInfo - KeepDbInfo to process

action - increment or decrement

Returns:

fluent

adjustConfiguredForms

KeepStatistics adjustConfiguredForms(KeepStatistics.StatisticAction action)

Adjusts number of configured forms by 1, up or down

Parameters:

action - increment or decrement

Returns:

fluent

createMetricForRegistry

io.micrometer.core.instrument.Meter createMetricForRegistry(java.lang.String key,
                                                            java.util.List<io.micrometer.core.instrument.Tag> metricsTags,
                                                            io.micrometer.core.instrument.Meter.Type type,
                                                            io.micrometer.core.instrument.MeterRegistry registry)

Creates a counter or timer for a specific registry. Currently the only registry in use is Prometheus. The future approach will call this recursively for all registries enabled

Parameters:

key - to create metric with

metricsTags - to create metric with

type - of Meter to create. Only Timer and Counter are currently supported

registry - registry into which to create the metric

Returns:

Meter created

getMetricsMap

java.util.Map<java.lang.String,io.micrometer.core.instrument.Meter> getMetricsMap()

Returns:

Map of metrics

getOrCreateCounter

io.micrometer.core.instrument.Counter getOrCreateCounter(java.lang.String key,
                                                         java.util.List<io.micrometer.core.instrument.Tag> metricsTags)

Gets or creates a counter. Use this if tags require minimal computation to pass

Parameters:

key - to create metric with

metricsTags - to create metric with

Returns:

Meter(Counter) created

getOrCreateTimer

io.micrometer.core.instrument.Timer getOrCreateTimer(java.lang.String key,
                                                     java.util.List<io.micrometer.core.instrument.Tag> metricsTags)

Gets or creates a counter. Use this if tags require minimal computation to pass

Parameters:

key - to create metric with

metricsTags - to create metric with

Returns:

Meter(Timer) created

reset

KeepStatistics reset()

Resets the statistics to start over. Mainly used when restarting keep

Returns:

fluent