在 AWS Prometheus 查询中使用 awscurl 添加过滤器的实用指南

2024-03-02 00:43:19

在 AWS Prometheus 查询中使用 awscurl 添加过滤器

背景

Prometheus 是一种广泛采用的开源监控和警报系统，而 Amazon Managed Service for Prometheus (AMP) 是 AWS 提供的托管服务，可简化在 AWS 中运行 Prometheus 的过程。

挑战

使用 awscurl Python 模块从 AMP 端点查询指标数据时，需要添加 PromQL 过滤器来精简结果。然而，许多开发者会遇到 400 状态代码和 'x-amzn-errortype': 'InvalidQueryStringException' 错误。

解决方法

要解决此问题，请遵循以下步骤：

1. 编码查询字符串
使用 urllib.parse.quote() 函数对 PromQL 查询字符串进行 URL 编码。

2. 使用 filter 参数
awscurl 提供 filter 参数，可让你指定 PromQL 过滤器。该参数是一个由逗号分隔的过滤器组成的字符串。

3. 构建查询 URI
将编码后的查询字符串和过滤器添加到查询 URI 中。该 URI 应遵循以下格式：

https://<SERVICE>-workspaces.<REGION>.amazonaws.com/workspaces/<WORKSPACE_ID>/api/v1/query_range?query=<ENCODED_QUERY_STRING>&filter=<FILTER_STRING>&start=<START_TIMESTAMP>&end=<END_TIMESTAMP>&step=<STEP_SIZE>

示例代码

以下 Python 代码演示了如何使用 awscurl 添加过滤器：

import awscurl.awscurl as aws
import urllib.parse

uri = 'https://<SERVICE>-workspaces.<REGION>.amazonaws.com/workspaces/<WORKSPACE_ID>/api/v1/query_range'
...
encoded_query_string = urllib.parse.quote(query_string)
query_uri = f'{uri}?query={encoded_query_string}&filter={filter_string}&start={start_timestamp}&end={end_timestamp}&step={step_size}'
...
r = aws.make_request(**awscurl_auth_params)