当前稳定的 HTTP API 可在 Prometheus 服务器上的 /api/v1 下访问。任何非破坏性添加都将在该端点下添加。
API 响应格式为 JSON。每个成功的 API 请求都返回 2xx 状态代码。
到达 API 处理程序的无效请求将返回一个 JSON 错误对象和以下 HTTP 响应代码之一
400 错误请求。422 不可处理的实体 (RFC4918).503 服务不可用。其他非 2xx 代码可能会因在到达 API 端点之前发生的错误而返回。
如果存在不阻止请求执行的错误，则可能会返回一组警告。可能会返回一组额外的信息级注释，用于潜在的查询问题，这些问题可能是也可能不是误报。所有成功收集的数据都将在 data 字段中返回。
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 set if there were warnings while executing the request.
// There will still be data in the data field.
"warnings": ["<string>"],
// Only set if there were info-level annnotations while executing the request.
"infos": ["<string>"]
}
通用占位符定义如下
<rfc3339 | unix_timestamp>：输入时间戳可以以 RFC3339 格式或以秒为单位的 Unix 时间戳提供，可选地包含小数位以表示亚秒精度。输出时间戳始终以秒为单位表示为 Unix 时间戳。<series_selector>：Prometheus 时间序列选择器，例如 http_requests_total 或 http_requests_total{method=~"(GET|POST)"}，需要进行 URL 编码。<duration>：Prometheus 持续时间字符串。例如，5m 表示 5 分钟的持续时间。<bool>：布尔值（字符串 true 和 false）。注意：可能重复的查询参数的名称以 [] 结尾。
查询语言表达式可以在单个时间点或一段时间范围内进行评估。以下部分描述了每种类型的表达式查询的 API 端点。
以下端点在单个时间点评估瞬时查询
GET /api/v1/query
POST /api/v1/query
URL 查询参数
query=<string>：Prometheus 表达式查询字符串。time=<rfc3339 | unix_timestamp>：评估时间戳。可选。timeout=<duration>：评估超时。可选。默认为 -query.timeout 标志的值并受其限制。如果省略 time 参数，则使用当前服务器时间。
您可以使用 POST 方法和 Content-Type: application/x-www-form-urlencoded 标头直接在请求正文中对这些参数进行 URL 编码。当指定可能超出服务器端 URL 字符限制的大型查询时，这很有用。
查询结果的 data 部分具有以下格式
{
"resultType": "matrix" | "vector" | "scalar" | "string",
"result": <value>
}
<value> 指的是查询结果数据，其格式根据 resultType 而有所不同。请参阅表达式查询结果格式。
以下示例在时间 2015-07-01T20:10:51.781Z 处评估表达式 up
$ curl 'https://127.0.0.1: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, "1" ]
},
{
"metric" : {
"__name__" : "up",
"job" : "node",
"instance" : "localhost:9100"
},
"value" : [ 1435781451.781, "0" ]
}
]
}
}
以下端点在一系列时间内评估表达式查询
GET /api/v1/query_range
POST /api/v1/query_range
URL 查询参数
query=<string>：Prometheus 表达式查询字符串。start=<rfc3339 | unix_timestamp>：开始时间戳，包含在内。end=<rfc3339 | unix_timestamp>：结束时间戳，包含在内。step=<duration | float>：查询分辨率步长宽度，以 duration 格式或秒数的浮点数表示。timeout=<duration>：评估超时。可选。默认为 -query.timeout 标志的值并受其限制。您可以使用 POST 方法和 Content-Type: application/x-www-form-urlencoded 标头直接在请求正文中对这些参数进行 URL 编码。当指定可能超出服务器端 URL 字符限制的大型查询时，这很有用。
查询结果的 data 部分具有以下格式
{
"resultType": "matrix",
"result": <value>
}
有关 <value> 占位符的格式，请参阅范围向量结果格式。
以下示例在 30 秒的范围内以 15 秒的查询分辨率评估表达式 up。
$ curl 'https://127.0.0.1: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" ]
]
}
]
}
}
以下端点以美化的方式格式化 PromQL 表达式
GET /api/v1/format_query
POST /api/v1/format_query
URL 查询参数
query=<string>：Prometheus 表达式查询字符串。您可以使用 POST 方法和 Content-Type: application/x-www-form-urlencoded 标头直接在请求正文中对这些参数进行 URL 编码。当指定可能超出服务器端 URL 字符限制的大型查询时，这很有用。
查询结果的 data 部分是一个字符串，包含格式化的查询表达式。请注意，格式化字符串中会删除所有注释。
以下示例格式化表达式 foo/bar
$ curl 'https://127.0.0.1:9090/api/v1/format_query?query=foo/bar'
{
"status" : "success",
"data" : "foo / bar"
}
Prometheus 提供一组 API 端点来查询有关序列及其标签的元数据。
以下端点返回与特定标签集匹配的时间序列列表。
GET /api/v1/series
POST /api/v1/series
URL 查询参数
match[]=<series_selector>：重复的序列选择器参数，用于选择要返回的序列。必须提供至少一个 match[] 参数。start=<rfc3339 | unix_timestamp>：开始时间戳。end=<rfc3339 | unix_timestamp>：结束时间戳。limit=<number>：返回序列的最大数量。可选。0 表示禁用。您可以使用 POST 方法和 Content-Type: application/x-www-form-urlencoded 标头直接在请求正文中对这些参数进行 URL 编码。当指定可能超出服务器端 URL 字符限制的大量或动态数量的序列选择器时，这很有用。
查询结果的 data 部分包含一个对象列表，这些对象包含标识每个序列的标签名称/值对。
以下示例返回与选择器 up 或 process_start_time_seconds{job="prometheus"} 中的任何一个匹配的所有序列
$ curl -g 'https://127.0.0.1:9090/api/v1/series?' --data-urlencode 'match[]=up' --data-urlencode '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"
}
]
}
以下端点返回标签名称列表
GET /api/v1/labels
POST /api/v1/labels
URL 查询参数
start=<rfc3339 | unix_timestamp>：开始时间戳。可选。end=<rfc3339 | unix_timestamp>：结束时间戳。可选。match[]=<series_selector>：重复的序列选择器参数，用于选择要从中读取标签名称的序列。可选。limit=<number>：返回序列的最大数量。可选。0 表示禁用。JSON 响应的 data 部分是字符串标签名称列表。
这是一个示例。
$ curl 'localhost:9090/api/v1/labels'
{
"status": "success",
"data": [
"__name__",
"call",
"code",
"config",
"dialer_name",
"endpoint",
"event",
"goversion",
"handler",
"instance",
"interval",
"job",
"le",
"listener_name",
"name",
"quantile",
"reason",
"role",
"scrape_job",
"slice",
"version"
]
}
以下端点返回提供的标签名称的标签值列表
GET /api/v1/label/<label_name>/values
URL 查询参数
start=<rfc3339 | unix_timestamp>：开始时间戳。可选。end=<rfc3339 | unix_timestamp>：结束时间戳。可选。match[]=<series_selector>：重复的序列选择器参数，用于选择要从中读取标签值的序列。可选。limit=<number>：返回序列的最大数量。可选。0 表示禁用。JSON 响应的 data 部分是字符串标签值列表。
此示例查询 job 标签的所有标签值
$ curl https://127.0.0.1:9090/api/v1/label/job/values
{
"status" : "success",
"data" : [
"node",
"prometheus"
]
}
这是**实验性**功能，将来可能会发生变化。以下端点返回特定时间范围内有效 PromQL 查询的示例列表
GET /api/v1/query_exemplars
POST /api/v1/query_exemplars
URL 查询参数
query=<string>：Prometheus 表达式查询字符串。start=<rfc3339 | unix_timestamp>：开始时间戳。end=<rfc3339 | unix_timestamp>：结束时间戳。$ curl -g 'https://127.0.0.1:9090/api/v1/query_exemplars?query=test_exemplar_metric_total&start=2020-09-14T15:22:25.479Z&end=2020-09-14T15:23:25.479Z'
{
"status": "success",
"data": [
{
"seriesLabels": {
"__name__": "test_exemplar_metric_total",
"instance": "localhost:8090",
"job": "prometheus",
"service": "bar"
},
"exemplars": [
{
"labels": {
"trace_id": "EpTxMJ40fUus7aGY"
},
"value": "6",
"timestamp": 1600096945.479
}
]
},
{
"seriesLabels": {
"__name__": "test_exemplar_metric_total",
"instance": "localhost:8090",
"job": "prometheus",
"service": "foo"
},
"exemplars": [
{
"labels": {
"trace_id": "Olp9XHlq763ccsfa"
},
"value": "19",
"timestamp": 1600096955.479
},
{
"labels": {
"trace_id": "hCtjygkIHwAN9vs4"
},
"value": "20",
"timestamp": 1600096965.489
}
]
}
]
}
表达式查询可能会在 data 部分的 result 属性中返回以下响应值。<sample_value> 占位符是数字样本值。JSON 不支持 NaN、Inf 和 -Inf 等特殊浮点值，因此样本值作为带引号的 JSON 字符串而不是原始数字进行传输。
仅当响应中存在实验性原生直方图时，键 "histogram" 和 "histograms" 才会显示。它们的占位符 <histogram> 在下面其自己的部分中进行了详细说明。
范围向量作为结果类型matrix返回。相应的result属性具有以下格式
[
{
"metric": { "<label_name>": "<label_value>", ... },
"values": [ [ <unix_time>, "<sample_value>" ], ... ],
"histograms": [ [ <unix_time>, <histogram> ], ... ]
},
...
]
每个序列可以具有"values"键，或"histograms"键，或两者兼而有之。对于给定的时间戳，将只会有一个浮点数或直方图类型样本。
序列按metric排序返回。诸如sort和sort_by_label之类的函数对范围向量没有影响。
瞬时向量作为结果类型vector返回。相应的result属性具有以下格式
[
{
"metric": { "<label_name>": "<label_value>", ... },
"value": [ <unix_time>, "<sample_value>" ],
"histogram": [ <unix_time>, <histogram> ]
},
...
]
每个序列可以具有"value"键，或"histogram"键，但不能同时具有两者。
除非使用诸如sort或sort_by_label之类的函数，否则不保证序列按任何特定顺序返回。
标量结果作为结果类型scalar返回。相应的result属性具有以下格式
[ <unix_time>, "<scalar_value>" ]
字符串结果作为结果类型string返回。相应的result属性具有以下格式
[ <unix_time>, "<string_value>" ]
上面使用的<histogram>占位符格式如下。
请注意，原生直方图是一项实验性功能，以下格式可能还会更改。
{
"count": "<count_of_observations>",
"sum": "<sum_of_observations>",
"buckets": [ [ <boundary_rule>, "<left_boundary>", "<right_boundary>", "<count_in_bucket>" ], ... ]
}
<boundary_rule>占位符是 0 到 3 之间的整数，其含义如下
请注意，对于当前实现的桶模式，正桶是“左开”，负桶是“右开”，零桶（左边界为负，右边界为正）是“两端都闭”。
以下端点返回 Prometheus 目标发现的当前状态概述
GET /api/v1/targets
默认情况下，活动目标和已丢弃目标都是响应的一部分。已丢弃的目标受keep_dropped_targets限制（如果设置）。labels表示重新标记后标签集。discoveredLabels表示在重新标记发生之前，服务发现期间检索到的未修改的标签。
$ curl https://127.0.0.1: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",
"globalUrl": "http://example-prometheus:9090/metrics",
"lastError": "",
"lastScrape": "2017-01-17T15:07:44.723715405+01:00",
"lastScrapeDuration": 0.050688943,
"health": "up",
"scrapeInterval": "1m",
"scrapeTimeout": "10s"
}
],
"droppedTargets": [
{
"discoveredLabels": {
"__address__": "127.0.0.1:9100",
"__metrics_path__": "/metrics",
"__scheme__": "http",
"__scrape_interval__": "1m",
"__scrape_timeout__": "10s",
"job": "node"
},
}
]
}
}
state查询参数允许调用方按活动目标或已丢弃目标进行筛选（例如，state=active、state=dropped、state=any）。请注意，对于被筛选出的目标，仍然会返回一个空数组。其他值将被忽略。
$ curl 'https://127.0.0.1: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",
"globalUrl": "http://example-prometheus:9090/metrics",
"lastError": "",
"lastScrape": "2017-01-17T15:07:44.723715405+01:00",
"lastScrapeDuration": 50688943,
"health": "up"
}
],
"droppedTargets": []
}
}
scrapePool查询参数允许调用方按抓取池名称进行筛选。
$ curl 'https://127.0.0.1:9090/api/v1/targets?scrapePool=node_exporter'
{
"status": "success",
"data": {
"activeTargets": [
{
"discoveredLabels": {
"__address__": "127.0.0.1:9091",
"__metrics_path__": "/metrics",
"__scheme__": "http",
"job": "node_exporter"
},
"labels": {
"instance": "127.0.0.1:9091",
"job": "node_exporter"
},
"scrapePool": "node_exporter",
"scrapeUrl": "http://127.0.0.1:9091/metrics",
"globalUrl": "http://example-prometheus:9091/metrics",
"lastError": "",
"lastScrape": "2017-01-17T15:07:44.723715405+01:00",
"lastScrapeDuration": 50688943,
"health": "up"
}
],
"droppedTargets": []
}
}
/rules API 端点返回当前加载的警报和记录规则的列表。此外，它还会返回每个警报规则的 Prometheus 实例触发的当前活动警报。
由于/rules端点比较新，因此它没有与上层 API v1 相同的稳定性保证。
GET /api/v1/rules
URL 查询参数
type=alert|record：仅返回警报规则（例如type=alert）或记录规则（例如type=record）。当参数不存在或为空时，不会执行任何过滤。rule_name[]=<string>：仅返回具有给定规则名称的规则。如果参数重复，则返回具有任何提供的名称的规则。如果我们已过滤掉组的所有规则，则不会返回该组。当参数不存在或为空时，不会执行任何过滤。rule_group[]=<string>：仅返回具有给定规则组名称的规则。如果参数重复，则返回具有任何提供的规则组名称的规则。当参数不存在或为空时，不会执行任何过滤。file[]=<string>：仅返回具有给定文件路径的规则。如果参数重复，则返回具有任何提供的文件路径的规则。当参数不存在或为空时，不会执行任何过滤。exclude_alerts=<bool>：仅返回规则，不返回活动警报。match[]=<label_selector>：仅返回配置的标签满足标签选择器的规则。如果参数重复，则返回匹配任何标签选择器集的规则。请注意，匹配是在每个规则定义中的标签上进行的，而不是在模板扩展后的值上进行的（对于警报规则）。可选。$ curl https://127.0.0.1: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 by (job) (http_inprogress_requests)",
"type": "recording"
}
],
"file": "/rules.yaml",
"interval": 60,
"limit": 0,
"name": "example"
}
]
},
"status": "success"
}
/alerts端点返回所有活动警报的列表。
由于/alerts端点比较新，因此它没有与上层 API v1 相同的稳定性保证。
GET /api/v1/alerts
$ curl https://127.0.0.1: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"
}
以下端点返回有关当前从目标抓取的指标的元数据。这是实验性的，将来可能会更改。
GET /api/v1/targets/metadata
URL 查询参数
match_target=<label_selectors>：通过其标签集匹配目标的标签选择器。如果为空，则选择所有目标。metric=<string>：要检索元数据的指标名称。如果为空，则检索所有指标元数据。limit=<number>：要匹配的最大目标数。查询结果的data部分包含一个对象列表，这些对象包含指标元数据和目标标签集。
以下示例返回来自具有标签job="prometheus"的前两个目标的go_goroutines指标的所有元数据条目。
curl -G https://127.0.0.1:9091/api/v1/targets/metadata \
--data-urlencode 'metric=go_goroutines' \
--data-urlencode 'match_target={job="prometheus"}' \
--data-urlencode 'limit=2'
{
"status": "success",
"data": [
{
"target": {
"instance": "127.0.0.1:9090",
"job": "prometheus"
},
"type": "gauge",
"help": "Number of goroutines that currently exist.",
"unit": ""
},
{
"target": {
"instance": "127.0.0.1:9091",
"job": "prometheus"
},
"type": "gauge",
"help": "Number of goroutines that currently exist.",
"unit": ""
}
]
}
以下示例返回所有具有标签instance="127.0.0.1:9090的目标的所有指标的元数据。
curl -G https://127.0.0.1:9091/api/v1/targets/metadata \
--data-urlencode 'match_target={instance="127.0.0.1:9090"}'
{
"status": "success",
"data": [
// ...
{
"target": {
"instance": "127.0.0.1:9090",
"job": "prometheus"
},
"metric": "prometheus_treecache_zookeeper_failures_total",
"type": "counter",
"help": "The total number of ZooKeeper failures.",
"unit": ""
},
{
"target": {
"instance": "127.0.0.1:9090",
"job": "prometheus"
},
"metric": "prometheus_tsdb_reloads_total",
"type": "counter",
"help": "Number of times the database reloaded block data from disk.",
"unit": ""
},
// ...
]
}
它返回有关当前从目标抓取的指标的元数据。但是，它不提供任何目标信息。这被认为是实验性的，将来可能会更改。
GET /api/v1/metadata
URL 查询参数
limit=<number>：要返回的最大指标数。limit_per_metric=<number>：每个指标要返回的最大元数据数。metric=<string>：用于筛选元数据的指标名称。如果为空，则检索所有指标元数据。查询结果的data部分包含一个对象，其中每个键都是一个指标名称，每个值都是唯一元数据对象的列表，这些对象是在所有目标上针对该指标名称公开的。
以下示例返回两个指标。请注意，指标http_requests_total的列表中有多个对象。至少一个目标的HELP值与其余目标不匹配。
curl -G https://127.0.0.1:9090/api/v1/metadata?limit=2
{
"status": "success",
"data": {
"cortex_ring_tokens": [
{
"type": "gauge",
"help": "Number of tokens in the ring",
"unit": ""
}
],
"http_requests_total": [
{
"type": "counter",
"help": "Number of HTTP requests",
"unit": ""
},
{
"type": "counter",
"help": "Amount of HTTP requests",
"unit": ""
}
]
}
}
以下示例仅返回每个指标的一个元数据条目。
curl -G https://127.0.0.1:9090/api/v1/metadata?limit_per_metric=1
{
"status": "success",
"data": {
"cortex_ring_tokens": [
{
"type": "gauge",
"help": "Number of tokens in the ring",
"unit": ""
}
],
"http_requests_total": [
{
"type": "counter",
"help": "Number of HTTP requests",
"unit": ""
}
]
}
}
以下示例仅返回指标http_requests_total的元数据。
curl -G https://127.0.0.1:9090/api/v1/metadata?metric=http_requests_total
{
"status": "success",
"data": {
"http_requests_total": [
{
"type": "counter",
"help": "Number of HTTP requests",
"unit": ""
},
{
"type": "counter",
"help": "Amount of HTTP requests",
"unit": ""
}
]
}
}
以下端点返回 Prometheus alertmanager 发现的当前状态概述
GET /api/v1/alertmanagers
活动和已丢弃的 Alertmanagers 都是响应的一部分。
$ curl https://127.0.0.1:9090/api/v1/alertmanagers
{
"status": "success",
"data": {
"activeAlertmanagers": [
{
"url": "http://127.0.0.1:9090/api/v1/alerts"
}
],
"droppedAlertmanagers": [
{
"url": "http://127.0.0.1:9093/api/v1/alerts"
}
]
}
}
以下状态端点公开了当前的 Prometheus 配置。
以下端点返回当前加载的配置文件
GET /api/v1/status/config
配置作为转储的 YAML 文件返回。由于 YAML 库的限制，不包含 YAML 注释。
$ curl https://127.0.0.1:9090/api/v1/status/config
{
"status": "success",
"data": {
"yaml": "<content of the loaded config file in YAML>",
}
}
以下端点返回 Prometheus 配置的标志值
GET /api/v1/status/flags
所有值的结果类型均为string。
$ curl https://127.0.0.1:9090/api/v1/status/flags
{
"status": "success",
"data": {
"alertmanager.notification-queue-capacity": "10000",
"alertmanager.timeout": "10s",
"log.level": "info",
"query.lookback-delta": "5m",
"query.max-concurrency": "20",
...
}
}
v2.2 中新增
以下端点返回有关 Prometheus 服务器的各种运行时信息属性
GET /api/v1/status/runtimeinfo
返回的值类型不同，具体取决于运行时属性的性质。
$ curl https://127.0.0.1:9090/api/v1/status/runtimeinfo
{
"status": "success",
"data": {
"startTime": "2019-11-02T17:23:59.301361365+01:00",
"CWD": "/",
"reloadConfigSuccess": true,
"lastConfigTime": "2019-11-02T17:23:59+01:00",
"timeSeriesCount": 873,
"corruptionCount": 0,
"goroutineCount": 48,
"GOMAXPROCS": 4,
"GOGC": "",
"GODEBUG": "",
"storageRetention": "15d"
}
}
v2.14 中新增
以下端点返回有关 Prometheus 服务器的各种构建信息属性
GET /api/v1/status/buildinfo
所有值的结果类型均为string。
$ curl https://127.0.0.1:9090/api/v1/status/buildinfo
{
"status": "success",
"data": {
"version": "2.13.1",
"revision": "cb7cbad5f9a2823a622aaa668833ca04f50a0ea7",
"branch": "master",
"buildUser": "julius@desktop",
"buildDate": "20191102-16:19:59",
"goVersion": "go1.13.1"
}
}
v2.14 中新增
以下端点返回有关 Prometheus TSDB 的各种基数统计信息
GET /api/v1/status/tsdb
URL 查询参数：- limit=<number>：将每组统计信息的返回项目数量限制为给定数量。默认情况下，返回 10 个项目。
查询结果的data部分包含- headStats：这提供了有关 TSDB 的头部块的以下数据：- numSeries：序列数。- chunkCount：块数。- minTime：当前以毫秒为单位的最小时间戳。- maxTime：当前以毫秒为单位的最大时间戳。- seriesCountByMetricName: 这将提供指标名称及其序列计数的列表。- labelValueCountByLabelName: 这将提供标签名称及其值计数的列表。- memoryInBytesByLabelName 这将提供标签名称及其使用的内存（以字节为单位）的列表。内存使用量是通过添加给定标签名称的所有值的长度来计算的。- seriesCountByLabelPair 这将提供标签值对及其序列计数的列表。
$ curl https://127.0.0.1:9090/api/v1/status/tsdb
{
"status": "success",
"data": {
"headStats": {
"numSeries": 508,
"chunkCount": 937,
"minTime": 1591516800000,
"maxTime": 1598896800143,
},
"seriesCountByMetricName": [
{
"name": "net_conntrack_dialer_conn_failed_total",
"value": 20
},
{
"name": "prometheus_http_request_duration_seconds_bucket",
"value": 20
}
],
"labelValueCountByLabelName": [
{
"name": "__name__",
"value": 211
},
{
"name": "event",
"value": 3
}
],
"memoryInBytesByLabelName": [
{
"name": "__name__",
"value": 8266
},
{
"name": "instance",
"value": 28
}
],
"seriesCountByLabelValuePair": [
{
"name": "job=prometheus",
"value": 425
},
{
"name": "instance=localhost:9090",
"value": 425
}
]
}
}
v2.15 中新增
以下端点返回有关 WAL 重放的信息
GET /api/v1/status/walreplay
read：到目前为止重放的段数。total：需要重放的总段数。progress：重放进度（0 - 100%）。state：重放状态。可能的状态：- waiting：等待重放开始。- in progress：重放正在进行中。- done：重放已完成。
$ curl https://127.0.0.1:9090/api/v1/status/walreplay
{
"status": "success",
"data": {
"min": 2,
"max": 5,
"current": 40,
"state": "in progress"
}
}
v2.28 中新增
这些 API 公开了高级用户数据库功能。除非设置了--web.enable-admin-api，否则这些 API 不会启用。
快照将所有当前数据创建快照到 TSDB 数据目录下的snapshots/<datetime>-<rand>，并返回目录作为响应。它可以选择跳过仅存在于头部块中的数据的快照，并且这些数据尚未压缩到磁盘。
POST /api/v1/admin/tsdb/snapshot
PUT /api/v1/admin/tsdb/snapshot
URL 查询参数
skip_head=<bool>：跳过存在于头部块中的数据。可选。$ curl -XPOST https://127.0.0.1:9090/api/v1/admin/tsdb/snapshot
{
"status": "success",
"data": {
"name": "20171210T211224Z-2be650b6d019eb54"
}
}
快照现在位于<data-dir>/snapshots/20171210T211224Z-2be650b6d019eb54
v2.1 中新增，并支持从 v2.9 开始的 PUT
DeleteSeries 删除一段时间内选定序列的数据。实际数据仍然存在于磁盘上，并在将来的压缩中清理，或者可以通过点击清理墓碑端点显式清理。
如果成功，则返回204。
POST /api/v1/admin/tsdb/delete_series
PUT /api/v1/admin/tsdb/delete_series
URL 查询参数
match[]=<series_selector>：重复的标签匹配器参数，用于选择要删除的序列。必须提供至少一个match[]参数。start=<rfc3339 | unix_timestamp>: 开始时间戳。可选，默认为最小可能时间。end=<rfc3339 | unix_timestamp>: 结束时间戳。可选，默认为最大可能时间。不提及开始和结束时间都会清除数据库中匹配的系列的所有数据。
示例
$ curl -X POST \
-g 'https://127.0.0.1:9090/api/v1/admin/tsdb/delete_series?match[]=up&match[]=process_start_time_seconds{job="prometheus"}'
v2.1 中新增，并支持从 v2.9 开始的 PUT
CleanTombstones 从磁盘中删除已删除的数据并清理现有的墓碑。这可以在删除系列后用于释放空间。
如果成功，则返回204。
POST /api/v1/admin/tsdb/clean_tombstones
PUT /api/v1/admin/tsdb/clean_tombstones
此操作不接收任何参数或主体。
$ curl -XPOST https://127.0.0.1:9090/api/v1/admin/tsdb/clean_tombstones
v2.1 中新增，并支持从 v2.9 开始的 PUT
Prometheus 可以配置为 Prometheus 远程写入协议的接收器。这被认为不是一种有效的样本摄取方式。谨慎用于特定的小容量用例。它不适合替换通过抓取进行的摄取并将 Prometheus 变成基于推送的指标收集系统。
通过设置--web.enable-remote-write-receiver启用远程写入接收器。启用后，远程写入接收器端点为/api/v1/write。在此处查找更多详细信息 here。
v2.33 中新增
Prometheus 可以配置为 OTLP 度量标准协议的接收器。这被认为不是一种有效的样本摄取方式。谨慎用于特定的小容量用例。它不适合替换通过抓取进行的摄取。
通过功能标志--enable-feature=otlp-write-receiver启用 OTLP 接收器。启用后，OTLP 接收器端点为/api/v1/otlp/v1/metrics。
v2.47 中新增
本文档是 开源的。请通过提交问题或拉取请求来帮助改进它。