Labels (mjaron-tinyloki-java 0.3.11 API)

java.lang.Object
- pl.mjaron.tinyloki.Labels

All Implemented Interfaces:

java.lang.Cloneable
```
public class Labels
extends java.lang.Object
implements java.lang.Cloneable
```
Represents label name - label value mappings. Contains common label constants and its values. Log level constants are defined at: Grafana API Reference

Field Summary

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`DEBUG` Debug log level.
`static java.lang.String`	`FATAL` Fatal log level.
`static java.lang.String`	`INFO` Info log level.
`static java.lang.String`	`LEVEL` Log level definition.
`static java.lang.String`	`TRACE` Trace log level (the same as verbose).
`static java.lang.String`	`UNKNOWN` Unknown log level.
`static java.lang.String`	`VERBOSE` Verbose log level.
`static java.lang.String`	`WARN` Warning log level.

Constructor Summary

Constructors
Constructor and Description
`Labels()` Default constructor.
`Labels(Labels other)` Creates a deep copy of other labels.
`Labels(java.util.Map<java.lang.String,java.lang.String> map)` Creates the labels from a given map.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`static void`	`assertLabelIdentifierNotNullOrEmpty(java.lang.String labelIdentifier)` Verifies if `labelIdentifier` is not null and not empty.
`static boolean`	`checkLabelIdentifierWhenNotEmpty(java.lang.String labelIdentifier)` Deprecated. Use `checkLabelNameWhenNotEmpty(String)`
`static boolean`	`checkLabelNameWhenNotEmpty(java.lang.String labelName)` Checks whether label name meets the following rules: Label contains only letters, digits or `_` First character is letter or `_` Label names beginning with __ are reserved for internal use
`Labels`	`clone()` Creates a deep copy of this object.
`static java.lang.String`	`correctLabelName(java.lang.String labelName)` Corrects label name to meet the rules: Label contains only letters, digits or `_` First character is letter or `_` Label names beginning with __ are reserved for internal use
`Labels`	`critical()` Sets `label level` to `FATAL`, the same as `fatal()`.
`Labels`	`debug()` Sets `label level` to `DEBUG`.
`boolean`	`equals(java.lang.Object other)` Compares this instance with other instance.
`Labels`	`fatal()` Sets `label level` to `FATAL`.
`static Labels`	`from(java.util.Map<java.lang.String,java.lang.String> labels)` Creates a new instance of `Labels` from given `Map` object.
`java.util.Map<java.lang.String,java.lang.String>`	`getMap()`
`int`	`hashCode()` Provides hash code.
`Labels`	`info()` Sets `label level` to `INFO`.
`static boolean`	`isNameFirstCharacterCorrect(char firstChar)` Checks whether first character is a letter or `_`.
`static boolean`	`isNameNotFirstCharacterCorrect(char notFirstChar)` Checks whether not-first character is a letter, digit or `_`.
`static boolean`	`isNameReservedForInternalUse(java.lang.String labelName)` Checks whether label name begins with `__`, which is reserved for internal use.
`Labels`	`l(Labels other)` Put other labels values.
`Labels`	`l(java.util.Map<java.lang.String,java.lang.String> map)` Put a map with labels.
`Labels`	`l(java.lang.String labelName, java.lang.String labelValue)` Add a new label and return this object.
`static java.lang.String`	`narrowLabelIdentifierLength(java.lang.String labelIdentifier, int maxLength)` Cuts down identifier if it is too long.
`static Labels`	`prettify(Labels labels, int maxLabelNameLength, int maxLabelValueLength)` Creates a new `Labels` object with corrected label values, so such labels will be accepted by Grafana Loki server.
`static Labels`	`prettify(Labels labels, LabelSettings labelSettings)` Creates a new `Labels` object with corrected label values, so such labels will be accepted by Grafana Loki server.
`static java.lang.String`	`prettifyLabelIdentifier(java.lang.String labelIdentifier)` Deprecated. This method will be removed in the future release. Use `prettifyLabelIdentifier(String, int)` instead.
`static java.lang.String`	`prettifyLabelIdentifier(java.lang.String labelIdentifier, int maxLength)` Deprecated. Use `prettifyLabelName(String, int)` or `prettifyLabelValue(String, int)` instead.
`static java.lang.String`	`prettifyLabelName(java.lang.String labelName, int maxLength)` Replaces invalid characters with `_` character.
`static java.lang.String`	`prettifyLabelValue(java.lang.String labelValue, int maxLength)` Cuts down identifier if it is too long.
`java.lang.String`	`toString()`
`Labels`	`trace()` Sets `label level` to `TRACE`, the same as `VERBOSE`.
`Labels`	`unknown()` Sets `label level` to `UNKNOWN`.
`static void`	`validateLabelIdentifierOrThrow(java.lang.String labelIdentifier)` Deprecated. This method is unnecessary and will be removed in the future.
`Labels`	`verbose()` Sets `label level` to `VERBOSE`.
`Labels`	`warning()` Sets `label level` to `WARN`.

Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait

