Skip to content

Commit 39b4a76

Browse files
docs: address review feedback
- Remove docs/README.md (unnecessary file) - Shorten OpenTelemetry section in README.md - Link to detailed observability.md documentation Addresses review comments on PR #288 Co-authored-by: Ona <[email protected]>
1 parent a64253c commit 39b4a76

File tree

2 files changed

+3
-52
lines changed

2 files changed

+3
-52
lines changed

README.md

Lines changed: 3 additions & 51 deletions
Original file line numberDiff line numberDiff line change
@@ -595,11 +595,9 @@ variables have an effect on leeway:
595595

596596
# OpenTelemetry Tracing
597597

598-
Leeway supports distributed tracing using OpenTelemetry to provide visibility into build performance and behavior.
598+
Leeway supports distributed tracing using OpenTelemetry for build performance visibility.
599599

600-
## Configuration
601-
602-
Enable tracing by setting the OTLP endpoint:
600+
## Quick Start
603601

604602
```bash
605603
# Local development (Jaeger)
@@ -613,53 +611,7 @@ export OTEL_EXPORTER_OTLP_HEADERS="x-honeycomb-team=YOUR_API_KEY"
613611
leeway build :my-package
614612
```
615613

616-
Or using CLI flags:
617-
618-
```bash
619-
leeway build :my-package --otel-endpoint=localhost:4318 --otel-insecure
620-
```
621-
622-
## Environment Variables
623-
624-
- `OTEL_EXPORTER_OTLP_ENDPOINT`: OTLP endpoint URL
625-
- `OTEL_EXPORTER_OTLP_INSECURE`: Disable TLS (`true` or `false`, default: `false`)
626-
- `OTEL_EXPORTER_OTLP_HEADERS`: Additional headers (e.g., API keys)
627-
- `TRACEPARENT`: W3C Trace Context traceparent header for distributed tracing
628-
- `TRACESTATE`: W3C Trace Context tracestate header
629-
630-
## CLI Flags
631-
632-
- `--otel-endpoint`: OTLP endpoint URL (overrides environment variable)
633-
- `--otel-insecure`: Disable TLS for OTLP endpoint
634-
- `--trace-parent`: W3C traceparent header for parent trace context
635-
- `--trace-state`: W3C tracestate header
636-
637-
## What Gets Traced
638-
639-
- Build lifecycle (start to finish)
640-
- Individual package builds with timing
641-
- Build phases (prep, pull, lint, test, build, package)
642-
- Cache hit/miss information
643-
- GitHub Actions context (when running in CI)
644-
645-
## Example with Jaeger
646-
647-
```bash
648-
# Start Jaeger
649-
docker run -d --name jaeger \
650-
-p 4318:4318 \
651-
-p 16686:16686 \
652-
jaegertracing/all-in-one:latest
653-
654-
# Build with tracing (insecure for local development)
655-
export OTEL_EXPORTER_OTLP_ENDPOINT=localhost:4318
656-
export OTEL_EXPORTER_OTLP_INSECURE=true
657-
leeway build :my-package
658-
659-
# View traces at http://localhost:16686
660-
```
661-
662-
For detailed information, see [docs/observability.md](docs/observability.md).
614+
**For detailed configuration, examples, and span attributes, see [docs/observability.md](docs/observability.md).**
663615

664616
# Provenance (SLSA) - EXPERIMENTAL
665617
leeway can produce provenance information as part of a build. At the moment only [SLSA Provenance v0.2](https://slsa.dev/provenance/v0.2) is supported. This support is **experimental**.

docs/README.md

Lines changed: 0 additions & 1 deletion
This file was deleted.

0 commit comments

Comments
 (0)