PingDirectory

Logging

Use the PingDirectory server trace log publisher for logging events generated by HTTP service operations.

About this task

You can use the trace logger to observe, debug, and audit consent requests.

Steps

  • Create a trace logger for all consent events using dsconfig create-log-publisher.

    To create a log of consent audit events only, remove all message types except for consent-message-type:audit.

    Example:

    The following example creates a trace logger for all consent events and summaries of HTTP requests and responses.

    $ bin/dsconfig create-log-publisher \
      --publisher-name "Consent Trace Logger" \
      --type file-based-trace \
      --set "description:Records Consent API operations" \
      --set enabled:true \
      --set consent-message-type:audit \
      --set consent-message-type:consent-created \
      --set consent-message-type:consent-deleted \
      --set consent-message-type:consent-retrieved \
      --set consent-message-type:consent-search \
      --set consent-message-type:consent-updated \
      --set consent-message-type:definition-created \
      --set consent-message-type:definition-deleted \
      --set consent-message-type:definition-retrieved \
      --set consent-message-type:definition-search \
      --set consent-message-type:definition-updated \
      --set consent-message-type:error \
      --set consent-message-type:localization-created \
      --set consent-message-type:localization-deleted \
      --set consent-message-type:localization-retrieved \
      --set consent-message-type:localization-search \
      --set consent-message-type:localization-updated \
      --set http-message-type:request \
      --set http-message-type:response \
      --set 'exclude-path-pattern://.css' \
      --set 'exclude-path-pattern://.eot' \
      --set 'exclude-path-pattern://.gif' \
      --set 'exclude-path-pattern://.ico' \
      --set 'exclude-path-pattern://.jpg' \
      --set 'exclude-path-pattern://.js' \
      --set 'exclude-path-pattern://.png' \
      --set 'exclude-path-pattern://.svg' \
      --set 'exclude-path-pattern://.ttf' \
      --set 'exclude-path-pattern://.woff' \
      --set 'exclude-path-pattern://*.woff2' \
      --set 'exclude-path-pattern:/console/' \
      --set 'exclude-path-pattern:/console//template/' \
      --set log-file:logs/consent-trace \
      --set "retention-policy:File Count Retention Policy" \
      --set "retention-policy:Free Disk Space Retention Policy" \
      --set "rotation-policy:24 Hours Time Limit Rotation Policy" \
      --set "rotation-policy:Size Limit Rotation Policy"