refactor to use OTLP env variables

Author: codeboten

.github/workflows/test.yaml

@@ -13,5 +13,4 @@ jobs:
         uses: codeboten/github-action-to-otlp@v1
         with:
           endpoint: "ingest.lightstep.com:443"
-        env:
-          LS_ACCESS_TOKEN: ${{ secrets.ACCESS_TOKEN }}
+          headers: "lightstep-access-token:${{ secrets.ACCESS_TOKEN }}"

action.yaml

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

go.mod

@@ -4,8 +4,10 @@ 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/lightstep/otel-launcher-go/pipelines v0.0.0-20210924222414-e413bcf575d8
 	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.opentelemetry.io/collector v0.28.0
+	go.opentelemetry.io/otel v1.0.0
+	go.opentelemetry.io/otel/sdk v1.0.0
+	go.opentelemetry.io/otel/trace v1.0.0
 )

go.sum

@@ -583,8 +583,8 @@ github.com/lib/pq v1.0.0/go.mod h1:5WUZQaWbwv1U+lTReE5YruASi9Al49XbQIvNi/34Woo=
 github.com/lib/pq v1.2.0/go.mod h1:5WUZQaWbwv1U+lTReE5YruASi9Al49XbQIvNi/34Woo=
 github.com/lightstep/lightstep-tracer-common/golang/gogo v0.0.0-20190605223551-bc2310a04743/go.mod h1:qklhhLq1aX+mtWk9cPHPzaBjWImj5ULL6C7HFJtXQMM=
 github.com/lightstep/lightstep-tracer-go v0.18.1/go.mod h1:jlF1pusYV4pidLvZ+XD0UBX0ZE6WURAspgAczcDHrL4=
-github.com/lightstep/otel-launcher-go v1.0.0-RC3 h1:u08r9nEjgxHdkWri7U0FQt/mK6bGzq2hjwIFE5rrh1A=
-github.com/lightstep/otel-launcher-go v1.0.0-RC3/go.mod h1:WxH2vxzKgHhDnrDgH17twtIyC1xvTyoZwFxspkW5lCc=
+github.com/lightstep/otel-launcher-go/pipelines v0.0.0-20210924222414-e413bcf575d8 h1:BDrgANrdSwsAKhQZapwbG9TIsFyaVqW0p0lA+84Iy/E=
+github.com/lightstep/otel-launcher-go/pipelines v0.0.0-20210924222414-e413bcf575d8/go.mod h1:k0DpkjWBF5gzRRfoTYMNTD4WmsKzBr7dzSxT4qcYHNA=
 github.com/lucasb-eyer/go-colorful v1.0.2/go.mod h1:0MS4r+7BZKSJ5mw4/S5MPN+qHFF1fYclkSPilDOKW0s=
 github.com/lucasb-eyer/go-colorful v1.0.3/go.mod h1:R4dSotOR9KMtayYi1e77YzuveK+i7ruzyGqttikkLy0=
 github.com/lyft/protoc-gen-validate v0.0.13/go.mod h1:XbGvPuh87YZc5TdIa2/I4pLk0QoUACkjt2znoq26NVQ=
@@ -785,8 +785,6 @@ github.com/securego/gosec v0.0.0-20200203094520-d13bb6d2420c/go.mod h1:gp0gaHj0W
 github.com/segmentio/kafka-go v0.1.0/go.mod h1:X6itGqS9L4jDletMsxZ7Dz+JFWxM6JHfPOCvTvk+EJo=
 github.com/segmentio/kafka-go v0.2.0/go.mod h1:X6itGqS9L4jDletMsxZ7Dz+JFWxM6JHfPOCvTvk+EJo=
 github.com/sergi/go-diff v1.0.0/go.mod h1:0CfEIISq7TuYL3j771MWULgwwjU+GofnZX9QAmXWZgo=