- Field Detail
  - LEVEL
```
public static final java.lang.String LEVEL
```
    Log level definition.
    
    See Also:
    
    Constant Field Values
  - FATAL
```
public static final java.lang.String FATAL
```
    Fatal log level.
    
    See Also:
    
    Constant Field Values
  - WARN
```
public static final java.lang.String WARN
```
    Warning log level.
    
    See Also:
    
    Constant Field Values
  - INFO
```
public static final java.lang.String INFO
```
    Info log level.
    
    See Also:
    
    Constant Field Values
  - DEBUG
```
public static final java.lang.String DEBUG
```
    Debug log level.
    
    See Also:
    
    Constant Field Values
  - VERBOSE
```
public static final java.lang.String VERBOSE
```
    Verbose log level.
    
    See Also:
    
    Constant Field Values
  - TRACE
```
public static final java.lang.String TRACE
```
    Trace log level (the same as verbose).
    
    See Also:
    
    Constant Field Values
  - UNKNOWN
```
public static final java.lang.String UNKNOWN
```
    Unknown log level.
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - Labels
```
public Labels()
```
    Default constructor. Creates empty labels with default parameters.
  - Labels
```
public Labels(Labels other)
```
    Creates a deep copy of other labels.
    
    Parameters:
    
    other - Other labels instance.
  - Labels
```
public Labels(java.util.Map<java.lang.String,java.lang.String> map)
```
    Creates the labels from a given map.
    
    Parameters:
    
    map - Given map is copied to internal Labels map.
- Method Detail
  - assertLabelIdentifierNotNullOrEmpty
```
public static void assertLabelIdentifierNotNullOrEmpty(java.lang.String labelIdentifier)
```
    Verifies if labelIdentifier is not null and not empty.
    
    Parameters:
    
    labelIdentifier - Label name or labelIdentifier value.
    
    Throws:
    
    java.lang.RuntimeException - When label identifier is null or empty.
    
    Since:
    
    0.2.0
  - validateLabelIdentifierOrThrow
```
@Deprecated
public static void validateLabelIdentifierOrThrow(java.lang.String labelIdentifier)
```
    Deprecated. This method is unnecessary and will be removed in the future.
    
    Checks whether label contains only letters, digits or '_' and first character is letter.
    
    Parameters:
    
    labelIdentifier - Label name or label value to check.
    
    Throws:
    
    java.lang.RuntimeException - when given label identifier is invalid.
    
    Since:
    
    0.2.0
  - checkLabelIdentifierWhenNotEmpty
```
@Deprecated
public static boolean checkLabelIdentifierWhenNotEmpty(java.lang.String labelIdentifier)
```
    Deprecated. Use checkLabelNameWhenNotEmpty(String)
    
    Checks whether label contains only letters, digits or '_' and first character is letter. It doesn't check whether the length of identifier is lower than any length limit.
    
    Parameters:
    
    labelIdentifier - Label name or label value to check.
    
    Returns:
    
    True when given label identifier is valid.
    
    Since:
    
    0.2.0
  - isNameFirstCharacterCorrect
