initial commit

Author: codeboten

.github/workflows/test.yaml

@@ -0,0 +1,17 @@
+on: [push]
+
+jobs:
+  test-otlp-output:
+    runs-on: ubuntu-latest
+    name: A job to test OTLP output
+    steps:
+      # To use this repository's private action,
+      # you must check out the repository
+      - name: Checkout
+        uses: actions/checkout@v2
+      - name: Send data to OTLP backend
+        uses: codeboten/github-action-to-otlp
+        with:
+          endpoint: "ingest.lightstep.com:443"
+        env:
+          LS_ACCESS_TOKEN: ${{ secrets.ACCESS_TOKEN }}

Dockerfile

@@ -0,0 +1,12 @@
+FROM golang:latest
+WORKDIR /app
+COPY go.mod go.sum ./
+RUN go mod download
+COPY main.go .
+RUN CGO_ENABLED=0 GOOS=linux go build -a -installsuffix cgo -o github-action-to-otlp .
+
+FROM alpine:latest
+RUN apk --no-cache add ca-certificates
+WORKDIR /root/
+COPY --from=0 /app/github-action-to-otlp .
+ENTRYPOINT ["/root/github-action-to-otlp"]

action.yaml

@@ -0,0 +1,14 @@
+name: "Github Action to OTLP"
+description: "Record job information as trace and transmit via OTLP"
+inputs:
+  endpoint: # endpoint of OTLP backend
+    description: "Endpoint to send OTLP to"
+    required: true
+  # headers: # endpoint of OTLP backend
+  #   description: "Headers to configure OTLP"
+  #   required: true
+runs:
+  using: "docker"
+  image: "Dockerfile"
+  env:
+    OTEL_ENDPOINT: ${{ inputs.endpoint }}

go.mod

@@ -0,0 +1,11 @@
+module github.com/codeboten/github-action-to-otlp
+
+go 1.15
+
+require (
+	github.com/google/go-github/v39 v39.0.0
+	github.com/lightstep/otel-launcher-go v1.0.0-RC3
+	github.com/stretchr/testify v1.7.0
+	go.opentelemetry.io/otel v1.0.0-RC3
+	go.opentelemetry.io/otel/trace v1.0.0-RC3
+)

go.sum

@@ -0,0 +1,118 @@
+package main
+
+import (
+	"context"
+	"errors"
+	"fmt"
+	"log"
+	"os"
+	"strconv"
+	"strings"
+
+	"github.com/google/go-github/v39/github"
+	"github.com/lightstep/otel-launcher-go/launcher"
+	"go.opentelemetry.io/otel"
+	"go.opentelemetry.io/otel/codes"
+	"go.opentelemetry.io/otel/trace"
+)
+
+type actionConfig struct {
+	workflow         string
+	githubRepository string
+	owner            string
+	repo             string
+	runID            string
+}
+
+// TODO: add attributes using https://docs.github.com/en/actions/learn-github-actions/environment-variables
+// TODO: add user-agent
+// TODO: add support for auth
+
+func getSteps(ctx context.Context, conf actionConfig) error {
+	tracer := otel.Tracer(conf.githubRepository)
+	client := github.NewClient(nil)
+	id, err := strconv.ParseInt(conf.runID, 10, 64)
+	if err != nil {
+		return err
+	}
+	workflow, _, err := client.Actions.GetWorkflowRunByID(ctx, conf.owner, conf.repo, id)
+	if err != nil {
+		return err
+	}
+
+	ctx, workflowSpan := tracer.Start(ctx, *workflow.Name, trace.WithTimestamp(workflow.CreatedAt.Time))
+	jobs, _, err := client.Actions.ListWorkflowJobs(context.Background(), conf.owner, conf.repo, id, &github.ListWorkflowJobsOptions{})
+	if err != nil {
+		return err
+	}
+
+	for _, job := range jobs.Jobs {
+		ctx, jobSpan := tracer.Start(ctx, *job.Name, trace.WithTimestamp(job.StartedAt.Time))
+		if err != nil {
+			return err
+		}
+		for _, step := range job.Steps {
+			_, stepSpan := tracer.Start(ctx, *step.Name, trace.WithTimestamp(step.StartedAt.Time))
+			stepSpan.End(trace.WithTimestamp(step.CompletedAt.Time))
+		}
+		jobSpan.End(trace.WithTimestamp(job.CompletedAt.Time))
+	}
+	workflowSpan.End(trace.WithTimestamp(workflow.UpdatedAt.Time))
+	return nil
+}
+
+func parseConfig() (actionConfig, error) {
+	githubRepository, ok := os.LookupEnv("GITHUB_REPOSITORY")
+	if !ok {
+		return actionConfig{}, errors.New("missing variable: GITHUB_REPOSITORY")
+	}
+
+	runID, ok := os.LookupEnv("GITHUB_RUN_ID")
+	if !ok {
+		return actionConfig{}, errors.New("missing variable: GITHUB_RUN_ID")
+	}
+
+	workflowName, ok := os.LookupEnv("GITHUB_WORKFLOW")
+	if !ok {
+		return actionConfig{}, errors.New("missing variable: GITHUB_WORKFLOW")
+	}
+
+	parts := strings.Split(githubRepository, "/")
+	if len(parts) < 2 {
+		return actionConfig{}, fmt.Errorf("invalid variable GITHUB_REPOSITORY: %s", githubRepository)
+	}
+	conf := actionConfig{
+		workflow:         workflowName,
+		githubRepository: githubRepository,
+		owner:            parts[0],
+		repo:             parts[1],
+		runID:            runID,
+	}
+
+	return conf, nil
+}
+
+func main() {
+
+	conf, err := parseConfig()
+	if err != nil {
+		log.Fatal(err)
+	}
+	lsOtel := launcher.ConfigureOpentelemetry(
+		launcher.WithServiceName(conf.githubRepository),
+	)
+	defer lsOtel.Shutdown()
+	tracer := otel.Tracer(conf.githubRepository)
+	ctx, span := tracer.Start(context.Background(), conf.workflow)
+	defer span.End()
+
+	if err != nil {
+		log.Printf("%v", err)
+	}
+
+	err = getSteps(ctx, conf)
+	if err != nil {
+		span.SetStatus(codes.Error, err.Error())
+		log.Println(err)
+	}
+}

main.go

@@ -0,0 +1,38 @@
+package main
+
+import (
+	"os"
+	"testing"
+
+	"github.com/stretchr/testify/require"
+)
+
+func TestParseConfig(t *testing.T) {
+	_, err := parseConfig()
+	require.Error(t, err)
+	require.Contains(t, err.Error(), "missing variable: GITHUB_REPOSITORY")
+
+	os.Setenv("GITHUB_REPOSITORY", "garbage")
+
+	_, err = parseConfig()
+	require.Error(t, err)
+	require.Contains(t, err.Error(), "missing variable: GITHUB_JOB")
+
+	os.Setenv("GITHUB_JOB", "123")
+
+	_, err = parseConfig()
+	require.Error(t, err)
+	require.Contains(t, err.Error(), "missing variable: GITHUB_WORKFLOW")
+
+	os.Setenv("GITHUB_WORKFLOW", "test name")
+
+	_, err = parseConfig()
+	require.Error(t, err)
+	require.Contains(t, err.Error(), "invalid variable GITHUB_REPOSITORY: garbage")
+
+	os.Setenv("GITHUB_REPOSITORY", "test/code")
+	conf, err := parseConfig()
+	require.NoError(t, err)
+	require.Equal(t, "test", conf.owner)
+	require.Equal(t, "code", conf.repo)
+}