prometheus.json (SchemaStore) JSON Schema

Type	object \| null
File match	`prometheus.yml` `prometheus.yaml`
Schema URL	https://catalog.lintel.tools/schemas/schemastore/prometheus-json/latest.json
Source	https://www.schemastore.org/prometheus.json

Validate with Lintel

npx @lintel/lintel check

Type: object | null

Prometheus configuration file

Properties

global object | null

The global configuration specifies parameters that are valid in all other configuration contexts. They also serve as defaults for other configuration sections.

11 nested properties

scrape_interval string | null

pattern=^[0-9]+(ms|[smhdwy])$

scrape_timeout string | null

pattern=^[0-9]+(ms|[smhdwy])$

evaluation_interval string | null

pattern=^[0-9]+(ms|[smhdwy])$

external_labels object | null

query_log_file string | null

format=uri-reference

body_size_limit string | null

An uncompressed response body larger than this many bytes will cause the scrape to fail. 0 means no limit. Example: 100MB.

Default: 0

sample_limit integer | null

Per-scrape limit on number of scraped samples that will be accepted. If more than this number of samples are present after metric relabelling the entire scrape will be treated as failed. 0 means no limit.

Default: 0

label_limit integer | null

Per-scrape limit on number of labels that will be accepted for a sample. If more than this number of labels are present post metric-relabeling, the entire scrape will be treated as failed. 0 means no limit.

Default: 0

label_name_length_limit integer | null

Per-scrape limit on length of labels name that will be accepted for a sample. If a label name is longer than this number post metric-relabeling, the entire scrape will be treated as failed. 0 means no limit.

Default: 0

label_value_length_limit integer | null

Per-scrape limit on length of labels value that will be accepted for a sample. If a label value is longer than this number post metric-relabeling, the entire scrape will be treated as failed. 0 means no limit.

Default: 0

target_limit integer | null

Per-scrape config limit on number of unique targets that will be accepted. If more than this number of targets are present after target relabeling, Prometheus will mark the targets as failed without scraping them. 0 means no limit.

Default: 0

rule_files array | null

Rule files specifies a list of globs. Rules and alerts are read from all matching files.

remote_write array | null

Settings related to the remote write feature.

remote_read array | null

Settings related to the remote read feature.

scrape_config_files array | null

Scrape config files specifies a list of globs. Scrape configs are read from all matching files and appended to the list of scrape configs.

scrape_configs array | null

A list of scrape configurations.

alerting object | null

Alerting specifies settings related to the Alertmanager.

2 nested properties

alert_relabel_configs array | null

alertmanagers array | null

storage object | null

Storage related settings that are runtime reloadable.

2 nested properties

tsdb object | null

1 nested properties

out_of_order_time_window string | null

pattern=^[0-9]+(ms|[smhdwy])$

exemplars object | null

1 nested properties

max_exemplars integer | null

Configures the maximum size of the circular buffer used to store exemplars for all series. Resizable during runtime.

Default: 100000

Definitions

duration string | null

label_name string

label_value string

labels object | null

filepath_glob string

filepath string | null

basic_auth object | null

Sets the Authorization header on every remote write request with the configured username and password. password and password_file are mutually exclusive.

username string required

password string | null

username_file string | null

format=uri-reference

password_file string | null

format=uri-reference

authorization object | null

Sets the Authorization header on every scrape request with the configured credentials.

type string | null

Sets the authentication type of the request.

Default: "Bearer"

credentials string | null

Sets the credentials of the request. It is mutually exclusive with credentials_file.

credentials_file string | null

format=uri-reference

sigv4 object | null

Optionally configures AWS's Signature Verification 4 signing process to sign requests.

region string | null

The AWS region. If blank, the region from the default credentials chain is used.

access_key string | null

The AWS API keys. If blank, the environment variables AWS_ACCESS_KEY_ID and AWS_SECRET_ACCESS_KEY are used.

secret_key string | null

The AWS API keys. If blank, the environment variables AWS_ACCESS_KEY_ID and AWS_SECRET_ACCESS_KEY are used.

profile string | null

Named AWS profile used to authenticate.

role_arn string | null

AWS Role ARN, an alternative to using AWS API keys.

azuread object | null

Optionally configure AzureAD.

cloud string

Default: "AzurePublic"

Constant: ["AzurePublic","AzureChina","AzureGovernment"]

managed_identity object

1 nested properties

client_id string

oauth2 object

3 nested properties

client_id string

client_secret string | null

tenant_id string

sdk

1 nested properties

tenant_id string

google_iam object

credentials_file string

oauth2 object | null

Optional OAuth 2.0 configuration. Cannot be used at the same time as basic_auth or authorization.

client_id string required

token_url string required

The URL to fetch the token from.

client_secret string | null

client_secret_file string | null

format=uri-reference

scopes array | null

Scopes for the token request.

endpoint_params Record<string, string>

Optional parameters to append to the token URL.

tls_config object | null

5 nested properties

ca_file string | null

format=uri-reference

cert_file string | null

format=uri-reference

key_file string | null

format=uri-reference

server_name string | null

ServerName extension to indicate the name of the server.

insecure_skip_verify boolean | null

Disable validation of the server certificate.

bearer_token string | null

Sets the Authorization header on every scrape request with the configured bearer token. It is mutually exclusive with bearer_token_file.

bearer_token_file string | null

auth

relabel_configs array | null

tls_config object | null

ca_file string | null

format=uri-reference

cert_file string | null

format=uri-reference

key_file string | null

format=uri-reference

server_name string | null

ServerName extension to indicate the name of the server.

insecure_skip_verify boolean | null

Disable validation of the server certificate.

scheme string | null

azure_sd_configs array | null

List of Azure service discovery configurations.

consul_sd_configs array | null

List of Consul service discovery configurations.

digitalocean_sd_configs array | null

List of DigitalOcean service discovery configurations.

docker_sd_configs array | null

List of Docker service discovery configurations.

dockerswarm_sd_configs array | null

List of Docker Swarm service discovery configurations.

dns_sd_configs array | null

List of DNS service discovery configurations.

ec2_sd_configs array | null

List of EC2 service discovery configurations.

eureka_sd_configs array | null

List of Eureka service discovery configurations.

file_sd_configs array | null

List of file service discovery configurations.

gce_sd_configs array | null

List of GCE service discovery configurations.

hetzner_sd_configs array | null

List of Hetzner service discovery configurations.

http_sd_configs array | null

List of HTTP service discovery configurations.

kubernetes_sd_configs array | null

List of Kubernetes service discovery configurations.

kuma_sd_configs array | null

List of Kuma service discovery configurations.

lightsail_sd_configs array | null

List of Lightsail service discovery configurations.

linode_sd_configs array | null

List of Linode service discovery configurations.

marathon_sd_configs array | null

List of Marathon service discovery configurations.

nerve_sd_configs array | null

List of AirBnB's Nerve service discovery configurations.

openstack_sd_configs array | null

List of OpenStack service discovery configurations.

puppetdb_sd_configs array | null

List of PuppetDB service discovery configurations.

scaleway_sd_configs array | null

List of Scaleway service discovery configurations.

serverset_sd_configs array | null

List of Zookeeper Serverset service discovery configurations.

triton_sd_configs array | null

List of Triton service discovery configurations.

uyuni_sd_configs array | null

List of Uyuni service discovery configurations.

static_configs array | null

List of labeled statically configured targets for this job.