TimeSeriesMessage

com.netflix.atlas.eval.model.TimeSeriesMessage
See theTimeSeriesMessage companion object
case class TimeSeriesMessage(id: String, query: String, groupByKeys: List[String], start: Long, end: Long, step: Long, label: String, tags: Map[String, String], data: ChunkData, styleMetadata: Option[LineStyleMetadata]) extends JsonSupport

Message type use for emitting time series data in LWC and fetch responses.

Value parameters

data

Data for the time series.

end

End time for the data.

groupByKeys

The final keys used for grouping the result. The value will be an empty list if the expression is not grouped. For multi-level group by this will be the final grouping used for the result.

id

Identifier for the time series. This can be used to stitch together messages for the same time series over time. For example in a streaming use-case you get one message per interval for each time series. To get all of the message for a given time series group by this id.

label

Label associated with the time series. This is either the auto-generated string based on the expression or the value specified by the legend.

query

Expression for the time series. Note, the same expression can result in many time series when using group by. For matching the data for a particular time series the id field should be used.

start

Start time for the data.

step

Time interval between data points.

styleMetadata

Metadata for presentation details related to how to render the line.

tags

Tags associated with the final expression result. This is the set of exact matches from the query plus any keys used in the group by clause.

Attributes

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

Members list

Value members

Concrete methods

override def encode(gen: JsonGenerator): Unit

Encode this object as JSON. By default it will just use Json.encode. This method can be overridden to customize the format or to provide a more performance implementation. When using a custom format, the subclass should also override hasCustomEncoding to return true. This will cause Json.encode to use the custom implementation rather than the default serializer for the type.

Encode this object as JSON. By default it will just use Json.encode. This method can be overridden to customize the format or to provide a more performance implementation. When using a custom format, the subclass should also override hasCustomEncoding to return true. This will cause Json.encode to use the custom implementation rather than the default serializer for the type.

Attributes

Definition Classes
JsonSupport
override def hasCustomEncoding: Boolean

Returns true if a custom encoding is used that does not rely on Json.encode.

Returns true if a custom encoding is used that does not rely on Json.encode.

Attributes

Definition Classes
JsonSupport

Inherited methods

def productElementNames: Iterator[String]

Attributes

Inherited from:
Product
def productIterator: Iterator[Any]

Attributes

Inherited from:
Product
final def toJson: String

Returns a JSON string representing this object.

Returns a JSON string representing this object.

Attributes

Inherited from:
JsonSupport