Elasticsearch 里面使用 Mustache 那点事

在 Elasticsearch 当中,如果要使用存储在本地的 Script 文件,往往会使用 Mustache 这种脚本语言。他就是一个模板内容,让我们可以从其他地方得到的参数直接替换内部资源。

使用它而不是内置的 painless 脚本方式,是因为他有更好的模板处理能力,例如 {{#tojson}}XXX{{/tojson}} 的自动扩展。

字符串替换

GET _search/template
{
  "source": {
    "size": 0,
    "query": {
      "bool": {
        "must": [{"term": {"beat.hostname": "{{hostname}}"} }]
      }
    }
  },
  "params": {
    "hostname": "host-1"
  }
}

Elasticsearch 的 RESTful API 会检查输入的 JSON 语法,这种字符串的替换是最简单的一种方式。无论你在双引号里面怎么写,都是满足 JSON 语法要求的,也就是 API 并没有问题。

tojson 的替换

但是在 Elasticsearch 中我们使用最频繁的应该是 tojson 这种替换规则。我们在 script 里面计算因为他都是 JSON 格式,输出一块内容会经常用这个 {{#tojson}}var-name{{/tojson}} 的内容。
但是,如果还是类似上面的内容就会报告语法错误:

{
  "source": {
    "size": 0,
    "query": {
      "bool": {
        "must": [{"terms": [{{#tojson}}hostname{{/tojson}}] }]
      }
    }
  },
  "params": {
    "hostname": ["host-1", "host-2"]
  }
}

在 search template 当中有一个特殊的事情,当我们保存一个 mustache 脚本的时候,source 这个域允许直接是一个 字符串 内容。

按照如下的写法就对了:

POST _scripts/test-json
{
  "script": {
    "lang": "mustache",
    "source": """{"size": 0, "query": {"bool": {"must": [{"terms": {{#tojson}}hostname{{/tojson}} }] } } }"""
  }
}

在调用的时候,就可以跟正常的脚本一样使用:

GET _search/template
{
  "id": "test-json",
  "params": {
    "hostname": ["host-1", "host-2"]
  }
}

在定义 source 的时候,我后面使用了三个双引号。在存储 scripts 的时候,如果定义 "lang": "mustache" 那么 Elasticsearch 的 RESTful API 会自动识别这种格式是合法的。

这样的方式方便了后面的实际 JSON Object 的编写,不用打无数个斜杠了。但是,这种三个引号的语法,实际测试在其他的地方是无效的,会直接报语法错误。例如只是简单的修改 "lang": "painless" 以后。

这个问题虽然 Elasticsearch 官方文档中有说明,但是实在是英文太差,一直有意无意的过滤了 下面这句话

the template should either be stored in a file (see Pre-registered templateedit) or, when used via the REST API, should be written as a string:

这个问题卡了好几天,就因为 source 可以写成 stirng 方式,而这个并不符合写 JSON 的习惯导致。希望遇到这个问题的人能够比我解决的快一些。

其他 Mustache 语法

Mustache 官方中,可以根据自己熟悉的语言看一下他的语法文档介绍。

这个东西的适应性还是很广泛的,但是因为我们只在 Elasticsearch 中使用这个模板语言。其他的内容基本上都可以用脚本来解决掉,就不跟这个东西较劲了。后面实际使用中如果发现什么好用,我会更新这里的内容。

预期 {{join}} 应该是一个后面使用过程中,可能会用到的东西。

其他参考

  • Mustache - 官方网站,里面有各种语言的 Github 连接,其中大部分都有详细的 Wiki 用于介绍具体的用法;
  • Elastic Search Template - 官方对于脚本的使用,其中常见的 Mustache 用法基本上说全了,一定要仔细看啊,我就是吃的看快了的亏😭
最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 194,761评论 5 460
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 81,953评论 2 371
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 141,998评论 0 320
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 52,248评论 1 263
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 61,130评论 4 356
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 46,145评论 1 272
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 36,550评论 3 381
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 35,236评论 0 253
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 39,510评论 1 291
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 34,601评论 2 310
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 36,376评论 1 326
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 32,247评论 3 313
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 37,613评论 3 299
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 28,911评论 0 17
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 30,191评论 1 250
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 41,532评论 2 342
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 40,739评论 2 335

推荐阅读更多精彩内容