Annotation Builder

Constructor#

import "github.com/perses/perses/go-sdk/annotation"

var options []annotation.Option
annotation.New("Deployments", options...)

Need to provide the name of the annotation and a list of options.

annotation.Name("Deployments")

Sets the annotation display name.

annotation.Description("Production deployments")

Sets the annotation description.

annotation.Hidden(true)

Controls whether the annotation is initially hidden.

annotation.Color("#ff0000")

Sets the annotation display color.

annotation.Plugin(plugin.Plugin{Kind: "PrometheusAnnotation", Spec: spec})

Sets the annotation plugin configuration. An annotation plugin SDK returns an annotation.Option that sets this field.

See the related documentation for each annotation plugin.

dashboard.AddAnnotation("Deployments",
	annotationPlugin(),
	annotation.Description("Production deployments"),
	annotation.Color("#ff0000"),
)