函數(shù)

說(shuō)明

過(guò)濾器

示例

float(value, default=0.0)

將整數(shù)或字符串轉(zhuǎn)換成浮點(diǎn)數(shù)。

如果轉(zhuǎn)換失敗，默認(rèn)返回0.0。通過(guò)default參數(shù)，可指定轉(zhuǎn)換失敗的返回值。

支持

• {{ float("123") }}的結(jié)果為123.0。

• {{ float("foo") }}的結(jié)果為0.0。

• {{ float("foo", default=1.23) }}的結(jié)果為1.23。

int(value, default=0)

將一個(gè)字符串或數(shù)字轉(zhuǎn)換為整數(shù)。

如果轉(zhuǎn)換失敗，默認(rèn)返回0。通過(guò)default參數(shù)，可指定轉(zhuǎn)換失敗的返回值。

支持

• {{ int(1.23) }}的結(jié)果為1。

• {{ int("1.23") }}的結(jié)果為1。

• {{ int("foo") }}的結(jié)果為0。

• {{ int("foo", default=5) }}的結(jié)果為5。

length(value)

返回對(duì)象（字符串、列表、元組等）的長(zhǎng)度或個(gè)數(shù)。

支持

• {{ length("foo") }}的結(jié)果為3。

• {{ length([1, 2]) }} 的結(jié)果為2。

• {{ length({"foo": "bar"}) }}的結(jié)果為1。

abs(value)

返回?cái)?shù)字的絕對(duì)值。

支持

{{ abs(-1) }}的結(jié)果為1。

min(value)

返回最小值。

支持

{{ min([1, 3, 2]) }}的結(jié)果為1。

max(value)

返回最大值。

支持

{{ max([1, 3, 2]) }}的結(jié)果為3。

ceil(value)

向上取整數(shù)。

支持

{{ ceil(1.23) }}的結(jié)果為2。

floor(value)

向下取整數(shù)。

支持

{{ floor(1.23) }}的結(jié)果為1。

round(value, 1)

四舍五入取整數(shù)。

其中，1表示保留1位小數(shù)。

支持

• {{ round(1.23) }}的結(jié)果為1。

• {{ round(1.56) }}的結(jié)果為2。

• {{ round(1.56, 1) }}的結(jié)果為1.6。

sum(value)

求和計(jì)算。

支持

{{ sum([1, 2, 3]) }}的結(jié)果為6。

函數(shù)

說(shuō)明

過(guò)濾器

示例

string(value)

將對(duì)象轉(zhuǎn)為字符串類(lèi)型。

支持

{{ string(1.23) }}的結(jié)果為1.23。

此處的1.23為字符串類(lèi)型。

capitalize(value)

將字符串的首字母轉(zhuǎn)換為大寫(xiě)形式，其它字符轉(zhuǎn)換為小寫(xiě)形式。

支持

{{ capitalize("heLLO World") }}的結(jié)果為Hello world。

lower(value)

將字符串轉(zhuǎn)換為小寫(xiě)形式。

支持

{{ lower("FOO") }}的結(jié)果為foo。

upper(value)

將字符串轉(zhuǎn)換為大寫(xiě)形式。

支持

{{ upper("foo") }}的結(jié)果為FOO。

title(value)

返回標(biāo)題化的字符串，即每個(gè)單詞的首字母為大寫(xiě)形式，其余字母為小寫(xiě)形式。

支持

{{ title("hello world") }}的結(jié)果為Hello World。

trim(value)

刪除字符串頭尾的空字符。

支持

{{ trim(" foo\n") }}的結(jié)果為foo。

replace(value, old, new)

替換目標(biāo)字符串。

不支持

{{ replace("foo", "oo", "ly") }}的結(jié)果為fly。

wordcount(value)

統(tǒng)計(jì)單詞個(gè)數(shù)。

支持

{{ wordcount("hello world") }}的結(jié)果為2。

truncate(value, n, end='')

截?cái)嘧址?/p>

• 通過(guò)truncate(value, n)，指定截?cái)嗟淖址麛?shù)。

