Scroll to navigation

Apache::Session::Browseable::Patroni(3pm) User Contributed Perl Documentation Apache::Session::Browseable::Patroni(3pm)

NAME

Apache::Session::Browseable::Patroni - PostgreSQL/Patroni cluster support for Apache::Session::Browseable::PgJSON

SYNOPSIS

  CREATE UNLOGGED TABLE sessions (
      id varchar(64) not null primary key,
      a_session jsonb,
  );

Optionally, add indexes on some fields. Example for Lemonldap::NG:

  CREATE INDEX uid1 ON sessions USING BTREE ( (a_session ->> '_whatToTrace') );
  CREATE INDEX  s1  ON sessions ( (a_session ->> '_session_kind') );
  CREATE INDEX  u1  ON sessions ( ( cast(a_session ->> '_utime' AS bigint) ) );
  CREATE INDEX ip1  ON sessions USING BTREE ( (a_session ->> 'ipAddr') );

Use it with Perl:

  use Apache::Session::Browseable::Patroni;
  my $args = {
       DataSource => 'dbi:Pg:dbname=sessions',
       UserName   => $db_user,
       Password   => $db_pass,
       Commit     => 1,
       # List Patroni API endpoints (comma or space separated)
       # Put preferred (local) endpoints first
       PatroniUrl => 'http://1.2.3.4:8008/cluster, http://2.3.4.5:8008/cluster',
       # Optional parameters with defaults:
       # PatroniTimeout             => 3,   # API request timeout in seconds
       # PatroniCacheTTL            => 60,  # Leader cache TTL in seconds
       # PatroniCircuitBreakerDelay => 30,  # Delay before retrying failed API
       # SSL options (verification enabled by default):
       # PatroniVerifySSL           => 1,   # Verify SSL certificates (default: 1)
       # PatroniSSLCAFile           => '/path/to/ca.pem',  # Custom CA file
       # PatroniSSLCAPath           => '/path/to/certs/',  # Custom CA directory
  };
  # Use it like L<Apache::Session::Browseable::PgJSON>

DESCRIPTION

Apache::Session::Browseable provides some class methods to manipulate all sessions and add the capability to index some fields to make research faster.

Apache::Session::Browseable::Patroni implements it for PostgreSQL databases using "json" or "jsonb" type to be able to browse sessions and is able to dial directly with Patroni API to find the master node of PostgreSQL cluster in case of error.

Resilience features

  • Circuit breaker: Avoids hammering the Patroni API when it's failing. After a failure, the API won't be queried again for "PatroniCircuitBreakerDelay" seconds (default: 30).
  • Leader caching: The discovered leader is cached for "PatroniCacheTTL" seconds (default: 60). This cache is used as fallback when the API is unavailable.
  • Split-brain detection: Refuses to use a cluster that reports multiple leaders.
  • Leader health check: Verifies that the leader is in "running" state before using it.
  • Multi-source support: Each DataSource maintains its own independent cache, allowing multiple Patroni clusters to be used simultaneously.

SSL/TLS Configuration

By default, SSL certificate verification is enabled when connecting to HTTPS Patroni endpoints. This protects against man-in-the-middle attacks.

Available SSL options:

  • "PatroniVerifySSL" (default: 1)

    Set to 0 to disable SSL certificate verification. Warning: This makes HTTPS connections vulnerable to MITM attacks. Only use in development or when you have other network-level protections.

      PatroniVerifySSL => 0,  # INSECURE - disable SSL verification
  • "PatroniSSLCAFile"

    Path to a custom CA certificate file (PEM format) for verifying the Patroni API server certificate.

      PatroniSSLCAFile => '/etc/ssl/certs/patroni-ca.pem',
  • "PatroniSSLCAPath"

    Path to a directory containing CA certificates for verification.

      PatroniSSLCAPath => '/etc/ssl/certs/',

SEE ALSO

<http://lemonldap-ng.org>, Apache::Session::Browseable::PgJSON

COPYRIGHT AND LICENSE

2009-2025 by Xavier Guimard
2013-2025 by Clément Oudot
2019-2025 by Maxime Besson
2013-2025 by Worteks
2023-2025 by Linagora

This library is free software; you can redistribute it and/or modify it under the same terms as Perl itself, either Perl version 5.10.1 or, at your option, any later version of Perl 5 you may have available.

2026-05-14 perl v5.40.1