Troubleshooting Go Compile-Time Instrumentation
このページは日本語には対応しておりません。随時翻訳に取り組んでいます。翻訳に関してご質問やご意見ございましたら、お気軽にご連絡ください。
Overview
This guide explains how to troubleshoot builds that Orchestrion manages. These procedures can help Datadog gather insights about build processes and can assist with bug reports.
The generated files may contain sensitive project information, such as source code and dependency names. If sharing such information publicly is a concern, contact Datadog support to share the data privately.
Preserving the work tree
Orchestrion records build transformations in the go build work tree. To prevent the go toolchain from cleaning this directory after building, use the -work flag:
orchestrion go build -work ./...
WORK=/tmp/go-build2455442813
The work tree location prints at the start of the build, marked with WORK=. This directory contains subdirectories for each built go package, which are called stage directories.
Work tree contents
When Orchestrion injects code into a source file, it writes the modified file to the package’s stage directory ($WORK/b###) in the orchestrion/src subdirectory. For modified package import configurations, the original file is preserved with a .original suffix. You can inspect these human-readable files to verify Orchestrion’s actions. Contact Datadog support for help interpreting these files.
Logging configuration
Log levels
Control Orchestrion’s logging output using the ORCHESTRION_LOG_LEVEL environment variable or --log-level flag:
| Level | Description |
|---|
NONE, OFF (default) | No logging output |
ERROR | Error information only |
WARN | Errors and warnings |
INFO | Errors, warnings, and informational messages |
DEBUG | Detailed logging |
TRACE | Extremely detailed logging |
Setting ORCHESTRION_LOG_LEVEL to the DEBUG or TRACE levels might have a significant impact on build performance. These settings are not recommended for normal operations.
Log file output
Write logging messages to files instead of the console by setting the ORCHESTRION_LOG_FILE environment variable or --log-file flag with the desired file path.
Setting ORCHESTRION_LOG_FILE changes the default value of ORCHESTRION_LOG_LEVEL to WARN.
The log file path can include $PID or ${PID} tokens, which are replaced with the logging process’s PID. This reduces file contention but creates multiple log files for large projects.
Logging appends to existing files rather than overwriting them, regardless of the presence of $PID in the file path.
Further reading
