prometheus二次开发之HTTP api（一）

其他 2020-03-05 10:39:21 阅读次数: 0

Prometheus在/api/v1的路径下开放了HTTP接口，用户可以通过这些接口进行二次开发。这篇笔记挑选了此次监控平台可能会用到的接口进行解析。

1、请求&响应格式

1.JSON响应格式

以JSON格式进行响应。
若API请求成功 返回一个2xx的状态码。
若请求失败，分情况返回以下状态码：

  • 400 Bad Request 参数丢失或不正确；
  • 422 Unprocessable Entity无法执行表达式时；
  • 503 Service Unavailable 查询超时或中止时。

响应JSON内容如下：

{
  "status": "success" | "error",
  "data": <data>,

  // Only set if status is "error". The data field may still hold
  // additional data.
  "errorType": "<string>",
  "error": "<string>",

  // Only if there were warnings while executing the request.
  // There will still be data in the data field.
  "warnings": ["<string>"]
}

2.时间戳格式

输出中的时间戳为以秒为单位的Unix时间戳，故若请求中有时间戳，推荐使用以秒为单位的Unix时间戳。

3.其他格式

可以重复查询的参数名称应用[]为后缀。

<series_selector>占位符指Prometheus的时间序列选择器，例如http_requests_total或http_requests_total{method=~"(GET|POST)"} 并且需要进行URL编码。

占位符 指Prometheus持续时间字符串。[0-9]+[smhdwy]。例如,5m指持续时间为5分钟。

占位符指布尔值（字符串true和false）。

2、表达式查询

用户可以通过接口使用promQL查询瞬时或某一个时间段的值，

1.瞬时查询

url地址：

GET /api/v1/query
POST /api/v1/query

URL查询参数：

扫描二维码关注公众号，回复： 9592020 查看本文章
  • query= *Prometheus表达式查询字符串，必选。
  • time=<rfc3339 | unix_timestamp> *查询的时间戳，可选。
  • timeout=*超时时间，可选。默认为启动参数-query.timeout标志的值，并由该标志的值限制。

注：
如果time参数未填写，则使用当前服务器时间。
使用POST方法和 Content-Type: application/x-www-form-urlencoded标头直接在请求正文中对这些参数进行URL编码。

返回结果格式：

{
  "resultType": "matrix" | "vector" | "scalar" | "string",
  "result": <value>
}

示例1： 查询Prometheus自带metric

$ curl 'http://localhost:9090/api/v1/query?query=up
{
   "status" : "success",
   "data" : {
      "resultType" : "vector",
      "result" : [
         {
            "metric" : {
               "__name__" : "up",
               "job" : "prometheus",
               "instance" : "localhost:9090"
            },
            "value": [ 1435781451.781, "1" ]
         },
         {
            "metric" : {
               "__name__" : "up",
               "job" : "node",
               "instance" : "localhost:9100"
            },
            "value" : [ 1435781451.781, "0" ]
         }
      ]
   }
}

示例2： 使用promQL查询

$ curl 'http://localhost:9090/api/v1/query?query=sum(time() - node_boot_time_seconds)

{
   "status": "success",
   "data":    {
      "resultType": "vector",
      "result": [      {
         "metric": {},
         "value":          [
            1.581498526305E9,
            "6767484.305000067"
         ]
      }]
   }
}

2.范围查询

ur地址：

GET /api/v1/query_range
POST /api/v1/query_range

URL查询参数：

  • query=*Prometheus表达式查询字符串，必选。
  • start=<rfc3339 | unix_timestamp>*开始时间戳，必选。
  • end=<rfc3339 | unix_timestamp>*结束时间戳，必选。
  • step=<duration | float>*以持续时间格式或秒数查询步长。
  • timeout=*超时时间，可选。默认为启动参数-query.timeout标志的值，并由该标志的值限制

返回结果可能有以下字段：

{
  "resultType": "matrix",
  "result": <value>
}

示例1：

$ curl 'http://localhost:9090/api/v1/query_range?query=up&start=2015-07-01T20:10:30.781Z&end=2015-07-01T20:11:00.781Z&step=15s'
{
   "status" : "success",
   "data" : {
      "resultType" : "matrix",
      "result" : [
         {
            "metric" : {
               "__name__" : "up",
               "job" : "prometheus",
               "instance" : "localhost:9090"
            },
            "values" : [
               [ 1435781430.781, "1" ],
               [ 1435781445.781, "1" ],
               [ 1435781460.781, "1" ]
            ]
         },
         {
            "metric" : {
               "__name__" : "up",
               "job" : "node",
               "instance" : "localhost:9091"
            },
            "values" : [
               [ 1435781430.781, "0" ],
               [ 1435781445.781, "0" ],
               [ 1435781460.781, "1" ]
            ]
         }
      ]
   }
}

3、统计Prometheus全局配置

查询Prometheus所监控的目标端、rules等，主要用作全局配置

1. 查询target

返回Prometheus所监控的目标端的当前状态的概述。

URL地址：

GET /api/v1/targets

默认会返回所有的端点，包括当前检测端点和已经删除的端点。
其中

  • labels 表示通过Prometheus配置文件重新贴标签后的标签集；
  • discoveredLabels 表示重新标记前的未修改标签。
    例如：
