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

Prometheus 支持基本访问认证 （也称为“基本认证”）来保护对 Prometheus 表达式浏览器和 HTTP API 的连接。

注意本教程涵盖到 Prometheus 实例的基本认证连接。Prometheus 实例到采集目标的连接也支持基本认证。

对密码进行哈希处理

假设您希望所有访问 Prometheus 实例的用户都必须提供用户名和密码。在本例中，我们使用 `admin` 作为用户名，并选择您喜欢的任何密码。

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

假设您运行的是类 debian 的发行版，可以通过运行 `apt install python3-bcrypt` 来安装它。还有其他生成哈希密码的方法；为了测试，您也可以使用网上的 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 https://:9090/graph

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

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

curl -u admin https://: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 端点的用户进行身份验证。