Elasticsearch：ES|QL 入门 - Python Notebook

数据丰富在本笔记本中，你将学习 Elasticsearch 查询语言 (ES|QL) 的基础知识。你将使用官方 Elasticsearch Python 客户端。

你将学习如何：

运行 ES|QL 查询
使用处理命令
对表格进行排序
查询数据
链式处理命令
计算值
计算统计数据
访问列
创建直方图
丰富数据
处理数据

⚠️ 不要在生产环境中使用 ES|QL。此功能处于技术预览阶段，可能会在未来版本中更改或删除。 Elastic 将努力解决任何问题，但技术预览版中的功能不受官方 GA 功能的支持 SLA 的约束。ES|QL 将在 8.13 正式发布（以官方发布为准）。

在一下的展示中，我将使用 Elastic Stack 8.12 来进行展示。

安装

安装 Elasticsarch 及 Kibana

如果你还没有安装好自己的 Elasticsearch 及 Kibana，请参考如下的链接来进行安装：

在安装的时候，我们选择 Elastic Stack 8.x 来进行安装。特别值得指出的是：ES|QL 只在 Elastic Stack 8.11 及以后得版本中才有。你需要下载 Elastic Stack 8.11 及以后得版本来进行安装。

在首次启动 Elasticsearch 的时候，我们可以看到如下的输出：

我们需要记下 Elasticsearch 超级用户 elastic 的密码。

我们还需要安装 Python 相关的包：

pip3 install elasticsearch

markdown 复制代码

1.  $ pip3 list | grep elasticsearch
2.  elasticsearch               8.12.1

创建环境变量

我们在项目的根目录下创建如下的 .env 文件：

.env

ini 复制代码

1.  ES_USER="elastic"
2.  ES_PASSWORD="q2rqAIphl-fx9ndQ36CO"
3.  ES_ENDPOINT="localhost"

你需要根据自己的 Elasticsearch 的配置来修改上面的值。

创建应用

在项目的根目录下打入如下的命令：

jupyter notebook

拷贝 Elasticsearch 证书

我们把 Elasticsearch 的证书拷贝到当前的项目根目录下：

bash 复制代码

cp ~/elastic/elasticsearch-8.12.0/config/certs/http_ca.crt .

你需要根据自己的安装目录进行相应的修改。

导入包并连接到 Elasticsearch

ini 复制代码

1.  from dotenv import load_dotenv
2.  from elasticsearch import Elasticsearch
3.  from elasticsearch.helpers import bulk
4.  import os

6.  load_dotenv()

8.  ES_USER = os.getenv("ES_USER")
9.  ES_PASSWORD = os.getenv("ES_PASSWORD")
10.  ES_ENDPOINT = os.getenv("ES_ENDPOINT")

12.  url = f"https://{ES_USER}:{ES_PASSWORD}@{ES_ENDPOINT}:9200"

14.  es = Elasticsearch(
15.      hosts=[url], 
16.      ca_certs = "./http_ca.crt", 
17.      verify_certs = True
18.  )

20.  print(es.info())

添加 sample data 到 Elasticsearch 中

在为示例数据集建立索引之前，让我们使用正确的映射创建一个名为 sample_data 的索引。

perl 复制代码

1.  index_name = "sample_data"

3.  mappings = {
4.      "mappings": {
5.          "properties": {"client_ip": {"type": "ip"}, "message": {"type": "keyword"}}
6.      }
7.  }

9.  # Create the index
10.  if not es.indices.exists(index=index_name):
11.      es.indices.create(index=index_name, body=mappings)

接下来，我们使用 Elasticsearch Python 客户端的 bulk helpers 来索引数据：

perl 复制代码

