Class CardinalityGuard

java.lang.Object
codes.grow.packages.loki.CardinalityGuard

public final class CardinalityGuard extends Object
Keeps Loki's index small: only allowlisted names become index labels, everything else is sent as structured metadata (per entry, not indexed).
  • Constructor Details

    • CardinalityGuard

      public CardinalityGuard(Collection<String> allowed)
      Creates a guard.
      Parameters:
      allowed - label names that may become index labels
  • Method Details

    • defaults

      public static CardinalityGuard defaults()
      Returns a guard with Labels.DEFAULT_ALLOWED_LABELS.
      Returns:
      the default guard
    • allowed

      public List<String> allowed()
      Returns the allowlist, sorted.
      Returns:
      immutable list
    • isAllowed

      public boolean isAllowed(String name)
      Returns whether a name may be an index label.
      Parameters:
      name - label name
      Returns:
      true when allowlisted
    • apply

      public LokiStream apply(LokiStream stream)
      Returns a copy of the stream whose labels outside the allowlist are moved to the structured metadata of every entry (an entry's own metadata wins).
      Parameters:
      stream - stream
      Returns:
      the guarded stream
    • split

      public void split(Map<String,?> attributes, Map<String,String> labels, Map<String,String> metadata)
      Splits attributes into index labels (allowlisted, non-empty scalar text) and structured metadata. Keys are normalized with Labels.normalizeLabelName(java.lang.String); values are rendered with Labels.attrToString(java.lang.Object). Keys are processed in sorted order, so the result is deterministic when two keys normalize to the same name.
      Parameters:
      attributes - attributes
      labels - receives index labels
      metadata - receives structured metadata
    • toString

      public String toString()
      Overrides:
      toString in class Object