【Blackbox Exporter】prober.Handler源码详细分析

	http.HandleFunc(path.Join(*routePrefix, "/probe"), func(w http.ResponseWriter, r *http.Request) {
		sc.Lock()
		conf := sc.C
		sc.Unlock()
		prober.Handler(w, r, conf, logger, rh, *timeoutOffset, nil, moduleUnknownCounter, allowedLevel)
	})

在这里插入图片描述

我们了解到blackbox_exporter中都是通过请求/probe来进行端口探测的,那么今天我们来详尽的分析prober.Handler相关源码。

目录

      • 函数签名
      • 1. 获取 URL 查询参数 `params`
      • 2. 获取探针模块名称
      • 3. 解析超时设置
      • 4. 创建上下文(Context)
      • 5. 创建 Prometheus 指标
      • 6. 获取目标(target)
      • 7. 获取探针类型和处理
      • 8. 设置 `hostname`(针对 HTTP 或 TCP 探测)
      • 9. 设置日志级别
      • 10. 开始探测
      • 11. 记录结果
      • 12. 返回调试输出(如果启用)
      • 13. 返回 Prometheus 格式的指标
      • 总结

函数签名

func Handler(w http.ResponseWriter, r *http.Request, c *config.Config, logger *slog.Logger, rh *ResultHistory, timeoutOffset float64, params url.Values, moduleUnknownCounter prometheus.Counter, logLevelProber *promslog.AllowedLevel)
  • w http.ResponseWriter:HTTP 响应对象,用于向客户端发送响应。
  • r *http.Request:HTTP 请求对象,包含请求信息。
  • c *config.Config:包含配置的对象,包含了可用的探针模块等配置。
  • logger *slog.Logger:日志记录器,用于输出日志。
  • rh *ResultHistory:用于记录结果历史的对象。
  • timeoutOffset float64:超时偏移量,可能用于调整默认的超时设置。
  • params url.Values:URL 查询参数,通常包含了目标和其他探测信息。
  • moduleUnknownCounter prometheus.Counter:Prometheus 计数器,用于统计未知模块的次数。
  • logLevelProber *promslog.AllowedLevel:日志级别,控制探测日志的详细程度。

1. 获取 URL 查询参数 params

if params == nil {
    params = r.URL.Query()
}
  • 如果 params 参数为空(即传入的 URL 查询参数为空),则使用 HTTP 请求的查询参数 r.URL.Query()

2. 获取探针模块名称

moduleName := params.Get("module")
if moduleName == "" {
    moduleName = "http_2xx"
}
module, ok := c.Modules[moduleName]
if !ok {
    http.Error(w, fmt.Sprintf("Unknown module %q", moduleName), http.StatusBadRequest)
    logger.Debug("Unknown module", "module", moduleName)
    if moduleUnknownCounter != nil {
        moduleUnknownCounter.Add(1)
    }
    return
}
  • 获取 URL 查询参数中的 module 参数。如果没有传递 module 参数,默认设置为 http_2xx
  • 通过 moduleName 从配置 c.Modules 中获取对应的模块配置。如果模块不存在,返回 HTTP 错误 400 BadRequest

3. 解析超时设置

timeoutSeconds, err := getTimeout(r, module, timeoutOffset)
if err != nil {
    http.Error(w, fmt.Sprintf("Failed to parse timeout from Prometheus header: %s", err), http.StatusInternalServerError)
    return
}
  • 调用 getTimeout 函数从请求头或模块配置中解析超时设置,超时偏移量会影响最终的超时值。
  • 如果解析超时出错,则返回 500 InternalServerError

4. 创建上下文(Context)

ctx, cancel := context.WithTimeout(r.Context(), time.Duration(timeoutSeconds*float64(time.Second)))
defer cancel()
r = r.WithContext(ctx)
  • 使用 context.WithTimeout 创建一个带有超时设置的上下文 ctx,并将其与请求 r 关联。超时会在 timeoutSeconds 秒后触发。

