Review Template Values for Trigger Payloads

George Alpizar
George Alpizar
  • Updated

Overview

You can use this document to learn about the template values for the payload contents of a trigger.


Review Template Values

Template values are variables defined by the Edge Delta agent that can be substituted based on matching template names. 

For example, if a user defines a trigger payload with ... {{ .ConfigID }} ...and the agent's configuration ID is ed832df2-740b-41c5-863e-3aa4b03932f1, then the incoming trigger message will become ... ed832df2-740b-41c5-863e-3aa4b03932f1 ....

These variables can be defined as template values.

Review the following template values: 

Template Value Description
Title This value is the pre-generated title for triggers.
Message This value is the pre-generated message for triggers. 
Tag This value is the tag that was defined in the configuration. 
ConfigID This value is the API key that is used by the Edge Delta agent. 
Host This value is the host name of the machine where the Edge Delta agent is deployed to.
EDAC This value is the unique identifier for alert type observations.
Source This value is the source of the observation.
SourceType This value is the source type, such as K8s, Docker, ECS, etc.
SourceAttributes

This value is the attributes of the source, such as pod name, namespace, controller name, etc. 

MetricName

This value is the metric name that caused the alert.

Epoch

This value is the timestamp of the ingested alert.

Timestamp

This value is the timestamp of the alert.

MatchedTerm

This value is the log that caused the alert.

ProcessorDescription

This value is the processor description from the configuration.

ThresholdDescription

This value is the threshold description from the threshold alert.

ThresholdValue

This value is the threshold value that the current metric value will be checked against.

ThresholdType

This value is the threshold type, such as upper and lower, that the current metric value will be checked against.

CurrentValue

This value is the current value of the metric.

ECSCluster

For a source with an ECS type, this value is the cluster name of the replica that the Edge Delta agent listens to.

ECSContainerName

For a source with an ECS type, this value is the container name of the replica that the Edge Delta agent listens to.

ECSTaskFamily

For a source with an ECS type, this value is the task family of the replica that the Edge Delta agent listens to. 

ECSTaskVersion

For a source with an ECS type, this value is the task version of the replica that the Edge Delta agent listens to.

K8sNamespace

For a source with a Kubernetes type, this value is the namespace of the replica that the Edge Delta agent listens to. 

K8sControllerKind

For a source with a Kubernetes type, this value is the controller type (such as, ReplicaSet, DaemonSet, etc.) of the replica that the Edge Delta agent listens to. 

K8sControllerLogicalName

For a source with a Kubernetes type, this value is the logical name of the replica's controller that the Edge Delta agent listens to. 

K8sPodName

For a source with a Kubernetes type, this value is the pod name of the replica that the Edge Delta agent listens to. 

K8sContainerName

For a source with a Kubernetes type, this value is the container name of the replica that the Edge Delta agent listens to. 

K8sContainerImage

For a source with a Kubernetes type, this value is the image name of the replica that the Edge Delta agent listens to. 

DockerContainerName

For a source with a Docker type, this value is the container name of the replica that the Edge Delta agent listens to. 

DockerContainerName

For a source with a Docker type, this value is the image name of the replica that the Edge Delta agent listens to. 

FileGlobPath

For a source with a File type, this value is the full path of the file that Edge Delta agent listens to.

 

 

Share this document