Prometheus监控学习笔记之在 HTTP API 中使用 PromQL
0x00 概述
Prometheus 当前稳定的 HTTP API 可以通过 /api/v1
访问。
0x01 API 响应格式
Prometheus API 使用了 JSON 格式的响应内容。 当 API 调用成功后将会返回 2xx
的 HTTP 状态码。
反之,当 API 调用失败时可能返回以下几种不同的 HTTP 状态码:
404 Bad Request
:当参数错误或者缺失时。422 Unprocessable Entity
: 当表达式无法执行时。503 Service Unavailable
: 当请求超时或者被中断时。
所有的 API 请求返回的格式均使用以下的 JSON 格式:
{
"status": "success" | "error",
"data": <data>, // Only set if status is "error". The data field may still hold
// additional data.
"errorType": "<string>",
"error": "<string>"
}
输入时间戳可以由 RFC3339 格式或者 Unix 时间戳提供,后面可选的小数位可以精确到亚秒级别。输出时间戳以 Unix 时间戳的方式呈现。
查询参数名称可以用中括号 []
重复次数。<series_selector>
占位符提供像 http_requests_total
或者 http_requests_total{method=~"(GET|POST)"}
的 Prometheus 时间序列选择器,并需要在 URL 中编码传输。
<duration>
占位符指的是 [0-9]+[smhdwy]
形式的 Prometheus 持续时间字符串。例如:5m 表示 5 分钟的持续时间。
<bool>
提供布尔值(字符串 true 和 false)。
0x02 表达式查询
通过 HTTP API 我们可以分别通过 /api/v1/query
和 /api/v1/query_range
查询 PromQL 表达式当前或者一定时间范围内的计算结果。
瞬时数据查询
通过使用 QUERY API
我们可以查询 PromQL 在特定时间点下的计算结果。
URL 请求参数:
query=<string>
: PromQL 表达式。time=<rfc3339 | unix_timestamp>
: 用于指定用于计算 PromQL 的时间戳。可选参数,默认情况下使用当前系统时间。timeout=<duration>
: 超时设置。可选参数,默认情况下使用全局设置的参数-query.timeout
。
如果 time
参数缺省,则使用当前服务器时间。
当 API 调用成功后,Prometheus 会返回 JSON 格式的响应内容,格式如上小节所示。并且在 data 部分返回查询结果。data 部分格式如下:
{
"resultType": "matrix" | "vector" | "scalar" | "string",
"result": <value>
}
<value>
指的是查询结果数据,具体的格式取决于 resultType
,不同的结果类型,会有不同的结果数据格式。参考 响应数据格式。
例如使用以下表达式查询表达式 up
在时间点 2015-07-01T20:10:51.781Z
的计算结果:
$ curl 'http://localhost:9090/api/v1/query?query=up&time=2015-07-01T20:10:51.781Z'
{
"status" : "success",
"data" : {
"resultType" : "vector",
"result" : [
{
"metric" : {
"__name__" : "up",
"job" : "prometheus",
"instance" : "localhost:9090"
},
"value": [ 1435781451.781, "" ]
},
{
"metric" : {
"__name__" : "up",
"job" : "node",
"instance" : "localhost:9100"
},
"value" : [ 1435781451.781, "" ]
}
]
}
}
区间数据查询
使用 QUERY_RANGE API 我们则可以直接查询 PromQL 表达式在一段时间返回内的计算结果。
URL 请求参数:
query=<string>
: PromQL 表达式。start=<rfc3339 | unix_timestamp>
: 起始时间戳。end=<rfc3339 | unix_timestamp>
: 结束时间戳。step=<duration | float>
: 查询时间步长,时间区间内每 step 秒执行一次。timeout=<duration>
: 超时设置。可选参数,默认情况下使用全局设置的参数-query.timeout
。
当使用 QUERY_RANGE API 查询 PromQL 表达式时,返回结果一定是一个区间向量:
{
"resultType": "matrix",
"result": <value>
}
[info] 注意
在 QUERY_RANGE API 中 PromQL 只能使用瞬时向量选择器类型的表达式。
对于 <value>
占位符的格式,详见 区间向量查询结果格式。
例如使用以下表达式查询表达式 up
在 30 秒范围内以 15 秒为间隔计算 PromQL 表达式的结果。
$ 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, "" ],
[ 1435781445.781, "" ],
[ 1435781460.781, "" ]
]
},
{
"metric" : {
"__name__" : "up",
"job" : "node",
"instance" : "localhost:9091"
},
"values" : [
[ 1435781430.781, "" ],
[ 1435781445.781, "" ],
[ 1435781460.781, "" ]
]
}
]
}
}
0x03 查询元数据
通过标签选择器查找时间序列
以下表达式返回与特定标签集匹配的时间序列列表:
URL 请求参数:
match[]=<series_selector>
: 表示标签选择器是series_selector
。必须至少提供一个match[]
参数。start=<rfc3339 | unix_timestamp>
: 起始时间戳。end=<rfc3339 | unix_timestamp>
: 结束时间戳。
返回结果的 data 部分,是由 key-value 键值对的对象列表组成的。
例如使用以下表达式查询表达式 up
或 process_start_time_seconds{job="prometheus"}
的计算结果:
$ curl -g 'http://localhost:9090/api/v1/series?match[]=up&match[]=process_start_time_seconds{job="prometheus"}'
{
"status" : "success",
"data" : [
{
"__name__" : "up",
"job" : "prometheus",
"instance" : "localhost:9090"
},
{
"__name__" : "up",
"job" : "node",
"instance" : "localhost:9091"
},
{
"__name__" : "process_start_time_seconds",
"job" : "prometheus",
"instance" : "localhost:9090"
}
]
}
查询标签值
下面这个例子返回了带有指定标签的的时间序列列表:
返回结果的 data
部分是一个标签值列表。例如,以下表达式返回结果的 data 部分是标签名称为 job
的所有标签值:
$ curl http://localhost:9090/api/v1/label/job/values
{
"status" : "success",
"data" : [
"node",
"prometheus"
]
}
0x04 响应数据格式
表达式查询结果可能会在 data 部分的 result
字段中返回以下的响应值。其中 <sample_value>
占位符是数值样本值。由于 json 不支持特殊浮点值,例如:NaN
, Inf
, 和 -Inf
,所以样本值将会作为字符串(而不是原始数值)来进行传输。
区间向量
当返回数据类型 resultType 为 matrix
时,result
响应格式如下:
[
{
"metric": { "<label_name>": "<label_value>", ... },
"values": [ [ <unix_time>, "<sample_value>" ], ... ]
},
...
]
其中 metrics
表示当前时间序列的特征维度,values
包含当前事件序列的一组样本。
瞬时向量
当返回数据类型 resultType 为 vector
时,result
响应格式如下:
[
{
"metric": { "<label_name>": "<label_value>", ... },
"value": [ <unix_time>, "<sample_value>" ]
},
...
]
其中 metrics
表示当前时间序列的特征维度,values
包含当前事件序列的一组样本。
标量
当返回数据类型 resultType 为 scalar
时,result
响应格式如下:
[ <unix_time>, "<scalar_value>" ]
由于标量不存在时间序列一说,因此 result
表示为当前系统时间一个标量的值。
字符串
当返回数据类型 resultType 为 string
时,result
响应格式如下:
[ <unix_time>, "<string_value>" ]
字符串类型的响应内容格式和标量相同。
Prometheus监控学习笔记之在 HTTP API 中使用 PromQL的更多相关文章
- Prometheus监控学习笔记之全面学习Prometheus
0x00 概述 Prometheus是继Kubernetes后第2个正式加入CNCF基金会的项目,容器和云原生领域事实的监控标准解决方案.在这次分享将从Prometheus的基础说起,学习和了解Pro ...
- Prometheus监控学习笔记之教程推荐
最近学习K8S和基于容器的监控,发现了如下的教程质量不错,记录下来以备参考 1. K8S最佳实战(包括了K8S的Prometheus监控和EFK日志搜集) https://jimmysong.io/k ...
- Prometheus监控学习笔记之容器监控Grafana模块
0x00 概述 Grafana 是一个开源的,可以用于大规模指标数据的可视化项目,甚至还能对指标进行报警.基于友好的 Apache License 2.0 开源协议,目前是prometheus监控展示 ...
- Prometheus监控学习笔记之prometheus的federation机制
0x00 概述 有时候对于一个公司,k8s集群或是所谓的caas只是整个技术体系的一部分,往往这个时候监控系统不仅仅要k8s集群以及k8s中部署的应用,而且要监控传统部署的项目.也就是说整个监控系统不 ...
- Prometheus监控学习笔记之Prometheus不完全避坑指南
0x00 概述 Prometheus 是一个开源监控系统,它本身已经成为了云原生中指标监控的事实标准,几乎所有 k8s 的核心组件以及其它云原生系统都以 Prometheus 的指标格式输出自己的运行 ...
- Prometheus监控学习笔记之Prometheus监控简介
0x00 Prometheus容器监控解决方案 Prometheus(普罗米修斯)是一个开源系统监控和警报工具,最初是在SoundCloud建立的.它是一个独立的开放源码项目,并且独立于任何公司.不同 ...
- Prometheus监控学习笔记之Prometheus查询无数据或者Grafana不显示数据的诡异问题
0x00 概述 Prometheus和Grafana部署完成后,网络正常,配置文件正常,抓取agent运行正常,使用curl命令获取监控端口数据正常,甚至Prometheus内的targets列表内都 ...
- Prometheus监控学习笔记
K8S最佳实战(包括了K8S的Prometheus监控和EFK日志搜集) https://jimmysong.io/kubernetes-handbook/practice/ Prometheus-b ...
- Prometheus监控学习笔记之Prometheus的Relabel,SD以及Federation功能
0x00 k8s 的监控设计 k8s 默认以及推荐的监控体系是它自己的一套东西:Heapster + cAdvisor + Influxdb + Grafana,具体可以看 这里 . 包括 k8s 自 ...
随机推荐
- elasticsearch6.0.0源码导入到idea总结
由于elasticsearch使用了gradle管理依赖,进行构建,再加上对gradle没有接触过. 因此,导入到idea中遇到问题非常多.这里大致罗列下并说明解决方法. 环境背景 gradle版本: ...
- windows系统上利用putty通过SSH连接亚马逊AWS服务器
1. 找到在购买亚马逊的AWS服务器时保存的密钥文件(假设为abc.pem). 2.打开PuTTYgen,如下图,点击图中1处的“load”,找到abc.pem文件所在的位置,并选择abc.pem,确 ...
- Elasticsearch集群管理工具head插件安装
Elasticsearch-head是一个elasticsearch的集群管理工具,它是完全由html5编写的独立网页程序,你可以通过插件把它集成到es.或直接下载源码,在本地打开index.html ...
- iOS 开发常用链接总结
知识归纳 1.招聘一个靠谱的程序员 面试题答案 https://github.com/ChenYilong/iOSInterviewQuestions 2.中文 iOS/Mac 开发博客列表 http ...
- list.remove出错 报 Not source之类的错误
private static String removePreviousString(String str,String strPre){ String[] strArray = str.split( ...
- WebSocket.之.基础入门-前端发送消息
WebSocket.之.基础入门-前端发送消息 在<WebSocket.之.基础入门-建立连接>的代码基础之上,进行添加代码.代码只改动了:TestSocket.java 和 index. ...
- LeetCode155.最小栈
设计一个支持 push,pop,top 操作,并能在常数时间内检索到最小元素的栈. push(x) -- 将元素 x 推入栈中. pop() -- 删除栈顶的元素. top() -- 获取栈顶元素. ...
- python 定义函数 两个文件调用函数
在def_function.py文件里面写 #coding=utf-8 #定义函数 def hello(): print "hello world" 在test.py里面调用 #c ...
- CoreWebApi集成Exceptionless
参考博客 https://www.cnblogs.com/akaxb/p/7207827.html 一. Exceptionlessr的安装部署 依乐祝,<ASP.NET Core免费开源分布式 ...
- VC2012+QT新建一个控制台程序
1.新建一个项目,选择控制台程序 2.下一步.project setting 可以包含模块,可以再这选择也可以之后选择 3.配置工程属性 1)需要源码的话添加VC++目录里的源目录 2)包含头文件 ...