5. 创建 Prometheus 指标

probeSuccessGauge := prometheus.NewGauge(prometheus.GaugeOpts{
    Name: "probe_success",
    Help: "Displays whether or not the probe was a success",
})
probeDurationGauge := prometheus.NewGauge(prometheus.GaugeOpts{
    Name: "probe_duration_seconds",
    Help: "Returns how long the probe took to complete in seconds",
})
  • 创建两个 Prometheus Gauge 类型的指标:
    • probe_success: 表示探测是否成功(1:成功,0:失败)。
    • probe_duration_seconds: 表示探测完成的时长(单位:秒)。

6. 获取目标(target)

target := params.Get("target")
if target == "" {
    http.Error(w, "Target parameter is missing", http.StatusBadRequest)
    return
}
  • 获取 URL 查询参数中的 target 参数,表示需要探测的目标地址。如果没有提供目标地址,则返回 400 BadRequest 错误。

7. 获取探针类型和处理

prober, ok := Probers[module.Prober]
if !ok {
    http.Error(w, fmt.Sprintf("Unknown prober %q", module.Prober), http.StatusBadRequest)
    return
}
  • 根据 module.Prober 获取对应的探针。如果探针类型不存在,则返回 400 BadRequest 错误。

8. 设置 hostname(针对 HTTP 或 TCP 探测)

hostname := params.Get("hostname")
if module.Prober == "http" && hostname != "" {
    err = setHTTPHost(hostname, &module)
    if err != nil {
        http.Error(w, err.Error(), http.StatusBadRequest)
        return
    }
}

if module.Prober == "tcp" && hostname != "" {
    if module.TCP.TLSConfig.ServerName == "" {
        module.TCP.TLSConfig.ServerName = hostname
    }
}
  • 如果是 http 探针并且 hostname 不为空,则调用 setHTTPHost 设置 HTTP 请求的 Host 头。
  • 如果是 tcp 探针并且 hostname 不为空,则设置 TLS 配置中的 ServerName

9. 设置日志级别

if logLevelProber == nil {
    logLevelProber = &promslog.AllowedLevel{}
}
if logLevelProber.String() == "" {
    _ = logLevelProber.Set("info")
}
sl := newScrapeLogger(logger, moduleName, target, logLevelProber)
slLogger := slog.New(sl)
  • 如果没有提供 logLevelProber,则使用默认的日志级别 “info”。
  • 创建一个新的日志记录器 slLogger,用于记录探测过程中的信息。

10. 开始探测

slLogger.Info("Beginning probe", "probe", module.Prober, "timeout_seconds", timeoutSeconds)

start := time.Now()
registry := prometheus.NewRegistry()
registry.MustRegister(probeSuccessGauge)
registry.MustRegister(probeDurationGauge)
success := prober(ctx, target, module, registry, slLogger)
duration := time.Since(start).Seconds()
probeDurationGauge.Set(duration)
if success {
    probeSuccessGauge.Set(1)
    slLogger.Info("Probe succeeded", "duration_seconds", duration)
} else {
    slLogger.Error("Probe failed", "duration_seconds", duration)
}
  • 记录日志开始探测。
  • 使用 prober(即相应的探针函数)开始实际的探测操作,并记录探测的持续时间。
  • 根据探测结果,设置 probe_successprobe_duration_seconds 指标。

11. 记录结果

debugOutput := DebugOutput(&module, &sl.buffer, registry)
rh.Add(moduleName, target, debugOutput, success)
  • 调用 DebugOutput 函数生成调试输出,并将结果添加到 ResultHistory(用于记录历史结果)。

12. 返回调试输出(如果启用)

if r.URL.Query().Get("debug") == "true" {
    w.Header().Set("Content-Type", "text/plain")
    w.Write([]byte(debugOutput))
    return
}
  • 如果查询参数 debug=true,则返回调试输出。

13. 返回 Prometheus 格式的指标

