vrr/goose
2
0
Fork 0
mirror of https://github.com/block/goose.git synced 2026-04-28 19:49:51 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 34

docs: update OTel environment variable and config guides (#7221)

Browse source 
Signed-off-by: Adrian Cole <adrian@tetrate.io>
Co-authored-by: Rizel Scarlett <rizel@squareup.com>
This commit is contained in:
Adrian Cole 2026-02-18 14:41:22 -05:00 • committed by GitHub
parent b5d8a3e30a
commit 88840791e6
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
2 changed files with 51 additions and 22 deletions
Download patch file Download diff file Expand all files Collapse all files

20
documentation/docs/guides/config-files.md
View file

@ -49,8 +49,6 @@ The following settings can be configured at the root level of your config.yaml f
| `GOOSE_ALLOWLIST` | URL for allowed extensions | Valid URL | None | No |
| `GOOSE_RECIPE_GITHUB_REPO` | GitHub repository for recipes | Format: "org/repo" | None | No |
| `GOOSE_AUTO_COMPACT_THRESHOLD` | Set the percentage threshold at which goose [automatically summarizes your session](/docs/guides/sessions/smart-context-management#automatic-compaction). | Float between 0.0 and 1.0 (disabled at 0.0)| 0.8 | No |
| `OTEL_EXPORTER_OTLP_ENDPOINT` | OTLP endpoint URL for [observability](/docs/guides/environment-variables#opentelemetry-protocol-otlp) | URL (e.g., `http://localhost:4318`) | None | No |
| `OTEL_EXPORTER_OTLP_TIMEOUT` | Export timeout in milliseconds for [observability](/docs/guides/environment-variables#opentelemetry-protocol-otlp) | Integer (ms) | 10000 | No |
| `SECURITY_PROMPT_ENABLED` | Enable [prompt injection detection](/docs/guides/security/prompt-injection-detection) to identify potentially harmful commands | true/false | false | No |
| `SECURITY_PROMPT_THRESHOLD` | Sensitivity threshold for prompt injection detection (higher = stricter) | Float between 0.01 and 1.0 | 0.8 | No |
| `SECURITY_PROMPT_CLASSIFIER_ENABLED` | Enable ML-based prompt injection detection for advanced threat identification | true/false | false | No |
@ -96,10 +94,6 @@ GOOSE_SEARCH_PATHS:
- "~/custom/tools"
- "/opt/homebrew/bin"
# Observability (OpenTelemetry)
OTEL_EXPORTER_OTLP_ENDPOINT: "http://localhost:4318"
OTEL_EXPORTER_OTLP_TIMEOUT: 20000
# Security Configuration
SECURITY_PROMPT_ENABLED: true
@ -155,6 +149,20 @@ GOOSE_SEARCH_PATHS:
These paths are prepended to the system PATH when running extension commands, ensuring your custom tools are found without modifying your global PATH.
## 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.
| Setting | Purpose | Values | Default |
|---------|---------|--------|---------|
| `otel_exporter_otlp_endpoint` | OTLP endpoint URL | URL (e.g., `http://localhost:4318`) | None |
| `otel_exporter_otlp_timeout` | Export timeout in milliseconds | Integer (ms) | 10000 |
```yaml
otel_exporter_otlp_endpoint: "http://localhost:4318"
otel_exporter_otlp_timeout: 20000
```
## Recipe Command Configuration
You can optionally set up [custom slash commands](/docs/guides/context-engineering/slash-commands) to run recipes that you create. List the command (without the leading `/`) along with the path to the recipe: