Skip to content

Commit

Permalink
docs: Removes the old scrape_configs block documentation (#2334)
Browse files Browse the repository at this point in the history
  • Loading branch information
cyriltovena authored Aug 30, 2023
1 parent 2ef529c commit 9e6b772
Show file tree
Hide file tree
Showing 2 changed files with 0 additions and 214 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -1754,111 +1754,4 @@ The `filesystem_storage_backend` block configures the usage of local file system
[dir: <string> | 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: <string> | default = ""]
# Optional HTTP URL parameters.
params:
[ <string>: [<string>, ...] ]
# How frequently to scrape targets from this job.
[scrape_interval: <duration> | default = 10s]
# Per-scrape timeout when scraping this job.
[scrape_timeout: <duration> | default = 0s]
# Configures the protocol scheme used for requests.
[scheme: <string> | default = "http"]
# Configures profile types and their path to scrape for this job.
profiling_config:
pprof_config:
[ <string>: [<pprof_config>]
[path_prefix: <string> | default = ""]
# List of target relabel configurations.
relabel_configs:
[ - <relabel_config> ... ]
# List of labeled statically configured targets for this job.
static_configs:
[ - <static_config> ... ]
# List of Kubernetes service discovery configurations.
kubernetes_sd_configs:
[ - <kubernetes_sd_config> ... ]
# List of HTTP service discovery configurations.
http_sd_configs:
[ - <http_sd_config> ... ]
# Sets the `Authorization` header on every scrape request with the
# configured username and password.
# password and password_file are mutually exclusive.
basic_auth:
[ username: <string> ]
[ password: <secret> ]
[ password_file: <string> ]

# Sets the `Authorization` header on every scrape request with
# the configured credentials.
authorization:
# Sets the authentication type of the request.
[ type: <string> | default: Bearer ]
# Sets the credentials of the request. It is mutually exclusive with
# `credentials_file`.
[ credentials: <secret> ]
# Sets the credentials of the request with the credentials read from the
# configured file. It is mutually exclusive with `credentials`.
[ credentials_file: <filename> ]

# Optional OAuth 2.0 configuration.
# Cannot be used at the same time as basic_auth or authorization.
oauth2:
[ <oauth2> ]

# Configure whether scrape requests follow HTTP 3xx redirects.
[ follow_redirects: <boolean> | default = true ]

# Whether to enable HTTP2.
[ enable_http2: <bool> | default: true ]

# Configures the scrape request's TLS settings.
tls_config:
[ <tls_config> ]

# Optional proxy URL.
[ proxy_url: <string> ]
```
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: <bool | default: none>]
# Configures the path to scrape this profile type.
[path: <string | default: none>]
# 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: <bool | default: false>]
```
Original file line number Diff line number Diff line change
Expand Up @@ -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: <string> | default = ""]

# Optional HTTP URL parameters.
params:
[ <string>: [<string>, ...] ]

# How frequently to scrape targets from this job.
[scrape_interval: <duration> | default = 10s]

# Per-scrape timeout when scraping this job.
[scrape_timeout: <duration> | default = 0s]

# Configures the protocol scheme used for requests.
[scheme: <string> | default = "http"]

# Configures profile types and their path to scrape for this job.
profiling_config:
pprof_config:
[ <string>: [<pprof_config>]
[path_prefix: <string> | default = ""]

# List of target relabel configurations.
relabel_configs:
[ - <relabel_config> ... ]

# List of labeled statically configured targets for this job.
static_configs:
[ - <static_config> ... ]

# List of Kubernetes service discovery configurations.
kubernetes_sd_configs:
[ - <kubernetes_sd_config> ... ]

# List of HTTP service discovery configurations.
http_sd_configs:
[ - <http_sd_config> ... ]

# Sets the `Authorization` header on every scrape request with the
# configured username and password.
# password and password_file are mutually exclusive.
basic_auth:
[ username: <string> ]
[ password: <secret> ]
[ password_file: <string> ]

# Sets the `Authorization` header on every scrape request with
# the configured credentials.
authorization:
# Sets the authentication type of the request.
[ type: <string> | default: Bearer ]
# Sets the credentials of the request. It is mutually exclusive with
# `credentials_file`.
[ credentials: <secret> ]
# Sets the credentials of the request with the credentials read from the
# configured file. It is mutually exclusive with `credentials`.
[ credentials_file: <filename> ]

# Optional OAuth 2.0 configuration.
# Cannot be used at the same time as basic_auth or authorization.
oauth2:
[ <oauth2> ]

# Configure whether scrape requests follow HTTP 3xx redirects.
[ follow_redirects: <boolean> | default = true ]

# Whether to enable HTTP2.
[ enable_http2: <bool> | default: true ]

# Configures the scrape request's TLS settings.
tls_config:
[ <tls_config> ]

# Optional proxy URL.
[ proxy_url: <string> ]
```

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: <bool | default: none>]

# Configures the path to scrape this profile type.
[path: <string | default: none>]

# 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: <bool | default: false>]
```

0 comments on commit 9e6b772

Please sign in to comment.