net.thisptr.jmx.exporter.agent.misc

Class SanitizingStringWriter

java.lang.Object

net.thisptr.jmx.exporter.agent.misc.SanitizingStringWriter

All Implemented Interfaces:

StringWriter

public class SanitizingStringWriter
extends Object
implements StringWriter

Constructor Summary

Constructors

Constructor and Description
SanitizingStringWriter()

Method Summary

Modifier and Type	Method and Description
int	expectedSize(String name)
static SanitizingStringWriter	getInstance()
int	write(String name, byte[] bytes, int index) Writes out a metric name into byte[] at the specified index.

Methods inherited from class java.lang.Object

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

Constructor Detail

SanitizingStringWriter

public SanitizingStringWriter()

Method Detail

getInstance

public static SanitizingStringWriter getInstance()

expectedSize

public int expectedSize(String name)

Specified by:

expectedSize in interface StringWriter

Returns:

the *maximum* expected byte length when written

write

public int write(String name,
                 byte[] bytes,
                 int index)

Writes out a metric name into byte[] at the specified index. Invalid characters are silently replaced by '_' (underscore). If the metric name is empty, this method just writes a single '_' (underscore). If the name starts with a number, '_' is prepended.

A metric name must match [a-zA-Z_:][a-zA-Z0-9_:]*.

It's caller's responsibility to ensure the byte[] has enough space. This method requires at most `name.length() + 1` bytes.

Specified by:

write in interface StringWriter

Parameters:

name -

Returns:

the next index after the metric name is written.

See Also:

https://prometheus.io/docs/concepts/data_model/