github.com/grafana/pyroscope@v1.18.0/docs/sources/configure-server/reference-configuration-parameters/index.template (about)

     1  ---
     2  description: Describes parameters used to configure Pyroscope.
     3  menuTitle: Configuration parameters
     4  title: Pyroscope configuration parameters
     5  weight: 300
     6  aliases:
     7    - /docs/phlare/latest/operators-guide/configuring/reference-configuration-parameters/
     8    - /docs/phlare/latest/configure-server/reference-configuration-parameters/
     9  ---
    10  
    11  # Pyroscope configuration parameters
    12  
    13  {{ .GeneratedFileWarning }}
    14  
    15  You can configure Pyroscope by using a YAML file or via command-line flags
    16  that represent configuration parameters.
    17  To specify the YAML file, use the `-config.file` command-line option.
    18  If you specify both the command-line flags and YAML configuration parameters,
    19  the command-line flags take precedence over values in a YAML file.
    20  
    21  To see the current configuration of any component,
    22  go to the `/config` HTTP API endpoint.
    23  Passwords are filtered out of this endpoint.
    24  
    25  Parameters are
    26  written in [YAML format](https://en.wikipedia.org/wiki/YAML), and
    27  brackets indicate that a parameter is optional.
    28  
    29  ## Generic placeholders
    30  
    31  - `<boolean>`: a boolean that can take the values `true` or `false`
    32  - `<int>`: any integer matching the regular expression `[1-9]+[0-9]*`
    33  - `<duration>`: a duration matching the regular expression `[0-9]+(ns|us|µs|ms|s|m|h|d|w|y)` where y = 365 days
    34  - `<string>`: a string
    35  - `<url>`: a URL
    36  - `<filepath>`: a string containing an absolute or relative path and filename to a file on disk
    37  - `<prefix>`: a CLI flag prefix based on the context (look at the parent configuration block to see which CLI flags prefix should be used)
    38  - `<relabel_config>`: a [Prometheus relabeling configuration](https://prometheus.io/docs/prometheus/latest/configuration/configuration/#relabel_config)
    39  - `<time>`: a timestamp, with available formats:
    40      - `2006-01-20` (midnight, local timezone)
    41      - `2006-01-20T15:04` (local timezone)
    42      - RFC 3339 formats: `2006-01-20T15:04:05Z` (UTC) or `2006-01-20T15:04:05+07:00` (explicit timezone)
    43  
    44  ## Use environment variables in the configuration
    45  
    46  You can use environment variable references in the YAML configuration file
    47  to set values that need to be configurable during deployment.
    48  To do this, pass `-config.expand-env=true` on the command line and use
    49  `${VAR}`,
    50  where `VAR` is the name of the environment variable.
    51  
    52  Each variable reference is replaced at startup by the value of the environment variable.
    53  The replacement is case-sensitive and occurs before the YAML file is parsed.
    54  References to undefined variables are replaced by empty strings unless you specify a default value or custom error text.
    55  
    56  To specify a default value, use `${VAR:-default_value}`,
    57  where `default_value` is the value to use if the environment variable is undefined.
    58  
    59  ## Configuration parameters
    60  
    61  {{ .ConfigFile }}
    62