How to get logs from the Go agent

Objective

In rare scenarios, bad instrumentation causes a web server process to crash or a specific page to error out. If you ever encounter a crash or error caused by Contrast, please report the error via the Submit a Request link at the bottom of this page.

If possible, follow the steps below to gather agent logs; this additional information is vital to reproducing and fixing these types of bugs.

Process

You can ask Contrast to log verbose information by doing one of the following.

• contrast_security.yaml file:

agent:
  logger:
     path: /path/to/trace_contrast_agent.log
     level: DEBUG

• Environment Variables:

CONTRAST__AGENT__LOGGER__PATH='/path/to/trace_contrast_agent.log'
CONTRAST__AGENT__LOGGER__LEVEL='DEBUG'

If your application is running in an SaaS/CaaS environment where the logs are not easily accessible, logging can be sent to STDOUT instead by one of the following methods:

• contrast_security.yaml file:

agent:
  logger:
    stdout: true
    level: DEBUG

• Environment Variables:

CONTRAST__AGENT__LOGGER__LEVEL='DEBUG'
CONTRAST__AGENT__LOGGER__STDOUT=true

These options will put Contrast into debug mode and log all output to the log file specified as the system property value. It will also prevent the log from rolling over into multiple files. The log file will start with some messages that look similar to this:

These verbose logs will allow our support team to diagnose any issues you may encounter. To contact the Contrast Support Team, please submit a ticket to our online support portal.