mudhorn/prometheus
1
0
Fork 0
mirror of https://github.com/prometheus/prometheus.git synced 2024-12-25 05:34:05 -08:00
Code Issues Actions 3 Packages Projects Releases Wiki Activity

Docs: fix types (#7508)

Browse source 
I have batched a bunch of fixes around types in the documentation.

Signed-off-by: Julien Pivotto <roidelapluie@inuits.eu>
This commit is contained in:
Julien Pivotto 2020-07-02 23:27:14 +02:00 committed by GitHub
parent e1f9816a33
commit 74a6959d46
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 12 additions and 11 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

23
docs/configuration/configuration.md
View file

@ -33,14 +33,15 @@ Generic placeholders are defined as follows:
* `<boolean>`: a boolean that can take the values `true` or `false` * `<boolean>`: a boolean that can take the values `true` or `false`
* `<duration>`: a duration matching the regular expression `[0-9]+(ms|[smhdwy])` * `<duration>`: a duration matching the regular expression `[0-9]+(ms|[smhdwy])`
* `<labelname>`: a string matching the regular expression `[a-zA-Z_][a-zA-Z0-9_]*`
* `<labelvalue>`: a string of unicode characters
* `<filename>`: a valid path in the current working directory * `<filename>`: a valid path in the current working directory
* `<host>`: a valid string consisting of a hostname or IP followed by an optional port number * `<host>`: a valid string consisting of a hostname or IP followed by an optional port number
* `<int>`: an integer value
* `<labelname>`: a string matching the regular expression `[a-zA-Z_][a-zA-Z0-9_]*`
* `<labelvalue>`: a string of unicode characters
* `<path>`: a valid URL path * `<path>`: a valid URL path
* `<scheme>`: a string that can take the values `http` or `https` * `<scheme>`: a string that can take the values `http` or `https`
* `<string>`: a regular string
* `<secret>`: a regular string that is a secret, such as a password * `<secret>`: a regular string that is a secret, such as a password
* `<string>`: a regular string
* `<tmpl_string>`: a string which is template-expanded before usage * `<tmpl_string>`: a string which is template-expanded before usage
The other placeholders are specified separately. The other placeholders are specified separately.
@ -376,7 +377,7 @@ tags:
[ tag_separator: <string> | default = , ] [ tag_separator: <string> | default = , ]
# Allow stale Consul results (see https://www.consul.io/api/features/consistency.html). Will reduce load on Consul. # Allow stale Consul results (see https://www.consul.io/api/features/consistency.html). Will reduce load on Consul.
[ allow_stale: <bool> | default = true ] [ allow_stale: <boolean> | default = true ]
# The time after which the provided names are refreshed. # The time after which the provided names are refreshed.
# On large setup it might be a good idea to increase this value because the catalog will change all the time. # On large setup it might be a good idea to increase this value because the catalog will change all the time.
@ -598,7 +599,7 @@ names:
[ type: <string> | default = 'SRV' ] [ type: <string> | default = 'SRV' ]
# The port number used if the query type is not SRV. # The port number used if the query type is not SRV.
[ port: <number>] [ port: <int>]
# The time after which the provided names are refreshed. # The time after which the provided names are refreshed.
[ refresh_interval: <duration> | default = 30s ] [ refresh_interval: <duration> | default = 30s ]
@ -1118,7 +1119,7 @@ servers:
# password and password_file are mutually exclusive. # password and password_file are mutually exclusive.
basic_auth: basic_auth:
[ username: <string> ] [ username: <string> ]
[ password: <string> ] [ password: <secret> ]
[ password_file: <string> ] [ password_file: <string> ]
# Sets the `Authorization` header on every request with # Sets the `Authorization` header on every request with
@ -1332,7 +1333,7 @@ prefix is guaranteed to never be used by Prometheus itself.
[ regex: <regex> | default = (.*) ] [ regex: <regex> | default = (.*) ]
# Modulus to take of the hash of the source label values. # Modulus to take of the hash of the source label values.
[ modulus: <uint64> ] [ modulus: <int> ]
# Replacement value against which a regex replace is performed if the # Replacement value against which a regex replace is performed if the
# regular expression matches. Regex capture groups are available. # regular expression matches. Regex capture groups are available.
@ -1402,7 +1403,7 @@ through the `__alerts_path__` label.
[ timeout: <duration> | default = 10s ] [ timeout: <duration> | default = 10s ]
# The api version of Alertmanager. # The api version of Alertmanager.
[ api_version: <version> | default = v1 ] [ api_version: <string> | default = v1 ]
# Prefix for the HTTP path alerts are pushed to. # Prefix for the HTTP path alerts are pushed to.
[ path_prefix: <path> | default = / ] [ path_prefix: <path> | default = / ]
@ -1415,7 +1416,7 @@ through the `__alerts_path__` label.
# password and password_file are mutually exclusive. # password and password_file are mutually exclusive.
basic_auth: basic_auth:
[ username: <string> ] [ username: <string> ]
[ password: <string> ] [ password: <secret> ]
[ password_file: <string> ] [ password_file: <string> ]
# Sets the `Authorization` header on every request with # Sets the `Authorization` header on every request with
@ -1516,7 +1517,7 @@ write_relabel_configs:
# password and password_file are mutually exclusive. # password and password_file are mutually exclusive.
basic_auth: basic_auth:
[ username: <string> ] [ username: <string> ]
[ password: <string> ] [ password: <secret> ]
[ password_file: <string> ] [ password_file: <string> ]
# Sets the `Authorization` header on every remote write request with # Sets the `Authorization` header on every remote write request with
@ -1588,7 +1589,7 @@ required_matchers:
# password and password_file are mutually exclusive. # password and password_file are mutually exclusive.
basic_auth: basic_auth:
[ username: <string> ] [ username: <string> ]
[ password: <string> ] [ password: <secret> ]
[ password_file: <string> ] [ password_file: <string> ]
# Sets the `Authorization` header on every remote read request with # Sets the `Authorization` header on every remote read request with