对于 AI 代理:可在 https://www.mongodb.com/zh-cn/docs/llms.txt 获取文档索引—通过在任何 URL 路径后添加 .md 可获取所有页面的 Markdown 版本。

与 Prometheus 集成

Prometheus 按给定的时间间隔从配置的目标收集指标,评估规则表达式,显示结果,并在观察到特定条件时触发警报。

我们的集成支持配置 Atlas,可以将部署的相关指标数据发送到您的 Prometheus 实例。

政府应用的 Atlas 不支持 Prometheus 集成。

  • Prometheus 集成仅适用于 M10+ 集群。

  • 有一个正常工作的 Prometheus实例。要设立工作实例,请参阅其安装指南。

  • 将托管 Prometheus 实例的设备的 IP 添加到 IP 访问列表。

    注意

    如果您向 IP 访问列表中添加任何 IPv4 /0 CIDR(例如 0.0.0.0/0),从而允许从公共互联网的任意位置访问集群,Atlas 将禁用 Prometheus 集成。

    如果 /0 CIDR 已在 IP 访问列表中,Atlas 会阻止您配置 Prometheus 集成。

    如果您将任何 IPv4 /0 CIDR(例如 0.0.0.0/0 或 10.0.0.0/0)添加到项目访问列表中,Atlas 会向所有直接被授予该项目角色的用户发送告警邮件;对于通过团队成员身份间接获得项目角色的用户(前提是该团队已被授予项目角色),Atlas 也会发送告警邮件。

  • (可选)使用 Grafana 可视化您的 Prometheus 指标。

要配置 Atlas 与 Prometheus 的集成:

1
  1. 如果尚未显示,请从导航栏上的 Organizations 菜单中选择包含所需项目的组织。

  2. 如果尚未显示,请从导航栏的Projects菜单中选择所需的项目。

  3. 在侧边栏中,单击 图标 Project Overview 旁边的图标。

显示项目设置页面。

2

单击 Integrations 标签页。

显示“项目集成”页面。

3
4

Prometheus 身份验证凭证专为与 MongoDB Atlas 中的 Prometheus 集成一起使用而设计。Atlas 仅将这些凭证用于访问 Prometheus 发现端点,并从 Atlas 节点抓取 Prometheus指标。它们严格限于这些功能,除了访问和收集监控数据外,没有任何其他权限或能力。

重要

复制用户名和密码,将其存储在安全位置。离开此屏幕后,您将无法访问密码。

5
探索方法
说明

此方法需要 Prometheus v2.28 及更高版本。它会自动生成配置文件的 scrape_config 部分,以通过HTTP端点发现目标。

  1. 将托管 Prometheus 实例的设备的 IP 添加到 IP 访问列表。这授予 Prometheus 网络访问权限,以从您的 Atlas 集群中抓取指标。确保 0.0.0.0/0 不在清单上。拥有此条目将禁用集成。

  2. 在 Atlas 用户界面中的 Choose Discovery API Target Type 步骤中,执行以下任务之一:

    • 选择 Public Internet 。

    • 选择 Private IP for Peering 。

    • 选择 Private Endpoint,然后选择或创建终结点。

  3. (可选)若要启用向 Prometheus 发送自定义资源标签,请将 Send Resource Tags 切换为 On。

    您必须选择启用此功能,才能将自定义资源标签发送到 Prometheus 指标。启用此功能后,Atlas 会将资源标签作为标签添加到 Prometheus 指标中。这样,您可以根据自定义标签来过滤、组织和定义监控逻辑。如需了解有关资源标签的更多信息,请参阅资源标签。

  4. 将以下代码片段插入到 Prometheus.yml 文件的 scrape_configs 部分,并使用 Prometheus 集成的值对其进行更新。

    对于私有端点,配置是根据所选终结点自动生成的。

    - job_name: "<insert-job-name>" scrape_interval: 10s metrics_path: /metrics scheme: https basic_auth: username: <insert-prometheus-user-id> password: <insert-password> http_sd_configs: - url: <url-of-the-service-discovery-configuration> refresh_interval: 60s basic_auth: username: <insert-prometheus-user-id> password: <insert-password>

此方法允许 Prometheus 读取 YAML 或 JSON 文档,以配置要抓取的目标。您负责向 Discovery API 发出请求并将其结果存储在 targets.json 文件,以此提供目标。

如需发出请求,请替换以下选项卡中的占位符文本,或用其他语言创建自己的脚本。

