From 9e6b772fda30af1b3b08136874caa450d9fe838a Mon Sep 17 00:00:00 2001 From: Cyril Tovena Date: Wed, 30 Aug 2023 11:49:45 +0200 Subject: [PATCH] docs: Removes the old scrape_configs block documentation (#2334) --- .../index.md | 107 ------------------ .../index.template | 107 ------------------ 2 files changed, 214 deletions(-) diff --git a/docs/sources/configure-server/reference-configuration-parameters/index.md b/docs/sources/configure-server/reference-configuration-parameters/index.md index 057381c913..5af226cc01 100644 --- a/docs/sources/configure-server/reference-configuration-parameters/index.md +++ b/docs/sources/configure-server/reference-configuration-parameters/index.md @@ -1754,111 +1754,4 @@ The `filesystem_storage_backend` block configures the usage of local file system [dir: | default = ""] ``` -### Scrape configs - -The root block `scrape_configs` configure the list of scrape config used by the Agent to scrape and push profiles. - -The `scrape_config` block configures a single Agent scrape config. - -```yaml -# The job name assigned to scraped profiles by default. -[job_name: | default = ""] - -# Optional HTTP URL parameters. -params: - [ : [, ...] ] - -# How frequently to scrape targets from this job. -[scrape_interval: | default = 10s] - -# Per-scrape timeout when scraping this job. -[scrape_timeout: | default = 0s] - -# Configures the protocol scheme used for requests. -[scheme: | default = "http"] - -# Configures profile types and their path to scrape for this job. -profiling_config: - pprof_config: - [ : [] - [path_prefix: | default = ""] - -# List of target relabel configurations. -relabel_configs: - [ - ... ] - -# List of labeled statically configured targets for this job. -static_configs: - [ - ... ] - -# List of Kubernetes service discovery configurations. -kubernetes_sd_configs: - [ - ... ] - -# List of HTTP service discovery configurations. -http_sd_configs: - [ - ... ] - -# Sets the `Authorization` header on every scrape request with the -# configured username and password. -# password and password_file are mutually exclusive. -basic_auth: - [ username: ] - [ password: ] - [ password_file: ] - -# Sets the `Authorization` header on every scrape request with -# the configured credentials. -authorization: - # Sets the authentication type of the request. - [ type: | default: Bearer ] - # Sets the credentials of the request. It is mutually exclusive with - # `credentials_file`. - [ credentials: ] - # Sets the credentials of the request with the credentials read from the - # configured file. It is mutually exclusive with `credentials`. - [ credentials_file: ] - -# Optional OAuth 2.0 configuration. -# Cannot be used at the same time as basic_auth or authorization. -oauth2: - [ ] - -# Configure whether scrape requests follow HTTP 3xx redirects. -[ follow_redirects: | default = true ] - -# Whether to enable HTTP2. -[ enable_http2: | default: true ] - -# Configures the scrape request's TLS settings. -tls_config: - [ ] - -# Optional proxy URL. -[ proxy_url: ] -``` - -You can refer to the Prometheus documentation the following block: - -- [relabel_config](https://prometheus.io/docs/prometheus/latest/configuration/configuration/#relabel_config) -- [static_config](https://prometheus.io/docs/prometheus/latest/configuration/configuration/#static_config) -- [kubernetes_sd_config](https://prometheus.io/docs/prometheus/latest/configuration/configuration/#kubernetes_sd_config) -- [http_sd_config](https://prometheus.io/docs/prometheus/latest/configuration/configuration/#http_sd_config) - -#### pprof_config - -The block `pprof_config` configure a single pprof scraping configuration. - -```yaml -# Whether to enable this profile type scraping. -[enabled: ] - -# Configures the path to scrape this profile type. -[path: ] - -# Whether this profile type is a delta. -# A delta profile type means the profile data contains data only for the scraping period. -# A seconds URL parameters will be added to all delta profile type scraping to notify the endpoint -# the period of scraping. -[delta: ] ``` diff --git a/docs/sources/configure-server/reference-configuration-parameters/index.template b/docs/sources/configure-server/reference-configuration-parameters/index.template index 32fa09214a..61462c154f 100644 --- a/docs/sources/configure-server/reference-configuration-parameters/index.template +++ b/docs/sources/configure-server/reference-configuration-parameters/index.template @@ -60,111 +60,4 @@ where `default_value` is the value to use if the environment variable is undefin {{ .ConfigFile }} -### Scrape configs - -The root block `scrape_configs` configure the list of scrape config used by the Agent to scrape and push profiles. - -The `scrape_config` block configures a single Agent scrape config. - -```yaml -# The job name assigned to scraped profiles by default. -[job_name: | default = ""] - -# Optional HTTP URL parameters. -params: - [ : [, ...] ] - -# How frequently to scrape targets from this job. -[scrape_interval: | default = 10s] - -# Per-scrape timeout when scraping this job. -[scrape_timeout: | default = 0s] - -# Configures the protocol scheme used for requests. -[scheme: | default = "http"] - -# Configures profile types and their path to scrape for this job. -profiling_config: - pprof_config: - [ : [] - [path_prefix: | default = ""] - -# List of target relabel configurations. -relabel_configs: - [ - ... ] - -# List of labeled statically configured targets for this job. -static_configs: - [ - ... ] - -# List of Kubernetes service discovery configurations. -kubernetes_sd_configs: - [ - ... ] - -# List of HTTP service discovery configurations. -http_sd_configs: - [ - ... ] - -# Sets the `Authorization` header on every scrape request with the -# configured username and password. -# password and password_file are mutually exclusive. -basic_auth: - [ username: ] - [ password: ] - [ password_file: ] - -# Sets the `Authorization` header on every scrape request with -# the configured credentials. -authorization: - # Sets the authentication type of the request. - [ type: | default: Bearer ] - # Sets the credentials of the request. It is mutually exclusive with - # `credentials_file`. - [ credentials: ] - # Sets the credentials of the request with the credentials read from the - # configured file. It is mutually exclusive with `credentials`. - [ credentials_file: ] - -# Optional OAuth 2.0 configuration. -# Cannot be used at the same time as basic_auth or authorization. -oauth2: - [ ] - -# Configure whether scrape requests follow HTTP 3xx redirects. -[ follow_redirects: | default = true ] - -# Whether to enable HTTP2. -[ enable_http2: | default: true ] - -# Configures the scrape request's TLS settings. -tls_config: - [ ] - -# Optional proxy URL. -[ proxy_url: ] -``` - -You can refer to the Prometheus documentation the following block: - -- [relabel_config](https://prometheus.io/docs/prometheus/latest/configuration/configuration/#relabel_config) -- [static_config](https://prometheus.io/docs/prometheus/latest/configuration/configuration/#static_config) -- [kubernetes_sd_config](https://prometheus.io/docs/prometheus/latest/configuration/configuration/#kubernetes_sd_config) -- [http_sd_config](https://prometheus.io/docs/prometheus/latest/configuration/configuration/#http_sd_config) - -#### pprof_config - -The block `pprof_config` configure a single pprof scraping configuration. - -```yaml -# Whether to enable this profile type scraping. -[enabled: ] - -# Configures the path to scrape this profile type. -[path: ] - -# Whether this profile type is a delta. -# A delta profile type means the profile data contains data only for the scraping period. -# A seconds URL parameters will be added to all delta profile type scraping to notify the endpoint -# the period of scraping. -[delta: ] ```