• 通過(guò)truncate(value, n, end='...')，指定要添加的后綴。

不支持

• {{ truncate("foo bar", 5) }}的結(jié)果為foo b。

• {{ truncate("foo bar", 5, end="...") }}的結(jié)果為foo b...。

quote(value)

使用半角雙引號(hào)（""）包裹字符串。

支持

• {{ quote(123) }}的結(jié)果為"123"

• {{ quote("foo") }}的結(jié)果為 "foo"。

indent(value, n=4)

對(duì)每一行字符串進(jìn)行縮進(jìn)，默認(rèn)縮進(jìn)4個(gè)空格。

通過(guò)n參數(shù)，可指定縮進(jìn)的空格數(shù)。

支持

• {{ "foobar\n" }}{{ indent("foo\nbar") }} 的結(jié)果如下：

  foobar
      foo
      bar

• {{ "foobar\n" }}{{ indent("foo\nbar", 2) }}的結(jié)果如下：

  foobar
    foo
    bar

startswith(value, prefix)

判斷字符串是否以特定子串開(kāi)始。

支持

{{ startswith("football", "foo") }}的結(jié)果為true。

endswith(value, suffix)

判斷字符串是否以特定子串結(jié)束。

支持

{{ endswith("football", "all") }}的結(jié)果為true。

removeprefix(value, prefix)

移除字符串的前綴。

支持

{{ removeprefix("football", "foot") }}的結(jié)果為ball。

removesuffix(value, suffix)

移除字符串的后綴。

支持

{{ removesuffix("football", "ball") }}的結(jié)果為foot。

split(value, sep=None, maxsplit=-1)

切割字符串。

• 通過(guò)sep參數(shù)指定分隔符。

• 通過(guò)maxsplit參數(shù)限制切割次數(shù)。

  如果未指定maxsplit或設(shè)置為-1，表示對(duì)切割數(shù)量沒(méi)有限制。

支持

• {{ split('a b c ') }} 的結(jié)果為['a', 'b', 'c']。

• {{ split('a-b-c', sep='-') }}的結(jié)果為['a', 'b', 'c']。

• {{ split('a-b-c', sep='-', maxsplit=1) }}的結(jié)果為['a', 'b-c']。

• {{ split('a<>b<>c', sep='<>') }}的結(jié)果為['a', 'b', 'c']。

函數(shù)

說(shuō)明

過(guò)濾器

示例

enumerate(value)

將一個(gè)可迭代的對(duì)象組合為一個(gè)索引序列，并列出原始元素和元素的下標(biāo)。

不支持

{{ enumerate(["foo", "bar"]) }}的結(jié)果為[(0, 'foo'), (1, 'bar')]。

list(value)

將一個(gè)可迭代的對(duì)象轉(zhuǎn)換為列表類(lèi)型。

支持

• {{ list(("foo", "bar")) }}的結(jié)果為 ['foo', 'bar']。

• {{ list("foo") }}的結(jié)果為 ['f', 'o', 'o']。

dict(value)

創(chuàng)建一個(gè)字典，類(lèi)似于直接使用{}創(chuàng)建字典。

不支持

{{ dict(foo=1, bar="hello") }}的結(jié)果為{'foo': 1, 'bar': 'hello'}。

first(value)

返回列表中的第一項(xiàng)。

支持

{{ first([1, 2, 3]) }}的結(jié)果為1。

last(value)

返回列表中的最后一項(xiàng)。

支持

{{ last([1, 2, 3]) }}的結(jié)果為3。

sort(value, reverse=true)

對(duì)列表中的元素進(jìn)行排序。

通過(guò)reverse=true，可實(shí)現(xiàn)逆序排序。

支持

• {{ sort([3, 1, 2]) }}的結(jié)果為[1, 2, 3]。

• {{ sort([3, 1, 2], reverse=true) }}的結(jié)果為[3, 2, 1]。

dictsort(value)

將對(duì)象中的鍵值對(duì)（Key:Value）按照Key進(jìn)行排序，返回?cái)?shù)組。