```
public static boolean isNameFirstCharacterCorrect(char firstChar)
```
    Checks whether first character is a letter or _. See label naming rules documentation: Data model | Prometheus
    
    Parameters:
    
    firstChar - First character of label name.
    
    Returns:
    
    True when first character passes label naming rules.
    
    Since:
    
    0.3.10
  - isNameNotFirstCharacterCorrect
```
public static boolean isNameNotFirstCharacterCorrect(char notFirstChar)
```
    Checks whether not-first character is a letter, digit or _. See label naming rules documentation: Data model | Prometheus
    
    Parameters:
    
    notFirstChar - Not first character of label name.
    
    Returns:
    
    True when first character passes label naming rules.
    
    Since:
    
    0.3.10
  - isNameReservedForInternalUse
```
public static boolean isNameReservedForInternalUse(java.lang.String labelName)
```
    Checks whether label name begins with __, which is reserved for internal use. See label naming rules documentation: Data model | Prometheus
    
    Parameters:
    
    labelName - Full name of a label.
    
    Returns:
    
    True when label name is reserved.
    
    Since:
    
    0.3.10
  - checkLabelNameWhenNotEmpty
```
public static boolean checkLabelNameWhenNotEmpty(java.lang.String labelName)
```
    Checks whether label name meets the following rules:
    - Label contains only letters, digits or _
    - First character is letter or _
    - Label names beginning with __ are reserved for internal use
    See naming rules documentation: Data model | Prometheus
    It doesn't check whether the length of label name is lower than any length limit.
    Parameters:
    
    labelName - Label name to check.
    
    Returns:
    
    True when given label name is valid.
    
    Since:
    
    0.3.9
  - correctLabelName
```
public static java.lang.String correctLabelName(java.lang.String labelName)
```
    Corrects label name to meet the rules:
    - Label contains only letters, digits or _
    - First character is letter or _
    - Label names beginning with __ are reserved for internal use
    See naming rules documentation: Data model | Prometheus
    Parameters:
    
    labelName - Label name to correct.
    
    Returns:
    
    Valid label name, accepted by Grafana Loki server.
  - prettifyLabelName
```
public static java.lang.String prettifyLabelName(java.lang.String labelName,
                                                 int maxLength)
```
    Replaces invalid characters with `_` character. If first character is invalid, replaces it with `A`. See label naming rules: Data model | Prometheus
    Cuts down label name if it is too long.
    
    Parameters:
    
    labelName - Label name to check.
    
    maxLength - Maximum accepted length of label name.
    
    Returns:
    
    Valid label name with wrong symbols removed.
    
    Throws:
    
    java.lang.RuntimeException - when given labelName is null or empty.
    
    Since:
    
    0.3.9
  - narrowLabelIdentifierLength
```
public static java.lang.String narrowLabelIdentifierLength(java.lang.String labelIdentifier,
                                                           int maxLength)
```
    Cuts down identifier if it is too long.
    
    Parameters:
    
    labelIdentifier - Label name or value to check.
    
    maxLength - Maximum accepted length of label value.
    
    Returns:
    
    Valid label identifier with correct length.
    
    Throws:
    
    java.lang.RuntimeException - when given labelIdentifier is null or empty.
    
    Since:
    
    0.3.10
  - prettifyLabelValue
```
public static java.lang.String prettifyLabelValue(java.lang.String labelValue,
                                                  int maxLength)
```
    Cuts down identifier if it is too long. See label naming rules: Data model | Prometheus
    
    Parameters:
    
    labelValue - Label value to check.
    
    maxLength - Maximum accepted length of label value.
    
    Returns:
    
    Valid labelValue identifier with correct length.
    
    Throws:
    
    java.lang.RuntimeException - when given labelValue is null or empty.
    
    Since:
    
    0.3.9
  - prettifyLabelIdentifier
