How to enable the fluent-bit debug logging in the Terraform Enterprise

Introduction

When troubleshooting logging issues in Terraform Enterprise, it may be necessary to temporarily increase the log verbosity of the fluent-bit container. This guide provides the procedure to set the log level to debug.

Prerequisites

• Root or sudo access to the Terraform Enterprise host machine.
• Terraform Enterprise installed via a Docker-based method.

Procedure

Follow these steps to modify the Fluent Bit configuration and enable debug logging.

1. Copy the fluent-bit.conf file from the tfe-fluent-bit container to the local filesystem on the host machine.

   # sudo docker cp tfe-fluent-bit:/fluent-bit/etc/fluent-bit.conf ./

2. Edit the local copy of fluent-bit.conf to add the Log_Level parameter with a value of debug under the [SERVICE] section.

   [SERVICE]
       Parsers_File /fluent-bit/etc/parsers.conf
       HTTP_Server On
       HTTP_Listen 0.0.0.0
       HTTP_Port 2020
       Health_Check On
       storage.path /fluent-bit/run/buffer
       storage.metrics on
       Log_Level debug

3. Copy the modified configuration file back into the container, placing it in a temporary directory.

   # sudo docker cp fluent-bit.conf tfe-fluent-bit:/tmp/fluent-bit.conf

4. Execute a command inside the container to move the new configuration file to its correct location, overwriting the original file.

   # sudo docker exec -it tfe-fluent-bit cp /tmp/fluent-bit.conf /fluent-bit/etc/fluent-bit.conf

5. Restart the tfe-fluent-bit container to apply the new configuration.

   # sudo docker restart tfe-fluent-bit

Verification

Confirm that the container has restarted with debug logging enabled by checking its logs.

# sudo docker logs tfe-fluent-bit

The log output should now include more verbose entries, indicating that the debug log level is active.

Note: After you have completed troubleshooting, we recommend reverting these changes to restore the default log level and reduce log volume.