支持

• alert.labels字段示例

  {
      "host": "host-1",
      "app": "nginx"
  }

• 內(nèi)容模板配置

  {%- for key, val in dictsort(alert.labels) %}
  {{ key }}: {{ val }}
  {%- endfor %}

• 結(jié)果

  app: nginx
  host: host-1

join(value, d='')

使用連接符連接列表中的元素。

通過(guò)d參數(shù)，可指定連接符。

支持

• {{ join([1, 2, 3]) }}的結(jié)果為123。

• {{ join([1, 2, 3], ',') }}的結(jié)果為1,2,3。

函數(shù)

說(shuō)明

過(guò)濾器

示例

escape_markdown(value)

轉(zhuǎn)義特殊的Markdown字符。

支持

{{ escape_markdown("__a__ **b** #c") }}的結(jié)果為__a__ **b** #c。

escape_html(value)

轉(zhuǎn)義特殊的HTML字符。

支持

{{ escape_html("<div>") }}的結(jié)果為<div>。

to_json(value)

將對(duì)象轉(zhuǎn)為JSON格式。

支持

• {{ to_json("foo") }}的結(jié)果為"foo"。

• {{ to_json(1.23) }}的結(jié)果為1.23。

• {{ to_json(True) }}的結(jié)果為true。

• {{ to_json(alert.labels) }}的結(jié)果為{"host": "host-1", "app": "nginx"}。

parse_json(value)

將字符串解析為JSON數(shù)據(jù)結(jié)構(gòu)。

支持

• {{ parse_json('{"foo": "bar"}').foo }}的結(jié)果為bar。

• {{ parse_json('[1, 2, 3]')[1] }}的結(jié)果為2。

函數(shù)

說(shuō)明

過(guò)濾器

示例

base64_encoding(value)

對(duì)輸入值進(jìn)行Base64編碼。

支持

{{ base64_encoding("foo") }}的結(jié)果為Zm9v。

base64_decoding(value)

對(duì)輸入值進(jìn)行Base64解碼。

支持

{{ base64_decoding("Zm9v") }}的結(jié)果為foo。

md5_encoding(value)

對(duì)輸入值進(jìn)行MD5編碼。

支持

{{ md5_encoding("foo") }}的結(jié)果為acbd18db4cc2f85cedef654fccc4a4d8。

url_encoding(value)

對(duì)輸入值進(jìn)行URL編碼。

支持

{{ url_encoding("https://example.com?a=b&c=d") }}的結(jié)果為https%3A%2F%2Fexample.com%3Fa%3Db%26c%3Dd。

url_decoding(value)

對(duì)輸入值進(jìn)行URL解碼。

支持

{{ url_decoding("https%3A%2F%2Fexample.com%3Fa%3Db%26c%3Dd") }}的結(jié)果為https://example.com?a=b&c=d。

函數(shù)

說(shuō)明

過(guò)濾器

示例

parse_date(value, fmt="%Y-%m-%d %H:%M:%S")

將輸入值轉(zhuǎn)為timestamp類(lèi)型的日期和時(shí)間表達(dá)式。

通過(guò)fmt參數(shù)，可指定日期和時(shí)間表達(dá)式的格式。

支持

• {{ parse_date(1629820800) }}的結(jié)果為2021-08-25 00:00:00。

• {{ parse_date("2021|08|25|00|00|00", fmt="%Y|%m|%d|%H|%M|%S") }}的結(jié)果為2021-08-25 00:00:00。

format_date(value, tz=None, fmt="%Y-%m-%d %H:%M:%S")

將輸入值進(jìn)行格式化。

通過(guò)fmt參數(shù)，可指定日期和時(shí)間表達(dá)式的格式。

如果輸入值不是日期對(duì)象，則函數(shù)會(huì)將其轉(zhuǎn)換為日期對(duì)象，再進(jìn)行格式化。關(guān)于日期時(shí)間格式化指令的更多信息，請(qǐng)參見(jiàn)日期時(shí)間格式化指令。關(guān)于時(shí)區(qū)列表的更多信息，請(qǐng)參見(jiàn)時(shí)區(qū)列表。

