├── LICENSE ├── README.md ├── docker-compose.yml ├── monitoring-pgbouncer.sql └── resources └── images ├── create_server.png ├── docker-compose-up.png ├── monitoring.png └── pgadmin_login.png /LICENSE: -------------------------------------------------------------------------------- 1 | Apache License 2 | Version 2.0, January 2004 3 | http://www.apache.org/licenses/ 4 | 5 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 6 | 7 | 1. Definitions. 8 | 9 | "License" shall mean the terms and conditions for use, reproduction, 10 | and distribution as defined by Sections 1 through 9 of this document. 11 | 12 | "Licensor" shall mean the copyright owner or entity authorized by 13 | the copyright owner that is granting the License. 14 | 15 | "Legal Entity" shall mean the union of the acting entity and all 16 | other entities that control, are controlled by, or are under common 17 | control with that entity. For the purposes of this definition, 18 | "control" means (i) the power, direct or indirect, to cause the 19 | direction or management of such entity, whether by contract or 20 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 21 | outstanding shares, or (iii) beneficial ownership of such entity. 22 | 23 | "You" (or "Your") shall mean an individual or Legal Entity 24 | exercising permissions granted by this License. 25 | 26 | "Source" form shall mean the preferred form for making modifications, 27 | including but not limited to software source code, documentation 28 | source, and configuration files. 29 | 30 | "Object" form shall mean any form resulting from mechanical 31 | transformation or translation of a Source form, including but 32 | not limited to compiled object code, generated documentation, 33 | and conversions to other media types. 34 | 35 | "Work" shall mean the work of authorship, whether in Source or 36 | Object form, made available under the License, as indicated by a 37 | copyright notice that is included in or attached to the work 38 | (an example is provided in the Appendix below). 39 | 40 | "Derivative Works" shall mean any work, whether in Source or Object 41 | form, that is based on (or derived from) the Work and for which the 42 | editorial revisions, annotations, elaborations, or other modifications 43 | represent, as a whole, an original work of authorship. For the purposes 44 | of this License, Derivative Works shall not include works that remain 45 | separable from, or merely link (or bind by name) to the interfaces of, 46 | the Work and Derivative Works thereof. 47 | 48 | "Contribution" shall mean any work of authorship, including 49 | the original version of the Work and any modifications or additions 50 | to that Work or Derivative Works thereof, that is intentionally 51 | submitted to Licensor for inclusion in the Work by the copyright owner 52 | or by an individual or Legal Entity authorized to submit on behalf of 53 | the copyright owner. For the purposes of this definition, "submitted" 54 | means any form of electronic, verbal, or written communication sent 55 | to the Licensor or its representatives, including but not limited to 56 | communication on electronic mailing lists, source code control systems, 57 | and issue tracking systems that are managed by, or on behalf of, the 58 | Licensor for the purpose of discussing and improving the Work, but 59 | excluding communication that is conspicuously marked or otherwise 60 | designated in writing by the copyright owner as "Not a Contribution." 61 | 62 | "Contributor" shall mean Licensor and any individual or Legal Entity 63 | on behalf of whom a Contribution has been received by Licensor and 64 | subsequently incorporated within the Work. 65 | 66 | 2. Grant of Copyright License. Subject to the terms and conditions of 67 | this License, each Contributor hereby grants to You a perpetual, 68 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 69 | copyright license to reproduce, prepare Derivative Works of, 70 | publicly display, publicly perform, sublicense, and distribute the 71 | Work and such Derivative Works in Source or Object form. 72 | 73 | 3. Grant of Patent License. Subject to the terms and conditions of 74 | this License, each Contributor hereby grants to You a perpetual, 75 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 76 | (except as stated in this section) patent license to make, have made, 77 | use, offer to sell, sell, import, and otherwise transfer the Work, 78 | where such license applies only to those patent claims licensable 79 | by such Contributor that are necessarily infringed by their 80 | Contribution(s) alone or by combination of their Contribution(s) 81 | with the Work to which such Contribution(s) was submitted. If You 82 | institute patent litigation against any entity (including a 83 | cross-claim or counterclaim in a lawsuit) alleging that the Work 84 | or a Contribution incorporated within the Work constitutes direct 85 | or contributory patent infringement, then any patent licenses 86 | granted to You under this License for that Work shall terminate 87 | as of the date such litigation is filed. 88 | 89 | 4. Redistribution. You may reproduce and distribute copies of the 90 | Work or Derivative Works thereof in any medium, with or without 91 | modifications, and in Source or Object form, provided that You 92 | meet the following conditions: 93 | 94 | (a) You must give any other recipients of the Work or 95 | Derivative Works a copy of this License; and 96 | 97 | (b) You must cause any modified files to carry prominent notices 98 | stating that You changed the files; and 99 | 100 | (c) You must retain, in the Source form of any Derivative Works 101 | that You distribute, all copyright, patent, trademark, and 102 | attribution notices from the Source form of the Work, 103 | excluding those notices that do not pertain to any part of 104 | the Derivative Works; and 105 | 106 | (d) If the Work includes a "NOTICE" text file as part of its 107 | distribution, then any Derivative Works that You distribute must 108 | include a readable copy of the attribution notices contained 109 | within such NOTICE file, excluding those notices that do not 110 | pertain to any part of the Derivative Works, in at least one 111 | of the following places: within a NOTICE text file distributed 112 | as part of the Derivative Works; within the Source form or 113 | documentation, if provided along with the Derivative Works; or, 114 | within a display generated by the Derivative Works, if and 115 | wherever such third-party notices normally appear. The contents 116 | of the NOTICE file are for informational purposes only and 117 | do not modify the License. You may add Your own attribution 118 | notices within Derivative Works that You distribute, alongside 119 | or as an addendum to the NOTICE text from the Work, provided 120 | that such additional attribution notices cannot be construed 121 | as modifying the License. 122 | 123 | You may add Your own copyright statement to Your modifications and 124 | may provide additional or different license terms and conditions 125 | for use, reproduction, or distribution of Your modifications, or 126 | for any such Derivative Works as a whole, provided Your use, 127 | reproduction, and distribution of the Work otherwise complies with 128 | the conditions stated in this License. 129 | 130 | 5. Submission of Contributions. Unless You explicitly state otherwise, 131 | any Contribution intentionally submitted for inclusion in the Work 132 | by You to the Licensor shall be under the terms and conditions of 133 | this License, without any additional terms or conditions. 134 | Notwithstanding the above, nothing herein shall supersede or modify 135 | the terms of any separate license agreement you may have executed 136 | with Licensor regarding such Contributions. 137 | 138 | 6. Trademarks. This License does not grant permission to use the trade 139 | names, trademarks, service marks, or product names of the Licensor, 140 | except as required for reasonable and customary use in describing the 141 | origin of the Work and reproducing the content of the NOTICE file. 142 | 143 | 7. Disclaimer of Warranty. Unless required by applicable law or 144 | agreed to in writing, Licensor provides the Work (and each 145 | Contributor provides its Contributions) on an "AS IS" BASIS, 146 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 147 | implied, including, without limitation, any warranties or conditions 148 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 149 | PARTICULAR PURPOSE. You are solely responsible for determining the 150 | appropriateness of using or redistributing the Work and assume any 151 | risks associated with Your exercise of permissions under this License. 152 | 153 | 8. Limitation of Liability. In no event and under no legal theory, 154 | whether in tort (including negligence), contract, or otherwise, 155 | unless required by applicable law (such as deliberate and grossly 156 | negligent acts) or agreed to in writing, shall any Contributor be 157 | liable to You for damages, including any direct, indirect, special, 158 | incidental, or consequential damages of any character arising as a 159 | result of this License or out of the use or inability to use the 160 | Work (including but not limited to damages for loss of goodwill, 161 | work stoppage, computer failure or malfunction, or any and all 162 | other commercial damages or losses), even if such Contributor 163 | has been advised of the possibility of such damages. 164 | 165 | 9. Accepting Warranty or Additional Liability. While redistributing 166 | the Work or Derivative Works thereof, You may choose to offer, 167 | and charge a fee for, acceptance of support, warranty, indemnity, 168 | or other liability obligations and/or rights consistent with this 169 | License. However, in accepting such obligations, You may act only 170 | on Your own behalf and on Your sole responsibility, not on behalf 171 | of any other Contributor, and only if You agree to indemnify, 172 | defend, and hold each Contributor harmless for any liability 173 | incurred by, or claims asserted against, such Contributor by reason 174 | of your accepting any such warranty or additional liability. 175 | 176 | END OF TERMS AND CONDITIONS 177 | 178 | APPENDIX: How to apply the Apache License to your work. 179 | 180 | To apply the Apache License to your work, attach the following 181 | boilerplate notice, with the fields enclosed by brackets "{}" 182 | replaced with your own identifying information. (Don't include 183 | the brackets!) The text should be enclosed in the appropriate 184 | comment syntax for the file format. We also recommend that a 185 | file or class name and description of purpose be included on the 186 | same "printed page" as the copyright notice for easier 187 | identification within third-party archives. 188 | 189 | Copyright {yyyy} {name of copyright owner} 190 | 191 | Licensed under the Apache License, Version 2.0 (the "License"); 192 | you may not use this file except in compliance with the License. 193 | You may obtain a copy of the License at 194 | 195 | http://www.apache.org/licenses/LICENSE-2.0 196 | 197 | Unless required by applicable law or agreed to in writing, software 198 | distributed under the License is distributed on an "AS IS" BASIS, 199 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 200 | See the License for the specific language governing permissions and 201 | limitations under the License. 202 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # docker-postgres-pgbouncer 2 | 3 | This is a simple project to install, configure and monitor [PgBouncer](https://pgbouncer.github.io) connection pooler for [PostgreSQL](https://www.postgresql.org) 4 | 5 | > This is a simple project using docker. 6 | 7 | # Table of contents 8 | 1. [Install](#install) 9 | 2. [Configuration](#configuration) 10 | 3. [Monitoring](#monitoring) 11 | 4. [References](#references) 12 | 13 | 14 | ### Install services 15 | 16 | Download the [docker-compose](https://docs.docker.com/compose/) file: 17 | 18 | ```sh 19 | wget https://raw.githubusercontent.com/guedim/docker-postgres-pgbouncer/master/docker-compose.yml 20 | ``` 21 | 22 | Later, start the services ([Postgres](https://www.postgresql.org/) - [PgBouncer](https://pgbouncer.github.io) - [PgAdmin](https://www.pgadmin.org)) using [docker-compose](https://docs.docker.com/compose/): 23 | ```sh 24 | docker-compose up 25 | ``` 26 |