-github.com/sethvargo/go-envconfig v0.3.2 h1:277Lb2iTpUZjUZu1qLoLa/aetwvtZbKh8wNWXmc6dSk=
-github.com/sethvargo/go-envconfig v0.3.2/go.mod h1:XZ2JRR7vhlBEO5zMmOpLgUhgYltqYqq4d4tKagtPUv0=
 github.com/shirou/gopsutil v2.20.9+incompatible/go.mod h1:5b4v6he4MtMOwMlS0TUMTu2PcXUg8+E1lC7eC3UO/RA=
 github.com/shirou/gopsutil v3.21.5+incompatible h1:OloQyEerMi7JUrXiNzy8wQ5XN+baemxSl12QgIzt0jc=
 github.com/shirou/gopsutil v3.21.5+incompatible/go.mod h1:5b4v6he4MtMOwMlS0TUMTu2PcXUg8+E1lC7eC3UO/RA=
@@ -912,26 +910,32 @@ go.opentelemetry.io/contrib/propagators/ot v0.23.0 h1:QD69MmaJwLOaLj8uNmxpJa52v/
 go.opentelemetry.io/contrib/propagators/ot v0.23.0/go.mod h1:uhAU1z0UtdOTHWPfmpAOlikY/vK79cGwrteYDkcxvGU=
 go.opentelemetry.io/otel v1.0.0-RC3 h1:kvwiyEkiUT/JaadXzVLI/R1wDO934A7r3Bs2wEe6wqA=
 go.opentelemetry.io/otel v1.0.0-RC3/go.mod h1:Ka5j3ua8tZs4Rkq4Ex3hwgBgOchyPVq5S6P2lz//nKQ=
+go.opentelemetry.io/otel v1.0.0 h1:qTTn6x71GVBvoafHK/yaRUmFzI4LcONZD0/kXxl5PHI=
+go.opentelemetry.io/otel v1.0.0/go.mod h1:AjRVh9A5/5DE7S+mZtTR6t8vpKKryam+0lREnfmS4cg=
 go.opentelemetry.io/otel/exporters/otlp/otlpmetric v0.23.0 h1:vKIEsT6IJU0NYd+iZccjgCmk80zsa7dTiC2Bu7U1jz0=
 go.opentelemetry.io/otel/exporters/otlp/otlpmetric v0.23.0/go.mod h1:pe9oOWRaZyapdajWCn64fnl76v3cmTEmNBgh7MkKvwE=
 go.opentelemetry.io/otel/exporters/otlp/otlpmetric/otlpmetricgrpc v0.23.0 h1:JSsJID+KU3G8wxynfHIlWaefOvYngDjnrmtHOGb1sb0=
 go.opentelemetry.io/otel/exporters/otlp/otlpmetric/otlpmetricgrpc v0.23.0/go.mod h1:aSP5oMNaAfOYq+sRydHANZ0vBYLyZR/3lR9pru9aPLk=
-go.opentelemetry.io/otel/exporters/otlp/otlptrace v1.0.0-RC3 h1:5gOhYk62x9f5NAGSQl9WBc6J5nCI0tuofzMZ/dAR01Q=
-go.opentelemetry.io/otel/exporters/otlp/otlptrace v1.0.0-RC3/go.mod h1:1tvDhRy/GCexiD9dQZzqwqGnI7/fnZOsi31DyvK3zyQ=
-go.opentelemetry.io/otel/exporters/otlp/otlptrace/otlptracegrpc v1.0.0-RC3 h1:F3cdr1An+QUPcj4SQrS92fEWV4A31jWFHCLpbiDUdCo=
-go.opentelemetry.io/otel/exporters/otlp/otlptrace/otlptracegrpc v1.0.0-RC3/go.mod h1:9JCUOSptzVKaFbxGVO+Wa1P8fDpA5QGVTuIzL/PKSrk=
+go.opentelemetry.io/otel/exporters/otlp/otlptrace v1.0.0 h1:Vv4wbLEjheCTPV07jEav7fyUpJkyftQK7Ss2G7qgdSo=
+go.opentelemetry.io/otel/exporters/otlp/otlptrace v1.0.0/go.mod h1:3VqVbIbjAycfL1C7sIu/Uh/kACIUPWHztt8ODYwR3oM=
+go.opentelemetry.io/otel/exporters/otlp/otlptrace/otlptracegrpc v1.0.0 h1:B9VtEB1u41Ohnl8U6rMCh1jjedu8HwFh4D0QeB+1N+0=
+go.opentelemetry.io/otel/exporters/otlp/otlptrace/otlptracegrpc v1.0.0/go.mod h1:zhEt6O5GGJ3NCAICr4hlCPoDb2GQuh4Obb4gZBgkoQQ=
 go.opentelemetry.io/otel/internal/metric v0.23.0 h1:mPfzm9Iqhw7G2nDBmUAjFTfPqLZPbOW2k7QI57ITbaI=
 go.opentelemetry.io/otel/internal/metric v0.23.0/go.mod h1:z+RPiDJe30YnCrOhFGivwBS+DU1JU/PiLKkk4re2DNY=
 go.opentelemetry.io/otel/metric v0.23.0 h1:mYCcDxi60P4T27/0jchIDFa1WHEfQeU3zH9UEMpnj2c=
 go.opentelemetry.io/otel/metric v0.23.0/go.mod h1:G/Nn9InyNnIv7J6YVkQfpc0JCfKBNJaERBGw08nqmVQ=
 go.opentelemetry.io/otel/sdk v1.0.0-RC3 h1:iRMkET+EmJUn5mW0hJzygBraXRmrUwzbOtNvTCh/oKs=
 go.opentelemetry.io/otel/sdk v1.0.0-RC3/go.mod h1:78H6hyg2fka0NYT9fqGuFLvly2yCxiBXDJAgLKo/2Us=