不支持

• {{ format_date(1629820800) }}的結(jié)果為2021-08-25 00:00:00。

• {{ format_date(1629820800, fmt="%Y/%m/%d %H:%M:%S") }}的結(jié)果為2021/08/25 00:00:00。

• {{ format_date(1629820800, tz="UTC", fmt="%Y/%m/%d %H:%M:%S") }}的結(jié)果為2021/08/24 16:00:00。

timestamp(value)

將時(shí)間和日期字符串轉(zhuǎn)換為Unix時(shí)間戳。

如果輸入值不是日期對(duì)象，則函數(shù)會(huì)將其轉(zhuǎn)換為日期對(duì)象，再進(jìn)行格式化。

支持

• {{ timestamp("2021-08-25 00:00:00") }}的結(jié)果為1629820800。

• {{ timestamp(parse_date("2021-08-25 00:00:00")) }}的結(jié)果為1629820800。

format_duration(value, locale='en-US', sep='')

格式化時(shí)間間隔。其中value的單位為秒。

通過(guò)locale參數(shù)，可指定文字的語(yǔ)言。locale參數(shù)的取值請(qǐng)參見(jiàn)告警業(yè)務(wù)函數(shù)locale取值。

支持

• {{ 10 | format_duration }}的結(jié)果為10s。

• {{ 60 | format_duration }}的結(jié)果為1m。

• {{ 3600 | format_duration }}的結(jié)果為1h。

• {{ 86400 | format_duration }}的結(jié)果為1d。

• {{ 100000 | format_duration }}的結(jié)果為1d3h46m40s。

• {{ 100000 | format_duration(sep=",") }}的結(jié)果為1d,3h,46m,40s。

• {{ 100000 | format_duration(locale="zh-CN") }}的結(jié)果為1天3小時(shí)46分鐘40秒。

函數(shù)

說(shuō)明

過(guò)濾器

示例

format_type(alert.type, locale=None)

將告警類(lèi)型轉(zhuǎn)換為文字描述。

通過(guò)locale參數(shù)，可指定文字的語(yǔ)言。locale參數(shù)的取值請(qǐng)參見(jiàn)告警業(yè)務(wù)函數(shù)locale取值。

支持

• 告警類(lèi)型為sls_pub

• 內(nèi)容模板配置

  {{ format_type(alert.type) }}

• 結(jié)果

  • 內(nèi)容模板中的語(yǔ)言配置為中文時(shí)，通知內(nèi)容為開(kāi)放告警。

  • 內(nèi)容模板中的語(yǔ)言配置為英文時(shí)，通知內(nèi)容為Pub Alert。

format_region(alert.region, locale=None)

將告警所在地域轉(zhuǎn)換為文字描述。

通過(guò)locale參數(shù)，可指定文字的語(yǔ)言。locale參數(shù)的取值請(qǐng)參見(jiàn)告警業(yè)務(wù)函數(shù)locale取值。

支持

• 當(dāng)前告警地域?yàn)?span data-tag="ph" id="codeph-kn3-4rc-7gr" class="ph">cn-hangzhou

• 內(nèi)容模板配置

  {{ format_region(alert.region) }}

• 結(jié)果

  • 內(nèi)容模板中的語(yǔ)言配置為中文時(shí)，通知內(nèi)容為華東1（杭州）。

  • 內(nèi)容模板中的語(yǔ)言配置為英文時(shí)，通知內(nèi)容為 China (Hangzhou)。

format_severity(alert.severity, locale=None)

將告警嚴(yán)重度轉(zhuǎn)換為文字描述，且支持彩色字體。

通過(guò)locale參數(shù)，可指定文字的語(yǔ)言。locale參數(shù)的取值請(qǐng)參見(jiàn)告警業(yè)務(wù)函數(shù)locale取值。

支持

• 告警嚴(yán)重度為6

• 內(nèi)容模板配置

  {{ format_severity(alert.severity) }}

