Class ISOMsgCounter

java.lang.Object

org.jpos.metrics.iso.ISOMsgCounter

All Implemented Interfaces:

Configurable, ISOMsgMetrics, LogSource

public class ISOMsgCounter
extends Object
implements ISOMsgMetrics, LogSource, Configurable

Nested Class Summary

Nested classes/interfaces inherited from interface ISOMsgMetrics

ISOMsgMetrics.Source

Field Summary

Fields inherited from interface ISOMsgMetrics

DEFAULT_CHANNEL_FIELDS, DEFAULT_CHANNEL_METRIC_NAME, DEFAULT_TAGS, ENV_CHANNEL_FIELDS, ENV_CHANNEL_TAGS

Constructor Summary

Constructors

Constructor	Description
ISOMsgCounter()

Method Summary

Modifier and Type	Method	Description
io.micrometer.core.instrument.Tags	addTags(io.micrometer.core.instrument.Tags tags)
protected Map<String,String>	getFieldSet()
Logger	getLogger()
protected Set<io.micrometer.core.instrument.Meter>	getMeters()	returns a clone set, which may not be up to date next time you use it
String	getMetricDescription()
String	getMetricName()
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 ISOMsgMetrics.getMetricName() and ISOMsgMetrics.getTags().
String	getRealm()
io.micrometer.core.instrument.MeterRegistry	getRegistry()
io.micrometer.core.instrument.Tags	getTags()
Map<String,String>	getTagsAsMap()
protected Map<String,String>	parseTagPairs(String tp, boolean copySingleTag)
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 ISOMsgMetrics.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()
protected String	resolveValExpr(ISOMsg m, String val)	Hook for subclasses to resolve, against an ISOMsg, the valexpr part of a tag:valexpr in a fieldset.
void	setConfiguration(Configuration cfg)
void	setLogger(Logger logger, String realm)
void	setMetricDescription(String metricDescription)
void	setMetricName(String metricName)
void	unregister()	It calls ISOMsgMetrics.removeMeters() and clears its internal reference to its MeterRegistry. It will also "unfreeze" the object, making it available for reconfiguration.
protected void	validateFieldSetMap(Map<String,String> fieldsMap)

Methods inherited from class Object

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

Methods inherited from interface ISOMsgMetrics

addTags

Constructor Details

ISOMsgCounter

public ISOMsgCounter()
              throws ConfigurationException

Throws:

ConfigurationException

Method Details

getMetricSignature

public String getMetricSignature()

Description copied from interface: ISOMsgMetrics

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 ISOMsgMetrics.getMetricName() and ISOMsgMetrics.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 ISOMsgMetrics.getTags().

Specified by:

getMetricSignature in interface ISOMsgMetrics

Returns:

This overrides the default implementation, also including the keys from the internal field set.

getMetricName

public String getMetricName()

Specified by:

getMetricName in interface ISOMsgMetrics

setMetricName

public void setMetricName(String metricName)

Specified by:

setMetricName in interface ISOMsgMetrics

getMetricDescription

public String getMetricDescription()

Specified by:

getMetricDescription in interface ISOMsgMetrics

setMetricDescription

public void setMetricDescription(String metricDescription)

Specified by:

setMetricDescription in interface ISOMsgMetrics

addTags

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

Specified by:

addTags in interface ISOMsgMetrics

getTags

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

Specified by:

getTags in interface ISOMsgMetrics

recordMessage

public void recordMessage(ISOMsg m)

Description copied from interface: ISOMsgMetrics

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.

Specified by:

recordMessage in interface ISOMsgMetrics

Parameters:

m - the ISOMsg to record.

recordMessage

public void recordMessage(ISOMsg m,
 MeterInfo meterInfo)

Description copied from interface: ISOMsgMetrics

Records an ISOMsg in the meter registry.
Similar to ISOMsgMetrics.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.

Specified by:

recordMessage in interface ISOMsgMetrics

Parameters:

m - the ISOMsg to record.

register

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

Description copied from interface: ISOMsgMetrics

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 ISOMsgMetrics.getRegistry())
• Before this object has been registered, it can be configured by setting tags, etc., but attempting to record a message (e.g. through ISOMsgMetrics.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 ISOMsgMetrics.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 ISOMsgMetrics.unregister() method should be called when done using this object.

Specified by:

register in interface ISOMsgMetrics

Returns:

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

unregister

public void unregister()

Description copied from interface: ISOMsgMetrics

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

Specified by:

unregister in interface ISOMsgMetrics

getRegistry

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

Specified by:

getRegistry in interface ISOMsgMetrics

removeMeters

public void removeMeters()

Specified by:

removeMeters in interface ISOMsgMetrics

setConfiguration

public void setConfiguration(Configuration cfg)
                      throws ConfigurationException

Specified by:

setConfiguration in interface Configurable

Parameters:

cfg - Configuration object

Throws:

ConfigurationException

parseTagPairs

protected Map<String,String> parseTagPairs(String tp,
 boolean copySingleTag)

validateFieldSetMap

protected void validateFieldSetMap(Map<String,String> fieldsMap)
                            throws ConfigurationException

Throws:

ConfigurationException

getMeters

protected Set<io.micrometer.core.instrument.Meter> getMeters()

returns a clone set, which may not be up to date next time you use it

getFieldSet

protected Map<String,String> getFieldSet()

getTagsAsMap

public Map<String,String> getTagsAsMap()

resolveValExpr

protected String resolveValExpr(ISOMsg m,
 String val)

Hook for subclasses to resolve, against an ISOMsg, the valexpr part of a tag:valexpr in a fieldset.
A subclass may add or override its own aliases, or have a special way to convert "valexpr" to a String taken from the given ISOMsg.
If the subclass can't resolve the alias/valexpr, it may call super (i.e. this method) as a fallback.

setLogger

public void setLogger(Logger logger,
 String realm)

Specified by:

setLogger in interface LogSource

getRealm

public String getRealm()

Specified by:

getRealm in interface LogSource

getLogger

public Logger getLogger()

Specified by:

getLogger in interface LogSource