Redis Exporter
本页面
简介
以下快速入门指南提供了 Redis Exporter 的设置说明和预配置仪表盘、告警规则和录制规则。完成本快速入门指南中的步骤后,您将拥有
设置并配置 Redis Exporter 以收集 Redis 指标,例如 Redis 正常运行时间、每秒执行的命令、内存利用率等。导出
redis info
命令中的大多数项目。Redis Exporter 将将其作为 Prometheus 样式指标公开。配置 Prometheus 以抓取 Redis Exporter 指标并将其可选地发送到 Grafana Cloud。
设置一组预配置和精选的录制规则以缓存频繁的 Prometheus 查询。
导入 Grafana 仪表盘以可视化您的指标数据。
设置 Prometheus 告警规则以根据您的指标数据发出告警。
指标用法
默认情况下,此导出器发布大约 190 个 Prometheus 时间序列。要查看此导出器默认情况下发布的指标列表,请从此处下载样本指标抓取此处。
请注意,根据其配置,Redis Exporter 可能收集和发布的指标远多于此默认集。要了解有关配置 Redis Exporter 和切换其收集器的更多信息,请参阅 Redis Exporter 的GitHub 存储库。
除了切换 Redis Exporter 的设置外,您还可以通过删除不需要存储在 Prometheus 或 Grafana Cloud 中的时间序列来减少指标使用量。要了解如何执行此操作,请参阅 Grafana Cloud 文档中的使用重新标记减少 Prometheus 指标使用量。
Grafana Cloud 的 Redis Exporter 集成
如果您使用 Grafana Cloud,则可以通过安装 Redis Exporter 集成来跳过本指南中的所有步骤,该集成旨在帮助您在几个命令和点击中启动和运行。 免费注册。
要了解如何使用 Redis Exporter 集成设置 Redis Exporter,请参阅 Grafana Cloud 文档中的Redis Exporter 集成。
本页面
Redis Exporter 快速入门
在本指南中,您将学习如何设置和配置 Redis Exporter 以收集 Redis 指标(例如 Redis 正常运行时间、每秒执行的命令和内存利用率),并将它们作为 Prometheus 样式指标公开。然后,您将配置Prometheus 以抓取 Redis 指标并将其可选地发送到 Grafana Cloud。最后,您将设置一组预配置和精选的录制规则、Grafana仪表盘和告警规则。在本指南结束时,您将拥有可用于可视化 Redis 指标的仪表盘,以及一组预配置的告警。
如果您使用Grafana Cloud,则Redis 集成可以帮助您快速启动和运行。Redis 集成将 Redis Exporter 嵌入到Grafana Cloud Agent 中,并自动配置告警规则和仪表盘,因此您无需执行本指南中的步骤。要了解如何使用 Redis 集成设置 Redis Exporter,请参阅 Grafana Cloud 文档中的Redis 集成。
先决条件
在开始之前,您应该具备以下条件
- Redis 服务器和端口 6379 可供 Redis Exporter 连接,如果您未安装 Redis,请参阅其下载页面。
- 与 Redis Exporter 版本兼容的 Linux 机器。要查看可用版本的列表,请参阅版本。
- 在您的环境中或直接在机器上运行 Prometheus。要了解如何安装 Prometheus,请参阅 Prometheus 文档中的安装。
- 在您的环境中或直接在机器上运行 Grafana。要了解如何安装 Grafana,请参阅 Grafana 文档中的安装 Grafana。
- (可选) Grafana Cloud 账户。Grafana Cloud 托管 Grafana 和一个基于 Mimir 的 Prometheus 指标端点。您仍然需要使用已安装在您的环境中的 Prometheus 或 Grafana Cloud Agent 刮取指标。要了解有关 Grafana Cloud 的更多信息,请参阅 Grafana Cloud。
步骤 1:设置 Redis Exporter
在此步骤中,您将在您的机器上设置 Redis Exporter 以收集并以 Prometheus 格式公开 Redis 指标。本指南使用 Ubuntu 20.04 系统和 Redis Server v6.2.1。步骤可能会因您的操作系统和 Redis 版本而略有不同。
首先,登录您的机器并下载相关的 Redis Exporter 二进制文件。本指南使用 linux-amd64
二进制文件,但您应该选择与您的系统操作系统和架构相对应的二进制文件。
wget https://github.com/oliver006/redis_exporter/releases/download/v1.18.0/redis_exporter-v1.18.0.linux-amd64.tar.gz
将 v1.18.0
替换为您想要安装的版本。本指南可能会过时,因此最好检查 Redis Exporter 发布 页面以获取最新稳定版本。
解压缩 tarball 并 cd
到目录中。
tar xvfz redis_exporter-v1.18.0.linux-amd64.tar.gz
cd redis_exporter-v1.18.0.linux-amd64
运行 Redis Exporter 时,您需要指定 Redis Server 运行地址。这可能与您的设置不同,默认情况下 Redis Exporter 将连接到本地主机,但可以使用 -redis.addr
标志设置地址。
最后,运行导出器。
./redis_exporter -redis.addr redis://127.0.0.1:6379
INFO[0000] Redis Metrics Exporter v1.18.0 build date: 2021-03-11-03:26:58 sha1: d0597c841d2c9fa30ce8b6ded6251d1994822e27 Go: go1.16.1 GOOS: linux GOARCH: amd64
INFO[0000] Providing metrics at :9121/metrics
如果您看到以上输出,则表示您已成功运行 Redis Exporter。
Redis Exporter 在端口 9121 上以 Prometheus 格式发布 Redis 指标。您可以使用 curl
测试这一点。您需要打开一个新的 SSH 会话或将 Redis Exporter 进程置于后台才能使用 curl
。
curl https://127.0.0.1:9121/metrics
. . .
redis_cluster_connections 0
# HELP redis_cluster_enabled cluster_enabled metric
# TYPE redis_cluster_enabled gauge
redis_cluster_enabled 0
# HELP redis_commands_duration_seconds_total Total amount of time in seconds spent per command
# TYPE redis_commands_duration_seconds_total counter
redis_commands_duration_seconds_total{cmd="client"} 1.7e-05
redis_commands_duration_seconds_total{cmd="command"} 0.000443
redis_commands_duration_seconds_total{cmd="config"} 0.000178
redis_commands_duration_seconds_total{cmd="info"} 8.1e-05
redis_commands_duration_seconds_total{cmd="latency"} 8e-06
redis_commands_duration_seconds_total{cmd="set"} 1.7e-05
redis_commands_duration_seconds_total{cmd="slowlog"} 1.4e-05
# HELP redis_commands_processed_total commands_processed_total metric
# TYPE redis_commands_processed_total counter
redis_commands_processed_total 10
如果您看到以上输出,则表示您已准备好开始使用 Prometheus 刮取 Redis 指标。
为了避免从命令行运行和管理 Redis Exporter,您可以创建一个 systemd
服务。要了解如何执行此操作,请参阅 创建 systemd 服务以管理代理。将代理二进制文件的路径替换为 Redis Exporter 的路径。
Redis Exporter 提供的功能包括:
- 对 Redis 进行身份验证
- TLS 配置
- 仅 Redis 指标
以及更多。要了解有关这些功能的更多信息,请参阅 Redis Exporter GitHub 存储库。
步骤 2:使用 Prometheus 抓取 Redis Exporter
现在 Redis Exporter 已在您的机器上启动并运行,您可以配置 Prometheus 刮取作业来收集和存储 Redis Exporter 指标。
将以下刮取作业配置添加到 prometheus.yml
配置文件的 scrape_configs
部分。
- job_name: redis
static_configs:
- targets: ['redis_exporter_machine_IP_address:9121']
将 redis_exporter_machine_IP_address
替换为运行 Redis Exporter 的机器的 IP 地址。如果您在同一台机器上运行 Prometheus,则将为 localhost
。要了解有关配置 Prometheus 的更多信息,请参阅 Prometheus 文档中的 配置。
如果您没有 prometheus.yml
配置文件,请使用您喜欢的文本编辑器创建一个简单的文件。打开您喜欢的文本编辑器并将以下 Prometheus 配置粘贴到其中。
global:
scrape_interval: 15s
scrape_configs:
- job_name: redis
static_configs:
- targets: ['redis_exporter_machine_IP_address:9121']
此配置指示 Prometheus 每 15 秒刮取所有作业。唯一配置的刮取作业称为 redis-exporter
,并定义了一个 redis_exporter_machine_IP_address:9121
目标。默认情况下,Prometheus 将使用 HTTP 刮取 /metrics
端点。
保存并关闭文件。然后,您可以使用以下命令运行该文件中的 Prometheus。
./prometheus --config.file=./prometheus.yml
将指标发送到 Grafana Cloud
要将 Redis Exporter 指标从 Prometheus 发送到 Grafana Cloud,请在 prometheus.yml
配置文件中配置 remote_write
参数。要了解更多信息,请参阅 Grafana Cloud 文档中的 指标 - Prometheus。要了解有关 remote_write
参数的更多信息,请参阅 Prometheus 文档中的 remote_write
。
步骤 3:配置录制规则
使用录制规则,您可以预计算和缓存经常查询的指标。例如,如果仪表板面板使用计算密集型查询(如 rate()
),则可以创建一个录制规则,该规则以规则的缩减间隔运行并保存密集型查询的结果到一个新的时间序列中。这避免了每次仪表板刷新时都获取和计算数据。要了解有关 Prometheus 录制规则的更多信息,请参阅 Prometheus 文档中的 录制规则。
注意:您应该在加载本指南中的仪表板之前加载以下录制规则。
仪表板查询和告警规则使用录制规则来减少 Prometheus 或 Grafana Cloud 指标服务器上的负载,具体取决于您在何处评估规则。
您可以 此处 获取录制规则 YAML 文件。
此录制规则 YAML 文件是使用 Redis Exporter mixin 生成的。
将录制规则加载到 Prometheus 中
要将录制规则加载到 Prometheus 中,请将以下内容添加到您的 prometheus.yml
配置文件中。
rule_files:
- "redis_exporter_recording_rules.yml"
请务必将 redis_exporter_recording_rules.yml
替换为 Redis Exporter 录制规则 YAML 文件的路径。
将录制规则加载到 Grafana Cloud 中
要了解如何在 Grafana Cloud 中加载录制规则,请参阅 使用 cortextool 的 Prometheus 和 Loki 规则。
步骤 4:配置仪表盘
此快速入门包含以下仪表板:
- 用于 Prometheus Redis Exporter 的 Redis 仪表板
要了解如何将这些仪表板导入 Grafana,请参阅 Grafana 文档中的 导入仪表板。
注意:这些仪表板查询可能依赖于上一步中定义的录制规则。请确保在导入仪表板之前导入这些规则。
您可以 此处 获取仪表板。
步骤 5:配置告警
使用 Prometheus 告警规则,您可以定义在 PromQL 表达式超过某个阈值或在一段时间内满足指定条件时触发的告警。例如,您可以定义一个 HighRequestLatency
告警,当请求延迟指标在一段时间内大于某个阈值时触发。一旦告警条件触发,告警将进入 Pending
状态。在满足条件一段时间(由 for
参数定义)后,告警将进入 Firing
状态。您可以使用像 Alertmanager 这样的工具配置触发告警的路由和通知。Alertmanager 也内置于 Grafana Cloud 中。
您可以 此处 获取告警规则 YAML 文件。
将告警规则加载到 Prometheus 中
要将告警规则加载到 Prometheus 中,请将以下内容添加到您的 prometheus.yml
配置文件中。
rule_files:
- "redis_exporter_alerting_rules.yml"
请务必将 redis_exporter_alerting_rules.yml
替换为 Redis 告警规则 YAML 文件的路径。
将告警规则加载到 Grafana Cloud 中
要了解如何在 Grafana Cloud 中加载告警规则,请参阅 使用 cortextool 的 Prometheus 和 Loki 规则。
结论
在本快速入门中,您在 Linux 机器上安装并运行了 Redis Exporter。然后,您配置了 Prometheus 以刮取 Redis Exporter 公开的 Redis 指标。您将录制规则和告警规则加载到 Prometheus 中,最后导入了 Grafana 仪表板以可视化您的 Redis 指标。
如果您使用的是 Grafana Cloud,则可以通过使用 Grafana Cloud Agent 安装 Redis 集成来跳过本指南中的所有步骤。此集成将预配置的 Redis Exporter 嵌入到代理中,并自动预配 Grafana 仪表板以及 Prometheus 告警和录制规则,因此您无需手动导入它们。要了解如何设置 Redis 集成,请参阅 Grafana Cloud 集成。
仪表板、录制规则和告警规则是使用 Redis Exporter Mixin 生成的。Mixin 是由主题专家策划和设计的仪表板、录制规则和告警的可重用模板。要了解更多信息,请参阅 Redis Mixin 存储库。
本页面
注意:您应该在加载本指南中的仪表板之前加载以下录制规则。仪表板查询使用录制规则来减少 Prometheus 或 Grafana Cloud 指标服务器上的负载,具体取决于您在何处评估规则。
此快速入门包含以下录制规则:
redis_memory_fragmentation_ratio
groups:
- name: redis_rules
rules:
- expr: redis_memory_used_rss_bytes / redis_memory_used_bytes
record: redis_memory_fragmentation_ratio
此录制规则 YAML 文件是使用 Redis Exporter mixin 生成的。
本页面
此快速入门包含以下告警规则:
RedisDown
Redis 实例已关闭
RedisOutOfMemory
Redis 内存不足
RedisTooManyConnections
Redis 连接的客户端超过 X 个
下载以下告警规则 YAML 文件:groups:
- name: redis
rules:
- alert: RedisDown
annotations:
description: |-
Redis instance is down
VALUE = {{ $value }}
LABELS: {{ $labels }}
summary: Redis down (instance {{ $labels.instance }})
expr: redis_up == 0
for: 5m
labels:
severity: critical
- alert: RedisOutOfMemory
annotations:
description: |-
Redis is running out of memory (> 90%)
VALUE = {{ $value }}
LABELS: {{ $labels }}
summary: Redis out of memory (instance {{ $labels.instance }})
expr: redis_memory_used_bytes / redis_total_system_memory_bytes * 100 > 90
for: 5m
labels:
severity: warning
- alert: RedisTooManyConnections
annotations:
description: |-
Redis instance has too many connections
VALUE = {{ $value }}
LABELS: {{ $labels }}
summary: Redis too many connections (instance {{ $labels.instance }})
expr: redis_connected_clients > 100
for: 5m
labels:
severity: warning
此告警规则 YAML 文件是使用 Redis Exporter mixin 生成的。
本页面
Grafana Cloud 提供了一套不断扩展的集成,可帮助您在几分钟内快速启动并运行可观测性堆栈。Redis 集成内置于 Grafana Cloud Agent 中,它公开并刮取基本的 Redis 指标并将它们推送到 Grafana Cloud。代理将使用嵌入的 Redis Exporter 刮取指标,Grafana Cloud 将自动预配定制的 Grafana 仪表板和告警,以可视化和处理这些数据。
要了解更多信息,请查看 Grafana Cloud 文档。
工作原理
配置、安装、连接和维护 Prometheus 监控组件通常需要大量的领域知识。从设置到仪表板和告警可能需要相当长的时间。作为 Grafana 的创建者 - 以及 Prometheus 和 Cortex 的核心贡献者 - 我们构建了简单的集成来抽象掉一些工作,以便快速入门。工作原理
- 注册(或登录)一个 免费 Grafana Cloud 账户。
- 选择您想要观察的目标(不断扩展的目录)。
- 运行一行命令以安装 Grafana Agent。代理嵌入并预配置导出器以公开默认指标,并将它们推送到 Grafana Cloud 指标后端。
- 瞧!您将看到定制的 Grafana 仪表板,并将受益于合理的告警默认值。
正在寻找不同的导出器或集成?查看我们 不断增长的流行组件集成库,例如 MySQL、Postgres、Redis、Memcached 等。