Interface ISOMsgMetrics

All Known Implementing Classes:

ISOMsgCounter

public interface ISOMsgMetrics

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	ISOMsgMetrics.Source

Field Summary

Fields

Modifier and Type	Field	Description
static final String	DEFAULT_CHANNEL_FIELDS
static final String	DEFAULT_CHANNEL_METRIC_NAME
static final String	DEFAULT_TAGS
static final String	ENV_CHANNEL_FIELDS
static final String	ENV_CHANNEL_TAGS

Method Summary

Modifier and Type	Method	Description
io.micrometer.core.instrument.Tags	addTags(io.micrometer.core.instrument.Tags tags)
default io.micrometer.core.instrument.Tags	addTags(String... tags)
String	getMetricDescription()
String	getMetricName()
default String	getMetricSignature()	A unique meter signature, concatenating the meter name, vertical pipe, comma-separated sorted list of all tag keys that this object produces. Default implementation uses the values from getMetricName() and getTags().
io.micrometer.core.instrument.MeterRegistry	getRegistry()
default io.micrometer.core.instrument.Tags	getTags()
void	recordMessage(ISOMsg m)	Records an ISOMsg in the meter registry. The metric name and tags will be taken strictly from this object's configuration.
void	recordMessage(ISOMsg m, MeterInfo meterInfo)	Records an ISOMsg in the meter registry. Similar to recordMessage(ISOMsg) but using the metric name, description and maybe some tags taken from the MeterInfo argument.
boolean	register(io.micrometer.core.instrument.MeterRegistry registry)	Register this object to work with a given MeterRegistry. This method may serve more than one purpose in the object's lifecycle: Assign a MeterRegistry to be used for the created meters.
void	removeMeters()
void	setMetricDescription(String metricDescription)
void	setMetricName(String metricName)
void	unregister()	It calls removeMeters() and clears its internal reference to its MeterRegistry. It will also "unfreeze" the object, making it available for reconfiguration.

Field Details

DEFAULT_CHANNEL_METRIC_NAME

static final String DEFAULT_CHANNEL_METRIC_NAME

ENV_CHANNEL_TAGS

static final String ENV_CHANNEL_TAGS

See Also:

• Constant Field Values

DEFAULT_TAGS

static final String DEFAULT_TAGS

See Also:

• Constant Field Values

ENV_CHANNEL_FIELDS

static final String ENV_CHANNEL_FIELDS

See Also:

• Constant Field Values

DEFAULT_CHANNEL_FIELDS

static final String DEFAULT_CHANNEL_FIELDS

See Also:

• Constant Field Values

Method Details

setMetricName

void setMetricName(String metricName)

getMetricName

String getMetricName()

getMetricDescription

String getMetricDescription()

setMetricDescription

void setMetricDescription(String metricDescription)

addTags

io.micrometer.core.instrument.Tags addTags(io.micrometer.core.instrument.Tags tags)

addTags

default io.micrometer.core.instrument.Tags addTags(String... tags)

getTags

default io.micrometer.core.instrument.Tags getTags()

recordMessage

void recordMessage(ISOMsg m)
            throws IllegalStateException

Records an ISOMsg in the meter registry.
The metric name and tags will be taken strictly from this object's configuration.
If this object hasn't been successfully registered, it throws an IllegalStateException.

Parameters:

m - the ISOMsg to record.

Throws:

IllegalStateException - when this object hasn't been registered

recordMessage

void recordMessage(ISOMsg m,
 MeterInfo meterInfo)
            throws IllegalStateException

Records an ISOMsg in the meter registry.
Similar to recordMessage(ISOMsg) but using the metric name, description and maybe some tags taken from the MeterInfo argument.

If the metric for that combination of MeterInfo values and local values fails to register in the global MeterRegistry (or any underlying one like the Prometheus registry), the method may throw an IllegalStateException. This also happens if this object hasn't been successfully registered by The metric name and tags will be taken from what has been configured. If this object hasn't been successfully registered, it throws an IllegalStateException.

Parameters:

m - the ISOMsg to record.

Throws:

IllegalStateException - when this object hasn't been registered

register

boolean register(io.micrometer.core.instrument.MeterRegistry registry)

Register this object to work with a given MeterRegistry.
This method may serve more than one purpose in the object's lifecycle:

• Assign a MeterRegistry to be used for the created meters. (The registry can be obtained by calling getRegistry())
• Before this object has been registered, it can be configured by setting tags, etc., but attempting to record a message (e.g. through recordMessage(ISOMsg)) will throw an IllegalStateException.
• After it has been registered, it's ready to record messages. However, it can't be configured any longer, or it will throw an IllegalStateException. The object's configuration can be considered "frozen".
• In some (future) implementation, it may make use of the getMetricSignature() to do some caching to ensure that every metric name has only one set of tag keys, thus avoiding metrics name+keyset collision in PrometheusMeterRegistry.

The unregister() method should be called when done using this object.

Returns:

true if successful, false if there was an error having this registered

unregister

void unregister()

It calls removeMeters() and clears its internal reference to its MeterRegistry.
It will also "unfreeze" the object, making it available for reconfiguration.

getRegistry

io.micrometer.core.instrument.MeterRegistry getRegistry()

removeMeters

void removeMeters()

getMetricSignature

default String getMetricSignature()

A unique meter signature, concatenating the meter name, vertical pipe, comma-separated sorted list of all tag keys that this object produces.
Default implementation uses the values from getMetricName() and getTags(). A concrete implementation must make sure of gathering all the appropriate tag keys from internal config state which may include more than what's returned by getTags().

Returns:

The unique metric signature.