docs.pact.io icon indicating copy to clipboard operation
docs.pact.io copied to clipboard

Document Verbose/Debug Logging for all Pact libraries

Open YOU54F opened this issue 1 year ago • 0 comments

Document Verbose/Debug Logging for all Pact libraries

What

We would like to document how to enable verbose / debug logging, for all Pact libraries

Centralised place - https://docs.pact.io/help/enabling-debug-logging

Why

Enabling debug/verbose logging can help identify the cause of issues. For many Pact libraries, this will allow you to see the HTTP requests and responses when the library interacts with a Pact Broker or PactFlow.

There may be different options available to you depending on your Pact client library and its particular version.

For older Pact libraries that wrap a shared Ruby Pact implementation, verbose logging can be enabled by setting the environment variable VERBOSE=true. New Pact libraries that use the shared Rust Pact implementation will have their own language specific ways of enabling verbose logging.

How can you help

We would like to centralise a place for this knowledge, so a docs page has been created.

We’re going to need to fill in these details , and it’s going to depend on the version of each library, depending whether it’s backed by ruby or rust.

If you are a maintainer, or user of a Pact client library, and you can find out how to enable verbose logging in your library, we would appreciate your help in sharing this knowledge with others.

Please make an edit to the page, this link will shortcut you to proposing a pull request.

Tasks

There are other Pact libraries not listed, please do not feel they are excluded, we would also appreciate pull requests for them.

Side notes

If anyone has any cool ideas about how best to present this information to you, as a user, potentially of multiple client libraries, please do get in touch

YOU54F avatar Mar 15 '23 14:03 YOU54F