docs: update OTel environment variable and config guides by codefromthecrypt · Pull Request #7221 · block/goose

codefromthecrypt · 2026-02-14T00:59:05Z

Summary

Updates documentation to canonical otel ENV

Type of Change

Documentation

AI Assistance

This PR was created or reviewed with AI assistance

Related Issues

Docs from #7144

Copilot

Pull request overview

This PR updates OpenTelemetry documentation to describe enhanced environment variable support introduced in PR #7144. However, PR #7144 has not been merged yet, so this documentation describes features that do not currently exist in the codebase.

Changes:

Updated environment-variables.md to document per-signal OTel exporter configuration (OTEL_TRACES_EXPORTER, OTEL_METRICS_EXPORTER, OTEL_LOGS_EXPORTER, OTEL_SDK_DISABLED)
Added comment to config-files.md recommending environment variables over config file for OTel settings

Reviewed changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated 2 comments.

File	Description
documentation/docs/guides/environment-variables.md	Expands OpenTelemetry section with per-signal exporter configuration, signal-specific endpoints, and updated examples
documentation/docs/guides/config-files.md	Adds comment recommending ENV over config file for OTel configuration

documentation/docs/guides/environment-variables.md

documentation/docs/guides/config-files.md

github-actions · 2026-02-14T01:02:07Z

PR Preview Action v1.8.1
Preview removed because the pull request was closed.
2026-02-18 19:49 UTC

Copilot

Pull request overview

Copilot reviewed 2 out of 2 changed files in this pull request and generated 1 comment.

documentation/docs/guides/config-files.md

Signed-off-by: Adrian Cole <adrian@tetrate.io>

codefromthecrypt · 2026-02-15T15:40:03Z

documentation/docs/guides/environment-variables.md

+# Debug traces to console (no collector needed)
+export OTEL_TRACES_EXPORTER="console"
+
+# Sample 10% of traces (reduce volume in production)


example for setting 10pct sampling as default is 100pct. 100pct is what a lot of APM backends want, as they can derive metrics from spans, but is expensive.

blackgirlbytes · 2026-02-16T23:47:36Z

awesome! thanks..once your other PR is released..I think it will go out in the next release..then we can merge this! cc-ing: @dianed-square as well so she's aware.

blackgirlbytes · 2026-02-16T23:49:12Z

documentation/docs/guides/config-files.md

what does this mean? excuse my ignorance.

i think i tmeans you can put it in the config, as here, but if you have environment variables, it will use them instead?

ohhh okay. I will suggest a slight rewrite for clarity. thanks mic

- Remove OTEL entries from Global Settings table - Remove OTEL block with awkward comment from Example Configuration - Add new Observability Configuration section with: - Proper hyperlink to environment variables guide - Table with lowercase keys (matching what code expects) - YAML example

Copilot

Pull request overview

Copilot reviewed 2 out of 2 changed files in this pull request and generated no new comments.

Copilot

Pull request overview

Copilot reviewed 2 out of 2 changed files in this pull request and generated 1 comment.

Copilot · 2026-02-18T19:43:32Z

documentation/docs/guides/config-files.md


