pact_broker 2.96.0 → 2.99.0

data/docs/CONFIGURATION.md

@@ -19,8 +19,8 @@ variable `PACT_BROKER_CONF` to the full path to the configuration file.
 
 The application log level
 
-**YAML configuration key name:** `log_level`<br/>
 **Environment variable name:** `PACT_BROKER_LOG_LEVEL`<br/>
+**YAML configuration key name:** `log_level`<br/>
 **Default:** `info`<br/>
 **Allowed values:** `debug`, `info`, `warn`, `error`, `fatal`<br/>
 
@@ -28,8 +28,8 @@ The application log level
 
 The application log format. Can be any value supported by Semantic Logger.
 
-**YAML configuration key name:** `log_format`<br/>
 **Environment variable name:** `PACT_BROKER_LOG_FORMAT`<br/>
+**YAML configuration key name:** `log_format`<br/>
 **Default:** `default`<br/>
 **Allowed values:** `default`, `json`, `color`<br/>
 **More information:** https://github.com/rocketjob/semantic_logger/tree/master/lib/semantic_logger/formatters<br/>
@@ -38,8 +38,8 @@ The application log format. Can be any value supported by Semantic Logger.
 
 The log file directory
 
-**YAML configuration key name:** `log_dir`<br/>
 **Environment variable name:** `PACT_BROKER_LOG_DIR`<br/>
+**YAML configuration key name:** `log_dir`<br/>
 **Default:** `./logs`<br/>
 
 ### log_stream
@@ -48,17 +48,29 @@ The stream to which the logs will be sent.
 
 While the default is `file` for the Ruby application, it is set to `stdout` on the supported Docker images.
 
-**YAML configuration key name:** `log_stream`<br/>
 **Environment variable name:** `PACT_BROKER_LOG_STREAM`<br/>
+**YAML configuration key name:** `log_stream`<br/>
 **Default:** `file`<br/>
 **Allowed values:** `stdout`, `file`<br/>
 
