Debugging and logging configuration for the DocuSign Elixir client.

Configure debug logging for HTTP requests and responses.

Configuration

Enable debugging by setting the :debug option in your application config:

config :docusign, debug: true

You can also configure logging at runtime before creating a connection:

DocuSign.Debug.enable_debugging()
DocuSign.Debug.disable_debugging()

The :debug setting determines whether debug steps are added when a connection is created. Changing it does not update existing connections. Messages use the :debug log level; configure Logger to allow that level to see them.

Debug Logging

With debug: true, the client logs the request method and URL, response status, and filtered request and response headers. Bodies are omitted by default.

Set debug_body: true in application configuration to log bodies:

config :docusign, debug: true, debug_body: true

Bodies are logged verbatim, without filtering. They can contain signer names, emails, and document content. Do not enable debug_body in production.

A direct DocuSign.Connection.request/2 call can override body and header logging:

DocuSign.Connection.request(conn,
  method: :get,
  url: "/accounts",
  debug_body: true,
  debug_headers: false
)

These per-request options require a connection created with debugging enabled. debug_body defaults to the application setting, or false. debug_headers defaults to true; setting it to false omits headers while keeping the method, URL, and status. Generated API functions do not forward these options.

Header Filtering

The authorization header is filtered by default. In both request and response logs, each header whose name matches the filter list has its entire value replaced with "[FILTERED]". Header names are kept and compared case-insensitively.

This configuration replaces the default list; keep "authorization" to continue filtering bearer tokens:

config :docusign, :debug_filter_headers, ["authorization", "x-api-key"]

Examples

# Enable debugging for development
config :docusign, debug: true

# Configure debug settings
config :docusign,
  debug: true,
  debug_filter_headers: ["authorization", "x-custom-secret"]

# Or enable at runtime
DocuSign.Debug.enable_debugging()