You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: advocacy_docs/pg_extensions/wait_states/index.mdx
+3-1Lines changed: 3 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -3,7 +3,9 @@ title: EDB Wait States
3
3
indexCards: none
4
4
directoryDefaults:
5
5
product: EDB Wait States
6
-
6
+
navigation:
7
+
- installing
8
+
- using
7
9
---
8
10
9
11
EDB Wait States is a tool for analyzing performance and tuning by allowing the collection and querying of wait event data. Wait events, introduced in PostgreSQL 9.6, are recorded alongside other session activity and provide a snapshot of whether a session is waiting for I/O, CPU, IPC, locks, or timeouts. Snapshots of this information are gathered by the EDB Wait States background worker (BGW) at regular intervals.
-`<install-package-name>` is the name of the Postgres distribution you're using. In the package names `<version>` is the version of the Postgres distribution.
27
+
28
+
| Type of Postgres distribution | Install command |
1. To launch the worker, register it in the `postgresql.conf` file using the `shared_preload_libraries` parameter. For example:
13
42
14
43
```ini
@@ -23,13 +52,51 @@ To install EDB Wait States on a Linux system:
23
52
CREATE EXTENSION edb_wait_states;
24
53
```
25
54
26
-
1. To terminate the EDB Wait States worker, remove `$libdir/edb_wait_states` from the `shared_preload_libraries` parameter, and restart the database server.
55
+
## On Debian and Ubuntu
27
56
28
-
## On Windows
57
+
To install EDB Wait States on Debian or Ubuntu:
58
+
59
+
1. Enter the following command:
60
+
61
+
```shell
62
+
sudo apt-get -y install <install-package-name>
63
+
```
64
+
65
+
Where:
66
+
67
+
`<install-package-name>` is the name of the Postgres distribution you're using. In the package names `<version>` is the version of the Postgres distribution.
68
+
69
+
| Type of Postgres distribution | Install command |
1. Restart the database server. After a successful restart, the background worker begins collecting data.
29
89
30
-
To install EDB Wait States on a Windows system:
90
+
1.To review the data, create the following extension:
31
91
32
-
1. To install the EDB Wait States module with the `EDB Modules` installer, invoke the StackBuilder Plus utility. Follow the onscreen instructions to finish installing the `EDB Modules`.
92
+
```sql
93
+
CREATE EXTENSION edb_wait_states;
94
+
```
95
+
96
+
97
+
## On Windows
98
+
99
+
An EDB Postgres Advanced Server installation includes support for EDB Wait States. After installing EDB Postgres Advanced Server, some additional steps are necessary to activate EDB Wait States.
33
100
34
101
1. To register the worker, modify the `postgresql.conf` file to include the EDB Wait States library in the `shared_preload_libraries` configuration parameter. The parameter value must include:
35
102
@@ -40,9 +107,11 @@ To install EDB Wait States on a Windows system:
40
107
The EDB Wait States installation places the `edb_wait_states.dll` library file in the following path:
41
108
42
109
```text
43
-
C:\Program Files\edb\as14\lib\
110
+
C:\Program Files\edb\as<xx>\lib\
44
111
```
45
112
113
+
where `<xx>` is the EDB Postgres Advanced Server version, such as `as16`.
114
+
46
115
1. Restart the database server to make the changes take effect. After a successful restart, the background worker starts and begins collecting the data.
47
116
48
117
1. To view the data, create the following extension:
1. Use the `DROP EXTENSION` command to drop the `edb_wait_states` extension.
65
-
1. Modify the `postgresql.conf` file, removing `$libdir/edb_wait_states.dll` from the `shared_preload_libraries` parameter.
66
-
1. To apply your changes, restart the database server.
134
+
1. Modify the `postgresql.conf` file, removing `$libdir/edb_wait_states` (for Linux) or `$libdir/edb_wait_states.dll` (for Windows) from the `shared_preload_libraries` parameter.
135
+
1. To apply your changes, restart the database server.
0 commit comments