atlas-core
API
Generated with
atlas-core/com.netflix.atlas.core/com.netflix.atlas.core.model

com.netflix.atlas.core.model

package com.netflix.atlas.core.model

Members list

Type members

Classlikes

case class ArrayBlock(var start: Long, size: Int) extends MutableBlock

Block that stores the raw data in an array.

Block that stores the raw data in an array.

Value parameters

size

number of data points to store in the block

start

start time for the block (epoch in milliseconds)

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
trait MutableBlock
trait Block
class Object
trait Matchable
class Any
Show all
final class ArrayTimeSeq(val dsType: DsType, val start: Long, val step: Long, val data: Array[Double]) extends TimeSeq

Attributes

Supertypes
trait TimeSeq
class Object
trait Matchable
class Any
case class BasicTaggedItem(tags: Map[String, String]) extends LazyTaggedItem

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
trait TaggedItem
class Object
trait Matchable
class Any
Show all
case class BasicTimeSeries(id: ItemId, tags: Map[String, String], label: String, data: TimeSeq) extends TimeSeries

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
trait TimeSeries
trait TaggedItem
class Object
trait Matchable
class Any
Show all
class BinaryOpTimeSeq(ts1: TimeSeq, ts2: TimeSeq, op: BinaryOp) extends TimeSeq

Attributes

Supertypes
trait TimeSeq
class Object
trait Matchable
class Any
object Block

Helper functions for working with blocks.

Helper functions for working with blocks.

Attributes

Companion
trait
Supertypes
class Object
trait Matchable
class Any
Self type
Block.type
sealed trait Block

Represents a fixed size window of metric data. All block implementations provide fast random access to data.

Represents a fixed size window of metric data. All block implementations provide fast random access to data.

Attributes

Companion
object
Supertypes
class Object
trait Matchable
class Any
Known subtypes
trait MutableBlock
class ArrayBlock
class RollupBlock
class SparseBlock
Show all
object BlockStats

Helper for tracking the number and amount of memory block data is using.

Helper for tracking the number and amount of memory block data is using.

Attributes

Supertypes
class Object
trait Matchable
class Any
Self type
BlockStats.type
object CollectorStats

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
case class CollectorStats(inputLines: Long, inputDatapoints: Long, outputLines: Long, outputDatapoints: Long)

Summary stats for how much data was processed by a collector.

Summary stats for how much data was processed by a collector.

Value parameters

inputDatapoints

number of datapoints in the input to the collector

inputLines

number of lines in the input to the collector

outputDatapoints

number of datapoints in the result output

outputLines

number of lines in the result output

Attributes

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

Helper for accumulating stats for a collector.

Helper for accumulating stats for a collector.

Attributes

Supertypes
class Object
trait Matchable
class Any
final case class CompressedArrayBlock(start: Long, size: Int) extends MutableBlock

Mutable block type that tries to compress data as it is updated. The main compression benefit comes by not needed to store the most common values that are seen in the data. Initially 2 bits per value will be used that indicate one of four common values: NaN, 0, 1, 1/60. If another value is used, then it will update the buffer to use 4 bits per value that can be one of the four common values or an index to an explicit value. If more than 12 distinct values are seen, then it will update the buffer to just be an array of double values.

Mutable block type that tries to compress data as it is updated. The main compression benefit comes by not needed to store the most common values that are seen in the data. Initially 2 bits per value will be used that indicate one of four common values: NaN, 0, 1, 1/60. If another value is used, then it will update the buffer to use 4 bits per value that can be one of the four common values or an index to an explicit value. If more than 12 distinct values are seen, then it will update the buffer to just be an array of double values.

Value parameters

size

Number of datapoints to include in the block.

start

Start time for the block.

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
trait MutableBlock
trait Block
class Object
trait Matchable
class Any
Show all
object CompressedArrayBlock

Attributes

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

Attributes

Companion
object
Supertypes
class Object
trait Matchable
class Any
Known subtypes
object Max
object Min
trait SumOrAvgCf
object Avg
object Sum
object ConsolidationFunction

Attributes

