Run test and lint during CI

.github/workflows/ci.yml

@@ -0,0 +1,35 @@
+name: ci
+on: ["push", "pull_request"]
+
+permissions:
+  contents: read
+
+jobs:
+  lint:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v3
+    - uses: actions/setup-go@v4
+      with:
+        go-version-file: go.mod
+        cache: true
+    - run: make lint
+    - run: make fmt
+    - name: Verify repo is up-to-date
+      run: |
+        if [ -n "$(git status --porcelain)" ]; then
+          echo 'Updates required:'
+          git status
+          exit 1
+        fi
+
+  run-tests:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v3
+    - uses: actions/setup-go@v4
+      with:
+        go-version-file: go.mod
+        cache: true
+    - name: Run tests
+      run: make test

Makefile

@@ -3,6 +3,8 @@
 STATES_DIR=$(CURDIR)/.states
 DIST_DIR=$(CURDIR)/dist
 
+MODULE_DEPS=$(sort $(shell go list -deps -tags=darwin,linux,windows -f "{{with .Module}}{{if not .Main}}{{.Path}}{{end}}{{end}}" ./...))
+
 all: test
 
 fmt: tools/go.mod
@@ -12,7 +14,10 @@ fmt: tools/go.mod
 lint: tools/go.mod
 	go run -modfile=tools/go.mod honnef.co/go/tools/cmd/staticcheck -checks=all ./...
 	go list -m -json $(MODULE_DEPS) | go run -modfile=tools/go.mod go.elastic.co/go-licence-detector \
-		-includeIndirect -rules tools/notice/rules.json -validate
+		-includeIndirect \
+		-rules tools/notice/rules.json \
+		-noticeTemplate tools/notice/NOTICE.txt.tmpl \
+		-noticeOut NOTICE.txt
 	go mod tidy && git diff --exit-code
 
 .PHONY: clean
@@ -64,8 +69,6 @@ publish: IMAGE_REF=$$(cat "$(STATES_DIR)/image_ref")
 publish:
 	docker push $(IMAGE_REF)
 
-MODULE_DEPS=$(sort $(shell go list -deps -tags=darwin,linux,windows -f "{{with .Module}}{{if not .Main}}{{.Path}}{{end}}{{end}}" ./...))
-
 notice: NOTICE.txt
 NOTICE.txt: go.mod tools/go.mod
 	go list -m -json $(MODULE_DEPS) | go run -modfile=tools/go.mod go.elastic.co/go-licence-detector \

cmd/apmbench/bench.go

@@ -12,16 +12,17 @@ import (
 	"testing"
 	"time"
 
-	"github.com/elastic/apm-perf/internal/loadgen"
-	loadgencfg "github.com/elastic/apm-perf/internal/loadgen/config"
-	"github.com/elastic/apm-perf/internal/loadgen/eventhandler"
 	"go.opentelemetry.io/otel/exporters/otlp/otlptrace"
 	"go.opentelemetry.io/otel/exporters/otlp/otlptrace/otlptracegrpc"
 	sdktrace "go.opentelemetry.io/otel/sdk/trace"
 	"golang.org/x/time/rate"
 	"google.golang.org/grpc"
 	"google.golang.org/grpc/credentials"
 
+	"github.com/elastic/apm-perf/internal/loadgen"
+	loadgencfg "github.com/elastic/apm-perf/internal/loadgen/config"
+	"github.com/elastic/apm-perf/internal/loadgen/eventhandler"
+
 	"go.elastic.co/apm/v2"
 	"go.elastic.co/apm/v2/transport"
 )
@@ -109,9 +110,9 @@ func Benchmark10000AggregationGroups(b *testing.B, l *rate.Limiter) {
 			}
 			tx := tracer.StartTransaction(fmt.Sprintf("name%d", i), fmt.Sprintf("type%d", i))
 			span := tx.StartSpanOptions(fmt.Sprintf("name%d", i), fmt.Sprintf("type%d", i), apm.SpanOptions{})