1.  # Documents to be indexed
2.  documents = [
3.      {
4.          "@timestamp": "2023-10-23T12:15:03.360Z",
5.          "client_ip": "172.21.2.162",
6.          "message": "Connected to 10.1.0.3",
7.          "event_duration": 3450233,
8.      },
9.      {
10.          "@timestamp": "2023-10-23T12:27:28.948Z",
11.          "client_ip": "172.21.2.113",
12.          "message": "Connected to 10.1.0.2",
13.          "event_duration": 2764889,
14.      },
15.      {
16.          "@timestamp": "2023-10-23T13:33:34.937Z",
17.          "client_ip": "172.21.0.5",
18.          "message": "Disconnected",
19.          "event_duration": 1232382,
20.      },
21.      {
22.          "@timestamp": "2023-10-23T13:51:54.732Z",
23.          "client_ip": "172.21.3.15",
24.          "message": "Connection error",
25.          "event_duration": 725448,
26.      },
27.      {
28.          "@timestamp": "2023-10-23T13:52:55.015Z",
29.          "client_ip": "172.21.3.15",
30.          "message": "Connection error",
31.          "event_duration": 8268153,
32.      },
33.      {
34.          "@timestamp": "2023-10-23T13:53:55.832Z",
35.          "client_ip": "172.21.3.15",
36.          "message": "Connection error",
37.          "event_duration": 5033755,
38.      },
39.      {
40.          "@timestamp": "2023-10-23T13:55:01.543Z",
41.          "client_ip": "172.21.3.15",
42.          "message": "Connected to 10.1.0.1",
43.          "event_duration": 1756467,
44.      },
45.  ]

47.  # Prepare the actions for the bulk API using list comprehension
48.  actions = [{"_index": index_name, "_source": doc} for doc in documents]

50.  # Perform the bulk index operation and capture the response
51.  success, failed = bulk(es, actions)

53.  if failed:
54.      print(f"Some documents failed to index: {failed}")
55.  else:
56.      print(f"Successfully indexed {success} documents.")

我们可以在 Kibana 中进行查看：

取消默认的 500 limit 警告

python 复制代码

1.  # Suppress specific Elasticsearch warnings about default limit of [500] that pollute responses

3.  import warnings
4.  from elasticsearch import ElasticsearchWarning

6.  warnings.filterwarnings("ignore", category=ElasticsearchWarning)

格式化响应为可以阅读的格式

python 复制代码

1.  # Format response to return human-readable tables

4.  def format_response(response_data):
5.      column_names = [col["name"] for col in response_data["columns"]]
6.      column_widths = [
7.          max(
8.              len(name),
9.              max(
10.                  (
11.                      len(str(row[i]) if row[i] is not None else "None")
12.                      for row in response_data["values"]
13.                  ),
14.                  default=0,
15.              ),
16.          )
17.          for i, name in enumerate(column_names)
18.      ]
19.      row_format = " | ".join(["{:<" + str(width) + "}" for width in column_widths])
20.      print(row_format.format(*column_names))
21.      print("-" * sum(column_widths) + "-" * (len(column_widths) - 1) * 3)
22.      for row in response_data["values"]:
23.          # Convert None values in the row to "None" before formatting
24.          formatted_row = [(str(cell) if cell is not None else "None") for cell in row]
25.          print(row_format.format(*formatted_row))

你的第一个 ES|QL 查询

每个 ES|QL 查询都以源命令开头。源命令会生成一个表，通常包含来自 Elasticsearch 的数据。

FROM source 命令返回一个表，其中包含来自数据流、索引或别名的文档。结果表中的每一行代表一个文档。此查询从 sample_data 索引中返回最多 500 个文档：

ini 复制代码

1.  esql_query = "FROM sample_data"

3.  response = es.esql.query(query=esql_query)
4.  format_response(response)

每列对应一个字段，并且可以通过该字段的名称进行访问。

ℹ️ ES|QL 关键字不区分大小写。 FROM sample_data 与 from sample_data 相同。

处理命令

源命令后面可以跟一个或多个处理命令，用竖线字符分隔：|。处理命令通过添加、删除或更改行和列来更改输入表。处理命令可以执行过滤、投影、聚合等。

例如，你可以使用 LIMIT 命令来限制返回的行数，最多为 10,000 行：