Companion
trait
Supertypes
trait Sum
trait Mirror
class Object
trait Matchable
class Any
Self type
case class ConstantBlock(start: Long, size: Int, value: Double) extends Block

Simple block type where all data points have the same value.

Simple block type where all data points have the same value.

Value parameters

size

number of data points to store in the block

start

start time for the block (epoch in milliseconds)

value

value for the data points

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
trait Block
class Object
trait Matchable
class Any
Show all
class CustomVocabulary(config: Config, dependencies: List[Vocabulary]) extends Vocabulary

Vocabulary that allows custom extension operations to be loaded from the config.

Vocabulary that allows custom extension operations to be loaded from the config.

Value parameters

config

Config instance to use for loading the custom operations. The settings will be loaded from the atlas.core.vocabulary block. Words Custom words can be defined using an expression. These are typically used by the operators to provide common helper functions.

   words = [
     {
       name = "square"
       body = ":dup,:mul"
       examples = ["2"]
     }
   ]

The supported fields are:

  • name: operation name, when the user calls the operation they will use :$name.
  • body: expression that is executed for this operation.
  • examples: set of example stacks that can be used as input to the operator to show how it works. Averages The custom-averages list contains a set of rewrites for averaging based on an arbitrary denominator query. This is typically used to make it easier for performing an average based on a separate infrastructure metric. For example, at Netflix there is a metric published for each instance that is UP in Eureka. To compute an average per UP server we could define a custom average like:
   custom-averages = [
     {
       name = "eureka-avg"
       base-query = "name,eureka.state,:eq,status,UP,:eq,:and"
       keys = ["nf.app", "nf.cluster", "nf.asg", "nf.node"]
     }
   ]

The supported fields are:

  • name: operation name, when the user calls the operation they will use :$name.
  • base-query: query for the denominator.
  • keys: tag keys that are available for use on the denominator.
dependencies

Other vocabularies to depend on, defaults to the StyleVocabulary.

Attributes

Companion
object
Supertypes
trait Vocabulary
class Object
trait Matchable
class Any
object CustomVocabulary

Attributes

Companion
class
Supertypes
class Object
trait Matchable
class Any
Self type
sealed trait DataExpr extends TimeSeriesExpr, Product

Attributes

Companion
object
Supertypes
trait Expr
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
Known subtypes
class Count
class Max
class Min
class Sum
class All
class GroupBy
Show all
object DataExpr

Attributes

Companion
trait
Supertypes
trait Sum
trait Mirror
class Object
trait Matchable
class Any
Self type
DataExpr.type
object DataVocabulary extends Vocabulary

Attributes

Supertypes
trait Vocabulary
class Object
trait Matchable
class Any
Self type
case class Datapoint(tags: Map[String, String], timestamp: Long, value: Double, step: Long) extends TimeSeries, TimeSeq

Time series with a single value.

Time series with a single value.

Value parameters

step

Step size for the datapoint. Defaults to the configured step size for the service.

tags

Metadata for the identifying the datapoint.

timestamp

Timestamp for the data point. The time is the end of an interval that starts at timestamp - step.

value

Value for the interval.

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
trait TimeSeq
trait TimeSeries
trait TaggedItem
class Object
trait Matchable
class Any
Show all
object Datapoint

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
Datapoint.type
case class DatapointTuple(id: ItemId, tags: Map[String, String], timestamp: Long, value: Double)

Simple tuple representing a datapoint. Can be used in place of Datapoint when the use-case does not require a TimeSeries. The id must be pre-computed for the tuple where it cannot be passed in an will be computed on first access for Datapoint.

Simple tuple representing a datapoint. Can be used in place of Datapoint when the use-case does not require a TimeSeries. The id must be pre-computed for the tuple where it cannot be passed in an will be computed on first access for Datapoint.

Attributes

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

Attributes

Supertypes
class Object
trait Matchable
class Any
Self type
sealed trait DsType

Attributes

Companion
object
Supertypes
class Object
trait Matchable
class Any
Known subtypes
object Gauge
object Rate
object DsType

Attributes

Companion
trait
Supertypes
trait Sum
trait Mirror
class Object
trait Matchable
class Any
Self type
DsType.type
case class EvalContext(start: Long, end: Long, step: Long, state: Map[StatefulExpr, Any])

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
sealed trait EventExpr extends Expr

