使用基本认证保护 Prometheus API 和 UI 端点

Prometheus 支持 基本认证 (也称为 "basic auth")，用于连接到 Prometheus 表达式浏览器 和 HTTP API。

哈希密码

假设您想要求所有访问 Prometheus 实例的用户提供用户名和密码。在本示例中，使用 admin 作为用户名并选择您想要的任何密码。

首先，生成密码的 bcrypt 哈希值。为了生成哈希密码，我们将使用 python3-bcrypt。

让我们运行 apt install python3-bcrypt 来安装它，假设您正在运行类似 Debian 的发行版。还有其他生成哈希密码的方法；对于测试，您也可以使用 网络上的 bcrypt 生成器。

这是一个使用 python3-bcrypt 提示输入密码并对其进行哈希处理的 python 脚本

import getpass
import bcrypt

password = getpass.getpass("password: ")
hashed_password = bcrypt.hashpw(password.encode("utf-8"), bcrypt.gensalt())
print(hashed_password.decode())

将该脚本另存为 gen-pass.py 并运行它

$ python3 gen-pass.py

这应该会提示您输入密码

password:
$2b$12$hNf2lSsxfm0.i4a.1kVpSOVyBCfIB51VRjgBUyv6kdnyTlgWj81Ay

在本示例中，我使用了 “test” 作为密码。

将该密码保存在某处，我们将在接下来的步骤中使用它！

创建 web.yml

让我们创建一个 web.yml 文件 (文档)，内容如下

basic_auth_users:
    admin: $2b$12$hNf2lSsxfm0.i4a.1kVpSOVyBCfIB51VRjgBUyv6kdnyTlgWj81Ay

您可以使用 promtool check web-config web.yml 验证该文件

$ promtool check web-config web.yml
web.yml SUCCESS

您可以向文件中添加多个用户。

启动 Prometheus

您可以使用以下方法使用 web 配置文件启动 prometheus

$ prometheus --web.config.file=web.yml

测试

您可以使用 cURL 与您的设置进行交互。尝试此请求

curl --head http://localhost:9090/graph

这将返回 401 Unauthorized 响应，因为您未能提供有效的用户名和密码。

要使用基本认证成功访问 Prometheus 端点，例如 /metrics 端点，请使用 -u 标志提供正确的用户名，并在提示时提供密码

curl -u admin http://localhost:9090/metrics
Enter host password for user 'admin':

这应该返回 Prometheus 指标输出，它应该看起来像这样

# HELP go_gc_duration_seconds A summary of the GC invocation durations.
# TYPE go_gc_duration_seconds summary
go_gc_duration_seconds{quantile="0"} 0.0001343
go_gc_duration_seconds{quantile="0.25"} 0.0002032
go_gc_duration_seconds{quantile="0.5"} 0.0004485
...

总结

在本指南中，您将用户名和哈希密码存储在 web.yml 文件中，启动了 prometheus 并使用了必要的参数来使用该文件中的凭据来验证访问 Prometheus HTTP 端点的用户。

本文档是 开源 的。请通过提交问题或拉取请求来帮助改进它。