curl --header 'Accept: application/json'# Sets the `Authorization` header on every scrape request with the# username and password from the previous step.--user <username>:<password># The URL that Prometheus fetches the targets from.# Replace the <group-id> with the project ID of your Atlas instance.--request GET "https://cloud.mongodb.com/prometheus/v1.0/groups/<group_id>/discovery"

要了解有关“发现 API”的更多信息,请参阅返回 Prometheus 的最新目标。

如果您将任何 IPv4 /0 CIDR(例如 0.0.0.0/0 或 10.0.0.0/0)添加到项目访问列表中,Atlas 会向所有直接被授予该项目角色的用户发送告警邮件;对于通过团队成员身份间接获得项目角色的用户(前提是该团队已被授予项目角色),Atlas 也会发送告警邮件。

警告

添加 /0 CIDR(例如 0.0.0.0/0)会允许从任何位置进行访问。此配置可能使您的部署暴露于未授权访问、数据外泄以及其他恶意活动风险之中。请尽可能将访问限制在受信任的 IP 地址或 CIDR 范围内,并在允许通过公共互联网访问时,为所有数据库用户使用强凭证。

6
7
  1. 将生成的代码片段复制到配置文件的 scrape_configs 部分,并替换占位符文本。

    有关这两种方法的配置文件示例,请参阅示例配置。

  2. 重新启动 Prometheus 实例。

  3. 在 Prometheus 实例中,单击顶部导航栏中的 Status,然后单击 Targets 以查看部署的指标。

以下显示了使用 HTTP SD 或 文件服务发现 方法时的 配置文件 示例。

这两种方法的配置文件都包含以下字段:

字段
说明

scrape_interval

时间,表示抓取目标的频率。该设置支持最短 10 秒。

job_name

分配给抓取指标的人类可读标签。

metrics_path

指示从何处获取目标指标的 HTTP 资源路径。

scheme

您想为请求配置的协议方案。

basic_auth

在每次抓取请求中使用的授权标头。

HTTP 服务发现方法还包含具有以下子字段的 http_sd_configs 字段:

字段
说明

url

Prometheus 从中获取目标的 URL。

refresh_interval

指示何时重新查询端点的时间。

basic_auth

用于向 API 服务器进行身份验证的凭据。

global: scrape_interval: 15s scrape_configs: - job_name: "Cloud-Testing-mongo-metrics" scrape_interval: 10s metrics_path: /metrics scheme : https basic_auth: username: prom_user_618d48e05277a606ed2496fe password: fSIMUngfTmOTVEB4 http_sd_configs: - url: https://cloud.mongodb.com/prometheus/v1.0/groups/618d48e05277a606ed2496fe/discovery refresh_interval: 60s basic_auth: username: prom_user_618d48e05277a606ed2496fe password: fSIMUngfTmOTVEB4

AWS PrivateLink 的 HTTP Service Discovery 方法还包含 url 字段,其中包含以下变量,您应使用值来定义:

注意

每个私有端点处理单个区域的指标抓取。对于多区域集群,您必须为每个区域的 Prometheus 实例指定不同的抓取配置。

字段
说明

group_id

标识 Atlas 项目的唯一字符串。例如,5f4a8b9c1d2e3f4a5b6c7d8e。

endpoint_id

AWS PrivateLink 端点 ID(格式:vpce-xxxxxxxxxxxxx)。例如,vpce-0a1b2c3d4e5f6g7h8。要查找您的端点 ID,请执行以下步骤之一:

  • 在 Atlas 用户界面中,前往 Network Access 标签页,Private Endpoint 部分,并复制 Endpoint ID 值。

  • 在 AWS 控制台中,转到 VPC 服务 Endpoints 部分,然后复制 Atlas 端点的 VPC Endpoint ID 值。

global: scrape_interval: 10s evaluation_interval: 10s scrape_configs: - job_name: "Cloud-Testing-mongo-metrics" scrape_interval: 10s scrape_timeout: 10s metrics_path: /metrics scheme : https basic_auth: username: prom_user_618d48e05277a606ed2496fe password: fSIMUngfTmOTVEB4 http_sd_configs: - url: https://cloud.mongodb.com/prometheus/v1.0/groups/{group_id}/discovery?targetScheme=PRIVATE_ENDPOINT&endpointId={endpoint_id} refresh_interval: 60s basic_auth: username: prom_user_618d48e05277a606ed2496fe password: fSIMUngfTmOTVEB4 relabel_configs: - source_labels: [__metrics_path__] target_label: __metrics_path__ - source_labels: [__instance__] target_label: instance

“文件服务发现”方法还包含带有以下子字段的 file_sd_configs 字段:

字段
说明

files

包含要从中提取指标抓取目标的文件的列表。