Base type for event expressions.

Base type for event expressions.

Attributes

Companion
object
Supertypes
trait Expr
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
Known subtypes
class Raw
class Table
object EventExpr

Attributes

Companion
trait
Supertypes
trait Sum
trait Mirror
class Object
trait Matchable
class Any
Self type
EventExpr.type
object EventVocabulary extends Vocabulary

Attributes

Supertypes
trait Vocabulary
class Object
trait Matchable
class Any
Self type
trait Expr extends Product

Attributes

Supertypes
trait Product
trait Equals
class Object
trait Matchable
class Any
Known subtypes
trait EventExpr
class Raw
class Table
trait Query
class And
object False
trait KeyQuery
class HasKey
class Equal
class GreaterThan
class In
class LessThan
trait PatternQuery
class Regex
class Not
class Or
object True
class StyleExpr
trait DataExpr
class Count
class Max
class Min
class Sum
class All
class GroupBy
trait FilterExpr
class Filter
class BottomK
class TopK
class Stat
trait StatExpr
object StatAvg
object StatCount
object StatLast
object StatMax
object StatMin
object StatTotal
trait MathExpr
trait AggrMathExpr
class Count
class Max
class Min
class Sum
class As
class Add
class And
class Divide
class FAdd
class FDivide
class FMultiply
class FSubtract
class GreaterThan
class LessThan
class Multiply
class Or
class Power
class Subtract
class ClampMax
class ClampMin
class Constant
class GroupBy
class NamedRewrite
class Percentiles
object Random
class SeededRandom
class Time
class TimeSpan
class Abs
class Negate
class PerStep
class Sine
class Sqrt
trait StatefulExpr
trait OnlineExpr
class Delay
class Derivative
class Des
class Integral
class RollingCount
class RollingMax
class RollingMean
class RollingMin
class RollingSum
class SlidingDes
class Trend
trait TraceQuery
class Child
class Simple
class SpanAnd
class SpanOr
class SpanFilter
Show all
trait FilterExpr extends TimeSeriesExpr

Attributes

Companion
object
Supertypes
trait Expr
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
Known subtypes
class Filter
class BottomK
class TopK
class Stat
trait StatExpr
object StatAvg
object StatCount
object StatLast
object StatMax
object StatMin
object StatTotal
Show all
object FilterExpr

Attributes

Companion
trait
Supertypes
class Object
trait Matchable
class Any
Self type
FilterExpr.type
object FilterVocabulary extends Vocabulary

Attributes

Supertypes
trait Vocabulary
class Object
trait Matchable
class Any
Self type
object FloatArrayBlock

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
case class FloatArrayBlock(start: Long, size: Int) extends Block

Block that stores the raw data in an array using single-precision floats rather than doubles to store the values.

Block that stores the raw data in an array using single-precision floats rather than doubles to store the values.

Value parameters

size

number of data points to store in the block

start

start time for the block (epoch in milliseconds)

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
trait Block
class Object
trait Matchable
class Any
Show all
class FunctionTimeSeq(val dsType: DsType, val step: Long, f: Long => Double) extends TimeSeq

Attributes

Supertypes
trait TimeSeq
class Object
trait Matchable
class Any
class ItemId extends Comparable[ItemId]

Represents an identifier for a tagged item.

Represents an identifier for a tagged item.

Value parameters

data

Bytes for the id. This is usually the results of computing a SHA1 hash over a normalized representation of the tags.

hc

Precomputed hash code for the bytes.

Attributes

Companion
object
Supertypes
trait Comparable[ItemId]
class Object
trait Matchable
class Any
object ItemId

Attributes

Companion
class
Supertypes
class Object
trait Matchable
class Any
Self type
ItemId.type
class ItemIdCalculator

Helper to compute an ItemId from a tag map. This class will reuse buffers and is not thread-safe.

Helper to compute an ItemId from a tag map. This class will reuse buffers and is not thread-safe.

Attributes

Companion
object
Supertypes
class Object
trait Matchable
class Any
object ItemIdCalculator