```
@Deprecated
public static java.lang.String prettifyLabelIdentifier(java.lang.String labelIdentifier,
                                                                   int maxLength)
```
    Deprecated. Use prettifyLabelName(String, int) or prettifyLabelValue(String, int) instead.
    
    Replaces invalid characters with `_` character. If first character is invalid, replaces it with `A`.
    Cuts down identifier if it is too long.
    
    Parameters:
    
    labelIdentifier - Label name or value to check.
    
    maxLength - Maximum accepted length of identifier.
    
    Returns:
    
    Valid labelIdentifier identifier with removed wrong symbols.
    
    Throws:
    
    java.lang.RuntimeException - when given labelIdentifier is null or empty.
    
    Since:
    
    0.3.0
  - prettifyLabelIdentifier
```
@Deprecated
public static java.lang.String prettifyLabelIdentifier(java.lang.String labelIdentifier)
```
    Deprecated. This method will be removed in the future release. Use prettifyLabelIdentifier(String, int) instead.
    
    Replaces invalid characters with `_` character. If first character is invalid, replaces it with `A`.
    Doesn't verify max length of identifier.
    
    Parameters:
    
    labelIdentifier - Label name or value to check.
    
    Returns:
    
    Valid labelIdentifier identifier with removed wrong symbols.
    
    Throws:
    
    java.lang.RuntimeException - when given labelIdentifier is null or empty.
    
    Since:
    
    0.2.0
  - prettify
```
public static Labels prettify(Labels labels,
                              int maxLabelNameLength,
                              int maxLabelValueLength)
```
    Creates a new Labels object with corrected label values, so such labels will be accepted by Grafana Loki server.
    
    Parameters:
    
    labels - Labels to prettify.
    
    maxLabelNameLength - Max length of valid label name. Based on: Grafana Loki server configuration.
    
    maxLabelValueLength - Max length of valid label value. Based on: Grafana Loki server configuration.
    
    Returns:
    
    New Labels object with corrected label values, so such labels will be accepted by Grafana Loki server.
    
    Since:
    
    0.3.0
  - prettify
```
public static Labels prettify(Labels labels,
                              LabelSettings labelSettings)
```
    Creates a new Labels object with corrected label values, so such labels will be accepted by Grafana Loki server.
    Used by LogController to pass correct labels to the server.
    
    Parameters:
    
    labels - Labels to prettify. Label length limits: Grafana Loki server configuration. Label naming rules: Data model | Prometheus
    
    labelSettings - Label parameters.
    
    Returns:
    
    New Labels object with corrected label values, so such labels will be accepted by Grafana Loki server.
    
    Since:
    
    0.3.0
  - from
```
public static Labels from(java.util.Map<java.lang.String,java.lang.String> labels)
```
    Creates a new instance of Labels from given Map object.
    
    Parameters:
    
    labels - Map with label-name mapped to label-value pairs.
    
    Returns:
    
    New instance of Labels.
    
    Since:
    
    0.3.0
  - getMap
```
public java.util.Map<java.lang.String,java.lang.String> getMap()
```
    Returns:
    
    Internal Map representation of labels content. User should not modify given map because modified values will not be checked for validity.
    
    Since:
    
    0.1.22
  - clone
```
public Labels clone()
```
    Creates a deep copy of this object.
    
    Overrides:
    
    clone in class java.lang.Object
    
    Returns:
    
    Deep copy of this object.
    
    Throws:
    
    java.lang.RuntimeException - When any member doesn't implement Cloneable.
    
    Since:
    
    0.2.2
  - equals
```
public boolean equals(java.lang.Object other)
```
    Compares this instance with other instance.
    Two instances are equal when its labels are equal. Label's length limits doesn't matter.
    
    Overrides:
    
    equals in class java.lang.Object
    
    Parameters:
    
    other - Other object instance.
    
    Returns:
    
    True if other object is the same as this object.
    
    Since:
    
    0.2.2
  - hashCode
```
public int hashCode()
```
    Provides hash code. See Object.hashCode().
    
    Overrides:
    
    hashCode in class java.lang.Object
    
    Returns:
    
    Hash code.
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object
  - l
```
public Labels l(java.lang.String labelName,
                java.lang.String labelValue)
```
    Add a new label and return this object.
    
    Parameters:
    
    labelName - Label name. Valid label identifier starts with letter and contains only letters, digits or '_'.
    
    labelValue - Label value. Valid label identifier starts with letter and contains only letters, digits or '_'.
    
    Returns:
    
    This object with added label.
    
    Throws:
    
    java.lang.RuntimeException - when given labelName or labelValue is null or empty.
    
    Since:
    
    0.1.22
  - l
