DocuSign.Debug (DocuSign v3.1.1)

Debugging and logging configuration for the DocuSign Elixir client.

This module provides functionality to configure debug logging for HTTP requests and responses, similar to the Ruby DocuSign client's debugging capabilities.

Configuration

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

config :docusign, debug: true

You can also configure logging at runtime:

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

Debug Logging

When debugging is enabled, the client will log:

HTTP request method, URL, and headers
HTTP request body (with sensitive data filtered)
HTTP response status, headers, and body
Request/response timing information

Header Filtering

Sensitive headers like authorization tokens are automatically filtered in debug logs:

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()

Summary

Functions

all_middleware() deprecated

Get all middleware for DocuSign connections including debugging and SDK headers.

debugging_enabled?()

Check if debugging is currently enabled.

disable_debugging()

Disable debugging for DocuSign HTTP requests.

enable_debugging()

Enable debugging for DocuSign HTTP requests.

filter_headers()

Get the list of headers to filter in debug logs.

middleware() deprecated

Build middleware for debugging based on current configuration.

sdk_headers()

Get SDK headers for identifying the Elixir client.

Functions

all_middleware()

This function is deprecated. Use sdk_headers() directly with Req configuration.

@spec all_middleware() :: list()

Get all middleware for DocuSign connections including debugging and SDK headers.

Note: This function is now deprecated as Req handles middleware differently. Use sdk_headers() directly if needed.