Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions .cspell-words.txt
Original file line number Diff line number Diff line change
Expand Up @@ -217,3 +217,5 @@ otlpmetric
otlpmetrichttp
sdkmetric
stdr
metricdata
nilerr
2 changes: 2 additions & 0 deletions BUILD.bazel
Original file line number Diff line number Diff line change
Expand Up @@ -105,6 +105,8 @@ GO_TARGETS = [
"//internal/budget:budget_test",
"//internal/ghclient",
"//internal/ghclient:ghclient_test",
"//internal/recorder",
"//internal/recorder:recorder_test",
"//internal/receiver",
"//deploy:deploy_test",
"//internal/receiver:receiver_test",
Expand Down
2 changes: 1 addition & 1 deletion cmd/github-metrics/main.go
Original file line number Diff line number Diff line change
Expand Up @@ -129,7 +129,7 @@ func run(addr string, log *slog.Logger) error {

type noopRecorder struct{}

func (noopRecorder) RecordPullRequest(_, _ string) error { return errNoRecorder }
func (noopRecorder) Record(_ context.Context, _ string, _ []byte) error { return errNoRecorder }

// probe asks the local health endpoint and returns the exit code.
func probe(addr string) int {
Expand Down
29 changes: 29 additions & 0 deletions internal/recorder/BUILD.bazel
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
# SPDX-License-Identifier: Apache-2.0
# Copyright Tony Burns

load("@rules_go//go:def.bzl", "go_library", "go_test")
load("@tbhb_rules//repo:defs.bzl", "repo_files")

repo_files()

go_library(
name = "recorder",
srcs = ["recorder.go"],
importpath = "github.com/tbhb-dev/github-metrics/internal/recorder",
visibility = ["//:__subpackages__"],
deps = [
"@io_opentelemetry_go_otel//attribute",
"@io_opentelemetry_go_otel_metric//:metric",
],
)

go_test(
name = "recorder_test",
srcs = ["recorder_test.go"],
visibility = ["//:__pkg__"],
deps = [
":recorder",
"@io_opentelemetry_go_otel_sdk_metric//:metric",
"@io_opentelemetry_go_otel_sdk_metric//metricdata",
],
)
94 changes: 94 additions & 0 deletions internal/recorder/recorder.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,94 @@
// SPDX-License-Identifier: Apache-2.0
// Copyright Tony Burns

// Package recorder counts queued GitHub deliveries as metrics.
package recorder

import (
"context"
"encoding/json"
"fmt"

"go.opentelemetry.io/otel/attribute"
"go.opentelemetry.io/otel/metric"
)

// Recorder counts events without recording webhook text in attributes.
type Recorder struct {
events, merges, conclusions, dropped metric.Int64Counter
}

// New creates the counters used to record deliveries.
func New(meter metric.Meter) (*Recorder, error) {
var recorder Recorder

for _, counter := range []struct {
target *metric.Int64Counter
name string
}{
{&recorder.events, "github.events"},
{&recorder.merges, "github.pr.merges"},
{&recorder.conclusions, "github.check.conclusions"},
{&recorder.dropped, "github.events.dropped"},
} {
instrument, err := meter.Int64Counter(counter.name)
if err != nil {
return nil, fmt.Errorf("create %s counter: %w", counter.name, err)
}

*counter.target = instrument
}

return &recorder, nil
}

// Record counts a delivery or a drop before allowing its removal from the queue.
func (r *Recorder) Record(ctx context.Context, event string, body []byte) error {
if event == "" {
r.dropped.Add(ctx, 1, metric.WithAttributes(attribute.String("reason", "empty_event")))

return nil
}

var delivery struct {
Repository struct {
FullName string `json:"full_name"` //nolint:tagliatelle // GitHub uses this field name.
} `json:"repository"`
Action string `json:"action"`
CheckRun struct {
Name string `json:"name"`
Conclusion string `json:"conclusion"`
} `json:"check_run"` //nolint:tagliatelle // GitHub uses this field name.
PullRequest struct {
Merged bool `json:"merged"`
} `json:"pull_request"` //nolint:tagliatelle // GitHub uses this field name.
}

err := json.Unmarshal(body, &delivery)
if err != nil {
r.dropped.Add(ctx, 1, metric.WithAttributes(attribute.String("reason", "bad_body")))

return nil //nolint:nilerr // Bad data is counted as a drop and may leave the queue.
}

repository := delivery.Repository.FullName
if repository == "" {
repository = "unknown"
}

repo := attribute.String("repository", repository)
r.events.Add(ctx, 1, metric.WithAttributes(repo,
attribute.String("event", event), attribute.String("action", delivery.Action)))

if event == "pull_request" && delivery.Action == "closed" && delivery.PullRequest.Merged {
r.merges.Add(ctx, 1, metric.WithAttributes(repo))
}

if event == "check_run" && delivery.Action == "completed" {
r.conclusions.Add(ctx, 1, metric.WithAttributes(repo,
attribute.String("check_name", delivery.CheckRun.Name),
attribute.String("conclusion", delivery.CheckRun.Conclusion)))
}

return nil
}
138 changes: 138 additions & 0 deletions internal/recorder/recorder_test.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,138 @@
// SPDX-License-Identifier: Apache-2.0
// Copyright Tony Burns

package recorder_test

import (
"reflect"
"testing"

"go.opentelemetry.io/otel/sdk/metric/metricdata"

sdkmetric "go.opentelemetry.io/otel/sdk/metric"

"github.com/tbhb-dev/github-metrics/internal/recorder"
)

const (
pullRequestEvent = "pull_request"
checkRunEvent = "check_run"
actionKey = "action"
eventKey = "event"
eventsName = "github.events"
repositoryKey = "repository"
unknownRepository = "unknown"
)

func TestRecord(t *testing.T) {
t.Parallel()

for _, test := range []struct {
want map[string]map[string]string
name, event, body string
}{
{
map[string]map[string]string{
eventsName: {repositoryKey: "tbhb-dev/github-metrics", eventKey: pullRequestEvent, actionKey: "closed"},
"github.pr.merges": {repositoryKey: "tbhb-dev/github-metrics"},
},
"merge", pullRequestEvent,
`{"repository":{"full_name":"tbhb-dev/github-metrics"},"action":"closed",` +
`"pull_request":{"merged":true,"title":"omit title","body":"omit body",` +
`"head":{"ref":"omit branch"},"user":{"login":"omit login"}},"comment":{"body":"omit text"}}`,
},
{
map[string]map[string]string{
eventsName: {repositoryKey: unknownRepository, eventKey: pullRequestEvent, actionKey: "closed"},
},
"closed without merge", pullRequestEvent, `{"action":"closed","pull_request":{"merged":false}}`,
},
{
map[string]map[string]string{
eventsName: {repositoryKey: unknownRepository, eventKey: checkRunEvent, actionKey: "completed"},
"github.check.conclusions": {repositoryKey: unknownRepository, "check_name": "build", "conclusion": "success"},
},
"completed check", checkRunEvent,
`{"action":"completed","check_run":{"name":"build","conclusion":"success"}}`,
},
{
map[string]map[string]string{
eventsName: {repositoryKey: unknownRepository, eventKey: checkRunEvent, actionKey: "created"},
},
"running check", checkRunEvent, `{"action":"created","check_run":{"name":"build"}}`,
},
{
map[string]map[string]string{
eventsName: {repositoryKey: unknownRepository, eventKey: "ping", actionKey: ""},
},
"other event with empty action", "ping", `{}`,
},
{
map[string]map[string]string{"github.events.dropped": {"reason": "empty_event"}},
"legacy entry", "", `{}`,
},
{
map[string]map[string]string{"github.events.dropped": {"reason": "bad_body"}},
"bad JSON", pullRequestEvent, `{"action":`,
},
} {
t.Run(test.name, func(t *testing.T) {
t.Parallel()

reader := sdkmetric.NewManualReader()
provider := sdkmetric.NewMeterProvider(sdkmetric.WithReader(reader))

t.Cleanup(func() {
shutdownErr := provider.Shutdown(t.Context())
if shutdownErr != nil {
t.Error(shutdownErr)
}
})

consumer, err := recorder.New(provider.Meter("test"))
if err != nil {
t.Fatal(err)
}

err = consumer.Record(t.Context(), test.event, []byte(test.body))
if err != nil {
t.Fatal(err)
}

checkMetrics(t, reader, test.want)
})
}
}

func checkMetrics(t *testing.T, reader *sdkmetric.ManualReader, want map[string]map[string]string) {
t.Helper()

var data metricdata.ResourceMetrics

err := reader.Collect(t.Context(), &data)
if err != nil {
t.Fatal(err)
}

got := make(map[string]map[string]string)

for _, scope := range data.ScopeMetrics {
for _, measurement := range scope.Metrics {
sum, ok := measurement.Data.(metricdata.Sum[int64])
if !ok || !sum.IsMonotonic || len(sum.DataPoints) != 1 || sum.DataPoints[0].Value != 1 {
t.Fatalf("%s: expected one counter observation of 1, got %v", measurement.Name, measurement.Data)
}

attrs := make(map[string]string)
for _, attr := range sum.DataPoints[0].Attributes.ToSlice() {
attrs[string(attr.Key)] = attr.Value.AsString()
}

got[measurement.Name] = attrs
}
}

if !reflect.DeepEqual(got, want) {
t.Fatalf("metrics = %v, want %v", got, want)
}
}
11 changes: 5 additions & 6 deletions internal/worker/BUILD.bazel
Original file line number Diff line number Diff line change
Expand Up @@ -16,11 +16,10 @@ go_library(

go_test(
name = "worker_test",
srcs = [
"export_test.go",
"worker_test.go",
],
embed = [":worker"],
srcs = ["worker_test.go"],
visibility = ["//:__pkg__"],
deps = ["//internal/store"],
deps = [
":worker",
"//internal/store",
],
)
7 changes: 0 additions & 7 deletions internal/worker/export_test.go

This file was deleted.

45 changes: 4 additions & 41 deletions internal/worker/worker.go
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,6 @@ package worker

import (
"context"
"encoding/json"
"errors"
"fmt"
"log/slog"
"strings"
Expand All @@ -18,11 +16,9 @@ import (

const batchSize = 100

var errMissingFields = errors.New("pull request repository or action is empty")

// Recorder records a pull request event, without a telemetry dependency.
// Recorder records a queued event, without a telemetry dependency.
type Recorder interface {
RecordPullRequest(repository, action string) error
Record(ctx context.Context, event string, body []byte) error
}

// Queue is the part of the store that a worker consumes.
Expand All @@ -31,7 +27,7 @@ type Queue interface {
Remove(seq uint64) error
}

// Worker records pull request events and removes consumed queue entries.
// Worker records events and removes consumed queue entries.
type Worker struct {
queue Queue
recorder Recorder
Expand Down Expand Up @@ -93,45 +89,12 @@ func (w *Worker) Pass(ctx context.Context) error {
}

func (w *Worker) record(ctx context.Context, entry store.Entry) bool {
if entry.Event != "pull_request" {
w.log.WarnContext(ctx, "unhandled event", "event", oneLine(entry.Event))

return false
}

repository, action, err := parse(entry.Body)
if err != nil {
w.log.WarnContext(ctx, "unhandled event", "reason", "bad pull request body")

return false
}

err = w.recorder.RecordPullRequest(repository, action)
err := w.recorder.Record(ctx, entry.Event, entry.Body)
if err != nil {
w.log.WarnContext(ctx, "recording failed", "event", oneLine(entry.Event))
}

return err == nil
}

func parse(body []byte) (string, string, error) {
var event struct {
Repository struct {
FullName string `json:"full_name"` //nolint:tagliatelle // GitHub uses this field name
} `json:"repository"`
Action string `json:"action"`
}

err := json.Unmarshal(body, &event)
if err != nil {
return "", "", fmt.Errorf("parse pull request: %w", err)
}

if event.Repository.FullName == "" || event.Action == "" {
return "", "", errMissingFields
}

return event.Repository.FullName, event.Action, nil
}

func oneLine(s string) string { return strings.ReplaceAll(strings.ReplaceAll(s, "\n", ""), "\r", "") }
Loading