$ curl http://localhost:9090/api/v1/targets
{
  "status": "success",
  "data": {
    "activeTargets": [
      {
        "discoveredLabels": {
          "__address__": "127.0.0.1:9090",
          "__metrics_path__": "/metrics",
          "__scheme__": "http",
          "job": "prometheus"
        },
        "labels": {
          "instance": "127.0.0.1:9090",
          "job": "prometheus"
        },
        "scrapePool": "prometheus",
        "scrapeUrl": "http://127.0.0.1:9090/metrics",
        "lastError": "",
        "lastScrape": "2017-01-17T15:07:44.723715405+01:00",
        "lastScrapeDuration": 0.050688943,
        "health": "up"
      }
    ],
    "droppedTargets": [
      {
        "discoveredLabels": {
          "__address__": "127.0.0.1:9100",
          "__metrics_path__": "/metrics",
          "__scheme__": "http",
          "job": "node"
        }
      }
    ]
  }
}

可以看到Prometheus将监控的target节点以json的格式返回，我们可以通过处理Json数据来统计当前处于各种状态的主机数量。

prometheuse还提供了state查询参数，用来过滤target
state可以选填 state=active，state=dropped，state=any

例如：

$ curl 'http://localhost:9090/api/v1/targets?state=active'
{
  "status": "success",
  "data": {
    "activeTargets": [
      {
        "discoveredLabels": {
          "__address__": "127.0.0.1:9090",
          "__metrics_path__": "/metrics",
          "__scheme__": "http",
          "job": "prometheus"
        },
        "labels": {
          "instance": "127.0.0.1:9090",
          "job": "prometheus"
        },
        "scrapePool": "prometheus",
        "scrapeUrl": "http://127.0.0.1:9090/metrics",
        "lastError": "",
        "lastScrape": "2017-01-17T15:07:44.723715405+01:00",
        "lastScrapeDuration": 50688943,
        "health": "up"
      }
    ],
    "droppedTargets": []
  }
}

2. 查询规则

该接口返回告警并记录当前配置生效的规则列表，此外，还返回当前活动的告警实例；

URL地址：

GET /api/v1/rules

URL查询参数 - type=alert|record： ：仅返回警报规则（例如type=alert）或记录规则（例如type=record）。如果该参数不存在或为空，则不执行任何过滤。

$ curl http://localhost:9090/api/v1/rules

{
    "data": {
        "groups": [
            {
                "rules": [
                    {
                        "alerts": [
                            {
                                "activeAt": "2018-07-04T20:27:12.60602144+02:00",
                                "annotations": {
                                    "summary": "High request latency"
                                },
                                "labels": {
                                    "alertname": "HighRequestLatency",
                                    "severity": "page"
                                },
                                "state": "firing",
                                "value": "1e+00"
                            }
                        ],
                        "annotations": {
                            "summary": "High request latency"
                        },
                        "duration": 600,
                        "health": "ok",
                        "labels": {
                            "severity": "page"
                        },
                        "name": "HighRequestLatency",
                        "query": "job:request_latency_seconds:mean5m{job=\"myjob\"} > 0.5",
                        "type": "alerting"
                    },
                    {
                        "health": "ok",
                        "name": "job:http_inprogress_requests:sum",
                        "query": "sum(http_inprogress_requests) by (job)",
                        "type": "recording"
                    }
                ],
                "file": "/rules.yaml",
                "interval": 60,
                "name": "example"
            }
        ]
    },
    "status": "success"
}

可以看到这个接口会返回告警信息，所以这个接口也可以用来获取当前告警。

3. 查询告警

该/alerts路径返回所有活动警报的列表。
URL地址：

GET /api/v1/alerts

$ curl http://localhost:9090/api/v1/alerts

{
    "data": {
        "alerts": [
            {
                "activeAt": "2018-07-04T20:27:12.60602144+02:00",
                "annotations": {},
                "labels": {
                    "alertname": "my-alert"
                },
                "state": "firing",
                "value": "1e+00"
            }
        ]
    },
    "status": "success"
}

此处返回告警信息，需要注意的是返回信息中的标签字段返回的是rules中配置的标签值，如果要根据对metrics的标签进行告警的区分还需要通过其他手段来获取。

宫凯宁
发布了48 篇原创文章 · 获赞 31 · 访问量 4万+
私信 关注

猜你喜欢

转载自blog.csdn.net/weixin_44723434/article/details/104282636
今日推荐
《美国对全球网络空间安全与发展的威胁和破坏》报告发布
火速冲上 GitHub 热榜 —— 开源编程语言、框架哪有这么可爱？
北京人形机器人创新中心发布全球首个纯电驱拟人奔跑的全尺寸人形机器人“天工”
LFOSSA 源来如此公开课 | 掌握云原生未来：CNCF 认证全面攻略与备考秘籍
国产云输入法——仅华为无云端数据上传安全问题
开源日报 | 工业开源项目OGG 1.0；姐姐，你要和我一起配置火狐吗；苹果AI遥遥落后？Fedora 40
周排行
购置笔记本常识
从源码看Spring Security之采坑笔记（Spring Boot篇）
大数据学习——高可用配置案例
如何避免选择不专业的建站公司?
Euclid's Game HDU - 1525（博弈）
面试笔记（六）---Js实现eventHandler
Windows 实例搭建的 FTP 在外网无法连接和访问
设计模式 : 桥接模式
USB 设备驱动开发之几个重要结构体分析
14-p14_sqrt求平方根
每日归档
更多
2024-04-29(40)
2024-04-28(0)
2024-04-27(56)
2024-04-26(39)
2024-04-25(22)
2024-04-24(36)
2024-04-23(26)
2024-04-22(39)
2024-04-21(0)
2024-04-20(6)

代码天地 © 2018 codetd.com

境外服务器   最新电视剧2022