菜单
文档面包屑箭头 Grafana Alloy面包屑箭头 参考面包屑箭头 组件面包屑箭头 prometheus面包屑箭头 prometheus.exporter.windows
开源

prometheus.exporter.windows

prometheus.exporter.windows 组件内嵌了 windows_exporter,它向基于Windows的系统公开了各种各样的硬件和操作系统指标。

windows_exporter 本身包含各种收集器,您可以根据需要启用或禁用它们。有关收集器的更多信息,请参阅collectors-list部分。

注意

黑白名单配置选项提供了向后兼容性,但已弃用。建议未来使用包含和排除配置选项。

用法

alloy
prometheus.exporter.windows "LABEL" {
}

参数

以下参数可用于配置导出器的行为。所有参数都是可选的。省略的字段将采用其默认值。

名称类型描述默认值必需
enabled_collectors列表(string)要启用的收集器列表。["cpu","cs","logical_disk","net","os","service","system"]
timeoutduration配置收集指标的超时。4m

enabled_collectors 定义了一组默认启用的收集器列表。如果设置,则该列表之外的任何内容默认禁用。有关默认集的信息,请参阅收集器列表

prometheus.exporter.windows 的定义中,支持以下块来配置收集器特定的选项。

层次结构名称描述必需
dfsrdfsr配置 dfsr 收集器。
exchangeexchange配置 exchange 收集器。
iisiis配置 iis 收集器。
logical_disklogical_disk配置 logical_disk 收集器。
msmqmsmq配置 msmq 收集器。
mssqlmssql配置 mssql 收集器。
networknetwork配置 network 收集器。
processprocess配置 process 收集器。
scheduled_taskscheduled_task配置 scheduled_task 收集器。
serviceservice配置 service 收集器。
smtpsmtp配置 smtp 收集器。
text_filetext_file配置 text_file 收集器。

dfsr 块

名称类型描述默认值必需
source_enabled列表(string)逗号分隔的 DFSR Perflib 源列表。["connection","folder","volume"]

exchange 块

名称类型描述默认值必需
enabled_liststring逗号分隔的收集器列表。""

enabled_list 中指定的收集器可以包括以下内容

  • ADAccessProcesses
  • TransportQueues
  • HttpProxy
  • ActiveSync
  • AvailabilityService
  • OutlookWebAccess
  • Autodiscover
  • WorkloadManagement
  • RpcClientAccess

例如,enabled_list 可设置为 "AvailabilityService,OutlookWebAccess"

iis 块

名称类型描述默认值必需
app_excludestring要忽略的应用的正则表达式。""
app_includestring要报告的应用的正则表达式。".*"
site_excludestring要忽略的网站的正则表达式。""
site_includestring要报告的网站的正则表达式。".*"

逻辑磁盘块

名称类型描述默认值必需
排除string要排除的卷的正则表达式。""
包含string要包含的卷的正则表达式。".+"

卷名称必须与由 include 指定的正则表达式匹配,并且不能与由 exclude 指定的正则表达式匹配才能被包含。

msmq 块

名称类型描述默认值必需
where_clausestring用于 WMI 指标查询的 WQL “where” 子句。""

指定 enabled_classes 可以用来限制响应仅限于指定的 MSMQ,从而减小响应大小。

mssql 块

名称类型描述默认值必需
enabled_classes列表(string)逗号分隔的 MSSQL WMI 类列表,用于。["accessmethods", "availreplica", "bufman", "databases", "dbreplica", "genstats", "locks", "memmgr", "sqlstats", "sqlerrors", "transactions"]

网络块

名称类型描述默认值必需
排除string要排除的 NIC: 的正则表达式。""
包含string要包含的 NIC: 的正则表达式。".*"

NIC 名称必须与由 include 指定的正则表达式匹配,并且不能与由 exclude 指定的正则表达式匹配才能被包含。

进程块

名称类型描述默认值必需
排除string要排除的进程的正则表达式。""
包含string要包含的进程的正则表达式。".*"

进程必须与由 include 指定的正则表达式匹配,并且不能与由 exclude 指定的正则表达式匹配才能被包含。

计划任务块

名称类型描述默认值必需
排除string要排除的任务的正则表达式。""
包含string要包含的任务的正则表达式。".+"

对于要包含的服务器名称,它必须与由 include 指定的正则表达式匹配,并且不能与由 exclude 指定的正则表达式匹配。

服务块

名称类型描述默认值必需
use_apistring使用 API 调用来收集服务数据而不是 WMI。false
where_clausestring用于 WMI 指标查询的 WQL “where” 子句。""

可以使用 where_clause 参数来限制响应仅限于指定的服务,以减小响应大小。如果启用 use_api,则“where_clause”将不会生效。

smtp 块

名称类型描述默认值必需
排除string要忽略的虚拟服务器的正则表达式。
包含string要包含的虚拟服务器的正则表达式。".+"

对于要包含的服务器名称,它必须与由 include 指定的正则表达式匹配,并且不能与由 exclude 指定的正则表达式匹配。

