schema stringclasses 471
values | key stringlengths 0 203 | description stringlengths 0 4.37k | object stringlengths 2 322k |
|---|---|---|---|
prometheus.json | rule_files | Rule files specifies a list of globs. Rules and alerts are read from all matching files. | {"type": ["array", "null"], "items": {}} |
prometheus.json | remote_write | Settings related to the remote write feature. | {"type": ["array", "null"], "items": {"type": "object", "properties": {"url": {"type": "string", "format": "uri-reference"}, "remote_timeout": {"default": "30s"}, "headers": {"type": ["object", "null"], "additionalProperties": {"type": "string"}}, "write_relabel_configs": {}, "name": {"type": ["string", "null"]}, "send_exemplars": {"type": ["boolean", "null"], "default": false}, "basic_auth": {}, "authorization": {}, "sigv4": {}, "oauth2": {}, "bearer_token": {}, "bearer_token_file": {}, "tls_config": {}, "proxy_url": {"type": ["string", "null"], "format": "uri-reference"}, "follow_redirects": {"type": ["boolean", "null"], "default": true}, "queue_config": {"type": ["object", "null"], "properties": {"capacity": {"type": ["integer", "null"], "default": 2500}, "max_shards": {"type": ["integer", "null"], "default": 200}, "min_shards": {"type": ["integer", "null"], "default": 1}, "max_samples_per_send": {"type": ["integer", "null"], "default": 500}, "batch_send_deadline": {"default": "5s"}, "min_backoff": {"default": "30ms"}, "max_backoff": {"default": "5s"}, "retry_on_http_429": {"type": ["boolean", "null"], "default": false}}, "additionalProperties": false}, "metadata_config": {"type": ["object", "null"], "properties": {"send": {"type": ["boolean", "null"], "default": true}, "send_interval": {"default": "1m"}, "max_samples_per_send": {"type": ["integer", "null"], "default": 500}}, "additionalProperties": false}}, "allOf": [{}], "additionalProperties": false, "required": ["url"]}} |
prometheus.json | url | The URL of the endpoint to send samples to. | {"type": "string", "format": "uri-reference"} |
prometheus.json | remote_timeout | Timeout for requests to the remote write endpoint. | {"default": "30s"} |
prometheus.json | headers | Custom HTTP headers to be sent along with each remote write request. Be aware that headers that are set by Prometheus itself can't be overwritten. | {"type": ["object", "null"], "additionalProperties": {"type": "string"}} |
prometheus.json | write_relabel_configs | List of remote write relabel configurations. | {} |
prometheus.json | name | Name of the remote write config, which if specified must be unique among remote write configs. The name will be used in metrics and logging in place of a generated value to help users distinguish between remote write configs. | {"type": ["string", "null"]} |
prometheus.json | send_exemplars | Enables sending of exemplars over remote write. Note that exemplar storage itself must be enabled for exemplars to be scraped in the first place. | {"type": ["boolean", "null"], "default": false} |
prometheus.json | tls_config | Configures the remote write request's TLS settings. | {} |
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 | queue_config | Configures the queue used to write to remote storage. | {"type": ["object", "null"], "properties": {"capacity": {"type": ["integer", "null"], "default": 2500}, "max_shards": {"type": ["integer", "null"], "default": 200}, "min_shards": {"type": ["integer", "null"], "default": 1}, "max_samples_per_send": {"type": ["integer", "null"], "default": 500}, "batch_send_deadline": {"default": "5s"}, "min_backoff": {"default": "30ms"}, "max_backoff": {"default": "5s"}, "retry_on_http_429": {"type": ["boolean", "null"], "default": false}}, "additionalProperties": false} |
prometheus.json | capacity | Number of samples to buffer per shard before we block reading of more samples from the WAL. It is recommended to have enough capacity in each shard to buffer several requests to keep throughput up while processing occasional slow remote requests. | {"type": ["integer", "null"], "default": 2500} |
prometheus.json | max_shards | Maximum number of shards, i.e. amount of concurrency. | {"type": ["integer", "null"], "default": 200} |
prometheus.json | min_shards | Minimum number of shards, i.e. amount of concurrency. | {"type": ["integer", "null"], "default": 1} |
prometheus.json | max_samples_per_send | Maximum number of samples per send. | {"type": ["integer", "null"], "default": 500} |
prometheus.json | batch_send_deadline | Maximum time a sample will wait in buffer. | {"default": "5s"} |
prometheus.json | min_backoff | Initial retry delay. Gets doubled for every retry. | {"default": "30ms"} |
prometheus.json | max_backoff | Maximum retry delay. | {"default": "5s"} |
prometheus.json | retry_on_http_429 | Retry upon receiving a 429 status code from the remote-write storage. | {"type": ["boolean", "null"], "default": false} |
prometheus.json | metadata_config | Configures the sending of series metadata to remote storage. | {"type": ["object", "null"], "properties": {"send": {"type": ["boolean", "null"], "default": true}, "send_interval": {"default": "1m"}, "max_samples_per_send": {"type": ["integer", "null"], "default": 500}}, "additionalProperties": false} |
prometheus.json | send | Whether metric metadata is sent to remote storage or not. | {"type": ["boolean", "null"], "default": true} |
prometheus.json | send_interval | How frequently metric metadata is sent to remote storage. | {"default": "1m"} |
prometheus.json | max_samples_per_send | Maximum number of samples per send. | {"type": ["integer", "null"], "default": 500} |
prometheus.json | remote_read | Settings related to the remote read feature. | {"type": ["array", "null"], "items": {"type": "object", "properties": {"url": {"type": "string", "format": "uri-reference"}, "name": {"type": ["string", "null"]}, "required_matchers": {}, "remote_timeout": {"default": "1m"}, "headers": {"type": ["object", "null"], "additionalProperties": {"type": "string"}}, "read_recent": {"type": ["boolean", "null"], "default": false}, "basic_auth": {}, "authorization": {}, "oauth2": {}, "bearer_token": {}, "bearer_token_file": {}, "tls_config": {}, "proxy_url": {"type": ["string", "null"], "format": "uri-reference"}, "follow_redirects": {"type": ["boolean", "null"], "default": true}}, "allOf": [{}], "additionalProperties": false, "required": ["url"]}} |
prometheus.json | url | The URL of the endpoint to query from. | {"type": "string", "format": "uri-reference"} |
prometheus.json | name | Name of the remote read config, which if specified must be unique among remote read configs. The name will be used in metrics and logging in place of a generated value to help users distinguish between remote read configs. | {"type": ["string", "null"]} |
prometheus.json | required_matchers | An optional list of equality matchers which have to be present in a selector to query the remote read endpoint. | {} |
prometheus.json | remote_timeout | Timeout for requests to the remote read endpoint. | {"default": "1m"} |
prometheus.json | headers | Custom HTTP headers to be sent along with each remote read request. Be aware that headers that are set by Prometheus itself can't be overwritten. | {"type": ["object", "null"], "additionalProperties": {"type": "string"}} |
prometheus.json | read_recent | Whether reads should be made for queries for time ranges that the local storage should have complete data for. | {"type": ["boolean", "null"], "default": false} |
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 | scrape_config_files | Scrape config files specifies a list of globs. Scrape configs are read from all matching files and appended to the list of scrape configs. | {"type": ["array", "null"], "items": {}} |
prometheus.json | scrape_configs | A list of scrape configurations. | {"type": ["array", "null"], "items": {"type": "object", "properties": {"job_name": {"type": "string"}, "scrape_interval": {}, "scrape_timeout": {}, "metrics_path": {"type": ["string", "null"], "default": "/metrics"}, "honor_labels": {"type": ["boolean", "null"], "default": false}, "honor_timestamps": {"type": ["boolean", "null"], "default": true}, "scheme": {"default": "http"}, "params": {"type": ["object", "null"], "additionalProperties": {"type": "array", "items": {"type": "string"}}}, "basic_auth": {}, "authorization": {}, "oauth2": {}, "bearer_token": {}, "bearer_token_file": {}, "follow_redirects": {"type": ["boolean", "null"], "default": true}, "tls_config": {}, "proxy_url": {"type": ["string", "null"], "format": "uri-reference"}, "azure_sd_configs": {}, "consul_sd_configs": {}, "digitalocean_sd_configs": {}, "docker_sd_configs": {}, "dockerswarm_sd_configs": {}, "dns_sd_configs": {}, "ec2_sd_configs": {}, "eureka_sd_configs": {}, "file_sd_configs": {}, "gce_sd_configs": {}, "hetzner_sd_configs": {}, "http_sd_configs": {}, "kubernetes_sd_configs": {}, "kuma_sd_configs": {}, "lightsail_sd_configs": {}, "linode_sd_configs": {}, "marathon_sd_configs": {}, "nerve_sd_configs": {}, "openstack_sd_configs": {}, "puppetdb_sd_configs": {}, "scaleway_sd_configs": {}, "serverset_sd_configs": {}, "triton_sd_configs": {}, "uyuni_sd_configs": {}, "static_configs": {}, "relabel_configs": {}, "metric_relabel_configs": {}, "body_size_limit": {"type": ["integer", "null"], "default": 0}, "sample_limit": {"type": ["integer", "null"], "default": 0}, "label_limit": {"type": ["integer", "null"], "default": 0}, "label_name_length_limit": {"type": ["integer", "null"], "default": 0}, "label_value_length_limit": {"type": ["integer", "null"], "default": 0}, "target_limit": {"type": ["integer", "null"], "default": 0}}, "allOf": [{}], "additionalProperties": false, "required": ["job_name"]}} |
prometheus.json | job_name | The job name assigned to scraped metrics by default. Must be unique across all scrape configurations. | {"type": "string"} |
prometheus.json | scrape_interval | How frequently to scrape targets from this job. Defaults to `global.scrape_interval`. | {} |
prometheus.json | scrape_timeout | Per-scrape timeout when scraping this job. Defaults to `global.scrape_timeout`. | {} |
prometheus.json | metrics_path | The HTTP resource path on which to fetch metrics from targets. | {"type": ["string", "null"], "default": "/metrics"} |
prometheus.json | honor_labels | Controls how Prometheus handles conflicts between labels that are already present in scraped data and labels that Prometheus would attach server-side ("job" and "instance" labels, manually configured target labels, and labels generated by service discovery implementations). | {"type": ["boolean", "null"], "default": false} |
prometheus.json | honor_timestamps | Controls whether Prometheus respects the timestamps present in scraped data. | {"type": ["boolean", "null"], "default": true} |
prometheus.json | scheme | Configures the protocol scheme used for requests. | {"default": "http"} |
prometheus.json | params | Optional HTTP URL parameters. | {"type": ["object", "null"], "additionalProperties": {"type": "array", "items": {"type": "string"}}} |
prometheus.json | follow_redirects | Configure whether scrape requests follow HTTP 3xx redirects. | {"type": ["boolean", "null"], "default": true} |
prometheus.json | tls_config | Configures the scrape request's TLS settings. | {} |
prometheus.json | proxy_url | Optional proxy URL. | {"type": ["string", "null"], "format": "uri-reference"} |
prometheus.json | relabel_configs | List of target relabel configurations. | {} |
prometheus.json | metric_relabel_configs | List of metric relabel configurations. | {} |
prometheus.json | body_size_limit | An uncompressed response body larger than this many bytes will cause the scrape to fail. 0 means no limit. Example: 100MB. | {"type": ["integer", "null"], "default": 0} |
prometheus.json | sample_limit | 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. | {"type": ["integer", "null"], "default": 0} |
prometheus.json | label_limit | 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. | {"type": ["integer", "null"], "default": 0} |
prometheus.json | label_name_length_limit | 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. | {"type": ["integer", "null"], "default": 0} |
prometheus.json | label_value_length_limit | 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. | {"type": ["integer", "null"], "default": 0} |
prometheus.json | target_limit | 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. | {"type": ["integer", "null"], "default": 0} |
prometheus.json | alerting | Alerting specifies settings related to the Alertmanager. | {"type": ["object", "null"], "properties": {"alert_relabel_configs": {}, "alertmanagers": {"type": ["array", "null"], "items": {"type": "object", "properties": {"timeout": {"default": "10s"}, "api_version": {"type": ["string", "null"], "default": "v2"}, "path_prefix": {"type": ["string", "null"], "default": "/"}, "scheme": {"default": "http"}, "basic_auth": {}, "authorization": {}, "oauth2": {}, "bearer_token": {}, "bearer_token_file": {}, "tls_config": {}, "proxy_url": {"type": ["string", "null"], "format": "uri-reference"}, "follow_redirects": {"type": ["boolean", "null"], "default": true}, "azure_sd_configs": {}, "consul_sd_configs": {}, "digitalocean_sd_configs": {}, "docker_sd_configs": {}, "dockerswarm_sd_configs": {}, "dns_sd_configs": {}, "ec2_sd_configs": {}, "eureka_sd_configs": {}, "file_sd_configs": {}, "gce_sd_configs": {}, "hetzner_sd_configs": {}, "http_sd_configs": {}, "kubernetes_sd_configs": {}, "kuma_sd_configs": {}, "lightsail_sd_configs": {}, "linode_sd_configs": {}, "marathon_sd_configs": {}, "nerve_sd_configs": {}, "openstack_sd_configs": {}, "puppetdb_sd_configs": {}, "scaleway_sd_configs": {}, "serverset_sd_configs": {}, "triton_sd_configs": {}, "uyuni_sd_configs": {}, "static_configs": {}, "relabel_configs": {}}, "allOf": [{}]}}}} |
prometheus.json | timeout | Per-target Alertmanager timeout when pushing alerts. | {"default": "10s"} |
prometheus.json | api_version | The api version of Alertmanager. | {"type": ["string", "null"], "default": "v2"} |
prometheus.json | path_prefix | Prefix for the HTTP path alerts are pushed to. | {"type": ["string", "null"], "default": "/"} |
prometheus.json | scheme | Configures the protocol scheme used for requests. | {"default": "http"} |
prometheus.json | tls_config | Configures the scrape request's TLS settings. | {} |
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 | static_configs | List of labeled statically configured Alertmanagers. | {} |
prometheus.json | relabel_configs | List of Alertmanager relabel configurations. | {} |
prometheus.json | storage | Storage related settings that are runtime reloadable. | {"type": ["array", "null"], "items": {"type": "object", "properties": {"max_exemplars": {"type": ["integer", "null"], "default": 100000}}, "additionalProperties": false}} |
foxx-manifest.json | Schema for ArangoDB Foxx service manifests | {"$schema": "http://json-schema.org/draft-04/schema#", "id": "https://json.schemastore.org/foxx-manifest.json", "properties": {"configuration": {"type": "object", "additionalProperties": {"type": "object", "properties": {"type": {"type": "string", "enum": ["integer", "boolean", "number", "string", "json", "password", "int", "bool"], "default": "string"}, "default": {}, "required": {"type": "boolean", "default": true}}, "required": ["type"]}}, "defaultDocument": {"type": "string"}, "dependencies": {"type": "object", "additionalProperties": {"oneOf": [{"type": "string", "default": "*"}, {"type": "object", "properties": {"name": {"type": "string", "default": "*"}, "version": {"type": "string", "default": "*"}, "required": {"type": "boolean", "default": true}, "multiple": {"type": "boolean", "default": false}}}]}}, "provides": {"type": "object", "additionalProperties": {"type": "string", "default": "*"}}, "engines": {"type": "object", "properties": {"arangodb": {"type": "string", "default": "^3.0.0"}}, "additionalProperties": {"type": "string"}}, "files": {"type": "object", "additionalProperties": {"oneOf": [{"type": "string"}, {"type": "object", "properties": {"path": {"type": "string"}, "gzip": {"type": "boolean", "default": false}, "type": {"type": "string"}}, "required": ["path"]}]}}, "lib": {"type": "string", "default": "."}, "main": {"type": "string", "default": "index.js"}, "scripts": {"type": "object", "additionalProperties": {"type": "string"}}, "tests": {"oneOf": [{"type": "string"}, {"type": "array", "items": {"type": "string"}}], "default": "test/**/*.js"}, "author": {"type": "string"}, "contributors": {"type": "array", "items": {"type": "string"}}, "keywords": {"type": "array", "items": {"type": "string"}}, "license": {"type": "string"}, "name": {"type": "string"}, "thumbnail": {"type": "string"}, "version": {"type": "string"}}, "type": "object"} | |
foxx-manifest.json | configuration | An object defining the configuration options this service requires. | {"type": "object", "additionalProperties": {"type": "object", "properties": {"type": {"type": "string", "enum": ["integer", "boolean", "number", "string", "json", "password", "int", "bool"], "default": "string"}, "default": {}, "required": {"type": "boolean", "default": true}}, "required": ["type"]}} |
foxx-manifest.json | description | A human-readable description of the option. | {"type": "string"} |
foxx-manifest.json | type | The type of value expected for this option. | {"type": "string", "enum": ["integer", "boolean", "number", "string", "json", "password", "int", "bool"], "default": "string"} |
foxx-manifest.json | default | The default value for this option in plain JSON. Can be omitted to provide no default value. | {} |
foxx-manifest.json | required | Whether the service can not function without this option. Defaults to true unless a default value is provided. | {"type": "boolean", "default": true} |
foxx-manifest.json | defaultDocument | If specified, the / (root) route of the service will automatically redirect to the given relative path, e.g. "index.html". | {"type": "string"} |
foxx-manifest.json | dependencies | The dependencies this service uses, i.e. which APIs its dependencies need to be compatible with. | {"type": "object", "additionalProperties": {"oneOf": [{"type": "string", "default": "*"}, {"type": "object", "properties": {"name": {"type": "string", "default": "*"}, "version": {"type": "string", "default": "*"}, "required": {"type": "boolean", "default": true}, "multiple": {"type": "boolean", "default": false}}}]}} |
foxx-manifest.json | additionalProperties | The semantic version ranges of the API the service expects. | {"type": "string", "default": "*"} |
foxx-manifest.json | name | Name of the API the service expects. | {"type": "string", "default": "*"} |
foxx-manifest.json | version | The semantic version ranges of the API the service expects. | {"type": "string", "default": "*"} |
foxx-manifest.json | description | A description of how the API is used or why it is needed. | {"type": "string"} |
foxx-manifest.json | required | Whether the service can not function without this dependency. | {"type": "boolean", "default": true} |
foxx-manifest.json | multiple | Whether the dependency can be specified more than once. | {"type": "boolean", "default": false} |
foxx-manifest.json | provides | The dependencies this provides, i.e. which APIs it claims to be compatible with. | {"type": "object", "additionalProperties": {"type": "string", "default": "*"}} |
foxx-manifest.json | additionalProperties | The semantic version ranges of the API the service implements. | {"type": "string", "default": "*"} |
foxx-manifest.json | engines | An object indicating the semantic version ranges of ArangoDB (or compatible environments) the service will be compatible with. | {"type": "object", "properties": {"arangodb": {"type": "string", "default": "^3.0.0"}}, "additionalProperties": {"type": "string"}} |
foxx-manifest.json | files | An object defining file assets served by this service. | {"type": "object", "additionalProperties": {"oneOf": [{"type": "string"}, {"type": "object", "properties": {"path": {"type": "string"}, "gzip": {"type": "boolean", "default": false}, "type": {"type": "string"}}, "required": ["path"]}]}} |
foxx-manifest.json | additionalProperties | Relative path of the file or folder within the service. | {"type": "string"} |
foxx-manifest.json | path | Relative path of the file or folder within the service. | {"type": "string"} |
foxx-manifest.json | gzip | If set to true the file will be served with gzip-encoding if supported by the client. This can be useful when serving text files like client-side JavaScript, CSS or HTML. | {"type": "boolean", "default": false} |
foxx-manifest.json | type | The MIME content type of the file. Defaults to an intelligent guess based on the filename's extension. | {"type": "string"} |
foxx-manifest.json | lib | The relative path to the Foxx JavaScript files in the service, e.g. "lib". Defaults to the folder containing this manifest. | {"type": "string", "default": "."} |
foxx-manifest.json | main | The relative path to the main entry point of this service (relative to lib), e.g. "index.js". | {"type": "string", "default": "index.js"} |
foxx-manifest.json | scripts | An object defining named scripts provided by this service, which can either be used directly or as queued jobs by other services. | {"type": "object", "additionalProperties": {"type": "string"}} |
foxx-manifest.json | additionalProperties | Path of the script (relative to lib), e.g. "scripts/setup.js". | {"type": "string"} |
foxx-manifest.json | tests | A path/pattern or list of paths/patterns of JavaScript tests provided for this service. | {"oneOf": [{"type": "string"}, {"type": "array", "items": {"type": "string"}}], "default": "test/**/*.js"} |
foxx-manifest.json | items | A single path/pattern of JavaScript tests provided for this service. | {"type": "string"} |
foxx-manifest.json | author | The full name of the author of the service (i.e. you). This will be shown in the web interface. | {"type": "string"} |
foxx-manifest.json | contributors | A list of names of people that have contributed to the development of the service in some way. This will be shown in the web interface. | {"type": "array", "items": {"type": "string"}} |
foxx-manifest.json | items | Human-readable representation of the contributor, e.g. their name. | {"type": "string"} |
foxx-manifest.json | description | A human-readable description of the service. This will be shown in the web interface. | {"type": "string"} |
foxx-manifest.json | keywords | A list of keywords that help categorize this service. This is used by the Foxx Store installers to organize services. | {"type": "array", "items": {"type": "string"}} |
foxx-manifest.json | items | A keyword relevant to the service. | {"type": "string"} |
foxx-manifest.json | license | A string identifying the license under which the service is published, ideally in the form of an SPDX license identifier. This will be shown in the web interface. | {"type": "string"} |
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.