Skip to content

Commit

Permalink
Merge pull request #5392 from EnterpriseDB/docs/edits_to_pwr_pr5380
Browse files Browse the repository at this point in the history
Edits to PWR PR5380
  • Loading branch information
nidhibhammar authored Mar 14, 2024
2 parents 2e8155f + be5dc28 commit b152346
Showing 1 changed file with 7 additions and 7 deletions.
14 changes: 7 additions & 7 deletions product_docs/docs/pwr/1/configuring.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -8,35 +8,35 @@ To reduce the number of command-line arguments needed when executing `pwr`, you

## Configuration file locations

Postgres Workload Report looks for a configuration file in the following places, and uses the first one found:
Postgres Workload Report looks for a configuration file in the following places and uses the first one found:

1. The file named in the `--config` command-line option, if given.
2. The file named in the `PWR_CONFIG_FILE` environment variable, if set.
3. `~/.pwr.conf`.
4. `/etc/pwr.conf`.

The installation package creates a template for the configuration file in `/etc/pwr.conf.templ`. We recommend copying this file to one of the
two places where Postgres Workload Report looks for a configuration file by default (locations #3 or #4 in the previous list), and editing the options in the template as necessary.
two places where Postgres Workload Report looks for a configuration file by default (`~/.pwr.conf` and `/etc/pwr.conf`), and editing the options in the template as necessary.

!!! Note
If no configuration file is found, Postgres Workload Report assumes the default value for all options, which can still be overriden via the corresponding command-line options. See [Using Postgres Workload Report](using/) for more on using command-line options.
If no configuration file is found, Postgres Workload Report assumes the default value for all options, which you can still override using the corresponding command-line options. See [Using Postgres Workload Report](using/) for more on using command-line options.
!!!

## Configuration file options

### `input_dir`

An existing directory where the `edb_wait_states` portion of a Lasso report are located. This option is used mainly for `pwr report` execution (see [Using Postgres Workload Report](using)).
An existing directory where the `edb_wait_states` portion of a Lasso report is located. This option is used mainly for `pwr report` execution (see [Using Postgres Workload Report](using)).

### `output_dir`

Location of the directory where Postgres Workload Report writes report files. Executing `pwr` will create this directory if it doesn't exist.
Location of the directory where Postgres Workload Report writes report files. Executing `pwr` creates this directory if it doesn't exist.

### `report_name`

The name of the report files generated. Usually, you would specify this option on the command line because different reports typically have different names.
The name of the report files generated. Usually, you specify this option on the command line because different reports typically have different names.

Don't include a file extension; an appropriate extension will be added will be added based on the output format(s) specified on the command line (`--pdf` adds `.pdf`, `--html` adds `.html`, and so on).
Don't include a file extension. An appropriate extension is added based on the output formats specified on the command line (that is, `--pdf` adds `.pdf`, `--html` adds `.html`, and so on).

### `log_file`

Expand Down

1 comment on commit b152346

@github-actions
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please sign in to comment.