-
Notifications
You must be signed in to change notification settings - Fork 1.9k
Managed telemetry.headers prevents OpenTelemetry (OTEL) export #4669
Copy link
Copy link
Closed
Labels
area:configurationConfig files, instruction files, settings, and environment variablesConfig files, instruction files, settings, and environment variablesarea:enterpriseGitHub Enterprise (GHE/GHES) support, org policies, and enterprise settingsGitHub Enterprise (GHE/GHES) support, org policies, and enterprise settingsarea:networkingProxy, SSL/TLS, certificates, corporate environments, and connectivity issuesProxy, SSL/TLS, certificates, corporate environments, and connectivity issues
Description
Activity
Metadata
Metadata
Assignees
Labels
area:configurationConfig files, instruction files, settings, and environment variablesConfig files, instruction files, settings, and environment variablesarea:enterpriseGitHub Enterprise (GHE/GHES) support, org policies, and enterprise settingsGitHub Enterprise (GHE/GHES) support, org policies, and enterprise settingsarea:networkingProxy, SSL/TLS, certificates, corporate environments, and connectivity issuesProxy, SSL/TLS, certificates, corporate environments, and connectivity issues
Describe the bug
When OpenTelemetry is configured through
/etc/github-copilot/managed-settings.json, adding any entry totelemetry.headerscauses Copilot CLI to stop exporting telemetry.The same configuration exports successfully when
headersis absent or empty. The same header also works when supplied throughOTEL_EXPORTER_OTLP_HEADERS.GitHub's managed-settings documentation lists
telemetry.headersas a supported Copilot CLI setting.Affected version
GitHub Copilot CLI 1.0.82
Steps to reproduce the behavior
Start a local OTLP/HTTP listener on
127.0.0.1:4318(see example here)Configure
/etc/github-copilot/managed-settings.json:{ "telemetry": { "enabled": true, "endpoint": "http://127.0.0.1:4318", "protocol": "http/json", "headers": {} } }Restart Copilot CLI and generate activity.
OTLP requests are received by the listener.
Change only
headers:Restart Copilot CLI and generate activity again.
No OTLP requests are received.
Remove
headersfrom the managed settings and instead start Copilot with:OTEL_EXPORTER_OTLP_HEADERS='X-Test=HELLO' copilotExpected behavior
A non-empty
telemetry.headersobject in managed settings should not disable OTLP export.For example:
should result in normal OTLP export with
X-Test: HELLOattached to the HTTP requests, consistent with the documented behavior.Additional context
/etc/github-copilot/managed-settings.jsonroot:root, mode0644