+### http_debug_logging_enabled
+
+Enable this setting to print the entire request and response to the logs at debug level. Used for troubleshooting issues.
+Do not leave this on permanently, as it will have performance and security issues.
+Ensure the application [`log_level`](#log_level) is set to `debug` when this setting is enabled.
+
+**Supported versions:** From v2.98.0<br/>
+**Environment variable name:** `PACT_BROKER_HTTP_DEBUG_LOGGING_ENABLED`<br/>
+**YAML configuration key name:** `http_debug_logging_enabled`<br/>
+**Default:** `false`<br/>
+**Allowed values:** `true`, `false`<br/>
+
 ### hide_pactflow_messages
 
 Set to `true` to hide the messages in the logs about Pactflow
 
-**YAML configuration key name:** `hide_pactflow_messages`<br/>
 **Environment variable name:** `PACT_BROKER_HIDE_PACTFLOW_MESSAGES`<br/>
+**YAML configuration key name:** `hide_pactflow_messages`<br/>
 **Default:** `true`<br/>
 **Allowed values:** `true`, `false`<br/>
 **More information:** https://pactflow.io<br/>
@@ -77,8 +89,8 @@ The database adapter. For production use, Postgres must be used.
 For investigations/spikes on a development machine, you can use SQlite. It is not supported as a production database, as it does not support
 concurrent requests.
 
-**YAML configuration key name:** `database_adapter`<br/>
 **Environment variable name:** `PACT_BROKER_DATABASE_ADAPTER`<br/>
+**YAML configuration key name:** `database_adapter`<br/>
 **Default:** `postgres`<br/>
 **Allowed values:** `postgres` (for production use), `sqlite` (for spikes only)<br/>
 
@@ -86,44 +98,44 @@ concurrent requests.
 
 The database username
 
-**YAML configuration key name:** `database_username`<br/>
 **Environment variable name:** `PACT_BROKER_DATABASE_USERNAME`<br/>
+**YAML configuration key name:** `database_username`<br/>
 
 ### database_password
 
 The database password
 
-**YAML configuration key name:** `database_password`<br/>
 **Environment variable name:** `PACT_BROKER_DATABASE_PASSWORD`<br/>
+**YAML configuration key name:** `database_password`<br/>
 
 ### database_name
 
 The database name. If using the `sqlite` adapter, this will be the path to the database file.
 
-**YAML configuration key name:** `database_name`<br/>
 **Environment variable name:** `PACT_BROKER_DATABASE_NAME`<br/>
+**YAML configuration key name:** `database_name`<br/>
 **Examples:** `pact_broker`, `/tmp/pact_broker.sqlite3`, `./tmp/pact_broker.sqlite3`<br/>
 
 ### database_host
 
 The database host
 
-**YAML configuration key name:** `database_host`<br/>
 **Environment variable name:** `PACT_BROKER_DATABASE_HOST`<br/>
+**YAML configuration key name:** `database_host`<br/>
 
 ### database_port
 
 The database port. If ommited, the default port for the adapter will be used.
 
-**YAML configuration key name:** `database_port`<br/>
 **Environment variable name:** `PACT_BROKER_DATABASE_PORT`<br/>
+**YAML configuration key name:** `database_port`<br/>
 
 ### database_url
 
 The full database URL may be specified instead of the separate adapter, username, password, name, host and port.
 
-**YAML configuration key name:** `database_url`<br/>
 **Environment variable name:** `PACT_BROKER_DATABASE_URL`<br/>
+**YAML configuration key name:** `database_url`<br/>
 **Format:** `{database_adapter}://{database_username}:{database_password}@{database_host}:{database_port}/{database_name}`<br/>
 **Examples:** `postgres://pact_broker_user:pact_broker_password@pact_broker_db_host/pact_broker`, `sqlite:///tmp/pact_broker.sqlite3` (relative path to working directory), `sqlite:////tmp/pact_broker.sqlite3` (absolute path)<br/>
 
@@ -131,8 +143,8 @@ The full database URL may be specified instead of the separate adapter, username
 
 The Postgresql ssl mode.
 
-**YAML configuration key name:** `database_sslmode`<br/>
 **Environment variable name:** `PACT_BROKER_DATABASE_SSLMODE`<br/>
+**YAML configuration key name:** `database_sslmode`<br/>
 **Default:** `prefer`<br/>
 **Allowed values:** `disable`, `allow`, `prefer`, `require`, `verify-ca`, `verify-full`<br/>
 **More information:** https://ankane.org/postgres-sslmode-explained<br/>
@@ -143,27 +155,38 @@ The log level that will be used when the SQL query statements are logged.
 
 To disable noisy SQL query logging when the application `log_level` is set to `debug` for other reasons, use the value `none`.
 
-**YAML configuration key name:** `sql_log_level`<br/>
 **Environment variable name:** `PACT_BROKER_SQL_LOG_LEVEL`<br/>
-**Default:** `debug`<br/>
+**YAML configuration key name:** `sql_log_level`<br/>
+**Default:** From 2.99+, the default is `none`. In previous versions, the default is `debug`.<br/>
 **Allowed values:** `none`, `debug`, `info`, `warn`, `error`, `fatal`<br/>
 
 ### sql_log_warn_duration
 
 The number of seconds after which to log an SQL query at warn level. Use this for detecting slow queries.
 
-**YAML configuration key name:** `sql_log_warn_duration`<br/>
 **Environment variable name:** `PACT_BROKER_SQL_LOG_WARN_DURATION`<br/>
+**YAML configuration key name:** `sql_log_warn_duration`<br/>
 **Default:** `5`<br/>
 **Allowed values:** A positive integer or float, as a string.<br/>
 **More information:** https://sequel.jeremyevans.net/rdoc/files/doc/opening_databases_rdoc.html#label-General+connection+options<br/>
 
+### sql_enable_caller_logging
+
+Whether or not to enable caller_logging extension for database connection.
+When enabled it logs source path that caused SQL query.
+
+**Environment variable name:** `PACT_BROKER_SQL_ENABLE_CALLER_LOGGING`<br/>
+**YAML configuration key name:** `sql_enable_caller_logging`<br/>
+**Default:** `false`<br/>
+**Allowed values:** `true`, `false`<br/>
+**More information:** https://sequel.jeremyevans.net/rdoc-plugins/files/lib/sequel/extensions/caller_logging_rb.html<br/>
+
 ### database_max_connections
 
 The maximum size of the connection pool (4 connections by default on most databases)
 
-**YAML configuration key name:** `database_max_connections`<br/>
 **Environment variable name:** `PACT_BROKER_DATABASE_MAX_CONNECTIONS`<br/>
+**YAML configuration key name:** `database_max_connections`<br/>
 **Default:** `4`<br/>
 **Allowed values:** A positive integer value.<br/>
 **More information:** https://sequel.jeremyevans.net/rdoc/files/doc/opening_databases_rdoc.html#label-General+connection+options<br/>
@@ -172,8 +195,8 @@ The maximum size of the connection pool (4 connections by default on most databa
 
 The number of seconds to wait if a connection cannot be acquired before raising an error
 
-**YAML configuration key name:** `database_pool_timeout`<br/>
 **Environment variable name:** `PACT_BROKER_DATABASE_POOL_TIMEOUT`<br/>
+**YAML configuration key name:** `database_pool_timeout`<br/>
 **Default:** `5`<br/>
 **Allowed values:** A positive integer.<br/>
 **More information:** https://sequel.jeremyevans.net/rdoc/files/doc/opening_databases_rdoc.html#label-General+connection+options<br/>
@@ -185,8 +208,8 @@ the Broker application process may be ready before the database is available for
 container to exit with an error. Setting the max retries to a non-zero number will allow it to retry the connection the
 configured number of times, waiting 3 seconds between attempts.
 
-**YAML configuration key name:** `database_connect_max_retries`<br/>
 **Environment variable name:** `PACT_BROKER_DATABASE_CONNECT_MAX_RETRIES`<br/>
+**YAML configuration key name:** `database_connect_max_retries`<br/>
 **Default:** `0`<br/>
 **Allowed values:** A positive integer value.<br/>
 
@@ -194,8 +217,8 @@ configured number of times, waiting 3 seconds between attempts.
 
 Whether or not to run the database schema migrations on start up. It is recommended to set this to `true`.
 
-**YAML configuration key name:** `auto_migrate_db`<br/>
 **Environment variable name:** `PACT_BROKER_AUTO_MIGRATE_DB`<br/>
+**YAML configuration key name:** `auto_migrate_db`<br/>
 **Default:** `true`<br/>
 **Allowed values:** `true`, `false`<br/>
 
@@ -203,8 +226,8 @@ Whether or not to run the database schema migrations on start up. It is recommen
 
 Whether or not to run the database data migrations on start up. It is recommended to set this to `true`.
 
-**YAML configuration key name:** `auto_migrate_db_data`<br/>
 **Environment variable name:** `PACT_BROKER_AUTO_MIGRATE_DB_DATA`<br/>
+**YAML configuration key name:** `auto_migrate_db_data`<br/>
 **Default:** `true`<br/>
 **Allowed values:** `true`, `false`<br/>
 
@@ -214,8 +237,8 @@ If `true`, will not raise an error if a database migration is recorded in the da
 equivalent file in the codebase. If this is true, an older version of the code may be used with a newer version of the database,
 however, data integrity issues may occur.
 
-**YAML configuration key name:** `allow_missing_migration_files`<br/>
 **Environment variable name:** `PACT_BROKER_ALLOW_MISSING_MIGRATION_FILES`<br/>
+**YAML configuration key name:** `allow_missing_migration_files`<br/>
 **Default:** `true`<br/>
 **More information:** https://sequel.jeremyevans.net/rdoc/classes/Sequel/Migrator.html<br/>
 
@@ -223,8 +246,8 @@ however, data integrity issues may occur.
 
 The number of seconds after which an SQL query will be aborted. Only supported for Postgresql connections.
 
-**YAML configuration key name:** `database_statement_timeout`<br/>
 **Environment variable name:** `PACT_BROKER_DATABASE_STATEMENT_TIMEOUT`<br/>
+**YAML configuration key name:** `database_statement_timeout`<br/>
 **Default:** `15`<br/>
 **Allowed values:** A positive integer or float.<br/>
 **More information:** https://www.postgresql.org/docs/9.3/runtime-config-client.html<br/>
@@ -235,8 +258,8 @@ The number of seconds after which the SQL queries used for the metrics endpoint
 This is configurable separately from the standard `database_statement_timeout` as it may need to be significantly
 longer than the desired value for standard queries.
 
-**YAML configuration key name:** `metrics_sql_statement_timeout`<br/>
 **Environment variable name:** `PACT_BROKER_METRICS_SQL_STATEMENT_TIMEOUT`<br/>
+**YAML configuration key name:** `metrics_sql_statement_timeout`<br/>
 **Default:** `30`<br/>
 **Allowed values:** A positive integer.<br/>
 
@@ -248,8 +271,8 @@ The number of seconds after which to check the health of a connection from a con
 when databases are restarted and connections are killed.  This has a performance
 penalty, so consider increasing this timeout if building a frequently accessed service.
 
-**YAML configuration key name:** `database_connection_validation_timeout`<br/>
 **Environment variable name:** `PACT_BROKER_DATABASE_CONNECTION_VALIDATION_TIMEOUT`<br/>
+**YAML configuration key name:** `database_connection_validation_timeout`<br/>
 **Default:** -1 for v2.85.1 and earlier, 3600 for later versions.<br/>
 **Allowed values:** -1 or any positive integer.<br/>
 **More information:** https://sequel.jeremyevans.net/rdoc-plugins/files/lib/sequel/extensions/connection_validator_rb.html<br/>
@@ -268,8 +291,8 @@ should be used for CI/CD.
 
 Whether to enable basic authorization. This is automatically set to true for the Docker images if the `basic_auth_username` and `basic_auth_password` are set.
 
-**YAML configuration key name:** `basic_auth_enabled`<br/>
 **Environment variable name:** `PACT_BROKER_BASIC_AUTH_ENABLED`<br/>
+**YAML configuration key name:** `basic_auth_enabled`<br/>
 **Default:** `false`<br/>
 **Allowed values:** `true`, `false`<br/>
 
@@ -277,36 +300,36 @@ Whether to enable basic authorization. This is automatically set to true for the
 
 The username for the read/write basic auth user.
 
-**YAML configuration key name:** `basic_auth_username`<br/>
 **Environment variable name:** `PACT_BROKER_BASIC_AUTH_USERNAME`<br/>
+**YAML configuration key name:** `basic_auth_username`<br/>
 
 ### basic_auth_password
 
 The password for the read/write basic auth user.
 
-**YAML configuration key name:** `basic_auth_password`<br/>
 **Environment variable name:** `PACT_BROKER_BASIC_AUTH_PASSWORD`<br/>
+**YAML configuration key name:** `basic_auth_password`<br/>
 
 ### basic_auth_read_only_username
 
 The username for the read only basic auth user.
 
-**YAML configuration key name:** `basic_auth_read_only_username`<br/>
 **Environment variable name:** `PACT_BROKER_BASIC_AUTH_READ_ONLY_USERNAME`<br/>
+**YAML configuration key name:** `basic_auth_read_only_username`<br/>
 
 ### basic_auth_read_only_password
 
 The password for the read only basic auth user.
 
-**YAML configuration key name:** `basic_auth_read_only_password`<br/>
 **Environment variable name:** `PACT_BROKER_BASIC_AUTH_READ_ONLY_PASSWORD`<br/>
+**YAML configuration key name:** `basic_auth_read_only_password`<br/>
 
 ### allow_public_read
 
 If you want to allow public read access, but still require credentials for writing, then leave `basic_auth_read_only_username` and `basic_auth_read_only_password` unset, and set `allow_public_read` to `true`.
 
-**YAML configuration key name:** `allow_public_read`<br/>
 **Environment variable name:** `PACT_BROKER_ALLOW_PUBLIC_READ`<br/>
+**YAML configuration key name:** `allow_public_read`<br/>
 **Default:** `false`<br/>
 **Allowed values:** `true`, `false`<br/>
 
@@ -314,8 +337,8 @@ If you want to allow public read access, but still require credentials for writi
 
 If you have enabled basic auth, but require unauthenticated access to the heartbeat URL (eg. for use within an AWS autoscaling group), set `public_heartbeat` to `true`.
 
-**YAML configuration key name:** `public_heartbeat`<br/>
 **Environment variable name:** `PACT_BROKER_PUBLIC_HEARTBEAT`<br/>
+**YAML configuration key name:** `public_heartbeat`<br/>
 **Default:** `false`<br/>
 **Allowed values:** `true`, `false`<br/>
 
@@ -323,8 +346,8 @@ If you have enabled basic auth, but require unauthenticated access to the heartb
 
 Set this to true to allow status badges to be embedded in README files without requiring a hardcoded password.
 
-**YAML configuration key name:** `enable_public_badge_access`<br/>
 **Environment variable name:** `PACT_BROKER_ENABLE_PUBLIC_BADGE_ACCESS`<br/>
+**YAML configuration key name:** `enable_public_badge_access`<br/>
 **Default:** `false`<br/>
 **Allowed values:** `true`, `false`<br/>
 
@@ -340,8 +363,8 @@ Set this to true to allow status badges to be embedded in README files without r
 The schedule of seconds to wait between webhook execution attempts.
 The default schedule is 10 sec, 1 min, 2 min, 5 min, 10 min, 20 min (38 minutes in total).
 
-**YAML configuration key name:** `webhook_retry_schedule`<br/>
 **Environment variable name:** `PACT_BROKER_WEBHOOK_RETRY_SCHEDULE`<br/>
+**YAML configuration key name:** `webhook_retry_schedule`<br/>
 **Format:** A space separated list of integers.<br/>
 **Default:** `10 60 120 300 600 1200`<br/>
 
@@ -350,8 +373,8 @@ The default schedule is 10 sec, 1 min, 2 min, 5 min, 10 min, 20 min (38 minutes
 The allowed HTTP methods for webhooks.
 It is highly recommended that only `POST` requests are allowed to ensure that webhooks cannot be used to retrieve sensitive information from hosts within the same network.
 
-**YAML configuration key name:** `webhook_http_method_whitelist`<br/>
 **Environment variable name:** `PACT_BROKER_WEBHOOK_HTTP_METHOD_WHITELIST`<br/>
+**YAML configuration key name:** `webhook_http_method_whitelist`<br/>
 **Format:** A space separated list.<br/>
 **Default:** `POST`<br/>
 **Allowed values:** `POST`, `GET` (not recommended), `PUT` (not recommended), `PATCH` (not recommended), `DELETE` (not recommended)<br/>
@@ -364,8 +387,8 @@ considered a success, otherwise the webhook will be re-triggered based on the `w
 In most cases, configuring this is not necessary, but there are some CI systems that return a non 200 status for a success,
 which is why this feature exists.
 
-**YAML configuration key name:** `webhook_http_code_success`<br/>
 **Environment variable name:** `PACT_BROKER_WEBHOOK_HTTP_CODE_SUCCESS`<br/>
+**YAML configuration key name:** `webhook_http_code_success`<br/>
 **Format:** A space separated list of integers.<br/>
 **Default:** `200 201 202 203 204 205 206`<br/>
 **Allowed values:** `Any valid HTTP status code`<br/>
@@ -374,8 +397,8 @@ which is why this feature exists.
 
 The allowed URL schemes for webhooks.
 
-**YAML configuration key name:** `webhook_scheme_whitelist`<br/>
 **Environment variable name:** `PACT_BROKER_WEBHOOK_SCHEME_WHITELIST`<br/>
+**YAML configuration key name:** `webhook_scheme_whitelist`<br/>
 **Format:** A space delimited list.<br/>
 **Default:** `https`<br/>
 **Allowed values:** `https`, `http`<br/>
@@ -387,37 +410,69 @@ Regular expressions should start and end with a `/` to differentiate them from S
 Note that backslashes need to be escaped with a second backslash when setting via an environment variable.
 Please read the [Webhook whitelists section](https://docs.pact.io/pact_broker/configuration/features#webhooks) of the Pact Broker configuration documentation to understand how the whitelist is used.
 
-**YAML configuration key name:** `webhook_host_whitelist`<br/>
 **Environment variable name:** `PACT_BROKER_WEBHOOK_HOST_WHITELIST`<br/>
+**Environment variable format:** A space separated list.<br/>
+**YAML configuration key name:** `webhook_host_whitelist`<br/>
+**YAML format:** A YAML list.<br/>
 **Examples:** `github.com`, `10.2.3.41/24`, `/.*\\.foo\\.com$/`<br/>
 **More information:** https://docs.pact.io/pact_broker/configuration/#webhook-whitelists<br/>
 
 ### webhook_certificates
 
-A list of SSL certificate configuration objects with the keys `description`, and either `content` or `path`. These
+A list of SSL certificate configuration objects with the key `description`, and either `content` or `path`. These
 certificates are used when a webhook needs to connect to a server that uses a self signed certificate.
 
 Each certificate configuration item accepts a chain of certificates in PEM format - there may be multiple 'BEGIN CERTIFICATE' and 'END CERTIFICATE' in the content of each item.
 
-When setting the content, use the syntax "content: |-" followed by a new line, and then the contents of the certificate
-chain in PEM format, indented by 2 more characters.
-
-When setting the path, the full path to the certificate file in PEM format must be specified.
-
 The certificate configuration is not validated on startup. If any of the configured certificates cannot be loaded during the execution of a webhook, an error
 will be logged, and they will be ignored. You can check if the configuration is working by testing the execution of
 a webhook that connects to the server with the self signed certificate by following these instructions https://docs.pact.io/pact_broker/webhooks/debugging_webhooks#testing-webhook-execution
 
-**YAML configuration key name:** `webhook_certificates`<br/>
+When setting the content in the YAML file, use the syntax "content: |-" followed by a new line, and then the contents of the certificate
+chain in PEM format, indented by 2 more characters.
+
+When setting the path, the full path to the certificate file in PEM format must be specified. When using Docker, you must ensure the
+certificate file is [mounted into the container](https://docs.docker.com/storage/volumes/).
+
+YAML Example:
+
+```yaml
+webhook_certificates:
+  - description: "An example self signed certificate with content"
+    content: |-
+      -----BEGIN CERTIFICATE-----
+      MIIDZDCCAkygAwIBAgIBATANBgkqhkiG9w0BAQsFADBCMRMwEQYKCZImiZPyLGQB
+      <REST OF CERTIFICATE>
+      jHT1Ty2CglM=
+      -----END CERTIFICATE-----
+  - description: "An example self signed certificate with a path"
+    path: "/full/path/to/the/cert.pem"
+
+```
+
+Environment variable example:
+
+```shell
+PACT_BROKER_WEBHOOK_CERTIFICATES__0__LABEL="An example self signed certificate with content"
+PACT_BROKER_WEBHOOK_CERTIFICATES__0__CONTENT="-----BEGIN CERTIFICATE-----
+      MIIDZDCCAkygAwIBAgIBATANBgkqhkiG9w0BAQsFADBCMRMwEQYKCZImiZPyLGQB
+      <REST OF CERTIFICATE>
+      jHT1Ty2CglM=
+      -----END CERTIFICATE-----"
+PACT_BROKER_WEBHOOK_CERTIFICATES__1__LABEL="An example self signed certificate with a path"
+PACT_BROKER_WEBHOOK_CERTIFICATES__1__PATH="/full/path/to/the/cert.pem"
+```
+
+**Supported versions:** From v2.90.0 for YAML and 2.97.0 for environment variables.<br/>
 **Environment variable name:** `PACT_BROKER_WEBHOOK_CERTIFICATES`<br/>
-**Supported versions:** From v2.90.0<br/>
+**YAML configuration key name:** `webhook_certificates`<br/>
 
 ### disable_ssl_verification
 
 If set to true, SSL verification will be disabled for the HTTP requests made by the webhooks
 
-**YAML configuration key name:** `disable_ssl_verification`<br/>
 **Environment variable name:** `PACT_BROKER_DISABLE_SSL_VERIFICATION`<br/>
+**YAML configuration key name:** `disable_ssl_verification`<br/>
 **Default:** `false`<br/>
 **Allowed values:** `true`, `false`<br/>
 
@@ -425,8 +480,8 @@ If set to true, SSL verification will be disabled for the HTTP requests made by
 
 The user agent to set when making HTTP requests for webhooks.
 
-**YAML configuration key name:** `user_agent`<br/>
 **Environment variable name:** `PACT_BROKER_USER_AGENT`<br/>
+**YAML configuration key name:** `user_agent`<br/>
 **Default:** `Pact Broker v{VERSION}`<br/>
 
 <br/>
@@ -442,8 +497,8 @@ The HTTP port that the Pact Broker application will run on. This will only be ho
 a package that actually reads this property (eg. one of the supported Docker images). If you are running the vanilla Ruby application,
 the application will run on the port the server has been configured to run on (eg. `bundle exec rackup -p 9393`)
 
-**YAML configuration key name:** `port`<br/>
 **Environment variable name:** `PACT_BROKER_PORT`<br/>
+**YAML configuration key name:** `port`<br/>
 **Default:** `9292`<br/>
 
 ### base_url
@@ -455,8 +510,8 @@ deploying the Pact Broker to production as it prevents cache poisoning security
 It is also required when deploying the Broker behind a reverse proxy, and when the application has been mounted at a non-root context.
 Note that this attribute does not change where the application is actually mounted (that is the concern of the deployment configuration) - it just changes the links.
 
-**YAML configuration key name:** `base_url`<br/>
 **Environment variable name:** `PACT_BROKER_BASE_URL`<br/>
+**YAML configuration key name:** `base_url`<br/>
 **Examples:** `https://pact-broker.mycompany.com`, `https://my-company.com:9292/pact-broker`<br/>
 
 ### base_urls
@@ -464,8 +519,8 @@ Note that this attribute does not change where the application is actually mount
 An alias of base_url. From version 2.79.0, multiple base URLs can be configured for architectures that use
 gateways or proxies that allow the same Pact Broker instance to be addressed with different base URLs.
 
-**YAML configuration key name:** `base_urls`<br/>
 **Environment variable name:** `PACT_BROKER_BASE_URLS`<br/>
+**YAML configuration key name:** `base_urls`<br/>
 **Format:** A space separated list.<br/>
 **Example:** `http://my-internal-pact-broker:9292 https://my-external-pact-broker`<br/>
 
@@ -473,8 +528,8 @@ gateways or proxies that allow the same Pact Broker instance to be addressed wit
 
 The URL of the shields.io server used to generate the README badges.
 
-**YAML configuration key name:** `shields_io_base_url`<br/>
 **Environment variable name:** `PACT_BROKER_SHIELDS_IO_BASE_URL`<br/>
+**YAML configuration key name:** `shields_io_base_url`<br/>
 **Default:** `https://img.shields.io`<br/>
 **More information:** https://shields.io<br/>
 
@@ -485,8 +540,8 @@ to render the badge from the shields.io server directly in the browser. This is
 When set to `proxy`, the Pact Broker will make a request directly to the configured shields.io server, and then send the returned file
 back to the browser. This mode is not recommended for security and performance reasons.
 
-**YAML configuration key name:** `badge_provider_mode`<br/>
 **Environment variable name:** `PACT_BROKER_BADGE_PROVIDER_MODE`<br/>
+**YAML configuration key name:** `badge_provider_mode`<br/>
 **Default:** `redirect`<br/>
 **Allowed values:** `redirect`, `proxy`<br/>
 
@@ -496,8 +551,8 @@ Whether or not to enable the diagnostic endpoints at `/diagnostic/status/heartbe
 The heartbeat endpoint is for use by load balancers, and the dependencies endpoint is for checking that the database
 is available (do not use this for load balancing, as it makes a database connection).
 
-**YAML configuration key name:** `enable_diagnostic_endpoints`<br/>
 **Environment variable name:** `PACT_BROKER_ENABLE_DIAGNOSTIC_ENDPOINTS`<br/>
+**YAML configuration key name:** `enable_diagnostic_endpoints`<br/>
 **Default:** `true`<br/>
 **Allowed values:** `true`, `false`<br/>
 
@@ -505,8 +560,8 @@ is available (do not use this for load balancing, as it makes a database connect
 
 Whether or not to enable the embedded HAL Browser.
 
-**YAML configuration key name:** `use_hal_browser`<br/>
 **Environment variable name:** `PACT_BROKER_USE_HAL_BROWSER`<br/>
+**YAML configuration key name:** `use_hal_browser`<br/>
 **Default:** `true`<br/>
 **Allowed values:** `true`, `false`<br/>
 **More information:** https://github.com/mikekelly/hal-browser<br/>
@@ -532,8 +587,8 @@ or that the pacticipant should be created manually if it was intended to be a ne
 To turn this feature off, set `check_for_potential_duplicate_pacticipant_names` to `false`, and make sure everyone is very careful with their naming!
 The usefulness of the Broker depends on the integrity of the data, which in turn depends on the correctness of the pacticipant names.
 
-**YAML configuration key name:** `check_for_potential_duplicate_pacticipant_names`<br/>
 **Environment variable name:** `PACT_BROKER_CHECK_FOR_POTENTIAL_DUPLICATE_PACTICIPANT_NAMES`<br/>
+**YAML configuration key name:** `check_for_potential_duplicate_pacticipant_names`<br/>
 **Default:** `true`<br/>
 **Allowed values:** `true`, `false`<br/>
 
@@ -544,9 +599,9 @@ also created for the pacticipant version.
 
 This is to assist in the migration from using tags to track deployments to using the deployed and released versions feature.
 
-**YAML configuration key name:** `create_deployed_versions_for_tags`<br/>
-**Environment variable name:** `PACT_BROKER_CREATE_DEPLOYED_VERSIONS_FOR_TAGS`<br/>
 **Supported versions:** From v2.81.0<br/>
+**Environment variable name:** `PACT_BROKER_CREATE_DEPLOYED_VERSIONS_FOR_TAGS`<br/>
+**YAML configuration key name:** `create_deployed_versions_for_tags`<br/>
 **Default:** `true`<br/>
 **Allowed values:** `true`, `false`<br/>
 **More information:** https://docs.pact.io/pact_broker/recording_deployments_and_releases/<br/>
@@ -558,9 +613,9 @@ will be used to populate the `branch` property of the version.
 
 This is to assist in the migration from using tags to track branches to using the branches feature.
 
-**YAML configuration key name:** `use_first_tag_as_branch`<br/>
-**Environment variable name:** `PACT_BROKER_USE_FIRST_TAG_AS_BRANCH`<br/>
 **Supported versions:** From v2.82.0<br/>
+**Environment variable name:** `PACT_BROKER_USE_FIRST_TAG_AS_BRANCH`<br/>
+**YAML configuration key name:** `use_first_tag_as_branch`<br/>
 **Default:** `true`<br/>
 **Allowed values:** `true`, `false`<br/>
 
@@ -571,9 +626,9 @@ the `mainBranch` property is set for that pacticipant if it is not already set.
 
 This is to assist in the migration from using tags to track branches to using the branches feature.
 
-**YAML configuration key name:** `auto_detect_main_branch`<br/>
-**Environment variable name:** `PACT_BROKER_AUTO_DETECT_MAIN_BRANCH`<br/>
 **Supported versions:** From v2.82.0<br/>
+**Environment variable name:** `PACT_BROKER_AUTO_DETECT_MAIN_BRANCH`<br/>
+**YAML configuration key name:** `auto_detect_main_branch`<br/>
 **Default:** `true`<br/>
 **Allowed values:** `true`, `false`<br/>
 
@@ -581,9 +636,9 @@ This is to assist in the migration from using tags to track branches to using th
 
 An array of potential main branch names used when automatically detecting the main branch for a pacticipant.
 
-**YAML configuration key name:** `main_branch_candidates`<br/>
-**Environment variable name:** `PACT_BROKER_MAIN_BRANCH_CANDIDATES`<br/>
 **Supported versions:** From v2.82.0<br/>
+**Environment variable name:** `PACT_BROKER_MAIN_BRANCH_CANDIDATES`<br/>
+**YAML configuration key name:** `main_branch_candidates`<br/>
 **Format:** A space delimited list.<br/>
 **Default:** `develop main master`<br/>
 
@@ -593,13 +648,22 @@ Whether or not to allow the pact content for an existing consumer version to be
 as allowing modification makes the results of can-i-deploy unreliable. When this is set to false as recommended, each commit must publish pacts
 with a unique version number.
 
-**YAML configuration key name:** `allow_dangerous_contract_modification`<br/>
-**Environment variable name:** `PACT_BROKER_ALLOW_DANGEROUS_CONTRACT_MODIFICATION`<br/>
 **Supported versions:** From v2.82.0<br/>
+**Environment variable name:** `PACT_BROKER_ALLOW_DANGEROUS_CONTRACT_MODIFICATION`<br/>
+**YAML configuration key name:** `allow_dangerous_contract_modification`<br/>
 **Default:** For new installations of v2.82.0 and later, this defaults to `false`.<br/>
 **Allowed values:** `true`, `false`<br/>
 **More information:** https://docs.pact.io/versioning<br/>
 
+### pact_content_diff_timeout
+
+The maximum amount of time in seconds to attempt to generate the diff between two pacts before aborting the request. This is required due to performance issues in the underlying diff generation code.
+
+**Supported versions:** From 2.99.0<br/>
+**Environment variable name:** `PACT_BROKER_PACT_CONTENT_DIFF_TIMEOUT`<br/>
+**YAML configuration key name:** `pact_content_diff_timeout`<br/>
+**Default:** `15`<br/>
+
 <br/>
 
 ## Miscellaneous
@@ -611,7 +675,7 @@ with a unique version number.
 
 A list of features to enable in the Pact Broker for beta testing before public release.
 
-**YAML configuration key name:** `features`<br/>
 **Environment variable name:** `PACT_BROKER_FEATURES`<br/>
+**YAML configuration key name:** `features`<br/>
 **Format:** A space separated list.<br/>
 

data/lib/db.rb

@@ -38,14 +38,8 @@ module DB
     con.extension(:connection_validator)
     con.extension(:pagination)
     con.extension(:statement_timeout)
+    con.extension(:any_not_empty)
     #con.extension(:caller_logging)
-    con.extend_datasets do
-      # rubocop: disable Lint/NestedMethodDefinition
-      def any?
-        !empty?
-      end
-      # rubocop: enable Lint/NestedMethodDefinition
-    end
     con.timezone = :utc
     con.run("SET sql_mode='STRICT_TRANS_TABLES';") if db_credentials[:adapter].to_s =~ /mysql/
     con

data/lib/pact_broker/api/middleware/http_debug_logs.rb

@@ -0,0 +1,42 @@
+require "pact_broker/logging"
+require "rack/pact_broker/request_target"
+
+module PactBroker
+  module Api
+    module Middleware
+      class HttpDebugLogs
+        include PactBroker::Logging
+        include Rack::PactBroker::RequestTarget
+
+        EXCLUDE_HEADERS = ["puma.", "rack.", "pactbroker."]
+        RACK_SESSION = "rack.session"
+
+        def initialize(app)
+          @app = app
+          @logger = logger
+        end
+
+        def call(env)
+          if request_for_api?(env)
+            env_to_log = env.reject { | header, _ | header.start_with?(*EXCLUDE_HEADERS) }
+            env_to_log["rack.session"] = env["rack.session"].to_hash if env["rack.session"]
+            env_to_log["rack.input"] = request_body(env) if env["rack.input"]
+            logger.debug("env", payload: env_to_log)
+            status, headers, body = @app.call(env)
+            logger.debug("response", payload: { "status" => status, "headers" => headers, "body" => body })
+            [status, headers, body]
+          else
+            @app.call(env)
+          end
+        end
+
+        def request_body(env)
+          buffer = env["rack.input"]
+          request_body = buffer.read
+          buffer.respond_to?(:rewind) && buffer.rewind
+          JSON.parse(request_body) rescue request_body
+        end
+      end
+    end
+  end
+end