+go.opentelemetry.io/otel/sdk v1.0.0 h1:BNPMYUONPNbLneMttKSjQhOTlFLOD9U22HNG1KrIN2Y=
+go.opentelemetry.io/otel/sdk v1.0.0/go.mod h1:PCrDHlSy5x1kjezSdL37PhbFUMjrsLRshJ2zCzeXwbM=
 go.opentelemetry.io/otel/sdk/export/metric v0.23.0 h1:7NeoKPPx6NdZBVHLEp/LY5Lq85Ff1WNZnuJkuRy+azw=
 go.opentelemetry.io/otel/sdk/export/metric v0.23.0/go.mod h1:SuMiREmKVRIwFKq73zvGTvwFpxb/ZAYkMfyqMoOtDqs=
 go.opentelemetry.io/otel/sdk/metric v0.23.0 h1:xlZhPbiue1+jjSFEth94q9QCmX8Q24mOtue9IAmlVyI=
 go.opentelemetry.io/otel/sdk/metric v0.23.0/go.mod h1:wa0sKK13eeIFW+0OFjcC3S1i7FTRRiLAXe1kjBVbhwg=
 go.opentelemetry.io/otel/trace v1.0.0-RC3 h1:9F0ayEvlxv8BmNmPbU005WK7hC+7KbOazCPZjNa1yME=
 go.opentelemetry.io/otel/trace v1.0.0-RC3/go.mod h1:VUt2TUYd8S2/ZRX09ZDFZQwn2RqfMB5MzO17jBojGxo=
+go.opentelemetry.io/otel/trace v1.0.0 h1:TSBr8GTEtKevYMG/2d21M989r5WJYVimhTHBKVEZuh4=
+go.opentelemetry.io/otel/trace v1.0.0/go.mod h1:PXTWqayeFUlJV1YDNhsJYB184+IvAH814St6o6ajzIs=
 go.opentelemetry.io/proto/otlp v0.7.0 h1:rwOQPCuKAKmwGKq2aVNnYIibI6wnV7EvzgfTCzcdGg8=
 go.opentelemetry.io/proto/otlp v0.7.0/go.mod h1:PqfVotwruBrMGOCsRd/89rSnXhoiJIqeYNgFYFoEGnI=
 go.opentelemetry.io/proto/otlp v0.9.0 h1:C0g6TWmQYvjKRnljRULLWUVJGy8Uvu0NEL/5frY2/t4=

main.go

@@ -5,13 +5,18 @@ import (
 	"errors"
 	"fmt"
 	"log"
+	"net/url"
 	"os"
 	"strconv"
 	"strings"
 
 	"github.com/google/go-github/v39/github"
-	"github.com/lightstep/otel-launcher-go/launcher"
+	"github.com/lightstep/otel-launcher-go/pipelines"
+	"go.opentelemetry.io/collector/translator/conventions"
 	"go.opentelemetry.io/otel"
+	"go.opentelemetry.io/otel/attribute"
+	"go.opentelemetry.io/otel/sdk/resource"
+	semconv "go.opentelemetry.io/otel/semconv/v1.4.0"
 	"go.opentelemetry.io/otel/trace"
 )
 
