schema stringclasses 471
values | key stringlengths 0 203 | description stringlengths 0 4.37k | object stringlengths 2 322k |
|---|---|---|---|
prometheus.json | type | Sets the authentication type of the request. | {"type": ["string", "null"], "default": "Bearer"} |
prometheus.json | credentials | Sets the credentials of the request. It is mutually exclusive with `credentials_file`. | {"type": ["string", "null"]} |
prometheus.json | credentials_file | Sets the credentials of the request with the credentials read from the configured file. It is mutually exclusive with `credentials`. | {} |
prometheus.json | sigv4 | Optionally configures AWS's Signature Verification 4 signing process to sign requests. | {"type": ["object", "null"], "properties": {"region": {"type": ["string", "null"]}, "access_key": {"type": ["string", "null"]}, "secret_key": {"type": ["string", "null"]}, "profile": {"type": ["string", "null"]}, "role_arn": {"type": ["string", "null"]}}, "additionalProperties": false} |
prometheus.json | region | The AWS region. If blank, the region from the default credentials chain is used. | {"type": ["string", "null"]} |
prometheus.json | access_key | The AWS API keys. If blank, the environment variables `AWS_ACCESS_KEY_ID` and `AWS_SECRET_ACCESS_KEY` are used. | {"type": ["string", "null"]} |
prometheus.json | secret_key | The AWS API keys. If blank, the environment variables `AWS_ACCESS_KEY_ID` and `AWS_SECRET_ACCESS_KEY` are used. | {"type": ["string", "null"]} |
prometheus.json | profile | Named AWS profile used to authenticate. | {"type": ["string", "null"]} |
prometheus.json | role_arn | AWS Role ARN, an alternative to using AWS API keys. | {"type": ["string", "null"]} |
prometheus.json | oauth2 | Optional OAuth 2.0 configuration. Cannot be used at the same time as basic_auth or authorization. | {"type": ["object", "null"], "properties": {"client_id": {"type": ["string"]}, "client_secret": {"type": ["string", "null"]}, "client_secret_file": {}, "scopes": {"type": ["array", "null"], "items": {"type": ["string", "null"]}}, "token_url": {"type": ["string"]}, "endpoint_params": {"type": ["object", "null"], "additionalProperties": {"type": "string"}}, "tls_config": {}}, "oneOf": [{"required": ["client_secret"]}, {"required": ["client_secret_file"]}], "additionalProperties": false, "required": ["client_id", "token_url"]} |
prometheus.json | client_secret_file | Read the client secret from a file. It is mutually exclusive with `client_secret`. | {} |
prometheus.json | scopes | Scopes for the token request. | {"type": ["array", "null"], "items": {"type": ["string", "null"]}} |
prometheus.json | token_url | The URL to fetch the token from. | {"type": ["string"]} |
prometheus.json | endpoint_params | Optional parameters to append to the token URL. | {"type": ["object", "null"], "additionalProperties": {"type": "string"}} |
prometheus.json | tls_config | Configures the token request's TLS settings. | {} |
prometheus.json | bearer_token | Sets the `Authorization` header on every scrape request with the configured bearer token. It is mutually exclusive with `bearer_token_file`. | {"type": ["string", "null"]} |
prometheus.json | bearer_token_file | Sets the `Authorization` header on every scrape request with the bearer token read from the configured file. It is mutually exclusive with `bearer_token`. | {} |
prometheus.json | source_labels | The source labels select values from existing labels. Their content is concatenated using the configured separator and matched against the configured regular expression for the replace, keep, and drop actions. | {"type": "array", "items": {}} |
prometheus.json | separator | Separator placed between concatenated source label values. | {"type": "string", "default": ";"} |
prometheus.json | target_label | Label to which the resulting value is written in a replace action. It is mandatory for replace actions. Regex capture groups are available. | {"type": "string"} |
prometheus.json | regex | Regular expression against which the extracted value is matched. | {"default": "(.*)"} |
prometheus.json | modulus | Modulus to take of the hash of the source label values. | {"type": "integer"} |
prometheus.json | replacement | Replacement value against which a regex replace is performed if the regular expression matches. Regex capture groups are available. | {"type": "string", "default": "$1"} |
prometheus.json | action | Action to perform based on regex matching. | {"type": "string", "enum": ["replace", "lowercase", "uppercase", "keep", "drop", "keepequal", "dropequal", "hashmod", "labelmap", "labeldrop", "labelkeep"], "default": "replace"} |
prometheus.json | ca_file | CA certificate to validate API server certificate with. | {} |
prometheus.json | cert_file | Certificate file for client cert authentication to the server. | {} |
prometheus.json | key_file | Key file for client cert authentication to the server. | {} |
prometheus.json | server_name | ServerName extension to indicate the name of the server. | {"type": ["string", "null"]} |
prometheus.json | insecure_skip_verify | Disable validation of the server certificate. | {"type": ["boolean", "null"]} |
prometheus.json | azure_sd_configs | List of Azure service discovery configurations. | {"type": ["array", "null"], "items": {"type": "object"}} |
prometheus.json | items | The information to access the Azure API. | {"type": "object"} |
prometheus.json | consul_sd_configs | List of Consul service discovery configurations. | {"type": ["array", "null"], "items": {"type": "object"}} |
prometheus.json | items | The information to access the Consul API. It is to be defined as the Consul documentation requires. | {"type": "object"} |
prometheus.json | digitalocean_sd_configs | List of DigitalOcean service discovery configurations. | {"type": ["array", "null"], "items": {"type": "object"}} |
prometheus.json | items | The information to access the DigitalOcean API. | {"type": "object"} |
prometheus.json | docker_sd_configs | List of Docker service discovery configurations. | {"type": ["array", "null"], "items": {"type": "object"}} |
prometheus.json | items | Docker SD configurations allow retrieving scrape targets from Docker Engine hosts. | {"type": "object"} |
prometheus.json | dockerswarm_sd_configs | List of Docker Swarm service discovery configurations. | {"type": ["array", "null"], "items": {"type": "object"}} |
prometheus.json | items | Docker Swarm SD configurations allow retrieving scrape targets from Docker Swarm engine. | {"type": "object"} |
prometheus.json | dns_sd_configs | List of DNS service discovery configurations. | {"type": ["array", "null"], "items": {"type": "object", "properties": {"names": {"type": "array", "items": {"type": "string"}, "minItems": 1}, "type": {"type": ["string", "null"], "enum": ["SRV", "A", "AAAA"], "default": "SRV"}, "port": {"type": ["integer", "null"]}, "refresh_interval": {"default": "30s"}}, "required": ["names"], "additionalProperties": false}} |
prometheus.json | items | A DNS-based service discovery configuration allows specifying a set of DNS domain names which are periodically queried to discover a list of targets. The DNS servers to be contacted are read from /etc/resolv.conf. This service discovery method only supports basic DNS A, AAAA and SRV record queries, but not the advanced DNS-SD approach specified in RFC6763. During the relabeling phase, the meta label __meta_dns_name is available on each target and is set to the record name that produced the discovered target. | {"type": "object", "properties": {"names": {"type": "array", "items": {"type": "string"}, "minItems": 1}, "type": {"type": ["string", "null"], "enum": ["SRV", "A", "AAAA"], "default": "SRV"}, "port": {"type": ["integer", "null"]}, "refresh_interval": {"default": "30s"}}, "required": ["names"], "additionalProperties": false} |
prometheus.json | names | A list of DNS domain names to be queried. | {"type": "array", "items": {"type": "string"}, "minItems": 1} |
prometheus.json | type | The type of DNS query to perform. One of SRV, A, or AAAA. | {"type": ["string", "null"], "enum": ["SRV", "A", "AAAA"], "default": "SRV"} |
prometheus.json | port | The port number used if the query type is not SRV. | {"type": ["integer", "null"]} |
prometheus.json | refresh_interval | The time after which the provided names are refreshed. | {"default": "30s"} |
prometheus.json | ec2_sd_configs | List of EC2 service discovery configurations. | {"type": ["array", "null"], "items": {"type": "object"}} |
prometheus.json | items | The information to access the EC2 API. | {"type": "object"} |
prometheus.json | eureka_sd_configs | List of Eureka service discovery configurations. | {"type": ["array", "null"], "items": {"type": "object"}} |
prometheus.json | items | The information to access the Eureka API. | {"type": "object"} |
prometheus.json | file_sd_configs | List of file service discovery configurations. | {"type": ["array", "null"], "items": {"type": "object", "properties": {"files": {"type": "array", "items": {"type": "string"}, "minItems": 1}, "refresh_interval": {"default": "5m"}}}} |
prometheus.json | files | Patterns for files from which target groups are extracted. Where the pattern may be a path ending in .json, .yml or .yaml. The last path segment may contain a single * that matches any character sequence, e.g. my/path/tg_*.json. | {"type": "array", "items": {"type": "string"}, "minItems": 1} |
prometheus.json | refresh_interval | Refresh interval to re-read the files. | {"default": "5m"} |
prometheus.json | gce_sd_configs | List of GCE service discovery configurations. | {"type": ["array", "null"], "items": {"type": "object"}} |
prometheus.json | items | The information to access the GCE API. | {"type": "object"} |
prometheus.json | hetzner_sd_configs | List of Hetzner service discovery configurations. | {"type": ["array", "null"], "items": {"type": "object"}} |
prometheus.json | items | The information to access the Hetzner API. | {"type": "object"} |
prometheus.json | http_sd_configs | List of HTTP service discovery configurations. | {"type": ["array", "null"], "items": {"type": "object", "properties": {"url": {"type": "string", "format": "uri-reference"}, "refresh_interval": {"default": "60s"}, "basic_auth": {}, "authorization": {}, "oauth2": {}, "bearer_token": {}, "bearer_token_file": {}, "proxy_url": {"type": ["string", "null"], "format": "uri-reference"}, "follow_redirects": {"type": ["boolean", "null"], "default": true}, "tls_config": {}}, "required": ["url"], "allOf": [{}], "additionalProperties": false}} |
prometheus.json | items | HTTP-based service discovery provides a more generic way to configure static targets and serves as an interface to plug in custom service discovery mechanisms. | {"type": "object", "properties": {"url": {"type": "string", "format": "uri-reference"}, "refresh_interval": {"default": "60s"}, "basic_auth": {}, "authorization": {}, "oauth2": {}, "bearer_token": {}, "bearer_token_file": {}, "proxy_url": {"type": ["string", "null"], "format": "uri-reference"}, "follow_redirects": {"type": ["boolean", "null"], "default": true}, "tls_config": {}}, "required": ["url"], "allOf": [{}], "additionalProperties": false} |
prometheus.json | url | URL from which the targets are fetched. | {"type": "string", "format": "uri-reference"} |
prometheus.json | refresh_interval | Refresh interval to re-query the endpoint. | {"default": "60s"} |
prometheus.json | proxy_url | Optional proxy URL. | {"type": ["string", "null"], "format": "uri-reference"} |
prometheus.json | follow_redirects | Configure whether HTTP requests follow HTTP 3xx redirects. | {"type": ["boolean", "null"], "default": true} |
prometheus.json | tls_config | TLS configuration. | {} |
prometheus.json | kubernetes_sd_configs | List of Kubernetes service discovery configurations. | {"type": ["array", "null"], "items": {"type": "object", "properties": {"api_server": {"type": ["string", "null"], "format": "uri-reference"}, "role": {"type": "string", "enum": ["endpoints", "service", "pod", "node", "ingress"]}, "kubeconfig_file": {}, "basic_auth": {}, "authorization": {}, "oauth2": {}, "bearer_token": {}, "bearer_token_file": {}, "proxy_url": {"type": ["string", "null"], "format": "uri-reference"}, "follow_redirects": {"type": ["boolean", "null"], "default": true}, "tls_config": {}, "namespaces": {"type": ["object", "null"], "properties": {"own_namespace": {"type": "boolean"}, "names": {"type": "array", "items": {"type": "string"}}}, "additionalProperties": false}, "selectors": {"type": ["array", "null"], "items": {"type": "object", "properties": {"role": {"type": "string"}, "label": {"type": ["string", "null"]}, "field": {"type": ["string", "null"]}}, "required": ["role"], "additionalProperties": false}}}, "allOf": [{}], "additionalProperties": false}} |
prometheus.json | items | The information to access the Kubernetes API. | {"type": "object", "properties": {"api_server": {"type": ["string", "null"], "format": "uri-reference"}, "role": {"type": "string", "enum": ["endpoints", "service", "pod", "node", "ingress"]}, "kubeconfig_file": {}, "basic_auth": {}, "authorization": {}, "oauth2": {}, "bearer_token": {}, "bearer_token_file": {}, "proxy_url": {"type": ["string", "null"], "format": "uri-reference"}, "follow_redirects": {"type": ["boolean", "null"], "default": true}, "tls_config": {}, "namespaces": {"type": ["object", "null"], "properties": {"own_namespace": {"type": "boolean"}, "names": {"type": "array", "items": {"type": "string"}}}, "additionalProperties": false}, "selectors": {"type": ["array", "null"], "items": {"type": "object", "properties": {"role": {"type": "string"}, "label": {"type": ["string", "null"]}, "field": {"type": ["string", "null"]}}, "required": ["role"], "additionalProperties": false}}}, "allOf": [{}], "additionalProperties": false} |
prometheus.json | api_server | The API server addresses. If left empty, Prometheus is assumed to run inside of the cluster and will discover API servers automatically and use the pod's CA certificate and bearer token file at /var/run/secrets/kubernetes.io/serviceaccount/. | {"type": ["string", "null"], "format": "uri-reference"} |
prometheus.json | role | The Kubernetes role of entities that should be discovered. One of endpoints, service, pod, node, or ingress. | {"type": "string", "enum": ["endpoints", "service", "pod", "node", "ingress"]} |
prometheus.json | proxy_url | Optional proxy URL. | {"type": ["string", "null"], "format": "uri-reference"} |
prometheus.json | follow_redirects | Configure whether scrape requests follow HTTP 3xx redirects. | {"type": ["boolean", "null"], "default": true} |
prometheus.json | tls_config | TLS configuration. | {} |
prometheus.json | namespaces | Optional namespace discovery. If omitted, all namespaces are used. | {"type": ["object", "null"], "properties": {"own_namespace": {"type": "boolean"}, "names": {"type": "array", "items": {"type": "string"}}}, "additionalProperties": false} |
prometheus.json | selectors | Optional label and field selectors to limit the discovery process to a subset of available resources. | {"type": ["array", "null"], "items": {"type": "object", "properties": {"role": {"type": "string"}, "label": {"type": ["string", "null"]}, "field": {"type": ["string", "null"]}}, "required": ["role"], "additionalProperties": false}} |
prometheus.json | kuma_sd_configs | List of Kuma service discovery configurations. | {"type": ["array", "null"], "items": {"type": "object"}} |
prometheus.json | items | The information to access the Kuma API. | {"type": "object"} |
prometheus.json | lightsail_sd_configs | List of Lightsail service discovery configurations. | {"type": ["array", "null"], "items": {"type": "object"}} |
prometheus.json | items | The information to access the Lightsail API. | {"type": "object"} |
prometheus.json | linode_sd_configs | List of Linode service discovery configurations. | {"type": ["array", "null"], "items": {"type": "object"}} |
prometheus.json | items | The information to access the Linode API. | {"type": "object"} |
prometheus.json | marathon_sd_configs | List of Marathon service discovery configurations. | {"type": ["array", "null"], "items": {"type": "object"}} |
prometheus.json | nerve_sd_configs | List of AirBnB's Nerve service discovery configurations. | {"type": ["array", "null"], "items": {"type": "object"}} |
prometheus.json | openstack_sd_configs | List of OpenStack service discovery configurations. | {"type": ["array", "null"], "items": {"type": "object"}} |
prometheus.json | items | The information to access the OpenStack API. | {"type": "object"} |
prometheus.json | puppetdb_sd_configs | List of PuppetDB service discovery configurations. | {"type": ["array", "null"], "items": {"type": "object"}} |
prometheus.json | items | The information to access the PuppetDB API. | {"type": "object"} |
prometheus.json | scaleway_sd_configs | List of Scaleway service discovery configurations. | {"type": ["array", "null"], "items": {"type": "object"}} |
prometheus.json | items | The information to access the Scaleway API. | {"type": "object"} |
prometheus.json | serverset_sd_configs | List of Zookeeper Serverset service discovery configurations. | {"type": ["array", "null"], "items": {"type": "object"}} |
prometheus.json | triton_sd_configs | List of Triton service discovery configurations. | {"type": ["array", "null"], "items": {"type": "object"}} |
prometheus.json | items | The information to access the Triton discovery API. | {"type": "object"} |
prometheus.json | uyuni_sd_configs | List of Uyuni service discovery configurations. | {"type": ["array", "null"], "items": {"type": "object"}} |
prometheus.json | items | The information to access the Uyuni API. | {"type": "object"} |
prometheus.json | static_configs | List of labeled statically configured targets for this job. | {"type": ["array", "null"], "items": {"type": "object", "properties": {"targets": {"type": ["array", "null"], "items": {"type": "string"}}, "labels": {}}}} |
prometheus.json | targets | The targets specified by the static config. | {"type": ["array", "null"], "items": {"type": "string"}} |
prometheus.json | labels | Labels assigned to all metrics scraped from the targets. | {} |
prometheus.json | global | The global configuration specifies parameters that are valid in all other configuration contexts. They also serve as defaults for other configuration sections. | {"type": ["object", "null"], "properties": {"scrape_interval": {"default": "1m"}, "scrape_timeout": {"default": "10s"}, "evaluation_interval": {"default": "1m"}, "external_labels": {}, "query_log_file": {}}, "additionalProperties": false} |
prometheus.json | scrape_interval | How frequently to scrape targets by default. | {"default": "1m"} |
prometheus.json | scrape_timeout | How long until a scrape request times out. | {"default": "10s"} |
prometheus.json | evaluation_interval | How frequently to evaluate rules. | {"default": "1m"} |
prometheus.json | external_labels | The labels to add to any time series or alerts when communicating with external systems (federation, remote storage, Alertmanager). | {} |
prometheus.json | query_log_file | File to which PromQL queries are logged. Reloading the configuration will reopen the file. | {} |
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.