Docs

Observability Platform

Notification templates

Extension functions and variables for Server-side Monitoring

You can use preset alert variables in notification templates. This topic describes the structure and parameters of preset alert variables for Server-side Monitoring.

Extension functions

Server-side Monitoring notification templates support Go Template built-in functions and extension functions. The following table provides the details.

Function	Description
Go Template built-in functions	Notification templates support Go Template built-in functions such as range, if, with, and len. For details, see the official documentation.
translate(typ, lang, val)	Convert values such as Type and Region into natural language. Example: {{ translate "Type" "zh" .Type }}.
levelColor(level, isRecovered)	Return the channel color value based on the severity level and whether the alert has recovered. Example: {{ levelColor .Level false }}.
levelCss(level, isRecovered)	Return a CSS class based on the severity level and whether the alert has recovered. Example: {{ levelCss .Level false }}.
formatKeyValues(kvs)	Format []KeyValues into k={v1,v2} text. Example: {{ formatKeyValues .Labels }}.
getMetrics(typ, metrics)	Filter the metric list by alert type for better display. Example: {{ range $m := getMetrics .Type $resource.Metrics }}.
Time formatting	Fields of the time.Time type supports .Format. Example: {{ .HappenedAt.Format "2006-01-02 15:04:05" }}.

Data structure

This topic uses the following JSON example to demonstrate the variables, parameters, and data structures included in Server-side Monitoring alert information. This helps you understand common Go template syntax and its usage.

Variable description

tip

You can use the standard Go Template approach to get values of non-nested variables. For example, you can use {{ .Region }}.

For nested variables, you need to use custom variables to obtain all resources. For example, you define the $resource variable and use iteration to get all resources: {{ range $idx, $resource := .Resources }}. For internal variables, you need to use $resource.fieldName (for example, {{ $resource.Id }}) to get variable values.

The following table provides the parameters and descriptions of preset variables that can be used in a notification template.

Variable name	Type	Description	Example	Example
Type	string	The alarm type. Valid values:	Metric / MetricRecovered	{{ translate "Type" "zh" .Type }}
SiteName	string	Site name.	Volcano Engine	{{ .SiteName }}
AccountName	string	Account name.	test_user(12345)	{{ .AccountName }}
AccountId	string	Account ID.	21000*****	{{ .AccountId }}
Region	string	The region.	cn-beijing	{{ translate "Region" "zh" .Region }}
HappenedAt	time.Time	The time when the alarm is triggered.	2025-12-01T00:00:00+08:00	{{ .HappenedAt.Format "2006-01-02 15:04:05" }}
Level	string	The alert level.	critical	{{ .Level }}
ProjectName	string	The project name.	default	{{ .ProjectName }}
TagSet	[]Tag	The tag set.	[{Key:"service",Value:"test1"}]	{{ range .TagSet }}{{ .Key }}={{ .Value }} {{ end }}
Domain	string	The console domain name.	console.volcengine.com	{{ .Domain }}
MaxCount	int	The maximum number of resources displayed in the current channel.	5	{{ .MaxCount }}
RuleName	string	Rule name.	Service alert test	{{ .RuleName }}
RuleURL	string	The URL of the rule details.	https://.../server/alarm/detail?...	[View the rule]({{ .RuleURL }})
RuleType	string	The rule type text.	Service alert	{{ .RuleType }}
RuleDesc	string	Rule description.	Template: test template...	{{ .RuleDesc }}
CreateSilenceURL	string	The URL for creating a silence rule.	Empty string or URL	[Create a silence rule]({{ .CreateSilenceURL }})
RelatedServices	[]string	The list of affected services.	["test1......", "test2-......"]	{{ range .RelatedServices }}{{ . }} {{ end }}
Labels	[]KeyValues	The list of rule labels.	[]	{{ formatKeyValues .Labels }}
ContentsByCondition	[]string	The description of the trigger policy generated from the configured conditions.	An alert is triggered when all of the following conditions are met:	{{ range .ContentsByCondition }}{{ . }}\n{{ end }}
Resources	[]APMPlusResource	The list of alert resources.	2 service resources	{{ range $resource := .Resources }}{{ $resource.ServiceName }}{{ end }}

Tag

Variable name	Type	Description	Example	Example
Key	string	The tag key.	service	{{ $tag.Key }}
Value	string	The tag value.	test1......	{{ $tag.Value }}

KeyValues

Variable name	Type	Description	Example	Example
Key	string	Tag key.	env	{{ $label.Key }}
Values	[]string	Multiple values under the same key.	["prod", "stg"]	{{ range $v := $label.Values }}{{ $v }} {{ end }}

APMPlusResource

Variable name	Type	Description	Example	Example
AlertGroupId	string	The ID of the alert group.	69afbf........625ccb7	{{ $resource.AlertGroupId }}
Region	string	The region where the resource is located.	cn-beijing	{{ translate "Region" "zh" $resource.Region }}
ServiceName	string	The service name.	test1......	{{ $resource.ServiceName }}
ServiceMonitorURL	string	The URL of the service monitoring details.	https://.../service/...	[Service monitoring]({{ $resource.ServiceMonitorURL }})
FirstAlertTime	time.Time	The time of the first alert.	2025-12-01T00:00:00+08:00	{{ $resource.FirstAlertTime.Format "2006-01-02 15:04:05" }}
LastAlertTime	time.Time	The time of the most recent alert.	2025-12-01T00:00:00+08:00	{{ $resource.LastAlertTime.Format "2006-01-02 15:04:05" }}
Metrics	[]APMPlusMetricValue	The list of metrics for this resource.	1 error rate metric	{{ range $m := $resource.Metrics }}{{ $m.Name }}={{ $m.Value }}{{ end }}
GroupBy	string	The display string for resource aggregation.	{service = test1......}	{{ $resource.GroupBy }}
GroupByTags	[]Tag	The set of resource aggregation tags.	[{Key:"service",Value:"test1......"}]	{{ range $tag := $resource.GroupByTags }}{{ $tag.Key }}={{ $tag.Value }} {{ end }}

APMPlusMetricValue

Variable name	Type	Description	Example	Example
Name	string	The metric name.	Error rate	{{ $metric.Name }}
Unit	string	The display unit.	%	{{ $metric.Unit }}
Threshold	string	The threshold text.	......	{{ $metric.Threshold }}
Value	string	The current value or rate of change.	......	{{ $metric.Value }}
Description	string	Metric description.	Error rate, no filter conditions, aggregated by average...	{{ $metric.Description }}
Warn	bool	Whether it is an alert metric.	true	{{ $metric.Warn }}
IsTimeCompare	bool	Whether the metric uses a same-period or sequential-period comparison.	false	{{ $metric.IsTimeCompare }}
InherentUnit	string	The inherent unit of the metric.	empty string	{{ $metric.InherentUnit }}
LastValue	string	The previous window value.	Empty string	{{ $metric.LastValue }}
CurrentValue	string	The current window value.	Empty string	{{ $metric.CurrentValue }}
Index	int	The condition index.	0	{{ $metric.Index }}
DeltaValue	string	The absolute change value.	Empty string	{{ $metric.DeltaValue }}

Last updated: 2026.09.07 19:40:06