h := promhttp.HandlerFor(registry, promhttp.HandlerOpts{})
h.ServeHTTP(w, r)
  • 创建 Prometheus 格式的 HTTP 处理程序,并返回探测结果的指标数据。

总结

它通过解析请求参数来执行指定类型的探测(如 HTTP、TCP 探测),并生成相应的 Prometheus 指标。返回的指标可以被 Prometheus 服务器抓取并进行监控。此外,代码还处理了探测过程中的日志记录和调试输出。
prober(ctx, target, module, registry, slLogger)是整个执行探测的核心部分,下一篇将重点分析此函数

本文来自互联网用户投稿,该文观点仅代表作者本人,不代表本站立场。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如若转载,请注明出处:/a/947263.html

如若内容造成侵权/违法违规/事实不符,请联系我们进行投诉反馈qq邮箱809451989@qq.com,一经查实,立即删除!

相关文章

SpringMVC核心、两种视图解析方法、过滤器拦截器 “ / “ 的意义

SpringMVC的执行流程 1. Spring MVC 的视图解析机制 Spring MVC 的核心职责之一是将数据绑定到视图并呈现给用户。它通过 视图解析器(View Resolver) 来将逻辑视图名称解析为具体的视图文件(如 HTML、JSP)。 核心流程 Controlle…

基于动力学的MPC控制器设计盲点解析