+## Observability Configuration
+
+Configure goose to export telemetry to [OpenTelemetry](https://opentelemetry.io/docs/) compatible platforms. Environment variables override these settings and support additional options like per-signal configuration. See the [environment variables guide](/docs/guides/environment-variables#opentelemetry-protocol-otlp) for details.


The anchor link #opentelemetry-protocol-otlp is broken. The section in environment-variables.md was renamed from "OpenTelemetry Protocol (OTLP)" to "Observability Configuration", so the anchor should be #observability-configuration.

Suggested change

Configure goose to export telemetry to [OpenTelemetry](https://opentelemetry.io/docs/) compatible platforms. Environment variables override these settings and support additional options like per-signal configuration. See the [environment variables guide](/docs/guides/environment-variables#opentelemetry-protocol-otlp) for details.

Configure goose to export telemetry to [OpenTelemetry](https://opentelemetry.io/docs/) compatible platforms. Environment variables override these settings and support additional options like per-signal configuration. See the [environment variables guide](/docs/guides/environment-variables#observability-configuration) for details.

* origin/main: docs: remove ALPHA_FEATURES flag from documentation (#7315) docs: escape variable syntax in recipes (#7314) docs: update OTel environment variable and config guides (#7221) docs: system proxy settings (#7311) docs: add Summon extension tutorial and update Skills references (#7310) docs: agent session id (#7289) fix(gemini-cli): restore streaming lost in #7247 (#7291) Update more instructions (#7305) feat: add Moonshot and Kimi Code declarative providers (#7304) fix(cli): handle Reasoning content and fix streaming thinking display (#7296) feat: add GOOSE_SUBAGENT_MODEL and GOOSE_SUBAGENT_PROVIDER config options (#7277) fix(openai): support "reasoning" field alias in streaming deltas (#7294) fix(ui): revert app-driven iframe width and send containerDimensions per ext-apps spec (#7300) New OpenAI event (#7301) ci: add fork guards to scheduled workflows (#7292)

* main: (54 commits) docs: add monitoring subagent activity section (#7323) docs: document Desktop UI recipe editing for model/provider and extensions (#7327) docs: add CLAUDE_THINKING_BUDGET and CLAUDE_THINKING_ENABLED environm… (#7330) fix: display 'Code Mode' instead of 'code_execution' in CLI (#7321) docs: add Permission Policy documentation for MCP Apps (#7325) update RPI plan prompt (#7326) docs: add CLI syntax highlighting theme customization (#7324) fix(cli): replace shell-based update with native Rust implementation (#7148) docs: rename Code Execution extension to Code Mode extension (#7316) docs: remove ALPHA_FEATURES flag from documentation (#7315) docs: escape variable syntax in recipes (#7314) docs: update OTel environment variable and config guides (#7221) docs: system proxy settings (#7311) docs: add Summon extension tutorial and update Skills references (#7310) docs: agent session id (#7289) fix(gemini-cli): restore streaming lost in #7247 (#7291) Update more instructions (#7305) feat: add Moonshot and Kimi Code declarative providers (#7304) fix(cli): handle Reasoning content and fix streaming thinking display (#7296) feat: add GOOSE_SUBAGENT_MODEL and GOOSE_SUBAGENT_PROVIDER config options (#7277) ...

codefromthecrypt requested a review from a team as a code owner February 14, 2026 00:59

Copilot AI review requested due to automatic review settings February 14, 2026 00:59

codefromthecrypt mentioned this pull request Feb 14, 2026

feat(otel): respect standard OTel env vars for exporter selection #7144

Merged

4 tasks

Copilot started reviewing on behalf of codefromthecrypt February 14, 2026 00:59 View session

Copilot AI reviewed Feb 14, 2026

View reviewed changes

documentation/docs/guides/environment-variables.md Outdated Show resolved Hide resolved

documentation/docs/guides/config-files.md Outdated Show resolved Hide resolved

codefromthecrypt marked this pull request as draft February 14, 2026 01:04

codefromthecrypt force-pushed the adrian/otel-env-docs branch from 06df55b to 9e9545d Compare February 14, 2026 01:27

codefromthecrypt marked this pull request as ready for review February 14, 2026 01:27

Copilot AI review requested due to automatic review settings February 14, 2026 01:27

Copilot started reviewing on behalf of codefromthecrypt February 14, 2026 01:28 View session

Copilot AI reviewed Feb 14, 2026

View reviewed changes

documentation/docs/guides/config-files.md Outdated Show resolved Hide resolved

codefromthecrypt added 2 commits February 15, 2026 10:35

docs: update OTel environment variable and config guides

fd40b38

Signed-off-by: Adrian Cole <adrian@tetrate.io>

docs(otel): add sampling example and fix config key casing

f537c70

Signed-off-by: Adrian Cole <adrian@tetrate.io>

codefromthecrypt force-pushed the adrian/otel-env-docs branch from 9e9545d to f537c70 Compare February 15, 2026 15:37

codefromthecrypt commented Feb 15, 2026

View reviewed changes

michaelneale approved these changes Feb 16, 2026

View reviewed changes

codefromthecrypt enabled auto-merge February 16, 2026 12:56

blackgirlbytes reviewed Feb 16, 2026

View reviewed changes

Copilot AI review requested due to automatic review settings February 18, 2026 19:23

Copilot started reviewing on behalf of blackgirlbytes February 18, 2026 19:24 View session

Copilot AI reviewed Feb 18, 2026

View reviewed changes

blackgirlbytes added 3 commits February 18, 2026 14:33

docs: simplify OTLP intro in environment-variables.md

6b38be4

docs: remove em-dash from observability config section

56e42ea

docs: rename OTLP section to Observability Configuration for consistency

249ae51

Copilot AI review requested due to automatic review settings February 18, 2026 19:40

Copilot started reviewing on behalf of blackgirlbytes February 18, 2026 19:41 View session

blackgirlbytes approved these changes Feb 18, 2026

View reviewed changes

codefromthecrypt added this pull request to the merge queue Feb 18, 2026

Copilot AI reviewed Feb 18, 2026

View reviewed changes

Merged via the queue into main with commit 8884079 Feb 18, 2026
28 checks passed

codefromthecrypt deleted the adrian/otel-env-docs branch February 18, 2026 19:46


		## Observability Configuration

		Configure goose to export telemetry to [OpenTelemetry](https://opentelemetry.io/docs/) compatible platforms. Environment variables override these settings and support additional options like per-signal configuration. See the [environment variables guide](/docs/guides/environment-variables#opentelemetry-protocol-otlp) for details.

Conversation

codefromthecrypt commented Feb 14, 2026

Summary

Type of Change

AI Assistance

Related Issues

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Uh oh!

Uh oh!

github-actions bot commented Feb 14, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Uh oh!

codefromthecrypt Feb 15, 2026

Choose a reason for hiding this comment

Uh oh!

blackgirlbytes commented Feb 16, 2026

Uh oh!

blackgirlbytes Feb 16, 2026

Choose a reason for hiding this comment

Uh oh!

michaelneale Feb 16, 2026

Choose a reason for hiding this comment

Uh oh!

blackgirlbytes Feb 17, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Copilot AI Feb 18, 2026

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Comments

github-actions bot commented Feb 14, 2026 •

edited

Loading