github.com/netdata/go.d.plugin@v0.58.1/modules/pgbouncer/metadata.yaml (about)

     1  plugin_name: go.d.plugin
     2  modules:
     3    - meta:
     4        id: collector-go.d.plugin-pgbouncer
     5        plugin_name: go.d.plugin
     6        module_name: pgbouncer
     7        monitored_instance:
     8          name: PgBouncer
     9          link: https://www.pgbouncer.org/
    10          icon_filename: postgres.svg
    11          categories:
    12            - data-collection.database-servers
    13        keywords:
    14          - pgbouncer
    15        related_resources:
    16          integrations:
    17            list: []
    18        info_provided_to_referring_integrations:
    19          description: ""
    20        most_popular: false
    21      overview:
    22        data_collection:
    23          metrics_description: |
    24            This collector monitors PgBouncer servers.
    25            
    26            Executed queries:
    27            
    28            - `SHOW VERSION;`
    29            - `SHOW CONFIG;`
    30            - `SHOW DATABASES;`
    31            - `SHOW STATS;`
    32            - `SHOW POOLS;`
    33            
    34            Information about the queries can be found in the [PgBouncer Documentation](https://www.pgbouncer.org/usage.html).
    35          method_description: ""
    36        supported_platforms:
    37          include: []
    38          exclude: []
    39        multi_instance: true
    40        additional_permissions:
    41          description: ""
    42        default_behavior:
    43          auto_detection:
    44            description: ""
    45          limits:
    46            description: ""
    47          performance_impact:
    48            description: ""
    49      setup:
    50        prerequisites:
    51          list:
    52            - title: Create netdata user
    53              description: |
    54                Create a user with `stats_users` permissions to query your PgBouncer instance.
    55                
    56                To create the `netdata` user:
    57                
    58                - Add `netdata` user to the `pgbouncer.ini` file:
    59                
    60                  ```text
    61                  stats_users = netdata
    62                  ```
    63                
    64                - Add a password for the `netdata` user to the `userlist.txt` file:
    65                
    66                  ```text
    67                  "netdata" "<PASSWORD>"
    68                  ```
    69                
    70                - To verify the credentials, run the following command
    71                
    72                  ```bash
    73                  psql -h localhost -U netdata -p 6432 pgbouncer -c "SHOW VERSION;" >/dev/null 2>&1 && echo OK || echo FAIL
    74                  ```
    75                
    76                  When it prompts for a password, enter the password you added to `userlist.txt`.
    77        configuration:
    78          file:
    79            name: go.d/pgbouncer.conf
    80          options:
    81            description: |
    82              The following options can be defined globally: update_every, autodetection_retry.
    83            folding:
    84              title: Config options
    85              enabled: true
    86            list:
    87              - name: update_every
    88                description: Data collection frequency.
    89                default_value: 5
    90                required: false
    91              - name: autodetection_retry
    92                description: Recheck interval in seconds. Zero means no recheck will be scheduled.
    93                default_value: 0
    94                required: false
    95              - name: dsn
    96                description: PgBouncer server DSN (Data Source Name). See [DSN syntax](https://www.postgresql.org/docs/current/libpq-connect.html#LIBPQ-CONNSTRING).
    97                default_value: postgres://postgres:postgres@127.0.0.1:6432/pgbouncer
    98                required: true
    99              - name: timeout
   100                description: Query timeout in seconds.
   101                default_value: 1
   102                required: false
   103          examples:
   104            folding:
   105              title: Config
   106              enabled: true
   107            list:
   108              - name: TCP socket
   109                description: An example configuration.
   110                config: |
   111                  jobs:
   112                    - name: local
   113                      dsn: 'postgres://postgres:postgres@127.0.0.1:6432/pgbouncer'
   114              - name: Unix socket
   115                description: An example configuration.
   116                config: |
   117                  jobs:
   118                    - name: local
   119                      dsn: 'host=/tmp dbname=pgbouncer user=postgres port=6432'
   120              - name: Multi-instance
   121                description: |
   122                  > **Note**: When you define multiple jobs, their names must be unique.
   123                  
   124                  Local and remote instances.
   125                config: |
   126                  jobs:
   127                    - name: local
   128                      dsn: 'postgres://postgres:postgres@127.0.0.1:6432/pgbouncer'
   129                  
   130                    - name: remote
   131                      dsn: 'postgres://postgres:postgres@203.0.113.10:6432/pgbouncer'
   132      troubleshooting:
   133        problems:
   134          list: []
   135      alerts: []
   136      metrics:
   137        folding:
   138          title: Metrics
   139          enabled: false
   140        description: ""
   141        availability: []
   142        scopes:
   143          - name: global
   144            description: These metrics refer to the entire monitored application.
   145            labels: []
   146            metrics:
   147              - name: pgbouncer.client_connections_utilization
   148                description: Client connections utilization
   149                unit: percentage
   150                chart_type: line
   151                dimensions:
   152                  - name: used
   153          - name: database
   154            description: These metrics refer to the database.
   155            labels:
   156              - name: database
   157                description: database name
   158              - name: postgres_database
   159                description: Postgres database name
   160            metrics:
   161              - name: pgbouncer.db_client_connections
   162                description: Database client connections
   163                unit: connections
   164                chart_type: line
   165                dimensions:
   166                  - name: active
   167                  - name: waiting
   168                  - name: cancel_req
   169              - name: pgbouncer.db_server_connections
   170                description: Database server connections
   171                unit: connections
   172                chart_type: line
   173                dimensions:
   174                  - name: active
   175                  - name: idle
   176                  - name: used
   177                  - name: tested
   178                  - name: login
   179              - name: pgbouncer.db_server_connections_utilization
   180                description: Database server connections utilization
   181                unit: percentage
   182                chart_type: line
   183                dimensions:
   184                  - name: used
   185              - name: pgbouncer.db_clients_wait_time
   186                description: Database clients wait time
   187                unit: seconds
   188                chart_type: line
   189                dimensions:
   190                  - name: time
   191              - name: pgbouncer.db_client_max_wait_time
   192                description: Database client max wait time
   193                unit: seconds
   194                chart_type: line
   195                dimensions:
   196                  - name: time
   197              - name: pgbouncer.db_transactions
   198                description: Database pooled SQL transactions
   199                unit: transactions/s
   200                chart_type: line
   201                dimensions:
   202                  - name: transactions
   203              - name: pgbouncer.db_transactions_time
   204                description: Database transactions time
   205                unit: seconds
   206                chart_type: line
   207                dimensions:
   208                  - name: time
   209              - name: pgbouncer.db_transaction_avg_time
   210                description: Database transaction average time
   211                unit: seconds
   212                chart_type: line
   213                dimensions:
   214                  - name: time
   215              - name: pgbouncer.db_queries
   216                description: Database pooled SQL queries
   217                unit: queries/s
   218                chart_type: line
   219                dimensions:
   220                  - name: queries
   221              - name: pgbouncer.db_queries_time
   222                description: Database queries time
   223                unit: seconds
   224                chart_type: line
   225                dimensions:
   226                  - name: time
   227              - name: pgbouncer.db_query_avg_time
   228                description: Database query average time
   229                unit: seconds
   230                chart_type: line
   231                dimensions:
   232                  - name: time
   233              - name: pgbouncer.db_network_io
   234                description: Database traffic
   235                unit: B/s
   236                chart_type: area
   237                dimensions:
   238                  - name: received
   239                  - name: sent