文章目录 Apollo MPC控制器的设计架构误差模型和离散化预测模型推导目标函数和约束设计优化求解优化OSQP求解器参考文献 Apollo MPC控制器的设计架构 误差模型和离散化 状态变量和控制变量 1、Apollo MPC控制器中状态变量主要有如下6个 matrix_state_ Matrix::Zero(basic_stat…

DC-DC 降压转换器设计提示和技巧

基本 DC-DC 降压转换器电路 在开始之前,我们先回顾一下DC-DC降压转换器的电路: 为了帮助您,我开发了降压设计中“什么影响什么”的矩阵: 主要的权衡是电感(与 k 因子成反比,即峰峰值与平均电感电流之比&a…

Unity3D仿星露谷物语开发9之创建农场Scene

1、目标 绘制农场的场景。通过不同Sorting Layer控制物体的显示优先级,绘制Tilemap地图,添加Tilemap Collider碰撞器,同时添加Composite Collider碰撞器优化性能。 ps:绘制Tilemap的技巧:通过"Shift [" 可…

Linux 定时任务:轻松创建与精准执行

Linux 定时任务:轻松创建与精准执行 在 Linux 系统的运维与自动化管理领域,定时任务扮演着举足轻重的角色。它能够让系统在预设的时间点或周期性时段,自动执行特定的脚本、命令,极大地减轻了管理员的工作负担,提升工作…

Linux驱动开发:深入理解I2C时序(二)

在Linux驱动开发中,I2C时序的理解和正确处理是保证I2C设备正常工作和通信的关键。I2C协议的时序特性决定了数据的有效传输和设备间的协作。因此,掌握I2C的时序细节,以及如何在Linux内核中进行时序处理,能够让开发者更好地处理设备通信问题。 本文将继续深入探讨I2C通信协议…

国产编辑器EverEdit - 常用资源汇总

1 国产编辑器EverEdit-常用资源汇总 EverEdit是一款国产文本编辑器,历经超过15年的更新和维护,拥有不输业界顶级商业文本编辑器(EmEditor、UltraEdit)的实力,甚至在某些方面的功能更强(当然,各有千秋),开发者对文本编辑…

解决uniapp H5页面限制输入框只能输数字问题

工作记录 最最近在做 uniapp 开发的移动端 H5 页面,有个需求是金额输入框只能输入数字,不能输入小数点和其他字符,经过各种尝试,发现其他字符可以通过正则过滤掉,但是输入小数点的话,因为没有触发 input 和…

面试准备备备备

职业技能 放到简历的黄金位置(HR刷选简历的重要参考) 基本准则:写在简历上的必须能聊,不然就别写 参考公式:职业技能 必要技术 其他技术 针对性的引导面试官(让他问一些你想让他问的) 寻找合…

npm install --global windows-build-tools --save 失败

注意以下点 为啥下载windows-build-tools,是因为node-sass4.14.1 一直下载不成功,提示python2 没有安装,最终要安装这个,但是安装这个又失败,主要有以下几个要注意的 1、node 版本 14.21.3 不能太高 2、管理员运行 …

Jenkins 中自动化部署 Spring Boot 项目

👨🏻‍💻 热爱摄影的程序员 👨🏻‍🎨 喜欢编码的设计师 🧕🏻 擅长设计的剪辑师 🧑🏻‍🏫 一位高冷无情的全栈工程师 欢迎分享 / 收藏 / 赞 / 在看…

【DSP/matlab】fftshift 是什么意思?在信号处理中有什么作用?

文章目录 前言一、定义什么是 fftshift?fftshift 在信号处理中的作用: 前言 dsp_paper 一、定义 fftshift 是一个在信号处理和数字信号处理中常用的函数,特别是在使用快速傅里叶变换(FFT)时。这个函数的主要作用是将…

【PCIe 总线及设备入门学习专栏 4.2 -- PCI 总线的三种传输模式 】

文章目录 OverviewProgrammed I/O(PIO)Direct Memory Access (DMA)Peer-to-Peer 本文转自:https://blog.chinaaet.com/justlxy/p/5100053095 Overview 本文来简单地介绍一下PCI Spec规定的三种数据传输模型:Programmed I/O&…

SpringBoot_第二天

SpringBoot_第二天 学习目标 Mybatis整合&数据访问 使用SpringBoot开发企业项目时,持久层数据访问是前端页面数据展示的基础,SpringBoot支持市面上常见的关系库产品(Oracle,Mysql,SqlServer,DB2等)对应的相关持久层框架,当然除了对于关系…

分类模型评估利器-混淆矩阵

相关文章 地理时空动态模拟工具介绍(上) 地理时空动态模拟工具介绍(下)地理时空动态模拟工具的使用方法 前言 混淆矩阵(Confusion Matrix)是机器学习领域中用于评估分类模型性能的一种工具。它通过矩阵的…

【SpringMVC】拦截器

拦截器(Interceptor)是一种用于动态拦截方法调用的机制。在 Spring MVC 中,拦截器能够动态地拦截控制器方法的执行过程。以下是请求发送与接收的基本流程: 当浏览器发出请求时,请求首先到达 Tomcat 服务器。Tomcat 根…

el-table 实现纵向多级表头

为了实现上图效果,最开始打算用el-row、el-col去实现,但发现把表头和数据分成两大列时,数据太多时会导致所在格高度变高。但由于每一格数据肯定不一样,为保持高度样式一致,就需要我们手动去获取最高格的高度之后再设置…

[paddle] 非线性拟合问题的训练

利用paddlepaddle建立神经网络,模拟有限个数据的非线性拟合 本文仍然考虑 f ( x ) sin ⁡ ( x ) x f(x)\frac{\sin(x)}{x} f(x)xsin(x)​ 函数在区间 [-10,10] 上固定数据的拟合。 import paddle import paddle.nn as nn import numpy as np import matplotlib.…

深入理解Python中的常用数据格式(如csv、json、pickle、npz、h5等):存储机制与性能解析

在数据科学与工程领域,数据的存储与读取是日常工作中不可或缺的一部分。选择合适的数据格式不仅影响数据处理的效率,还关系到存储空间的利用与后续分析的便捷性。本文将以通俗易懂的方式,深入探讨Python中几种常用的数据读写格式(…

算法 class 005 (对数器C语言实现)

对数器的概念: 用来测试你的算法是否正确。 怎么做呢? 1:比如,写个冒泡排序,作为对比的对象 2:生成一个随机数 数组,用来测试 3:用冒泡排序和你想要验证的那个排序算法,同…