DEBUGGING.md

ULS Troubleshooting and debugging

This document describes how to troubleshoot and debug Unified Log Streamer software.

Please make sure you follow the steps before filing an issue on the GitHub Issues Page, collecting these information increase our chance to understand the issue, and shorten the time to provide you support.

Make sure you're using the latest version

We strive at fixing issues as they arise and add new features, with new version coming throughout the months.

We strongly encourage to always get the latest version of ULS. You can find the latest version in the release page. See also ULS updater script documentation.

Table of contents

• ULS Troubleshooting and debugging
  • Make sure you're using the latest version
  • Table of contents
  • Version information
    • Commands to trigger version output
      • Command line
      • Docker
    • Example Output
  • Debug output from ULS
    • Commands to trigger debug output
      • Command Line
      • Docker
  • Debug output from CLI's
    • Steps to get CLI Debug output
      • CLI with ULS
      • DOCKER / DOCKER-COMPOSE

Version information

Providing information about relevant module & software versions can help identify issues.

Commands to trigger version output

Command line

python3 bin/uls.py --version

Docker

docker run -ti --mount type=bind,source="/path/to/your/.edgerc",target="/opt/akamai-uls/.edgerc",readonly --rm akamai/uls -v 

Example Output

Akamai Unified Log Streamer Version information
ULS Version             0.0.1

EAA Version             0.3.8
ETP Version             0.3.4
MFA Version             0.0.4

OS Plattform            Linux-5.10.25-linuxkit-x86_64-with-glibc2.28
OS Version              5.10.25-linuxkit
Python Version          3.9.5

Debug output from ULS

To debug problems into depth, ULS provides an extremely verbose output about every step processed within ULS.

Commands to trigger debug output

Command Line

python3 bin/uls.py --loglevel debug <rest of your ULS command>

Docker

docker run -ti \
  --mount type=bind,source="/path/to/your/.edgerc",target="/opt/akamai-uls/.edgerc",readonly \
  --rm \
  --name uls_debugging \
  akamai/uls --loglevel debug <rest of your ULS command parameters> 

Instead of adding it to the command line, you can also set the ULS_LOGLEVEL ENV VAR to "DEBUG"

Debug output from CLI's

This is helpful when a deeper debugging from within the CLI tool is required.

Steps to get CLI Debug output

CLI with ULS

1. Run the desired stream in ULS DEBUG mode and grab the command output i.e.

    ULS D UlsInputCli - CLI Command:  ['python3', 'ext/cli-eaa/bin/akamai-eaa', '--edgerc', '~/.edgerc', '--section', 'akamaidemo', '--user-agent-prefix', 'ULS/0.0.3_EAA-CONHEALTH', 'connector', 'list', '--perf', '--tail', '--json']

2. Use the output to draft an RAWCMD and run it with the --rawcmd flag

   python3.9 bin/uls.py --rawcmd "--edgerc ~/.edgerc --section akamaidemo connector list --perf --tail --json" --output raw

   Feel free to omit the "--user-agent-prefix" flag To get a more detailed output, you can add the CLI debugging flag -d

   python3.9 bin/uls.py --rawcmd "-d --edgerc ~/.edgerc --section akamaidemo connector list --perf --tail --json" --output raw --loglevel debug

   Via this way, you can get the full CLI debugging output within ULS

DOCKER / DOCKER-COMPOSE

1. Start a debugging docker instance and connect to it's console

   docker run -ti \
     --mount type=bind,source="/path/to/your/.edgerc",target="/opt/akamai-uls/.edgerc",readonly \
     --entrypoint "/bin/bash" \
     --name uls_debugging \
     --rm akamai/uls:latest

2. Run CLI directly within the container
   Example:

    ext/cli-eaa/bin/akamai-eaa -d --edgerc ~/.edgerc --section akamaidemo connector list --perf --tail --json

   This will debug the exact same thing as above, but without passing the data through ULS (and eventually your SIEM)
   As alternative you also can run the above command omn the CLI directly ;)