
Redis 导出器
本页内容
简介
以下快速入门指南提供了 Redis 导出器的设置说明以及预配置的仪表盘、告警规则和记录规则。完成本快速入门中的步骤后,您将能够:
设置并配置 Redis 导出器,以采集 Redis 指标,例如 Redis 正常运行时间、每秒执行的命令数、内存使用情况等。
redis info
命令的大多数信息都会被导出。Redis 导出器将这些指标以 Prometheus 格式暴露。配置 Prometheus 以抓取 Redis 导出器指标,并选择性地将它们发送到 Grafana Cloud。
设置一组预配置和精选的记录规则,以缓存频繁的 Prometheus 查询。
导入 Grafana 仪表盘以可视化您的指标数据。
设置 Prometheus 告警规则以根据您的指标数据发出告警。
指标使用
此导出器默认发布大约 190 个 Prometheus 时序。要查看此导出器默认附带的指标列表,请在此处下载样本指标抓取结果。
请注意,根据其配置,Redis 导出器可能会采集和发布比此默认集多得多的指标。要了解有关配置 Redis 导出器和切换其采集器的更多信息,请参阅 Redis 导出器的 GitHub 仓库。
除了调整 Redis 导出器的设置外,您还可以通过删除不需要存储在 Prometheus 或 Grafana Cloud 中的时序来减少指标使用量。要了解如何操作,请参阅 Grafana Cloud 文档中的使用 relabeling 减少 Prometheus 指标使用量。
Grafana Cloud 的 Redis 导出器集成
如果您正在使用 Grafana Cloud,则可以通过安装 Redis 导出器集成来跳过本指南中的所有步骤,该集成旨在帮助您通过几个命令和点击快速启动并运行。免费注册。
要了解如何使用 Redis 导出器集成设置 Redis 导出器,请参阅 Grafana Cloud 文档中的Redis 导出器集成。
本页内容
Redis 导出器快速入门
在本指南中,您将学习如何设置和配置 Redis 导出器,以采集 Redis 指标,例如 Redis 正常运行时间、每秒执行的命令数和内存使用情况,并将它们以 Prometheus 格式暴露。然后,您将配置 Prometheus 来抓取 Redis 指标,并选择性地将它们发送到 Grafana Cloud。最后,您将设置一组预配置和精选的记录规则、Grafana 仪表盘和告警规则。在本指南结束时,您将拥有可用于可视化 Redis 指标的仪表盘以及一组预配置的告警。
如果您正在使用Grafana Cloud,Redis 集成可以帮助您快速启动并运行。Redis 集成将 Redis 导出器嵌入到 Grafana Cloud Agent 中,并自动提供告警规则和仪表盘,因此您无需执行本指南中的步骤。要了解如何使用 Redis 集成设置 Redis 导出器,请参阅 Grafana Cloud 文档中的Redis 集成。
先决条件
在开始之前,您应该具备以下条件:
- 可供 Redis 导出器连接的 Redis 服务器和端口 6379,如果您尚未安装 Redis,请参阅其下载页面。
- 一台兼容 Redis 导出器版本的 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 导出器
在这一步中,您将在您的机器上设置 Redis 导出器,以 Prometheus 格式采集并暴露 Redis 指标。本指南使用 Ubuntu 20.04 系统和 Redis Server v6.2.1。具体步骤可能因您的操作系统和 Redis 版本而略有不同。
首先,登录您的机器并下载相应的 Redis 导出器二进制文件。本指南使用 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 导出器的版本发布页面以获取最新的稳定版本。
解压 tar 包并 cd
到目录中
tar xvfz redis_exporter-v1.18.0.linux-amd64.tar.gz
cd redis_exporter-v1.18.0.linux-amd64
运行 Redis 导出器时,您需要指定 Redis 服务器运行的地址。这可能与您的设置不同,默认情况下,Redis 导出器将连接到 localhost,但可以通过使用 -redis.addr
标志设置地址。
最后,运行导出器
./redis_exporter -redis.addr redis://: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 导出器。
Redis 导出器在端口 9121 上以 Prometheus 格式发布 Redis 指标。您可以使用 curl
进行测试。您需要打开一个新的 SSH 会话或将 Redis 导出器进程放到后台才能使用 curl
。
curl https://: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 导出器,您可以创建一个 systemd
服务。要了解如何操作,请参阅创建 systemd 服务来管理 Agent。将 Agent 二进制文件的路径替换为 Redis 导出器的路径。
Redis 导出器提供以下功能:
- 对 Redis 进行身份验证
- TLS 配置
- 仅 Redis 指标
以及更多功能。要了解有关这些功能的更多信息,请参阅Redis 导出器 GitHub 仓库。
步骤 2:使用 Prometheus 抓取 Redis 导出器
现在 Redis 导出器已在您的机器上启动并运行,您可以配置 Prometheus 抓取作业来采集并存储 Redis 导出器指标。
将以下抓取作业配置添加到您的 prometheus.yml
配置文件中的 scrape_configs
部分
- job_name: redis
static_configs:
- targets: ['redis_exporter_machine_IP_address:9121']
将 redis_exporter_machine_IP_address
替换为运行 Redis 导出器的机器的 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 导出器指标从 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 导出器 mixin 生成的。
将记录规则加载到 Prometheus
要将记录规则加载到 Prometheus 中,请将以下内容添加到您的 prometheus.yml
配置文件中
rule_files:
- "redis_exporter_recording_rules.yml"
请务必将 redis_exporter_recording_rules.yml
替换为您的 Redis 导出器记录规则 YAML 文件的路径。
将记录规则加载到 Grafana Cloud
要了解如何将记录规则加载到 Grafana Cloud 中,请参阅使用 cortextool 加载 Prometheus 和 Loki 规则。
步骤 4:配置仪表盘
本快速入门指南包含以下仪表盘
- 用于 Prometheus Redis 导出器的 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 导出器。然后,您配置了 Prometheus 来抓取 Redis 导出器暴露的 Redis 指标。您将记录规则和告警规则加载到 Prometheus 中,最后导入了 Grafana 仪表盘来可视化您的 Redis 指标。
如果您正在使用 Grafana Cloud,您可以通过安装带 Grafana Cloud Agent 的 Redis 集成来跳过本指南中的所有步骤。此集成将预配置的 Redis 导出器嵌入到 Agent 中,并自动提供 Grafana 仪表盘以及 Prometheus 告警和记录规则,因此您无需手动导入它们。要了解如何设置 Redis 集成,请参阅Grafana Cloud 集成。
仪表盘、记录规则和告警规则是使用 Redis 导出器 Mixin 生成的。Mixins 是由主题专家策划和设计的,用于仪表盘、记录规则和告警的可重用模板。要了解更多信息,请参阅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 导出器 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 导出器 mixin 生成的。
本页内容
Grafana Cloud 提供了不断扩展的集成集,可在几分钟内快速启动并运行可观测性堆栈。内置于 Grafana Cloud Agent 中的 Redis 集成暴露并抓取重要的 Redis 指标,并将其推送到 Grafana Cloud。Agent 将使用嵌入式 Redis 导出器抓取指标,Grafana Cloud 将自动提供定制的 Grafana 仪表盘和告警,以便可视化和处理这些数据。
要了解更多信息,请查阅Grafana Cloud 文档。
工作原理
配置、安装、连接和维护 Prometheus 监控组件通常需要大量的领域知识。从设置到仪表盘和告警可能需要相当长的时间。作为 Grafana 的创建者以及 Prometheus 和 Cortex 的核心贡献者,我们构建了简单的集成来抽象化一部分工作,以便快速开始使用。工作原理
- 注册(或登录)免费的 Grafana Cloud 账号。
- 选择您想要观测的目标(目录正在不断扩展中)。
- 运行一行命令即可安装 Grafana Agent。Agent 嵌入并预配置了导出器,以暴露默认指标,并将它们推送到 Grafana Cloud 指标后端。
- 瞧!您将看到定制的 Grafana 仪表盘,并将受益于合理的默认告警配置。
正在寻找不同的导出器或集成?查阅我们针对 MySQL、Postgres、Redis、Memcached 等流行组件的不断增长的集成库。