global: scrape_interval: 15s scrape_configs: - job_name: "Cloud-Testing-mongo-metrics" scrape_interval: 10s metrics_path: /metrics scheme : https basic_auth: username: prom_user_618d48e05277a606ed2496fe password: fSIMUngfTmOTVEB4 file_sd_configs: - files: - /usr/local/etc/targets.json

导入示例Grafana仪表盘:

1

在 Grafana用户界面中,单击“确定”按钮,然后单击 Import。

2
3

要学习;了解有关导入 Grafana 仪表盘的更多信息,请参阅 Grafana 文档。

警告

提供的 Grafana 仪表盘在部分面板中使用 PromQL 的 rate() 函数。对于您希望实现的最低粒度,至少应有 4 个数据点。例如,若要以 1 分钟粒度可视化指标,请将 Prometheus 抓取间隔设置为 15 秒或更短。

如需了解更多信息,请参阅 Prometheus rate() 函数文档和 Prometheus 直方图文档。

您也可以将仪表盘模板中的 $interval 变量替换为 $__rate_interval。该变量会根据您的抓取间隔自动解析为适当的间隔。例如,在步长为 1 分钟、抓取间隔为 10 秒的仪表盘上,$__rate_interval 会解析为 1 分钟 10 秒。如需了解更多信息,请参阅 Grafana 关于 rate intervals 的博文。

注意

对于托管 Grafana 用户

Atlas Prometheus 集成提供超过 3000 个可抓取指标。如果您有成本限制,且提供的仪表盘能够满足您的监控需求,则可以通过筛选仅抓取这些仪表盘使用的特定指标。

仪表盘使用以下不同的指标:

  • hardware_disk_metrics_disk_space_free_bytes

  • hardware_disk_metrics_disk_space_used_bytes

  • hardware_disk_metrics_read_count

  • hardware_disk_metrics_read_throughput_bytes_per_second

  • hardware_disk_metrics_read_time_milliseconds

  • hardware_disk_metrics_total_time_milliseconds

  • hardware_disk_metrics_weighted_time_io_milliseconds

  • hardware_disk_metrics_write_count

  • hardware_disk_metrics_write_time_milliseconds

  • hardware_platform_num_logical_cpus

  • hardware_process_cpu_children_kernel_milliseconds

  • hardware_process_cpu_children_user_milliseconds

  • hardware_process_cpu_kernel_milliseconds

  • hardware_process_cpu_user_milliseconds

  • hardware_system_cpu_guest_milliseconds

  • hardware_system_cpu_io_wait_milliseconds

  • hardware_system_cpu_irq_milliseconds

  • hardware_system_cpu_kernel_milliseconds

  • hardware_system_cpu_nice_milliseconds

  • hardware_system_cpu_soft_irq_milliseconds

  • hardware_system_cpu_steal_milliseconds

  • hardware_system_cpu_user_milliseconds

  • hardware_system_memory_buffers_kilobytes

  • hardware_system_memory_cached_kilobytes

  • hardware_system_memory_mem_available_kilobytes

  • hardware_system_memory_mem_free_kilobytes

  • hardware_system_memory_mem_total_kilobytes

  • hardware_system_memory_shared_mem_kilobytes

  • hardware_system_memory_swap_free_kilobytes

  • hardware_system_memory_swap_total_kilobytes

  • hardware_system_network_eth0_bytes_in_bytes

  • hardware_system_network_eth0_bytes_out_bytes

  • hardware_system_vm_page_swap_in

  • hardware_system_vm_page_swap_out

  • mongodb_asserts_msg

  • mongodb_asserts_regular

  • mongodb_asserts_user

  • mongodb_asserts_warning

  • mongodb_catalogStats_collections

  • mongodb_catalogStats_views

  • mongodb_connections_current

  • mongodb_extra_info_page_faults

  • mongodb_globalLock_currentQueue_readers

  • mongodb_globalLock_currentQueue_total

  • mongodb_globalLock_currentQueue_writers

  • mongodb_indexStats_count

  • mongodb_info

  • mongodb_mem_resident

  • mongodb_mem_virtual

  • mongodb_metrics_cursor_open_total

  • mongodb_metrics_cursor_timedOut

  • mongodb_metrics_document_deleted

  • mongodb_metrics_document_inserted

  • mongodb_metrics_document_returned

  • mongodb_metrics_document_updated

  • mongodb_metrics_operation_scanAndOrder

  • mongodb_metrics_queryExecutor_scanned

  • mongodb_metrics_queryExecutor_scannedObjects

  • mongodb_metrics_query_sort_spillToDisk

  • mongodb_metrics_ttl_deletedDocuments

  • mongodb_network_bytesIn

  • mongodb_network_bytesOut

  • mongodb_network_numRequests

  • mongodb_opLatencies_commands_latency

  • mongodb_opLatencies_commands_ops

  • mongodb_opLatencies_reads_latency

  • mongodb_opLatencies_reads_ops

  • mongodb_opLatencies_writes_latency

  • mongodb_opLatencies_writes_ops

  • mongodb_opcounters_command

  • mongodb_opcounters_delete

  • mongodb_opcounters_getmore

  • mongodb_opcounters_insert

  • mongodb_opcounters_query

  • mongodb_opcounters_update

  • mongodb_oplog_earliestOptime

  • mongodb_oplog_latestOptime

  • mongodb_queues_execution_read_available

  • mongodb_queues_execution_write_available

  • mongodb_repl_secondary

  • mongodb_up

  • mongodb_uptime

  • mongodb_wiredTiger_cache_bytes_currently_in_the_cache

  • mongodb_wiredTiger_cache_bytes_read_into_cache

  • mongodb_wiredTiger_cache_bytes_written_from_cache

  • mongodb_wiredTiger_cache_maximum_bytes_configured

  • mongodb_wiredTiger_cache_tracked_dirty_bytes_in_the_cache

