Skip to content

Commit

Permalink
Change the file export location for CNB traces
Browse files Browse the repository at this point in the history
  • Loading branch information
joshwlewis committed May 30, 2024
1 parent d87875c commit 6438aed
Showing 1 changed file with 4 additions and 4 deletions.
8 changes: 4 additions & 4 deletions text/0000-build-observability.md
Original file line number Diff line number Diff line change
Expand Up @@ -66,9 +66,9 @@ Format](https://opentelemetry.io/docs/specs/otel/protocol/file-exporter/).

In this solution, each lifecycle phase would write a `.jsonl` file with
tracing data for that phase. For example, `lifecycle detector --telemetry`
would write to `/cnb/telemetry/lifecycle-detect.jsonl`. Additionally each
would write to `/layers/lifecycle-detect.jsonl`. Additionally each
buildpack may also write tracing data to it's own `.jsonl` files (at
`/cnb/telemetry/{BUILDPACK_ID}.jsonl`).
`/layers/#{buildpack-id}.jsonl`).

These `.jsonl` files may be read by platform operators for consumption,
transformation, enrichment, and/or export to an OpenTelemetry backend. Given
Expand All @@ -93,7 +93,7 @@ inherit `trace-id` and `parent-id` from platform systems.
If `lifecycle` is provided the telemetry opt-in flag (such as `--telemetry`),
`lifecycle` phases (such as `detect`, `build`, `export`) may emit an
OpenTelemetry File Export with tracing data to a known location, such as
`/cnb/telemetry/lifecycle-detect.jsonl` with contents like this:
`/layers/lifecycle-detect.jsonl` with contents like this:

```json
{
Expand Down Expand Up @@ -149,7 +149,7 @@ OpenTelemetry File Export with tracing data to a known location, such as
### Buildpack telemetry files

During a buildpack's `detect` or `build` execution, a buildpack may emit
an OpenTelemetry File Export with tracing data to `/cnb/telemetry/#{buildpack-id}.jsonl`
an OpenTelemetry File Export with tracing data to `/layers/#{buildpack-id}.jsonl`
with contents like this:

```json
Expand Down

0 comments on commit 6438aed

Please sign in to comment.