Attributes

Companion
class
Supertypes
class Object
trait Matchable
class Any
Self type
trait LazyTaggedItem extends TaggedItem

Attributes

Supertypes
trait TaggedItem
class Object
trait Matchable
class Any
Known subtypes
case class LazyTimeSeries(tags: Map[String, String], label: String, data: TimeSeq) extends TimeSeries

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
trait TimeSeries
trait TaggedItem
class Object
trait Matchable
class Any
Show all
class MapStepTimeSeq(ts: TimeSeq, val step: Long, cf: ConsolidationFunction) extends TimeSeq

Attributes

Supertypes
trait TimeSeq
class Object
trait Matchable
class Any
trait MathExpr extends TimeSeriesExpr

Attributes

Companion
object
Supertypes
trait Expr
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object MathExpr

Attributes

Companion
trait
Supertypes
class Object
trait Matchable
class Any
Self type
MathExpr.type
object MathVocabulary extends Vocabulary

Attributes

Supertypes
trait Vocabulary
class Object
trait Matchable
class Any
Self type
object ModelExtractors

Attributes

Supertypes
class Object
trait Matchable
class Any
Self type
trait MutableBlock extends Block

Block type that can be update incrementally as data is coming in.

Block type that can be update incrementally as data is coming in.

Attributes

Supertypes
trait Block
class Object
trait Matchable
class Any
Known subtypes
class ArrayBlock
class RollupBlock
class OffsetTimeSeq(seq: TimeSeq, offset: Long) extends TimeSeq

Attributes

Supertypes
trait TimeSeq
class Object
trait Matchable
class Any
sealed trait Query extends Expr

Attributes

Companion
object
Supertypes
trait Expr
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
Known subtypes
class And
object False
trait KeyQuery
class HasKey
class Equal
class GreaterThan
class In
class LessThan
trait PatternQuery
class Regex
class Not
class Or
object True
Show all
object Query

Attributes

Companion
trait
Supertypes
trait Sum
trait Mirror
class Object
trait Matchable
class Any
Self type
Query.type
object QueryVocabulary extends Vocabulary

Attributes

Supertypes
trait Vocabulary
class Object
trait Matchable
class Any
Self type
case class ResultSet(expr: TimeSeriesExpr, data: List[TimeSeries], state: Map[StatefulExpr, Any], messages: List[String])

Attributes

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

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
case class RollupBlock(sum: Block, count: Block, min: Block, max: Block) extends MutableBlock

A block representing a set of aggregates computed by rolling up a metric.

A block representing a set of aggregates computed by rolling up a metric.

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
trait MutableBlock
trait Block
class Object
trait Matchable
class Any
Show all
object SparseBlock

Constants used for sparse blocks. Common values that are often repeated are special cased to further reduce storage. In particular the values for NaN, 0, and 1 are not stored.

Constants used for sparse blocks. Common values that are often repeated are special cased to further reduce storage. In particular the values for NaN, 0, and 1 are not stored.

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
case class SparseBlock(start: Long, indexes: Array[Byte], values: Array[Double]) extends Block

A block optimized for storing a small set of discrete values.

A block optimized for storing a small set of discrete values.

Value parameters

indexes

stores the index into the values array for each slot in the block

start

start time for the block (epoch in milliseconds)

values

set of distinct values

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
trait Block
class Object
trait Matchable
class Any
Show all
trait StatefulExpr extends TimeSeriesExpr

Attributes

Companion
object
Supertypes
trait Expr
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
Known subtypes
trait OnlineExpr
class Delay
class Derivative
class Des
class Integral
class RollingCount
class RollingMax
class RollingMean
class RollingMin
class RollingSum
class SlidingDes
class Trend
Show all
object StatefulExpr

Attributes

Companion
trait
Supertypes
class Object
trait Matchable
class Any
Self type
object StatefulVocabulary extends Vocabulary

Attributes

Supertypes
trait Vocabulary
class Object
trait Matchable
class Any
Self type
case class StyleExpr(expr: TimeSeriesExpr, settings: Map[String, String]) extends Expr

Attributes

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

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
StyleExpr.type
object StyleVocabulary extends Vocabulary