当您将 Prometheus 与 Atlas 集群集成时,以下指标可用:

注意

在 Atlas Infinite 集群上,可用指标描述的是集群的计算节点,而不是存储层,有些列出的指标不可用。有关 Atlas Infinite 上可用的指标,请查看 查看可用指标。

每个 MongoDB 指标都包含以下标签:

注意

除了下面列出的标签外,Atlas 还会将用户定义的资源标签作为标签添加到 Prometheus 中。这是一项可选功能,您可以通过 UI 或 API 启用。请参阅本文档中的“过程”部分,详细了解各个步骤。

标签
说明

availability_zone

AWS 可用性分区 ID、Google Cloud 分区的完全限定名称或 Azure 分区编号。

Azure 仅在部分区域支持可用区。Atlas 仅为支持可用区的区域提供 Azure 的预定义可用区标签。要了解更多信息,请参阅 Microsoft Azure。

有关每个云提供商可能的 availabilityZone 值的更多信息,请参阅Amazon Web Services、GCP或Azure文档。

cl_name

用于标识集群的人类可读标签。

cl_role

人类可读标签,用于定义集群角色。

group_id

标识项目的唯一十六进制数字字符串。

group_name

唯一标识项目的标签。

org_id

标识组织的唯一十六进制数字字符串。

node_type

节点类型。

可能的值为 ELECTABLE、READ_ONLY 和 ANALYTICS。

有关详细信息,请参阅节点类型。

process_port

进程运行的端口。

provider

预配节点的云提供商。

可能的值为 AWS、GCP 和 AZURE。

region

节点所在的云区域。

有关可能的region 值的完整列表,请参阅Amazon Web Services 、 GCP或Azure参考页面。

rs_nm

用于标识副本集的人类可读标签。

rs_state

表示副本集状态的数字。

mongodb_info 是一个始终具有 1 值的仪表盘。该指标包含所有 MongoDB 指标标签以及以下标签:

标签
说明

mongodb_version

表示主要版本、次要版本和补丁的字符串。

replica_state_name

字符串,用于表示副本集成员状态。

process_type

指示正在运行的进程的字符串。其值可以是 mongod、mongos 或 config。

注意

您还可以在Prometheus表达式浏览器中查看每个硬件指标的描述。

名称
类型
说明

hardware_disk_metrics_disk_space_free_bytes

仪表盘

已挂载文件系统中的可用磁盘空间。

hardware_disk_metrics_disk_space_used_bytes

仪表盘

挂载的文件系统中使用的磁盘空间。

hardware_disk_metrics_read_count

计数器

已处理的读取 I/O 数量。

hardware_disk_metrics_read_time_milliseconds

计数器

读取请求的总等待时间。

hardware_disk_metrics_sectors_read

计数器

读取的扇区数。

hardware_disk_metrics_sectors_written

计数器

写入扇区数。

hardware_disk_metrics_total_time_milliseconds

计数器

此区块设备处于活动状态的总时间。

hardware_disk_metrics_weighted_time_io_milliseconds

计数器

用于 I/O 的加权时间。

hardware_disk_metrics_write_count

计数器

已处理的写 I/O 数量。

hardware_disk_metrics_write_time_milliseconds

计数器

写入请求的总等待时间。