-			span.Context.SetDestinationService(apm.DestinationServiceSpanContext{
-				Name:     fmt.Sprintf("name%d", i),
-				Resource: fmt.Sprintf("resource%d", i),
+			span.Context.SetServiceTarget(apm.ServiceTargetSpanContext{
+				Name: fmt.Sprintf("name%d", i),
+				Type: fmt.Sprintf("resource%d", i),
 			})
 			span.Duration = time.Second
 			span.End()

cmd/apmbench/main.go

@@ -13,8 +13,9 @@ import (
 	"testing"
 	"time"
 
-	"github.com/elastic/apm-perf/internal/otelcollector"
 	"go.uber.org/zap"
+
+	"github.com/elastic/apm-perf/internal/otelcollector"
 )
 
 func main() {
@@ -26,7 +27,7 @@ func main() {
 	}
 
 	extraMetrics := func(*testing.B) error { return nil }
-	resetFunc := func() { return }
+	resetFunc := func() {}
 	if cfg.CollectorConfigYaml != "" {
 		logger.Info("starting otel collector...")
 

cmd/apmbench/run.go

@@ -13,10 +13,11 @@ import (
 	"strings"
 	"testing"
 
-	"github.com/elastic/apm-perf/internal/loadgen"
-	loadgencfg "github.com/elastic/apm-perf/internal/loadgen/config"
 	"go.elastic.co/apm/v2/stacktrace"
 	"golang.org/x/time/rate"
+
+	"github.com/elastic/apm-perf/internal/loadgen"
+	loadgencfg "github.com/elastic/apm-perf/internal/loadgen/config"
 )
 
 const benchmarkFuncPrefix = "Benchmark"

cmd/apmsoak/run.go

@@ -22,13 +22,13 @@ type RunOptions struct {
 	ScenariosPath string
 	ServerURL     string
 	SecretToken   string
-	ApiKeys       string
+	APIKeys       string
 	BypassProxy   bool
 }
 
 func (opts *RunOptions) toRunnerConfig() (*soaktest.RunnerConfig, error) {
 	apiKeys := make(map[string]string)
-	pairs := strings.Split(opts.ApiKeys, ",")
+	pairs := strings.Split(opts.APIKeys, ",")
 	for _, pair := range pairs {
 		kv := strings.Split(pair, ":")
 		if len(kv) != 2 {
@@ -41,7 +41,7 @@ func (opts *RunOptions) toRunnerConfig() (*soaktest.RunnerConfig, error) {
 		ScenariosPath: opts.ScenariosPath,
 		ServerURL:     opts.ServerURL,
 		SecretToken:   opts.SecretToken,
-		ApiKeys:       apiKeys,
+		APIKeys:       apiKeys,
 		BypassProxy:   opts.BypassProxy,
 	}, nil
 }
@@ -78,7 +78,7 @@ func NewCmdRun() *cobra.Command {
 	cmd.Flags().StringVar(&options.Scenario, "scenario", "steady", "Specify which scenario to use. the value should match one of the scenario key defined in given scenarios YAML file")
 	cmd.Flags().StringVarP(&options.ScenariosPath, "file", "f", "./scenarios.yml", "Path to scenarios file")
 	cmd.Flags().StringVar(&options.SecretToken, "secret-token", "", "Secret token for APM Server. Managed intake service doesn't support secret token")
-	cmd.Flags().StringVar(&options.ApiKeys, "api-keys", "", "API keys for managed service. Specify key value pairs as `project_id_1:my_api_key,project_id_2:my_key`")
+	cmd.Flags().StringVar(&options.APIKeys, "api-keys", "", "API keys for managed service. Specify key value pairs as `project_id_1:my_api_key,project_id_2:my_key`")
 	cmd.Flags().BoolVar(&options.BypassProxy, "bypass-proxy", false, "Detach from proxy dependency and provide projectID via header. Useful when testing locally")
 	return cmd
 }

internal/loadgen/config/config.go

@@ -2,6 +2,7 @@
 // or more contributor license agreements. Licensed under the Elastic License 2.0;
 // you may not use this file except in compliance with the Elastic License 2.0.
 
+// Package loadgencfg contains configuration related code for load generator.
 package loadgencfg
 
 import (

internal/loadgen/eventhandler.go

@@ -2,6 +2,7 @@
 // or more contributor license agreements. Licensed under the Elastic License 2.0;
 // you may not use this file except in compliance with the Elastic License 2.0.
 
+// Package loadgen contains code for generating load based on real agent data.
 package loadgen
 
 import (

internal/loadgen/eventhandler/handler.go

@@ -2,6 +2,8 @@
 // or more contributor license agreements. Licensed under the Elastic License 2.0;
 // you may not use this file except in compliance with the Elastic License 2.0.
 
+// Package eventhandler contains code for replaying batch of agent data to APM
+// server.
 package eventhandler
 
 import (

internal/otelcollector/collector.go

@@ -2,6 +2,9 @@
 // or more contributor license agreements. Licensed under the Elastic License 2.0;
 // you may not use this file except in compliance with the Elastic License 2.0.
 
+// Package otelcollector contains code for OTEL based in-memory telemetry
+// collector responsible for exposing OTEL receiver endpoints, caching telemetry
+// data sentand providing queryable interface for the collected data.
 package otelcollector
 
 import (
@@ -10,7 +13,6 @@ import (
 	"fmt"
 	"time"
 
-	"github.com/elastic/apm-perf/internal/otelcollector/exporter/inmemexporter"
 	"go.opentelemetry.io/collector/component"
 	"go.opentelemetry.io/collector/config/configtelemetry"
 	"go.opentelemetry.io/collector/exporter"
@@ -22,6 +24,8 @@ import (
 	"go.opentelemetry.io/collector/service/telemetry"
 	"go.uber.org/zap"
 	"go.uber.org/zap/zapcore"
+
+	"github.com/elastic/apm-perf/internal/otelcollector/exporter/inmemexporter"
 )
 
 // Collector defines an OTEL collector for collecting metrics. Services
@@ -108,7 +112,7 @@ func (c *Collector) Shutdown() error {
 	return nil
 }
 
-// GetAggregatedMetrics returns a aggregated value for the given
+// GetAggregatedMetric returns a aggregated value for the given
 // aggregation config.
 func (c *Collector) GetAggregatedMetric(
 	cfg inmemexporter.AggregationConfig,

internal/otelcollector/config.go

@@ -8,9 +8,10 @@ import (
 	"fmt"
 	"os"
 
-	"github.com/elastic/apm-perf/internal/otelcollector/exporter/inmemexporter"
 	"go.uber.org/zap/zapcore"
 	"gopkg.in/yaml.v3"
+
+	"github.com/elastic/apm-perf/internal/otelcollector/exporter/inmemexporter"
 )
 
 // CollectorConfig defines the configuration to customize the collector.

internal/otelcollector/config_test.go

@@ -10,9 +10,10 @@ import (
 	"path"
 	"testing"
 
-	"github.com/elastic/apm-perf/internal/otelcollector/exporter/inmemexporter"
 	"github.com/stretchr/testify/assert"
 	"github.com/stretchr/testify/require"
+
+	"github.com/elastic/apm-perf/internal/otelcollector/exporter/inmemexporter"
 )
 
 func TestLoadConfigFromYamlFile(t *testing.T) {

internal/otelcollector/exporter/inmemexporter/exporter.go

@@ -2,6 +2,7 @@
 // or more contributor license agreements. Licensed under the Elastic License 2.0;
 // you may not use this file except in compliance with the Elastic License 2.0.
 
+// Package inmemexporter contains code for creating an in-memory OTEL exporter.
 package inmemexporter
 
 import (

internal/soaktest/runner.go

@@ -2,6 +2,8 @@
 // or more contributor license agreements. Licensed under the Elastic License 2.0;
 // you may not use this file except in compliance with the Elastic License 2.0.
 
+// Package soaktest contains code for defining soak testing scenarios and providing
+// an interface for running them.
 package soaktest
 
 import (
@@ -29,7 +31,7 @@ type RunnerConfig struct {
 	ScenariosPath string
 	ServerURL     string
 	SecretToken   string
-	ApiKeys       map[string]string
+	APIKeys       map[string]string
 	BypassProxy   bool
 }
 
@@ -124,7 +126,7 @@ func getHandlerParams(runnerConfig *RunnerConfig, config ScenarioConfig) (loadge
 		return params, err
 	}
 	if config.APIKey == "" {
-		config.APIKey = runnerConfig.ApiKeys[config.ProjectID]
+		config.APIKey = runnerConfig.APIKeys[config.ProjectID]
 	}
 
 	burst, interval, err := getEventRate(config.EventRate)

internal/version/settings.go

@@ -2,6 +2,7 @@
 // or more contributor license agreements. Licensed under the Elastic License 2.0;
 // you may not use this file except in compliance with the Elastic License 2.0.
 
+// Package version contains metadata for commands.
 package version
 
 import (