ReservedKeyRule

com.netflix.atlas.core.validation.ReservedKeyRule
See theReservedKeyRule companion object
case class ReservedKeyRule(prefix: String, allowedKeys: Set[String]) extends TagRule

Verifies that only allowed keys are used for reserved prefixes. Reserved prefixes are used to prevent user defined tags from overlapping with common infrastructure tagging that should be consistent for all data. Sample config:

prefix = "nf."
allowed-keys = ["app", "cluster"]

This config would only allow "nf.app" and "nf.cluster" with a prefix of "nf.".

Attributes

Companion
object
Graph
Supertypes
trait Serializable
trait Product
trait Equals
trait TagRule
trait Rule
class Object
trait Matchable
class Any
Show all

Members list

Value members

Concrete methods

override def validate(k: String, v: String): String

Check the key/value pair and return null if it is valid or a reason string if there is a validation failure. The null type for success is used to avoid allocations or other overhead since the validation checks tend to be a hot path.

Check the key/value pair and return null if it is valid or a reason string if there is a validation failure. The null type for success is used to avoid allocations or other overhead since the validation checks tend to be a hot path.

Attributes

Definition Classes

Inherited methods

def productElementNames: Iterator[String]

Attributes

Inherited from:
Product
def productIterator: Iterator[Any]

Attributes

Inherited from:
Product
override def validate(id: Id): ValidationResult

Validates that the id matches the rule.

Validates that the id matches the rule.

Attributes

Definition Classes
Inherited from:
TagRule
override def validate(tags: SortedTagMap): ValidationResult

Validates that the tag map matches the rule.

Validates that the tag map matches the rule.

Attributes

Definition Classes
Inherited from:
TagRule
override def validate(tags: SmallHashMap[String, String]): ValidationResult

Validates that the tag map matches the rule.

Validates that the tag map matches the rule.

Attributes

Definition Classes
Inherited from:
TagRule
def validate(tags: Map[String, String]): ValidationResult

Validates that the tag map matches the rule.

Validates that the tag map matches the rule.

Attributes

Inherited from:
Rule