@@ -21,6 +26,7 @@ type actionConfig struct {
 	owner            string
 	repo             string
 	runID            string
+	pipelineConfig   pipelines.PipelineConfig
 }
 
 // TODO: add attributes using https://docs.github.com/en/actions/learn-github-actions/environment-variables
@@ -71,7 +77,39 @@ func getSteps(ctx context.Context, conf actionConfig) error {
 	return nil
 }
 
+// Code inspired from the opentelemetry-go OTLP exporter
+//
+// https://github.com/open-telemetry/opentelemetry-go/blob/92551d3933c9c7ef5eaf4f93f876a5487d0024b9/exporters/otlp/otlpmetric/internal/otlpconfig/envconfig.go#L172
+func stringToHeader(value string) map[string]string {
+	headersPairs := strings.Split(value, ",")
+	headers := make(map[string]string)
+
+	for _, header := range headersPairs {
+		nameValue := strings.SplitN(header, "=", 2)
+		if len(nameValue) < 2 {
+			continue
+		}
+		name, err := url.QueryUnescape(nameValue[0])
+		if err != nil {
+			continue
+		}
+		trimmedName := strings.TrimSpace(name)
+		trimmedValue := strings.TrimSpace(nameValue[1])
+
+		headers[trimmedName] = trimmedValue
+	}
+
+	return headers
+}
+
 func parseConfig() (actionConfig, error) {
+	endpoint, ok := os.LookupEnv("OTEL_EXPORTER_OTLP_ENDPOINT")
+	if !ok || len(endpoint) == 0 {
+		return actionConfig{}, errors.New("invalid endpoint")
+	}
+
+	headers := stringToHeader(os.Getenv("OTEL_EXPORTER_OTLP_HEADERS"))
+
 	githubRepository, ok := os.LookupEnv("GITHUB_REPOSITORY")
 	if !ok {
 		return actionConfig{}, errors.New("missing variable: GITHUB_REPOSITORY")
@@ -91,12 +129,30 @@ func parseConfig() (actionConfig, error) {
 	if len(parts) < 2 {
 		return actionConfig{}, fmt.Errorf("invalid variable GITHUB_REPOSITORY: %s", githubRepository)
 	}
+
+	attributes := []attribute.KeyValue{
+		attribute.String(conventions.AttributeServiceName, githubRepository),
+	}
+
+	r, _ := resource.New(context.Background(),
+		resource.WithSchemaURL(semconv.SchemaURL),
+		resource.WithAttributes(attributes...),
+	)
+
+	insecure := false
 	conf := actionConfig{
 		workflow:         workflowName,
 		githubRepository: githubRepository,
 		owner:            parts[0],
 		repo:             parts[1],
 		runID:            runID,
+		pipelineConfig: pipelines.PipelineConfig{
+			Endpoint:    endpoint,
+			Insecure:    insecure, // TODO: provide config for this
+			Headers:     headers,
+			Propagators: []string{"tracecontext"}, // TODO: provide config for this
+			Resource:    r,
+		},
 	}
 
 	return conf, nil
@@ -108,10 +164,9 @@ func main() {
 	if err != nil {
 		log.Fatal(err)
 	}
-	lsOtel := launcher.ConfigureOpentelemetry(
-		launcher.WithServiceName(conf.githubRepository),
-	)
-	defer lsOtel.Shutdown()
+
+	pipelineShutdown, err := pipelines.NewTracePipeline(conf.pipelineConfig)
+	defer pipelineShutdown()
 
 	if err != nil {
 		log.Printf("%v", err)

main_test.go

@@ -8,17 +8,24 @@ import (
 )
 
 func TestParseConfig(t *testing.T) {
+
 	_, err := parseConfig()
 	require.Error(t, err)
+	require.Contains(t, err.Error(), "invalid endpoint")
+
+	os.Setenv("OTEL_EXPORTER_OTLP_ENDPOINT", "endpoint:443")
+
+	_, 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")
+	require.Contains(t, err.Error(), "missing variable: GITHUB_RUN_ID")
 
-	os.Setenv("GITHUB_JOB", "123")
+	os.Setenv("GITHUB_RUN_ID", "123")
 
 	_, err = parseConfig()
 	require.Error(t, err)