ini 复制代码

1.  esql_query = """
2.  FROM sample_data
3.  | LIMIT 3
4.  """

6.  response = es.esql.query(query=esql_query)
7.  format_response(response)

对表格进行排序

另一个处理命令是 SORT 命令。默认情况下，FROM 返回的行没有定义的排序顺序。使用 SORT 命令对一列或多列上的行进行排序：

ini 复制代码

1.  esql_query = """
2.  FROM sample_data
3.  | SORT @timestamp DESC
4.  """

6.  response = es.esql.query(query=esql_query)
7.  format_response(response)

查询数据

使用 WHERE 命令来查询数据。例如，要查找持续时间超过 5 毫秒的所有事件：

ini 复制代码

1.  esql_query = """
2.  FROM sample_data
3.  | WHERE event_duration > 5000000
4.  """

6.  response = es.esql.query(query=esql_query)
7.  format_response(response)

WHERE 支持多个运算符。

例如，你可以使用 LIKE 对消息列运行通配符查询：

ini 复制代码

1.  esql_query = """
2.  FROM sample_data
3.  | WHERE message LIKE "Connected*"
4.  """

6.  response = es.esql.query(query=esql_query)
7.  format_response(response)

链式处理命令

你可以链接处理命令，并用竖线字符分隔：|。每个处理命令都作用于前一个命令的输出表。查询的结果是最终处理命令生成的表。

以下示例首先根据 @timestamp 对表进行排序，然后将结果集限制为 3 行：

ini 复制代码

1.  esql_query = """
2.  FROM sample_data
3.  | SORT @timestamp DESC
4.  | LIMIT 3
5.  """

7.  response = es.esql.query(query=esql_query)
8.  format_response(response)

ℹ️ 处理命令的顺序很重要。首先将结果集限制为 3 行，然后再对这 3 行进行排序，很可能会返回与此示例不同的结果，其中排序在限制之前。

计算值

使用 EVAL 命令将包含计算值的列追加到表中。例如，以下查询附加一个 duration_ms 列。该列中的值是通过将 event_duration 除以 1,000,000 计算得出的。换句话说： event_duration 从纳秒转换为毫秒。

ini 复制代码

1.  esql_query = """
2.  FROM sample_data
3.  | EVAL duration_ms = event_duration/1000000.0
4.  """

6.  response = es.esql.query(query=esql_query)
7.  format_response(response)

EVAL 支持多种函数。例如，要将数字四舍五入为最接近指定位数的数字，请使用 ROUND 函数：

ini 复制代码

1.  esql_query = """
2.  FROM sample_data
3.  | EVAL duration_ms = ROUND(event_duration/1000000.0, 1)
4.  """

6.  response = es.esql.query(query=esql_query)
7.  format_response(response)

计算统计数据

你还可以使用 ES|QL 来聚合数据。使用 STATS ... BY 命令计算统计数据。

例如，计算中位持续时间：

ini 复制代码

1.  esql_query = """
2.  FROM sample_data
3.  | STATS median_duration = MEDIAN(event_duration)
4.  """

6.  response = es.esql.query(query=esql_query)
7.  format_response(response)

你可以使用一个命令计算多个统计数据：

ini 复制代码

1.  esql_query = """
2.  FROM sample_data
3.  | STATS median_duration = MEDIAN(event_duration), max_duration = MAX(event_duration)
4.  """

6.  response = es.esql.query(query=esql_query)
7.  format_response(response)

使用 BY 按一列或多列对计算的统计数据进行分组。例如，要计算每个客户端 IP 的中位持续时间：

ini 复制代码

1.  esql_query = """
2.  FROM sample_data
3.  | STATS median_duration = MEDIAN(event_duration) BY client_ip
4.  """

6.  response = es.esql.query(query=esql_query)
7.  format_response(response)

访问列