Attributes

Supertypes
trait Vocabulary
class Object
trait Matchable
class Any
Self type
object SummaryStats

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
case class SummaryStats(count: Int, min: Double, max: Double, last: Double, total: Double)

Attributes

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

Helper functions for tags.

Helper functions for tags.

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
Tag.type
case class Tag(key: String, value: String, count: Int) extends Comparable[Tag]

Represents a key/value pair and it's associated count. The count is the number of items that are marked with the tag.

Represents a key/value pair and it's associated count. The count is the number of items that are marked with the tag.

Value parameters

count

number of items with this tag or -1 if unknown

key

key for the tag

value

value associated with the key

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
trait Comparable[Tag]
class Object
trait Matchable
class Any
Show all
object TagKey

Helper functions and constants for standard tag keys.

Helper functions and constants for standard tag keys.

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
TagKey.type
case class TagKey(name: String, count: Int)

Key name and an associated count.

Key name and an associated count.

Value parameters

count

number of items with this tag key or -1 if unknown

name

key for the tag

Attributes

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

Helper functions for manipulating tagged items.

Helper functions for manipulating tagged items.

Attributes

Companion
trait
Supertypes
class Object
trait Matchable
class Any
Self type
TaggedItem.type
trait TaggedItem

Represents an item that can be searched for using a set of tags.

Represents an item that can be searched for using a set of tags.

Attributes

Companion
object
Supertypes
class Object
trait Matchable
class Any
Known subtypes
trait TimeSeries
class Datapoint
Show all
trait TimeSeq

Attributes

Supertypes
class Object
trait Matchable
class Any
Known subtypes
class ArrayTimeSeq
class Datapoint
Show all
object TimeSeries

Attributes

Companion
trait
Supertypes
class Object
trait Matchable
class Any
Self type
TimeSeries.type
trait TimeSeries extends TaggedItem

Attributes

Companion
object
Supertypes
trait TaggedItem
class Object
trait Matchable
class Any
Known subtypes
class Datapoint
trait TimeSeriesExpr extends Expr

Base type for expressions that have a set of time series as the result.

Base type for expressions that have a set of time series as the result.

Attributes

Supertypes
trait Expr
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
Known subtypes
trait DataExpr
class Count
class Max
class Min
class Sum
class All
class GroupBy
trait FilterExpr
class Filter
class BottomK
class TopK
class Stat
trait StatExpr
object StatAvg
object StatCount
object StatLast
object StatMax
object StatMin
object StatTotal
trait MathExpr
trait AggrMathExpr
class Count
class Max
class Min
class Sum
class As
class Add
class And
class Divide
class FAdd
class FDivide
class FMultiply
class FSubtract
class GreaterThan
class LessThan
class Multiply
class Or
class Power
class Subtract
class ClampMax
class ClampMin
class Constant
class GroupBy
class NamedRewrite
class Percentiles
object Random
class SeededRandom
class Time
class TimeSpan
class Abs
class Negate
class PerStep
class Sine
class Sqrt
trait StatefulExpr
trait OnlineExpr
class Delay
class Derivative
class Des
class Integral
class RollingCount
class RollingMax
class RollingMean
class RollingMin
class RollingSum
class SlidingDes
class Trend
Show all
sealed trait TraceQuery extends Expr

Base type for a query to match a trace.

Base type for a query to match a trace.

Attributes

Companion
object
Supertypes
trait Expr
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
Known subtypes
class Child
class Simple
class SpanAnd
class SpanOr
object TraceQuery

Attributes

Companion
trait
Supertypes
trait Sum
trait Mirror
class Object
trait Matchable
class Any
Self type
TraceQuery.type
object TraceVocabulary extends Vocabulary

Attributes

Supertypes
trait Vocabulary
class Object
trait Matchable
class Any
Self type
class UnaryOpTimeSeq(ts: TimeSeq, f: UnaryOp) extends TimeSeq

Attributes

Supertypes
trait TimeSeq
class Object
trait Matchable
class Any

Types

type BinaryOp = (Double, Double) => Double
type UnaryOp = Double => Double
Generated with