mirror of
https://github.com/prometheus/prometheus.git
synced 2025-08-06 22:27:17 +02:00
Standardize doc page title handling
See https://groups.google.com/g/prometheus-developers/c/cwL3cM66Em8 Signed-off-by: Julius Volz <julius.volz@gmail.com>
This commit is contained in:
Julius Volz
parent
ab1b1db128
commit
13564c03ef
@ -2,12 +2,9 @@
|
||||
title: prometheus
|
||||
---
|
||||
|
||||
# prometheus
|
||||
|
||||
The Prometheus monitoring server
|
||||
|
||||
|
||||
|
||||
## Flags
|
||||
|
||||
| Flag | Description | Default |
|
||||
|
||||
@ -2,12 +2,9 @@
|
||||
title: promtool
|
||||
---
|
||||
|
||||
# promtool
|
||||
|
||||
Tooling for the Prometheus monitoring system.
|
||||
|
||||
|
||||
|
||||
## Flags
|
||||
|
||||
| Flag | Description |
|
||||
|
||||
@ -3,8 +3,6 @@ title: Alerting rules
|
||||
sort_rank: 3
|
||||
---
|
||||
|
||||
# Alerting rules
|
||||
|
||||
Alerting rules allow you to define alert conditions based on Prometheus
|
||||
expression language expressions and to send notifications about firing alerts
|
||||
to an external service. Whenever the alert expression results in one or more
|
||||
|
||||
@ -3,8 +3,6 @@ title: Configuration
|
||||
sort_rank: 1
|
||||
---
|
||||
|
||||
# Configuration
|
||||
|
||||
Prometheus is configured via command-line flags and a configuration file. While
|
||||
the command-line flags configure immutable system parameters (such as storage
|
||||
locations, amount of data to keep on disk and in memory, etc.), the
|
||||
|
||||
@ -3,8 +3,6 @@ title: HTTPS and authentication
|
||||
sort_rank: 7
|
||||
---
|
||||
|
||||
# HTTPS and authentication
|
||||
|
||||
Prometheus supports basic authentication and TLS.
|
||||
This is **experimental** and might change in the future.
|
||||
|
||||
|
||||
@ -1,10 +1,9 @@
|
||||
---
|
||||
title: Recording rules
|
||||
title: Defining recording rules
|
||||
nav_title: Recording rules
|
||||
sort_rank: 2
|
||||
---
|
||||
|
||||
# Defining recording rules
|
||||
|
||||
## Configuring rules
|
||||
|
||||
Prometheus supports two types of rules which may be configured and then
|
||||
|
||||
@ -3,8 +3,6 @@ title: Template examples
|
||||
sort_rank: 4
|
||||
---
|
||||
|
||||
# Template examples
|
||||
|
||||
Prometheus supports templating in the annotations and labels of alerts,
|
||||
as well as in served console pages. Templates have the ability to run
|
||||
queries against the local database, iterate over data, use conditionals,
|
||||
|
||||
@ -3,8 +3,6 @@ title: Template reference
|
||||
sort_rank: 5
|
||||
---
|
||||
|
||||
# Template reference
|
||||
|
||||
Prometheus supports templating in the annotations and labels of alerts,
|
||||
as well as in served console pages. Templates have the ability to run
|
||||
queries against the local database, iterate over data, use conditionals,
|
||||
|
||||
@ -1,10 +1,8 @@
|
||||
---
|
||||
title: Unit Testing for Rules
|
||||
title: Unit testing for rules
|
||||
sort_rank: 6
|
||||
---
|
||||
|
||||
# Unit Testing for Rules
|
||||
|
||||
You can use `promtool` to test your rules.
|
||||
|
||||
```shell
|
||||
|
||||
@ -3,8 +3,6 @@ title: Feature flags
|
||||
sort_rank: 12
|
||||
---
|
||||
|
||||
# Feature flags
|
||||
|
||||
Here is a list of features that are disabled by default since they are breaking changes or are considered experimental.
|
||||
Their behaviour can change in future releases which will be communicated via the [release changelog](https://github.com/prometheus/prometheus/blob/main/CHANGELOG.md).
|
||||
|
||||
|
||||
@ -3,8 +3,6 @@ title: Federation
|
||||
sort_rank: 6
|
||||
---
|
||||
|
||||
# Federation
|
||||
|
||||
Federation allows a Prometheus server to scrape selected time series from
|
||||
another Prometheus server.
|
||||
|
||||
|
||||
@ -3,8 +3,6 @@ title: Getting started
|
||||
sort_rank: 1
|
||||
---
|
||||
|
||||
# Getting started
|
||||
|
||||
This guide is a "Hello World"-style tutorial which shows how to install,
|
||||
configure, and use a simple Prometheus instance. You will download and run
|
||||
Prometheus locally, configure it to scrape itself and an example application,
|
||||
|
||||
@ -1,10 +1,9 @@
|
||||
---
|
||||
title: HTTP SD
|
||||
title: Writing HTTP service discovery
|
||||
nav_title: HTTP SD
|
||||
sort_rank: 7
|
||||
---
|
||||
|
||||
# Writing HTTP Service Discovery
|
||||
|
||||
Prometheus provides a generic [HTTP Service Discovery](https://prometheus.io/docs/prometheus/latest/configuration/configuration/#http_sd_config),
|
||||
that enables it to discover targets over an HTTP endpoint.
|
||||
|
||||
|
||||
@ -3,8 +3,6 @@ title: Installation
|
||||
sort_rank: 2
|
||||
---
|
||||
|
||||
# Installation
|
||||
|
||||
## Using pre-compiled binaries
|
||||
|
||||
We provide precompiled binaries for most official Prometheus components. Check
|
||||
|
||||
@ -3,12 +3,10 @@ title: Management API
|
||||
sort_rank: 8
|
||||
---
|
||||
|
||||
# Management API
|
||||
|
||||
Prometheus provides a set of management APIs to facilitate automation and integration.
|
||||
|
||||
|
||||
### Health check
|
||||
## Health check
|
||||
|
||||
```
|
||||
GET /-/healthy
|
||||
@ -18,7 +16,7 @@ HEAD /-/healthy
|
||||
This endpoint always returns 200 and should be used to check Prometheus health.
|
||||
|
||||
|
||||
### Readiness check
|
||||
## Readiness check
|
||||
|
||||
```
|
||||
GET /-/ready
|
||||
@ -28,7 +26,7 @@ HEAD /-/ready
|
||||
This endpoint returns 200 when Prometheus is ready to serve traffic (i.e. respond to queries).
|
||||
|
||||
|
||||
### Reload
|
||||
## Reload
|
||||
|
||||
```
|
||||
PUT /-/reload
|
||||
@ -40,7 +38,7 @@ This endpoint triggers a reload of the Prometheus configuration and rule files.
|
||||
Alternatively, a configuration reload can be triggered by sending a `SIGHUP` to the Prometheus process.
|
||||
|
||||
|
||||
### Quit
|
||||
## Quit
|
||||
|
||||
```
|
||||
PUT /-/quit
|
||||
|
||||
@ -1,10 +1,9 @@
|
||||
---
|
||||
title: Migration
|
||||
title: Prometheus 3.0 migration guide
|
||||
nav_title: Migration
|
||||
sort_rank: 10
|
||||
---
|
||||
|
||||
# Prometheus 3.0 migration guide
|
||||
|
||||
In line with our [stability promise](https://prometheus.io/docs/prometheus/latest/stability/),
|
||||
the Prometheus 3.0 release contains a number of backwards incompatible changes.
|
||||
This document offers guidance on migrating from Prometheus 2.x to Prometheus 3.0 and newer versions.
|
||||
|
||||
@ -3,8 +3,6 @@ title: HTTP API
|
||||
sort_rank: 7
|
||||
---
|
||||
|
||||
# HTTP API
|
||||
|
||||
The current stable HTTP API is reachable under `/api/v1` on a Prometheus
|
||||
server. Any non-breaking additions will be added under that endpoint.
|
||||
|
||||
|
||||
@ -4,8 +4,6 @@ nav_title: Basics
|
||||
sort_rank: 1
|
||||
---
|
||||
|
||||
# Querying Prometheus
|
||||
|
||||
Prometheus provides a functional query language called PromQL (Prometheus Query
|
||||
Language) that lets the user select and aggregate time series data in real
|
||||
time.
|
||||
|
||||
@ -1,11 +1,9 @@
|
||||
---
|
||||
title: Querying examples
|
||||
title: Query examples
|
||||
nav_title: Examples
|
||||
sort_rank: 4
|
||||
---
|
||||
|
||||
# Query examples
|
||||
|
||||
## Simple time series selection
|
||||
|
||||
Return all time series with the metric `http_requests_total`:
|
||||
|
||||
@ -4,8 +4,6 @@ nav_title: Functions
|
||||
sort_rank: 3
|
||||
---
|
||||
|
||||
# Functions
|
||||
|
||||
Some functions have default arguments, e.g. `year(v=vector(time())
|
||||
instant-vector)`. This means that there is one argument `v` which is an instant
|
||||
vector, which if not provided it will default to the value of the expression
|
||||
|
||||
@ -3,8 +3,6 @@ title: Operators
|
||||
sort_rank: 2
|
||||
---
|
||||
|
||||
# Operators
|
||||
|
||||
## Binary operators
|
||||
|
||||
Prometheus's query language supports basic logical and arithmetic operators.
|
||||
|
||||
@ -3,9 +3,7 @@ title: Remote Read API
|
||||
sort_rank: 7
|
||||
---
|
||||
|
||||
# Remote Read API
|
||||
|
||||
> This is not currently considered part of the stable API and is subject to change even between non-major version releases of Prometheus.
|
||||
NOTE: This is not currently considered part of the stable API and is subject to change even between non-major version releases of Prometheus.
|
||||
|
||||
This API provides data read functionality from Prometheus. This interface expects [snappy](https://github.com/google/snappy) compression.
|
||||
The API definition is located [here](https://github.com/prometheus/prometheus/blob/master/prompb/remote.proto).
|
||||
@ -15,12 +13,12 @@ Request are made to the following endpoint.
|
||||
/api/v1/read
|
||||
```
|
||||
|
||||
### Samples
|
||||
## Samples
|
||||
|
||||
This returns a message that includes a list of raw samples matching the
|
||||
requested query.
|
||||
|
||||
### Streamed Chunks
|
||||
## Streamed Chunks
|
||||
|
||||
These streamed chunks utilize an XOR algorithm inspired by the [Gorilla](http://www.vldb.org/pvldb/vol8/p1816-teller.pdf)
|
||||
compression to encode the chunks. However, it provides resolution to the millisecond instead of to the second.
|
||||
|
||||
@ -1,10 +1,9 @@
|
||||
---
|
||||
title: API Stability
|
||||
title: API stability guarantees
|
||||
nav_title: API stability
|
||||
sort_rank: 11
|
||||
---
|
||||
|
||||
# API Stability Guarantees
|
||||
|
||||
Prometheus promises API stability within a major version, and strives to avoid
|
||||
breaking changes for key features. Some features, which are cosmetic, still
|
||||
under development, or depend on 3rd party services, are not covered by this.
|
||||
|
||||
@ -3,8 +3,6 @@ title: Storage
|
||||
sort_rank: 5
|
||||
---
|
||||
|
||||
# Storage
|
||||
|
||||
Prometheus includes a local on-disk time series database, but also optionally integrates with remote storage systems.
|
||||
|
||||
## Local storage
|
||||
|
||||
@ -58,11 +58,8 @@ func header(title, help string) []byte {
|
||||
title: %s
|
||||
---
|
||||
|
||||
# %s
|
||||
|
||||
%s
|
||||
|
||||
`, title, title, help))
|
||||
`, title, help))
|
||||
}
|
||||
|
||||
func createFlagRow(flag *kingpin.FlagModel) []string {
|
||||
|
||||
Loading…
Reference in New Issue
Block a user