你可以通过名称访问列。如果名称包含特殊字符，则需要用反引号（`）引起来。

为 EVAL 或 STATS 创建的列分配显式名称是可选的。如果不提供名称，则新列名称等于函数表达式。例如：

ini 复制代码

1.  esql_query = """
2.  FROM sample_data
3.  | EVAL event_duration/1000000.0
4.  """

6.  response = es.esql.query(query=esql_query)
7.  format_response(response)

在此查询中，EVAL 添加一个名为 event_duration/1000000.0 的新列。由于其名称包含特殊字符，因此要访问此列，请用反引号引用它：

ini 复制代码

1.  esql_query = """
2.  FROM sample_data
3.  | EVAL event_duration/1000000.0
4.  | STATS MEDIAN(`event_duration/1000000.0`)
5.  """
6.  response = es.esql.query(query=esql_query)
7.  format_response(response)

创建直方图

为了跟踪一段时间内的统计数据，ES|QL 允许你使用 AUTO_BUCKET 函数创建直方图。 AUTO_BUCKET 创建人性化的存储桶大小，并为每行返回一个与该行所属的结果存储桶相对应的值。

例如，要为 10 月 23 日的数据创建每小时存储桶：

ini 复制代码

1.  esql_query = """
2.  FROM sample_data
3.  | KEEP @timestamp
4.  | EVAL bucket = AUTO_BUCKET (@timestamp, 24, "2023-10-23T00:00:00Z", "2023-10-23T23:59:59Z")
5.  """
6.  response = es.esql.query(query=esql_query)
7.  format_response(response)

将 AUTO_BUCKET 与 STATS ... BY 结合起来创建直方图。例如，要计算每小时的事件数：

ini 复制代码

1.  esql_query = """
2.  FROM sample_data
3.  | KEEP @timestamp, event_duration
4.  | EVAL bucket = AUTO_BUCKET (@timestamp, 24, "2023-10-23T00:00:00Z", "2023-10-23T23:59:59Z")
5.  | STATS COUNT(*) BY bucket
6.  """
7.  response = es.esql.query(query=esql_query)
8.  format_response(response)

或每小时的中位持续时间：

ini 复制代码

1.  esql_query = """
2.  FROM sample_data
3.  | KEEP @timestamp, event_duration
4.  | EVAL bucket = AUTO_BUCKET (@timestamp, 24, "2023-10-23T00:00:00Z", "2023-10-23T23:59:59Z")
5.  | STATS median_duration = MEDIAN(event_duration) BY bucket
6.  """
7.  response = es.esql.query(query=esql_query)
8.  format_response(response)

丰富数据

ES|QL 使你能够使用 ENRICH 命令使用 Elasticsearch 中索引的数据来丰富表。

ℹ️ 在使用 ENRICH 之前，你首先需要创建并执行丰富策略。我们在 ela.st/ql 提供了一个演示环境，其中已经创建并执行了名为 clientip_policy 的丰富策略，如果你只是想看看它是如何工作的。

以下请求创建并执行名为 clientip_policy 的策略。该策略将 IP 地址链接到环境（"Development"、"QA" 或 "Production"）。

perl 复制代码

1.  # Define the mapping
2.  mapping = {
3.      "mappings": {
4.          "properties": {"client_ip": {"type": "keyword"}, "env": {"type": "keyword"}}
5.      }
6.  }

8.  # Create the index with the mapping
9.  es.indices.create(index="clientips", body=mapping)

11.  # Prepare bulk data
12.  bulk_data = [
13.      {"index": {}},
14.      {"client_ip": "172.21.0.5", "env": "Development"},
15.      {"index": {}},
16.      {"client_ip": "172.21.2.113", "env": "QA"},
17.      {"index": {}},
18.      {"client_ip": "172.21.2.162", "env": "QA"},
19.      {"index": {}},
20.      {"client_ip": "172.21.3.15", "env": "Production"},
21.      {"index": {}},
22.      {"client_ip": "172.21.3.16", "env": "Production"},
23.  ]

25.  # Bulk index the data
26.  es.bulk(index="clientips", body=bulk_data)

28.  # Define the enrich policy
29.  policy = {
30.      "match": {
31.          "indices": "clientips",
32.          "match_field": "client_ip",
33.          "enrich_fields": ["env"],
34.      }
35.  }

37.  # Put the enrich policy
38.  es.enrich.put_policy(, body=policy)

40.  # Execute the enrich policy without waiting for completion
41.  es.enrich.execute_policy(, wait_for_completion=True)

创建并执行策略后，你可以将其与 ENRICH 命令一起使用：

ini 复制代码

1.  esql_query = """
2.  FROM sample_data
3.  | KEEP @timestamp, client_ip, event_duration
4.  | EVAL client_ip = TO_STRING(client_ip)
5.  | ENRICH clientip_policy ON client_ip WITH env
6.  """
7.  response = es.esql.query(query=esql_query)
8.  format_response(response)

你可以在后续命令中使用 ENRICH 命令添加的新 env 列。例如，要计算每个环境的中位持续时间：

ini 复制代码

1.  esql_query = """
2.  FROM sample_data
3.  | KEEP @timestamp, client_ip, event_duration
4.  | EVAL client_ip = TO_STRING(client_ip)
5.  | ENRICH clientip_policy ON client_ip WITH env
6.  | STATS median_duration = MEDIAN(event_duration) BY env
7.  """
8.  response = es.esql.query(query=esql_query)
9.  format_response(response)

有关使用 ES|QL 进行数据丰富的更多信息，请参阅数据丰富。

处理数据

你的数据可能包含非结构化字符串，你希望对其进行结构化以便更轻松地分析数据。例如，示例数据包含如下日志消息：

css 复制代码

Connected to 10.1.0.3

通过从这些消息中提取 IP 地址，你可以确定哪个 IP 接受了最多的客户端连接。

要在查询时构建非结构化字符串，你可以使用 ES|QL DISSECT 和 GROK 命令。 DISSECT 的工作原理是使用基于分隔符的模式分解字符串。 GROK 的工作原理类似，但使用正则表达式。这使得 GROK 更强大，但通常也更慢。

在这种情况下，不需要正则表达式，因为 message 很简单："Connected to "，后跟服务器 IP。要匹配此字符串，你可以使用以下 DISSECT 命令：

ini 复制代码

1.  esql_query = """
2.  FROM sample_data
3.  | DISSECT message "Connected to %{server_ip}"
4.  """
5.  response = es.esql.query(query=esql_query)
6.  format_response(response)

这会将 server_ip 列添加到具有与此模式匹配的 message 的那些行。对于其他行，server_ip 的值为空。

你可以在后续命令中使用 DISSECT 命令添加的新 server_ip 列。例如，要确定每个服务器已接受多少个连接：

ini 复制代码

 2.  esql_query = """
3.  FROM sample_data
4.  | WHERE STARTS_WITH(message, "Connected to")
5.  | DISSECT message "Connected to %{server_ip}"
6.  | STATS COUNT(*) BY server_ip
7.  """
8.  response = es.esql.query(query=esql_query)
9.  format_response(response)

ℹ️ 要了解有关使用 ES|QL 进行数据处理的更多信息，请参阅使用 DISSECT 和 GROK 进行数据处理。

了解更多，请阅读 "Elasticsearch：ES|QL 查询展示"。

最终的 Notebook 可以在地址 github.com/liu-xiao-gu... 下载。

Elasticsearch：ES|QL 入门 - Python Notebook

安装

安装 Elasticsarch 及 Kibana

创建环境变量

创建应用

拷贝 Elasticsearch 证书

导入包并连接到 Elasticsearch

添加 sample data 到 Elasticsearch 中

取消默认的 500 limit 警告

格式化响应为可以阅读的格式

你的第一个 ES|QL 查询

处理命令

对表格进行排序

查询数据

更多处理命令

链式处理命令

计算值

计算统计数据

访问列

创建直方图

丰富数据

处理数据