From 174260ad44e9ed5eb574cb9ea2d99ac5b868b031 Mon Sep 17 00:00:00 2001 From: MJ Date: Wed, 12 Oct 2022 12:21:27 -0700 Subject: [PATCH 1/6] be clear that status will end the trace --- README.md | 1 + 1 file changed, 1 insertion(+) diff --git a/README.md b/README.md index 2b2cdcf..b628366 100644 --- a/README.md +++ b/README.md @@ -19,6 +19,7 @@ This GitHub Action instruments your workflows using [Honeycomb's buildevents too - The required input field `job-status` has been renamed to `status`. This was done because status now can be job's or the workflow's. We still support job-status but will give a warning that it is deprecated and encourage the switch to the status field. +- Including the `status` field ends a trace. For multi job workflows this is only required as part of the last job. - Each Job MUST include unique STEP IDs to ensure each job's spans are properly organized together. - An example of adopting these changes is in the [Integration Worflow](.github/workflows/integration.yaml) of this repo. Here is the corresponding trace: From b789afa69f4835e22015688789bebb8926250976 Mon Sep 17 00:00:00 2001 From: MJ Date: Wed, 12 Oct 2022 12:22:26 -0700 Subject: [PATCH 2/6] adds a note --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index b628366..086d230 100644 --- a/README.md +++ b/README.md @@ -19,7 +19,7 @@ This GitHub Action instruments your workflows using [Honeycomb's buildevents too - The required input field `job-status` has been renamed to `status`. This was done because status now can be job's or the workflow's. We still support job-status but will give a warning that it is deprecated and encourage the switch to the status field. -- Including the `status` field ends a trace. For multi job workflows this is only required as part of the last job. +- Including the `status` field ends a trace. For multi job workflows this is only required as part of the last job. Do NOT include this in every job. - Each Job MUST include unique STEP IDs to ensure each job's spans are properly organized together. - An example of adopting these changes is in the [Integration Worflow](.github/workflows/integration.yaml) of this repo. Here is the corresponding trace: From 508986b61aedca038a16b91923d0d0348a6b9b0d Mon Sep 17 00:00:00 2001 From: MJ Date: Wed, 12 Oct 2022 12:26:14 -0700 Subject: [PATCH 3/6] add an explanation of NOT needing to start trace in every job --- README.md | 10 ++++++++-- 1 file changed, 8 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 086d230..4b3402b 100644 --- a/README.md +++ b/README.md @@ -56,7 +56,6 @@ This GitHub Action instruments your workflows using [Honeycomb's buildevents too In the **FIRST JOB** -Note: The step to start the workflow's trace should run first (before other jobs too) ```yaml the-job-that-runs-first: @@ -86,7 +85,14 @@ the-job-that-runs-first: # ... Job 2 ... ``` -Then add the **new** **LAST JOB** +**NOTE:** + +The step to start the workflow's trace should run first (before other jobs too). You do not need to start the trace in subsequent jobs. + +The output is important. This is the parent trace ID and will be used by the LAST job to connect all other traces. + + +Add the **new** **LAST JOB** ```yaml end-trace: From 12f3cef04061b9a0dad86835cd6de220179c432e Mon Sep 17 00:00:00 2001 From: MJ Date: Wed, 12 Oct 2022 12:30:08 -0700 Subject: [PATCH 4/6] little more editing --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 4b3402b..632b4a5 100644 --- a/README.md +++ b/README.md @@ -16,10 +16,10 @@ This GitHub Action instruments your workflows using [Honeycomb's buildevents too ### 📣 Adopting version 2.0.0 -- The required input field `job-status` has been renamed to `status`. This was done because status now can be job's or the workflow's. +- The input field `job-status` has been renamed to `status`. This no longer required in every job. This was done because status now can be job's or the workflow's. We still support job-status but will give a warning that it is deprecated and encourage the switch to the status field. -- Including the `status` field ends a trace. For multi job workflows this is only required as part of the last job. Do NOT include this in every job. +- `status` is no longer required in every job because including the `status` field ends a trace. For multi job workflows this is only required as part of the last job or the job that will end the trace. - Each Job MUST include unique STEP IDs to ensure each job's spans are properly organized together. - An example of adopting these changes is in the [Integration Worflow](.github/workflows/integration.yaml) of this repo. Here is the corresponding trace: From 92818a8722ef8a3763cb97915afc4f9c0973099c Mon Sep 17 00:00:00 2001 From: Mridula Jayaraman Date: Wed, 12 Oct 2022 12:47:43 -0700 Subject: [PATCH 5/6] Update README.md Co-authored-by: Brooke Sargent --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 632b4a5..fe4df9b 100644 --- a/README.md +++ b/README.md @@ -16,7 +16,7 @@ This GitHub Action instruments your workflows using [Honeycomb's buildevents too ### 📣 Adopting version 2.0.0 -- The input field `job-status` has been renamed to `status`. This no longer required in every job. This was done because status now can be job's or the workflow's. +- The input field `job-status` has been renamed to `status`. This is no longer required in every job. This was done because status can now be job status or workflow status. We still support job-status but will give a warning that it is deprecated and encourage the switch to the status field. - `status` is no longer required in every job because including the `status` field ends a trace. For multi job workflows this is only required as part of the last job or the job that will end the trace. From 8013abd9cb7a009dff1983bf70c4698a15760f5e Mon Sep 17 00:00:00 2001 From: Mridula Jayaraman Date: Wed, 12 Oct 2022 12:48:11 -0700 Subject: [PATCH 6/6] Update README.md Co-authored-by: Brooke Sargent --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index fe4df9b..63d2757 100644 --- a/README.md +++ b/README.md @@ -89,7 +89,7 @@ the-job-that-runs-first: The step to start the workflow's trace should run first (before other jobs too). You do not need to start the trace in subsequent jobs. -The output is important. This is the parent trace ID and will be used by the LAST job to connect all other traces. +The output is important. This is the `trace-start` timestamp and will be used by the LAST job to ensure the duration of the full trace is correct. Add the **new** **LAST JOB**