```
public Labels l(java.util.Map<java.lang.String,java.lang.String> map)
```
    Put a map with labels. Valid label identifier starts with letter and contains only letters, digits or '_'.
    
    Parameters:
    
    map - Map containing label key - value pairs.
    
    Returns:
    
    This reference.
    
    Throws:
    
    java.lang.RuntimeException - when given map contains null or empty keys or values.
    
    Since:
    
    0.1.22
  - l
```
public Labels l(Labels other)
```
    Put other labels values. New values will override existing values, when label names (keys) are equal.
    
    Parameters:
    
    other - Other Labels instance.
    
    Returns:
    
    This reference.
    
    Since:
    
    0.2.2
  - critical
```
public Labels critical()
```
    Sets label level to FATAL, the same as fatal().
    Only one level may be assigned to single log stream. Setting other level will override previous value.
    
    Returns:
    
    This reference.
    
    Since:
    
    0.2.1
    
    See Also:
    
    LEVEL, FATAL
  - fatal
```
public Labels fatal()
```
    Sets label level to FATAL.
    Only one level may be assigned to single log stream. Setting other level will override previous value.
    
    Returns:
    
    This reference.
    
    Since:
    
    0.2.1
    
    See Also:
    
    LEVEL, FATAL
  - warning
```
public Labels warning()
```
    Sets label level to WARN.
    Only one level may be assigned to single log stream. Setting other level will override previous value.
    
    Returns:
    
    This reference.
    
    Since:
    
    0.2.1
    
    See Also:
    
    LEVEL, WARN
  - info
```
public Labels info()
```
    Sets label level to INFO.
    Only one level may be assigned to single log stream. Setting other level will override previous value.
    
    Returns:
    
    This reference.
    
    Since:
    
    0.2.1
    
    See Also:
    
    LEVEL, INFO
  - debug
```
public Labels debug()
```
    Sets label level to DEBUG.
    Only one level may be assigned to single log stream. Setting other level will override previous value.
    
    Returns:
    
    This reference.
    
    Since:
    
    0.2.1
    
    See Also:
    
    LEVEL, DEBUG
  - verbose
```
public Labels verbose()
```
    Sets label level to VERBOSE.
    Only one level may be assigned to single log stream. Setting other level will override previous value.
    
    Returns:
    
    This reference.
    
    Since:
    
    0.2.1
    
    See Also:
    
    LEVEL, VERBOSE
  - trace
```
public Labels trace()
```
    Sets label level to TRACE, the same as VERBOSE.
    Only one level may be assigned to single log stream. Setting other level will override previous value.
    
    Returns:
    
    This reference.
    
    Since:
    
    0.2.1
    
    See Also:
    
    LEVEL, TRACE, VERBOSE
  - unknown
```
public Labels unknown()
```
    Sets label level to UNKNOWN.
    Only one level may be assigned to single log stream. Setting other level will override previous value.
    
    Returns:
    
    This reference.
    
    Since:
    
    0.2.1
    
    See Also:
    
    LEVEL, UNKNOWN

Class Labels

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

LEVEL

FATAL

WARN

INFO

DEBUG

VERBOSE

TRACE

UNKNOWN

Constructor Detail

Labels

Labels

Labels

Method Detail

assertLabelIdentifierNotNullOrEmpty

validateLabelIdentifierOrThrow

checkLabelIdentifierWhenNotEmpty

isNameFirstCharacterCorrect

isNameNotFirstCharacterCorrect

isNameReservedForInternalUse

checkLabelNameWhenNotEmpty

correctLabelName

prettifyLabelName

narrowLabelIdentifierLength

prettifyLabelValue

prettifyLabelIdentifier

prettifyLabelIdentifier

prettify

prettify

from

getMap

clone

equals

hashCode

toString

l

l

l

critical

fatal

warning

info

debug

verbose

trace

unknown