• 結(jié)果

  • 內(nèi)容模板中的語(yǔ)言配置為中文時(shí)，通知內(nèi)容為中級(jí)，黃色字體。

  • 內(nèi)容模板中的語(yǔ)言配置為英文時(shí)，通知內(nèi)容為 Medium，黃色字體。

format_status(alert.status, locale=None)

將告警狀態(tài)轉(zhuǎn)換為文字描述，且支持彩色字體。

通過(guò)locale參數(shù)，可指定文字的語(yǔ)言。locale參數(shù)的取值請(qǐng)參見(jiàn)告警業(yè)務(wù)函數(shù)locale取值。

支持

• 當(dāng)前告警為觸發(fā)狀態(tài)

• 內(nèi)容模板配置

  {{ format_status(alert.status) }}

• 結(jié)果

  • 內(nèi)容模板中的語(yǔ)言配置為中文時(shí)，通知內(nèi)容為觸發(fā)，紅色字體。

  • 內(nèi)容模板中的語(yǔ)言配置為英文時(shí)，通知內(nèi)容為 Firing，紅色字體。

to_list(value)

將數(shù)組或?qū)ο筠D(zhuǎn)換為列表。

支持

• 告警標(biāo)簽

  {
      "app": "nginx",
      "host": "host-1"
  }

• 內(nèi)容模板配置

  {{ to_list(alert.labels) }}

• 結(jié)果

  • 通知內(nèi)容為Markdown格式時(shí)，返回結(jié)果如下：

    支持根據(jù)渠道是否需要進(jìn)行Markdown轉(zhuǎn)義而自動(dòng)轉(zhuǎn)義。

    - app: nginx
    - host: host-1

  • 通知內(nèi)容為HTML格式時(shí)，返回結(jié)果如下：

    <ul>
      <li>app: nginx</li>
      <li>host: host-1</li>
    </ul>

  • 通知內(nèi)容為普通文本格式時(shí)，返回結(jié)果如下：

    [app: nginx][host: host-1]

annotations_to_list(alert.annotations, locale=None)

將告警標(biāo)注轉(zhuǎn)換為列表形式。類(lèi)似于to_list(alert.annotations)，區(qū)別在于annotations_to_list函數(shù)支持自動(dòng)將標(biāo)準(zhǔn)名稱(chēng)轉(zhuǎn)換為文字描述，例如將title字段轉(zhuǎn)換為標(biāo)題或者Title。標(biāo)準(zhǔn)名稱(chēng)列表，請(qǐng)參見(jiàn)告警標(biāo)注字段映射。

通過(guò)locale參數(shù)，可指定文字的語(yǔ)言。locale參數(shù)的取值請(qǐng)參見(jiàn)告警業(yè)務(wù)函數(shù)locale取值。

支持

• 告警標(biāo)注

  {
      "title": "Nginx訪(fǎng)問(wèn)異常",
      "desc": "PV同比下降80%",
      "cnt": "120"
  }

• 內(nèi)容模板配置

  {{ annotations_to_list(alert.annotations) }}

• 結(jié)果

  通知內(nèi)容為Markdown格式時(shí)，返回結(jié)果如下：

  - 標(biāo)題: Nginx訪(fǎng)問(wèn)異常
  - 描述: PV同比下降80%
  - cnt: 120

blockquote(value)

為通知內(nèi)容添加引用樣式。

• 通知內(nèi)容為Markdown格式時(shí)，在每一行的開(kāi)頭添加>符號(hào)。

• 通知內(nèi)容為HTML格式時(shí)，使用<blockquote>標(biāo)簽包裹通知內(nèi)容。

支持

• 內(nèi)容模板配置

  {{ blockquote("foo\nbar") }}

• 結(jié)果

  • 通知內(nèi)容為Markdown格式時(shí)，返回結(jié)果如下：

    > foo
    > bar

  • 通知內(nèi)容為HTML格式時(shí)，返回結(jié)果如下：

    <blockquote>
    foo
    bar
    </blockquote>