文本文件块

名称类型描述默认值必需
text_file_directorystring包含要导入文件的目录。C:\Program Files\GrafanaLabs\Alloy\textfile_inputs

当设置 text_file_directory 时,仅读取指定目录内扩展名为 .prom 的文件。每个找到的 .prom 文件必须以空行结尾才能正常工作。

导出字段

以下字段被导出,可以被其他组件引用。

名称类型描述
targetslist(map(string))可以用来收集导出器度量值的targets。

例如,targets 可以传递给一个 discovery.relabel 组件来重写 targets 的标签集,或者传递给一个收集暴露度量的 prometheus.scrape 组件。

导出的 targets 使用由 运行命令 指定的配置的 内存流量 地址。

组件健康

prometheus.exporter.windows 只有在给定无效配置时才报告为不健康。在这种情况下,导出的字段保留其最后健康值。

调试信息

prometheus.exporter.windows 不公开任何与组件特定的调试信息。

调试指标

prometheus.exporter.windows 不公开任何与组件特定的调试指标。

收集器列表

以下表格列出了 windows_exporter捆绑提供的可用收集器。某些收集器只能用于特定的操作系统;在运行 Alloy 的宿主操作系统上启用不受支持的收集器是无效的。

用户可以选择启用收集器的一个子集,以限制由 prometheus.exporter.windows 组件暴露的度量值数量,或者禁用运行成本较高的收集器。

名称描述默认启用
ad活动目录域服务
adcs活动目录证书服务
adfs活动目录联合服务
cache缓存度量指标
cpuCPU 使用率
cpu_infoCPU 信息
cs“计算机系统”度量指标(系统属性,CPU数量/总内存)
container容器度量指标
dfsrDFSR 度量指标
dhcpDHCP 服务器
dnsDNS 服务器
exchangeExchange 度量指标
fsrmquota微软文件服务器资源管理器 (FSRM) 配额收集器
hypervHyper-V 主机
iisIIS 站点和应用程序
logical_disk逻辑磁盘,磁盘 I/O
logon用户登录会话
memory内存使用度量指标
mscluster_clusterMSCluster 集群度量指标
mscluster_networkMSCluster 网络度量指标
mscluster_nodeMSCluster 节点度量指标
mscluster_resourceMSCluster 资源度量指标
mscluster_resourcegroupMSCluster 资源组度量指标
msmqMSMQ 队列
mssqlSQL Server 性能对象 度量指标
netframework_clrexceptions.NET 框架 CLR 异常
netframework_clrinterop.NET 框架 Interop 度量指标
netframework_clrjit.NET 框架 JIT 度量指标
netframework_clrloading.NET 框架 CLR 加载度量指标
netframework_clrlocksandthreads.NET 框架 锁和线程度量指标
netframework_clrmemory.NET 框架 内存度量指标
netframework_clrremoting.NET 框架 远程度量指标
netframework_clrsecurity.NET 框架 安全检查度量指标
net网络接口 I/O
os操作系统度量指标(内存、进程、用户)
physical_disk物理磁盘
process进程度量指标
remote_fx远程FX协议(RDP)度量指标
scheduled_task计划任务度量指标
serviceService state metrics
smtpIIS SMTP 服务器
system系统调用
tcpTCP 连接
teradici_pcoipTeradici PCoIP 会话度量指标
timeWindows 时间服务
thermalzone热信息
terminal_services终端服务(RDS)
textfile从文本文件读取 Prometheus 度量指标
vmware_blastVMware Blast 会话度量指标
vmware由 VMware guest agent 安装的性能计数器

有关报告的度量指标、配置设置和使用示例的更多信息,请参阅每个收集器的链接文档。

注意

某些收集器会导致 Aluminum 崩溃,如果使用这些收集器并且未安装所需的工具。这些包括但不限于 mscluster_*、vmware、nps、dns、msmq、teradici_pcoip、ad、hyperv 和 scheduled_task。

示例

此示例使用一个 prometheus.scrape 组件prometheus.exporter.windows 收集度量指标

alloy
prometheus.exporter.windows "default" { }

// Configure a prometheus.scrape component to collect windows metrics.
prometheus.scrape "example" {
  targets    = prometheus.exporter.windows.default.targets
  forward_to = [prometheus.remote_write.demo.receiver]
}

prometheus.remote_write "demo" {
  endpoint {
    url = PROMETHEUS_REMOTE_WRITE_URL

    basic_auth {
      username = USERNAME
      password = PASSWORD
    }
  }
}

替换以下内容

  • PROMETHEUS_REMOTE_WRITE_URL:要发送度量指标到的 Prometheus remote_write 兼容服务器的 URL。
  • USERNAME:用于身份验证远程_write API 的用户名。
  • PASSWORD:用于身份验证远程_write API 的密码。

兼容组件

prometheus.exporter.windows 有以下可以由以下组件使用的导出

注意

连接某些组件可能不合理,或者组件可能需要进一步配置才能正确连接。有关详细信息,请参阅链接文档。