Allow self-hosted customers to export Open Telemetry traces to disk

[desruc]

Are you a customer of Octopus Deploy? Don't raise the issue here. Please contact our support team so we can triage your feature request, making sure it's handled appropriately.

Prerequisites

• I have searched open and closed issues to make sure it isn't already requested
• My team has started working on this issue
• I have written a descriptive issue title

The enhancement

The Need

OpenTelemetry traces are a valuable tool for troubleshooting issues. We currently send traces to Honeycomb for Octopus Cloud customers, but self-hosted environments have no equivalent capability.

We have built the ability for Octopus Server to capture OpenTelemetry trace data locally. If a problem occurs, self-hosted customers can send this trace data to Octopus support to help us diagnose and fix the issue.

Solution

Trace data is stored on disk as .tar files in OTLP JSON format, which (when decompressed) is compatible with the open-source OpenTelemetry Collector.

Customers can enable and configure this feature via Configuration ➜ Diagnostics with the following settings:

• Enabled/Disabled
• Retention days - how long to keep trace files
• Max storage size - disk space limit for trace files

Trace files can be downloaded directly from the Diagnostics page and sent to Octopus support when requested.

Screenshots and Mockups

Diagnostics page:

Server Traces page:

Links

More information can be found on our public docs.