Skip to content

Commit

Permalink
feat(#31): Omit spans for skipped and canceled jobs (#33)
Browse files Browse the repository at this point in the history 
* Omit trace spans for canceled or skipped steps

When an GitHub Actions workflow job decides to forgo running a
particular step, whether due to it being canceled or skipped because
some precondition fails, do not publish a trace span to represent that
step having occurred.

* Include step ID as a span attribute when present

For GitHub Actions job steps that include an ID, publish it in the
respective trace span as the "github.job.step.id" string-typed
attribute.
  • Loading branch information
@seh
seh authored Jan 24, 2023
1 parent 0da4af9 commit 8ef4ea0
Show file tree
Hide file tree
Showing 3 changed files with 46 additions and 39 deletions.
71 changes: 36 additions & 35 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -133,41 +133,42 @@ jobs:
| ---------------------------- | ------- | ------------------------------------------------- |
| name | string | Workflow/Job/Step name |
| service.instance.id | string | {repo_full_name}/{workflow_id}/{run_id}/{run_num} |
| service.name | string | Github Workflow Name |
| service.namespace | string | Github Repo Full Name |
| service.version | string | Github Workflow Run HEAD SHA |
| github.workflow_id | integer | Github Workflow ID |
| github.workflow | string | Github Workflow Name |
| github.workflow_url | string | Github Workflow URL |
| github.run_attempt | integer | Github Workflow Run Attempt |
| github.run_id | integer | Github Workflow Run ID |
| github.run_number | integer | Github Workflow Run Number |
| github.created_at | integer | Github Workflow Run Created Timestamp |
| github.updated_at | integer | Github Workflow Run Updated Timestamp |
| github.run_started_at | integer | Github Workflow Run Started Timestamp |
| github.html_url | string | Github Workflow Run HTML URL |
| github.author_email | string | Github Workflow Run Author Email |
| github.author_name | string | Github Workflow Run Author Name |
| github.conclusion | string | Github Workflow Run Conclusion |
| github.event | string | Github Workflow Run Event Name |
| github.git_refs_url | string | Github Workflow Run refs url |
| github.head_sha | string | Github Workflow Run HEAD SHA |
| github.job.id | float | Github Job Run ID |
| github.job.name | string | Github Job Run Name |
| github.job.started_at | string | Github Job Run started_at |
| github.job.completed_at | string | Github Job Run completed_at |
| github.job.conclusion | string | Github Job Run Conclusion |
| github.job.labels | string | Github Job Run Labels. Comma separated values |
| github.job.run_attempt | integer | Github Job Run Run Attempt |
| github.job.run_id | integer | Github Job Run Run ID |
| github.job.runner_group_id | integer | Github Job Runner Group ID |
| github.job.runner_group_name | string | Github Job Runner Group Name |
| github.job.runner_name | string | Github Job Runner Name |
| github.job.step.conclusion | string | Github Step Run Conclusion |
| github.job.step.name | string | Github Step Run Name |
| github.job.step.number | integer | Github Step Run Number |
| github.job.step.started_at | string | Github Step Run started_at |
| github.job.step.completed_at | string | Github Step Run completed_at |
| service.name | string | GitHub Workflow Name |
| service.namespace | string | GitHub Repo Full Name |
| service.version | string | GitHub Workflow Run HEAD SHA |
| github.workflow_id | integer | GitHub Workflow ID |
| github.workflow | string | GitHub Workflow Name |
| github.workflow_url | string | GitHub Workflow URL |
| github.run_attempt | integer | GitHub Workflow Run Attempt |
| github.run_id | integer | GitHub Workflow Run ID |
| github.run_number | integer | GitHub Workflow Run Number |
| github.created_at | integer | GitHub Workflow Run Created Timestamp |
| github.updated_at | integer | GitHub Workflow Run Updated Timestamp |
| github.run_started_at | integer | GitHub Workflow Run Started Timestamp |
| github.html_url | string | GitHub Workflow Run HTML URL |
| github.author_email | string | GitHub Workflow Run Author Email |
| github.author_name | string | GitHub Workflow Run Author Name |
| github.conclusion | string | GitHub Workflow Run Conclusion |
| github.event | string | GitHub Workflow Run Event Name |
| github.git_refs_url | string | GitHub Workflow Run refs URL |
| github.head_sha | string | GitHub Workflow Run HEAD SHA |
| github.job.id | float | GitHub Job ID |
| github.job.name | string | GitHub Job Run Name |
| github.job.started_at | string | GitHub Job Run started_at |
| github.job.completed_at | string | GitHub Job Run completed_at |
| github.job.conclusion | string | GitHub Job Run Conclusion |
| github.job.labels | string | GitHub Job Run Labels. Comma separated values |
| github.job.run_attempt | integer | GitHub Job Run Run Attempt |
| github.job.run_id | integer | GitHub Job Run ID |
| github.job.runner_group_id | integer | GitHub Job Runner Group ID |
| github.job.runner_group_name | string | GitHub Job Runner Group Name |
| github.job.runner_name | string | GitHub Job Runner Name |
| github.job.step.conclusion | string | GitHub Step Run Conclusion |
| github.job.step.id | string | GitHub Step ID |
| github.job.step.name | string | GitHub Step Name |
| github.job.step.number | integer | GitHub Step Run Number |
| github.job.step.started_at | string | GitHub Step Run started_at |
| github.job.step.completed_at | string | GitHub Step Run completed_at |

## Honeycomb Example Trace

Expand Down
7 changes: 4 additions & 3 deletions src/github.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -16,11 +16,12 @@ export type ListJobsForWorkflowRunType =
export type WorkflowRunJob = ListJobsForWorkflowRunType["data"]["jobs"][0];
export type WorkflowRunJobStep = {
status: "queued" | "in_progress" | "completed";
conclusion: string | null;
conclusion?: string | null;
id?: string;
name: string;
number: number;
started_at?: string | null | undefined;
completed_at?: string | null | undefined;
started_at?: string | null;
completed_at?: string | null;
};
export type WorkflowRun = GetWorkflowRunType["data"];
export type ListWorkflowRunArtifactsResponse =
Expand Down
7 changes: 6 additions & 1 deletion src/tracing/step.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,11 @@ export async function traceWorkflowRunStep({
}: TraceWorkflowRunStepParams) {
if (!step || !step.completed_at || !step.started_at) {
const stepName = step?.name || "UNDEFINED";
console.warn(`Step ${stepName} is not completed yet`);
console.warn(`Step ${stepName} is not completed yet.`);
return;
}
if (step.conclusion == "cancelled" || step.conclusion == "skipped") {
console.info(`Step ${step.name} did not run.`);
return;
}
core.debug(`Trace Step ${step.name}`);
Expand All @@ -44,6 +48,7 @@ export async function traceWorkflowRunStep({
"github.job.step.started_at": step.started_at || undefined,
"github.job.step.completed_at": step.completed_at || undefined,
error: step.conclusion === "failure",
...(step.id && { "github.job.step.id": step.id }),
},
startTime,
},
Expand Down

0 comments on commit 8ef4ea0

Please sign in to comment.