hardware_platform_num_logical_cpus

仪表盘

当前进程可用的逻辑 CPU 数。

hardware_process_cpu_children_kernel_milliseconds

计数器

在内核模式下为此进程安排的等待子级的时间量。

hardware_process_cpu_children_user_milliseconds

计数器

在用户模式下为此进程安排的等待子级的时间量。

hardware_process_cpu_kernel_milliseconds

计数器

在内核模式下为此进程安排的时间量。

hardware_process_cpu_user_milliseconds

计数器

在使用模式下为此进程安排的时间量。

hardware_system_cpu_guest_milliseconds

计数器

在 Linux 内核的控制下为客户机操作系统运行虚拟 CPU 所花费的时间。

hardware_system_cpu_guest_nice_milliseconds

计数器

调整优先级后运行客户机所花费的时间。

hardware_system_cpu_idle_milliseconds

计数器

在空闲任务中花费的时间。

hardware_system_cpu_io_wait_milliseconds

计数器

等待 I/O 完成的时间。

hardware_system_cpu_irq_milliseconds

计数器

服务中断花费的时间。

hardware_system_cpu_kernel_milliseconds

计数器

在系统模式下花费的时间。

hardware_system_cpu_nice_milliseconds

计数器

在低优先级用户模式 (nice) 下所用的时间。

hardware_system_cpu_soft_irq_milliseconds

计数器

修复 softirqs 所用的时间。

hardware_system_cpu_steal_milliseconds

计数器

在虚拟环境中运行时在其他操作系统中花费的时间。

hardware_system_cpu_user_milliseconds

计数器

在用户模式下花费的时间。

hardware_system_memory_buffers_kilobytes

仪表盘

原始磁盘区块的临时存储,不应变得非常大。

hardware_system_memory_cached_kilobytes

仪表盘

从磁盘读取文件的内存缓存。其中不包括 SwapCached。

hardware_system_memory_mem_available_kilobytes

仪表盘

在不进行交换的情况下,估计有多少内存可用于启动新应用程序。

hardware_system_memory_mem_free_kilobytes

仪表盘

LowFree + HighFree 之和。

hardware_system_memory_mem_total_kilobytes

仪表盘

总可用 RAM(物理 RAM 减去几个保留位和内核二进制代码)。

hardware_system_memory_shared_mem_kilobytes

仪表盘

内容驻留在虚拟内存中的文件系统消耗的内存量。

hardware_system_memory_swap_free_kilobytes

仪表盘

未使用交换空间总量。

hardware_system_memory_swap_total_kilobytes

仪表盘

可用的交换空间总量。

hardware_system_network_eth0_bytes_in_bytes

计数器

接口接收的数据字节数。

hardware_system_network_eth0_bytes_out_bytes

计数器

接口传输的数据字节数。

hardware_system_network_lo_bytes_in_bytes

计数器

接口接收的数据字节数。

hardware_system_network_lo_bytes_out_bytes

计数器

接口传输的数据字节数。

hardware_system_vm_page_swap_in

计数器

系统已交换到磁盘的页面数量。

hardware_system_vm_page_swap_out

计数器

系统已交换到磁盘的页面数量。

每个硬件指标都包含以下标签:

注意

除了下面列出的标签外,Atlas 还会将用户定义的资源标签作为标签添加到 Prometheus 中。这是一项可选功能,您可以通过 UI 或 API 启用。请参阅本文档中的“过程”部分,详细了解各个步骤。

标签
说明

availability_zone

AWS 可用性分区 ID、Google Cloud 分区的完全限定名称或 Azure 分区编号。

Azure 仅在部分区域支持可用区。Atlas 仅为支持可用区的区域提供 Azure 的预定义可用区标签。要了解更多信息,请参阅 Microsoft Azure。

有关每个云提供商可能的 availabilityZone 值的更多信息,请参阅Amazon Web Services、GCP或Azure文档。

cl_name

唯一标识集群的标签。

disk_name

标识磁盘的人类可读标签。

group_id

标识项目的唯一十六进制数字字符串。

group_name

唯一标识项目的标签。

org_id

标识组织的唯一十六进制数字字符串。

node_type

节点类型。

可能的值为 ELECTABLE、READ_ONLY 和 ANALYTICS。

有关详细信息,请参阅节点类型。

process_port

进程运行的端口。

provider

预配节点的云提供商。

可能的值为 AWS、GCP 和 AZURE。

region

节点所在的云区域。

有关可能的region 值的完整列表,请参阅Amazon Web Services 、 GCP或Azure参考页面。

replica_set_name

唯一标识副本集的标签。