Merge pull request #5609 from EnterpriseDB/docs/PWR-release-1.1.0

PWR release 1.1.0
EnterpriseDB · May 15, 2024 · 96a0212 · 96a0212 · github-actions · May 15, 2024
2 parents 332c1bb + 00ad0c0
commit 96a0212
Show file tree

Hide file tree

Showing 4 changed files with 33 additions and 2 deletions.
diff --git a/product_docs/docs/pwr/1/configuring.mdx b/product_docs/docs/pwr/1/configuring.mdx
@@ -6,6 +6,10 @@ description: "How to configure Postgres Workload Report after installation"
 
 To reduce the number of command-line arguments needed when executing `pwr`, you can use a configuration file to specify options that always have the same value and whose values differ from the default.
 
+!!! Note
+`edb-lasso` requires a configuration file to be present to work properly. If not configured correctly, `pwr` will fail to complete. Please refer to the [lasso documentation](https://www.enterprisedb.com/docs/lasso/latest/configuration/) for more information on how to configure it.
+!!!
+
 ## Configuration file locations
 
 Postgres Workload Report looks for a configuration file in the following places and uses the first one found:

diff --git a/product_docs/docs/pwr/1/rel_notes/110_rel_notes.mdx b/product_docs/docs/pwr/1/rel_notes/110_rel_notes.mdx
@@ -0,0 +1,21 @@
+---
+title: "Postgres Workload Report 1.1.0 release notes"
+navTitle: Version 1.1.0
+---
+
+Released: 15 May 2024
+
+New features, enhancements, bug fixes, and other changes in Postgres Workload Report 1.1.0 include:
+
+|       Type        |                                            Description                                                                                                  |
+| ----------------- |-------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| Feature    | Add locking to PWR commands to avoid concurrent runs |
+| Change     | Changed the default value for the `assets_dir` config parameter to use the folder where packages place the assets  (`/usr/share/pwr/assets`) |
+| Change     | Added the `--use-plain-report-name` option to `execute` and `report` commands. This will bypass the default behavior of appending the database name and report timestamp to the report name |
+| Change     | Rework of pwr output and logging |
+| Bug Fix    | Fixed RPM package to have a strict dependency on `edb-lasso` >= 4.13.0 |
+| Bug Fix    | Fixed PWR to not fail when `edb_wait_states` has no samples in the range |
+| Bug Fix    | Fix issues when using timestamp without time zone |
+| Bug Fix    | Fix issues related with configuration handling |
+| Bug Fix    | Fix issue with `pwr report` failing if `--output-directory` does not exist |
+
diff --git a/product_docs/docs/pwr/1/rel_notes/index.mdx b/product_docs/docs/pwr/1/rel_notes/index.mdx
@@ -8,5 +8,6 @@ description: "Release notes for Postgres Workload Report"
 The Postgres Workload Report (PWR) documentation describes the latest version of PWR 1, including minor releases and patches. The release notes provide information on what was new in each release. For new functionality introduced in a minor or patch release, indicators in the content provide information about the release that introduced the feature.
 
 | Version                   | Release date | 
-| ------------------------- | ------------ | 
+| ------------------------- | ------------ |
+| [1.1.0](110_rel_notes)    | 15 May 2024  |
 | [1.0.0](100_rel_notes)    | 15 Feb 2024  | 
diff --git a/product_docs/docs/pwr/1/using.mdx b/product_docs/docs/pwr/1/using.mdx
@@ -33,13 +33,18 @@ pwr execute --host-name myserver --sampling-start '2024-01-10 09:00:00+00:00' \
 ```
 
 !!! Note
-`--sampling-start` and `--sampling-end` accept both timestamps with or without time zone. If no time zone is explicitly set in the timestamp(s), PWR uses the system time zone.
+`--sampling-start` and `--sampling-end` accept timestamps with or without time zone. If no time zone is explicitly set in the timestamp(s), PWR uses the system time zone.
 !!!
 
 Run `pwr execute -h` to get the full list of options available.
 
 ## Example for the `report` option
 
+!!! Note
+To avoid overwriting previous reports, the `pwr execute` command will append the database name and a timestamp with the format `%Y%m%d%H%M%S` (e.g. `March_report-mydatabase-20240321-133727.html`) to the report name provided.
+To avoid this behavior, the user can use the `--use-plain-report-name` option when executing `pwr execute`.
+!!!
+
 In some cases, you already have a Lasso report and want PWR to use the Lasso report as the source and build a report based on it. For these cases, the `pwr report` option is useful.
 
 This example uses the same scenario already described but uses a Lasso report that was executed using the time boundaries in the previous example. Suppose that the Lasso report's name is `edb-lasso-Jan10-incident.tar.bz2` and is located in the home directory of the machine where `pwr report` will be executed.