com.netflix.atlas.core.validation

Members list

Type members

Classlikes

case class CompositeTagRule(tagRules: List[TagRule]) extends TagRule

Verifies that all of the tag rules match.

Verifies that all of the tag rules match.

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
trait TagRule
trait Rule
class Object
trait Matchable
class Any
Show all
case class HasKeyRule(key: String) extends Rule

Verifies that the tags contain a specified key. Sample config:

Verifies that the tags contain a specified key. Sample config:

key = name

Attributes

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

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
HasKeyRule.type
case class KeyLengthRule(minLength: Int, maxLength: Int) extends TagRule

Verifies that the keys are within the specified length bounds. Sample config:

Verifies that the keys are within the specified length bounds. Sample config:

min-length = 2
max-length = 60

Attributes

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

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
case class KeyPatternRule(pattern: Pattern) extends TagRule

Verifies that the keys match a specified pattern. Sample config:

Verifies that the keys match a specified pattern. Sample config:

pattern = "^[-_.a-zA-Z0-9]{4,60}$"

Attributes

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

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
case class MaxUserTagsRule(limit: Int) extends Rule

Verifies that the number of custom user tags are within a specified limit. Sample config:

Verifies that the number of custom user tags are within a specified limit. Sample config:

limit = 10

Attributes

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

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
case class NameValueLengthRule(nameRule: ValueLengthRule, valueRule: ValueLengthRule) extends TagRule

Verifies that the name and values are within the specified length bounds. The limits for the value of the name key can be set independently from the values of other keys. Sample config:

Verifies that the name and values are within the specified length bounds. The limits for the value of the name key can be set independently from the values of other keys. Sample config:

name {
 min-length = 2
 max-length = 80
}
others {
 min-length = 2
 max-length = 60
}

Attributes

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

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
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:

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
Supertypes
trait Serializable
trait Product
trait Equals
trait TagRule
trait Rule
class Object
trait Matchable
class Any
Show all

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
trait Rule

Base type for validation rules.

Base type for validation rules.

Attributes

Companion
object
Supertypes
class Object
trait Matchable
class Any
Known subtypes
object Rule

Attributes

Companion
trait
Supertypes
class Object
trait Matchable
class Any
Self type
Rule.type
trait TagRule extends Rule

Helper for rules that can be checked using a single key and value pair.

Helper for rules that can be checked using a single key and value pair.

Attributes

Companion
object
Supertypes
trait Rule
class Object
trait Matchable
class Any
Known subtypes
object TagRule

Attributes

Companion
trait
Supertypes
class Object
trait Matchable
class Any
Self type
TagRule.type
case class ValidCharactersRule(defaultSet: AsciiSet, overrides: Map[String, AsciiSet]) extends TagRule

Verifies that the keys and values only use the set of ASCII characters specificied in the config. By default it will be alpha-numeric, underscore, dash, and period. Sample config:

Verifies that the keys and values only use the set of ASCII characters specificied in the config. By default it will be alpha-numeric, underscore, dash, and period. Sample config:

default-pattern = "-._A-Za-z0-9"
overrides = [
 {
   key = "nf.cluster"
   value = "-._A-Za-z0-9^~"
 },
 {
   key = "nf.asg"
   value = "-._A-Za-z0-9^~"
 }
]

Attributes

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

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
sealed trait ValidationResult

Attributes

Companion
object
Supertypes
class Object
trait Matchable
class Any
Known subtypes
class Fail
object Pass

Attributes

Companion
trait
Supertypes
trait Sum
trait Mirror
class Object
trait Matchable
class Any
Self type
case class ValueLengthRule(minLength: Int, maxLength: Int) extends TagRule

Verifies that the values are within the specified length bounds. Sample config:

Verifies that the values are within the specified length bounds. Sample config:

min-length = 2
max-length = 60

Attributes

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

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
case class ValuePatternRule(pattern: PatternMatcher) extends TagRule

Verifies that the values match a specified pattern. Sample config:

Verifies that the values match a specified pattern. Sample config:

pattern = "^[-_.a-zA-Z0-9]{4,60}$"

Attributes

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

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type