27 | 28 |

29 | 30 | 31 | ### Configuration 32 | 33 | Access to [PgAdmin](https://www.pgadmin.org) console, using http://192.168.99.100:5050 34 | 35 | > Use the credentials: 36 | > Username:pgbouncer_database 37 | > Password:12345678 38 | 39 |

40 | 41 |

42 | 43 | Create a server, but dont forget to use the [PgBouncer](https://pgbouncer.github.io) credentials, host and port: 44 | 45 | > Use the parameters: 46 | > host:192.168.99.100 47 | > port:6432 48 | > user:postgres 49 | > password:postgres 50 | > database:postgres 51 | 52 |

53 | 54 |

55 | 56 | Now, you are connected to Postgres but using [PgBouncer](https://pgbouncer.github.io). 57 | 58 | ### Monitoring 59 | 60 | For Monitoring, we will use [PgBouncer stats](https://pgbouncer.github.io/usage.html) in one new database schema. 61 | 62 | Execute the sql file https://raw.githubusercontent.com/guedim/docker-postgres-pgbouncer/master/monitoring-pgbouncer.sql: 63 | 64 | ```sql 65 | # Create server and register pgbouncer 66 | CREATE EXTENSION dblink; 67 | CREATE SERVER pgbouncer FOREIGN DATA WRAPPER dblink_fdw OPTIONS (host '192.168.99.100',port '6432', dbname 'pgbouncer'); 68 | CREATE USER MAPPING FOR PUBLIC SERVER pgbouncer OPTIONS (user 'pgbouncer'); 69 | 70 | # Register pgbouncer data in one isolated schema 71 | CREATE SCHEMA pgbouncer; 72 | CREATE VIEW pgbouncer.clients AS SELECT * FROM dblink('pgbouncer', 'show clients') AS _(type text, "user" text, database text, state text, addr text, port integer, local_addr text, local_port integer, connect_time timestamp with time zone, request_time timestamp with time zone, ptr text, link text, remote_pid smallint, tls text); 73 | CREATE VIEW pgbouncer.config AS SELECT * FROM dblink('pgbouncer', 'show config') AS _(key text, value text, changeable boolean); 74 | CREATE VIEW pgbouncer.databases AS SELECT * FROM dblink('pgbouncer', 'show databases') AS _(name text, host text, port integer, database text, force_user text, pool_size integer, reserve_pool integer, pool_mode text, max_connections integer, current_connections integer, paused integer, disabled integer); 75 | CREATE VIEW pgbouncer.lists AS SELECT * FROM dblink('pgbouncer', 'show lists') AS _(list text, items int); 76 | CREATE VIEW pgbouncer.pools AS SELECT * FROM dblink('pgbouncer', 'show pools') AS _(database text, "user" text, cl_active integer, cl_waiting integer, sv_active integer, sv_idle integer, sv_used integer, sv_tested integer, sv_login integer, maxwait integer, pool_mode text); 77 | CREATE VIEW pgbouncer.servers AS SELECT * FROM dblink('pgbouncer', 'show servers') AS _(type text, "user" text, database text, state text, addr text, port integer, local_addr text, local_port integer, connect_time timestamp with time zone, request_time timestamp with time zone, ptr text, link text, remote_pid smallint, tls text); 78 | CREATE VIEW pgbouncer.sockets AS SELECT * FROM dblink('pgbouncer', 'show sockets') AS _(type text, "user" text, database text, state text, addr text, port int, local_addr text, local_port int, connect_time timestamp with time zone, request_time timestamp with time zone, ptr text, link text, recv_pos int, pkt_pos int, pkt_remain int, send_pos int, send_remain int, pkt_avail int, send_avail int); 79 | ``` 80 | 81 | Finally, you can query the [PgBouncer stats](https://pgbouncer.github.io/usage.html) 82 | 83 |

84 | 85 |

86 | 87 | 88 | ### References 89 | 90 | * https://wiki.postgresql.org/wiki/PgBouncer 91 | * https://pgbouncer.github.io/usage.html 92 | * https://pgbouncer.github.io/faq.html 93 | * https://opensourcedbms.com/dbms/setup-pgbouncer-connection-pooling-for-postgresql-on-centosredhatfedora/https://www.enterprisedb.com/resources/tutorials/how-set-pgbouncer-connection-pooling-postgres-plus-standard-server 94 | * https://opensourcedbms.com/dbms/setup-pgbouncer-connection-pooling-for-postgresql-on-centosredhatfedora/ 95 | * https://www.enterprisedb.com/resources/tutorials/how-set-pgbouncer-connection-pooling-postgres-plus-standard-server 96 | * http://get.enterprisedb.com/docs/Tutorial_All_PPSS_pgBouncer.pdf 97 | -------------------------------------------------------------------------------- /docker-compose.yml: -------------------------------------------------------------------------------- 1 | version: '3.1' 2 | 3 | services: 4 | # pgadmin4 for pgbouncer. 5 | pgadmin4-master: 6 | image: fenglc/pgadmin4 7 | ports: 8 | - 5050:5050 9 | links: 10 | - postgres:postgres 11 | environment: 12 | DEFAULT_USER: pgbouncer_database 13 | DEFAULT_PASSWORD: 12345678 14 | # Postgres database. 15 | postgres: 16 | image: postgres:9.6.5 17 | environment: 18 | POSTGRES_USER: postgres # define credentials 19 | POSTGRES_PASSWORD: postgres # define credentials 20 | POSTGRES_DB: postgres # define database 21 | ports: 22 | - 5432:5432 # Postgres port 23 | # Postgres database. 24 | pgbouncer: 25 | image: brainsam/pgbouncer:1.7.2 26 | environment: 27 | DB_HOST: postgres 28 | DB_USER: postgres # define credentials 29 | DB_PASSWORD: postgres # define credentials 30 | DB_port: 5432 # define database 31 | links: 32 | - postgres:postgres 33 | ports: 34 | - 6432:6432 # PgBouncer port 35 | -------------------------------------------------------------------------------- /monitoring-pgbouncer.sql: -------------------------------------------------------------------------------- 1 | # Create the dblink extension 2 | CREATE EXTENSION dblink; 3 | # Create the server using the pgbouncer credentials and dblink extension 4 | CREATE SERVER pgbouncer FOREIGN DATA WRAPPER dblink_fdw OPTIONS (host '192.168.99.100',port '6432', dbname 'pgbouncer'); 5 | # Create the mapping 6 | CREATE USER MAPPING FOR PUBLIC SERVER pgbouncer OPTIONS (user 'pgbouncer'); 7 | 8 | # Register pgbouncer data in one isolated schema 9 | CREATE SCHEMA pgbouncer; 10 | CREATE VIEW pgbouncer.clients AS SELECT * FROM dblink('pgbouncer', 'show clients') AS _(type text, "user" text, database text, state text, addr text, port integer, local_addr text, local_port integer, connect_time timestamp with time zone, request_time timestamp with time zone, ptr text, link text, remote_pid smallint, tls text); 11 | CREATE VIEW pgbouncer.config AS SELECT * FROM dblink('pgbouncer', 'show config') AS _(key text, value text, changeable boolean); 12 | CREATE VIEW pgbouncer.databases AS SELECT * FROM dblink('pgbouncer', 'show databases') AS _(name text, host text, port integer, database text, force_user text, pool_size integer, reserve_pool integer, pool_mode text, max_connections integer, current_connections integer, paused integer, disabled integer); 13 | CREATE VIEW pgbouncer.lists AS SELECT * FROM dblink('pgbouncer', 'show lists') AS _(list text, items int); 14 | CREATE VIEW pgbouncer.pools AS SELECT * FROM dblink('pgbouncer', 'show pools') AS _(database text, "user" text, cl_active integer, cl_waiting integer, sv_active integer, sv_idle integer, sv_used integer, sv_tested integer, sv_login integer, maxwait integer, pool_mode text); 15 | CREATE VIEW pgbouncer.servers AS SELECT * FROM dblink('pgbouncer', 'show servers') AS _(type text, "user" text, database text, state text, addr text, port integer, local_addr text, local_port integer, connect_time timestamp with time zone, request_time timestamp with time zone, ptr text, link text, remote_pid smallint, tls text); 16 | CREATE VIEW pgbouncer.sockets AS SELECT * FROM dblink('pgbouncer', 'show sockets') AS _(type text, "user" text, database text, state text, addr text, port int, local_addr text, local_port int, connect_time timestamp with time zone, request_time timestamp with time zone, ptr text, link text, recv_pos int, pkt_pos int, pkt_remain int, send_pos int, send_remain int, pkt_avail int, send_avail int); 17 | 18 | 19 | -------------------------------------------------------------------------------- /resources/images/create_server.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/guedim/docker-postgres-pgbouncer/4362a89be65b9c3e5b386f8b9c0c2079f4e55f46/resources/images/create_server.png -------------------------------------------------------------------------------- /resources/images/docker-compose-up.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/guedim/docker-postgres-pgbouncer/4362a89be65b9c3e5b386f8b9c0c2079f4e55f46/resources/images/docker-compose-up.png -------------------------------------------------------------------------------- /resources/images/monitoring.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/guedim/docker-postgres-pgbouncer/4362a89be65b9c3e5b386f8b9c0c2079f4e55f46/resources/images/monitoring.png -------------------------------------------------------------------------------- /resources/images/pgadmin_login.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/guedim/docker-postgres-pgbouncer/4362a89be65b9c3e5b386f8b9c0c2079f4e55f46/resources/images/pgadmin_login.png --------------------------------------------------------------------------------