Skip to content

Commit eb4982b

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 <no-reply@ona.com>
1 parent 01bfb7a commit eb4982b

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
@@ -600,11 +600,9 @@ variables have an effect on leeway:
600600

601601
# OpenTelemetry Tracing
602602

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

605-
## Configuration
606-
607-
Enable tracing by setting the OTLP endpoint:
605+
## Quick Start
608606

609607
```bash
610608
# Local development (Jaeger)
@@ -618,53 +616,7 @@ export OTEL_EXPORTER_OTLP_HEADERS="x-honeycomb-team=YOUR_API_KEY"
618616
leeway build :my-package
619617
```
620618

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

669621
# Provenance (SLSA) - EXPERIMENTAL
670622
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)