Skip to content

wip: instrument OpenTelemetry metrics #497

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

wip: instrument OpenTelemetry metrics #497

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
65 changes: 64 additions & 1 deletion cmd/skyeye/main.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@
"fmt"
"io/fs"
"math/rand/v2"
"net/http"
"os"
"os/signal"
"reflect"
Expand All @@ -19,6 +20,7 @@
"golang.org/x/sys/cpu"

"github.com/martinlindhe/unit"
"github.com/prometheus/client_golang/prometheus/promhttp"
"github.com/rs/zerolog/log"
"github.com/spf13/cobra"
"github.com/spf13/pflag"
Expand All @@ -30,6 +32,12 @@
"github.com/dharmab/skyeye/pkg/coalitions"
"github.com/dharmab/skyeye/pkg/synthesizer/voices"
"github.com/ggerganov/whisper.cpp/bindings/go/pkg/whisper"

"go.opentelemetry.io/otel"
"go.opentelemetry.io/otel/exporters/prometheus"
"go.opentelemetry.io/otel/sdk/metric"
"go.opentelemetry.io/otel/sdk/resource"
semconv "go.opentelemetry.io/otel/semconv/v1.26.0"
)

// Used for CLI configuration values.
Expand Down Expand Up @@ -66,6 +74,8 @@
threatMonitoringInterval time.Duration
threatMonitoringRequiresSRS bool
mandatoryThreatRadiusNM float64
exportMetrics bool
metricsPort int
enableTracing bool
discordWebhookID string
discordWebhookToken string
Expand Down Expand Up @@ -130,6 +140,10 @@
skyeye.Flags().Float64Var(&mandatoryThreatRadiusNM, "mandatory-threat-radius", 25, "Briefed radius for mandatory THREAT calls, in nautical miles")
skyeye.Flags().BoolVar(&threatMonitoringRequiresSRS, "threat-monitoring-requires-srs", true, "Require aircraft to be on SRS to receive THREAT calls. Only useful to disable when debugging")

// Metrics
skyeye.Flags().BoolVar(&exportMetrics, "export-metrics", false, "Export Prometheus metrics via HTTP")
skyeye.Flags().IntVar(&metricsPort, "metrics-port", 8080, "TCP port on which to export Prometheus metrics via HTTP")

// Tracing
skyeye.Flags().BoolVar(&enableTracing, "tracing", false, "Enable tracing")
skyeye.Flags().StringVar(&discordWebhookID, "discord-webhook-id", "", "Discord webhook ID for tracing")
Expand All @@ -140,9 +154,11 @@
skyeye.Flags().DurationVar(&exitAfter, "exit-after", time.Hour*24*365*20, "Exit after running for the specified duration")
}

const commandName = "skyeye"

// Top-level CLI command.
var skyeye = &cobra.Command{
Use: "skyeye",
Use: commandName,
Version: Version,
Short: "AI Powered GCI Bot for DCS World",
Long: "Skyeye uses real-time telemetry data from TacView to provide Ground-Controlled Intercept service over SimpleRadio-Standalone.",
Expand Down Expand Up @@ -288,6 +304,31 @@
return
}

func loadMeterProvider() (*metric.MeterProvider, error) {
appResource, err := resource.Merge(
resource.Default(),
resource.NewWithAttributes(
semconv.SchemaURL,
semconv.ServiceName(commandName),
semconv.ServiceVersion(Version),
),
)
if err != nil {
return nil, fmt.Errorf("failed to create metric resource: %w", err)
}

exporter, err := prometheus.New()
if err != nil {
return nil, fmt.Errorf("failed to create prometheus exporter: %w", err)
}

provider := metric.NewMeterProvider(
metric.WithResource(appResource),
metric.WithReader(exporter),
)
return provider, nil
}

func preRun(cmd *cobra.Command, _ []string) error {
if err := initializeConfig(cmd); err != nil {
return fmt.Errorf("failed to initialize config: %w", err)
Expand Down Expand Up @@ -333,6 +374,28 @@
callsign := loadCallsign(rando)
parsedSRSFrequencies := cli.LoadFrequencies(srsFrequencies)

log.Info().Msg("configuring metrics")
meterProvider, err := loadMeterProvider()
if err != nil {
log.Fatal().Err(err).Msg("failed to create metric provider")
}
defer func() {
log.Info().Msg("shutting down meter provider")
if err := meterProvider.Shutdown(ctx); err != nil {
log.Error().Err(err).Msg("failed to shut down meter provider")
}
}()
otel.SetMeterProvider(meterProvider)
if exportMetrics {
log.Info().Msgf("exporting metrics on :%d/metrics", metricsPort)
go func() {
http.Handle("/metrics", promhttp.Handler())
if err := http.ListenAndServe(fmt.Sprintf(":%d", metricsPort), nil); err != nil {

Check failure on line 393 in cmd/skyeye/main.go

View workflow job for this annotation

GitHub Actions / Lint 

G114: Use of net/http serve function that has no support for setting timeouts (gosec)
log.Error().Err(err).Msg("failed to serve metrics")
}
}()
}

config := conf.Configuration{
ACMIFile: acmiFile,
TelemetryAddress: telemetryAddress,
Expand Down
30 changes: 19 additions & 11 deletions go.mod
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,12 +26,16 @@ require (
github.com/spf13/cobra v1.8.1
github.com/spf13/pflag v1.0.5
github.com/spf13/viper v1.19.0
github.com/stretchr/testify v1.9.0
github.com/stretchr/testify v1.10.0
github.com/zaf/resample v1.5.0
go.opentelemetry.io/otel v1.34.0
go.opentelemetry.io/otel/exporters/prometheus v0.56.0
go.opentelemetry.io/otel/sdk v1.34.0
go.opentelemetry.io/otel/sdk/metric v1.34.0
golang.org/x/exp v0.0.0-20240719175910-8a7402abbf56
golang.org/x/lint v0.0.0-20210508222113-6edffad5e616
golang.org/x/net v0.33.0
golang.org/x/sys v0.28.0
golang.org/x/sys v0.29.0
google.golang.org/grpc v1.64.1
gopkg.in/hraban/opus.v2 v2.0.0-20230925203106-0188a62cb302
gotest.tools/gotestsum v1.11.0
Expand Down Expand Up @@ -71,7 +75,7 @@ require (
github.com/butuzov/mirror v1.2.0 // indirect
github.com/catenacyber/perfsprint v0.7.1 // indirect
github.com/ccojocar/zxcvbn-go v1.0.2 // indirect
github.com/cespare/xxhash/v2 v2.2.0 // indirect
github.com/cespare/xxhash/v2 v2.3.0 // indirect
github.com/charithe/durationcheck v0.0.10 // indirect
github.com/chavacava/garif v0.1.0 // indirect
github.com/ckaznocha/intrange v0.1.2 // indirect
Expand All @@ -88,6 +92,8 @@ require (
github.com/fzipp/gocyclo v0.6.0 // indirect
github.com/ghostiam/protogetter v0.3.6 // indirect
github.com/go-critic/go-critic v0.11.4 // indirect
github.com/go-logr/logr v1.4.2 // indirect
github.com/go-logr/stdr v1.2.2 // indirect
github.com/go-toolsmith/astcast v1.1.0 // indirect
github.com/go-toolsmith/astcopy v1.1.0 // indirect
github.com/go-toolsmith/astequal v1.2.0 // indirect
Expand All @@ -99,7 +105,6 @@ require (
github.com/go-xmlfmt/xmlfmt v1.1.2 // indirect
github.com/gobwas/glob v0.2.3 // indirect
github.com/gofrs/flock v0.12.1 // indirect
github.com/golang/protobuf v1.5.4 // indirect
github.com/golangci/dupl v0.0.0-20180902072040-3e9179ac440a // indirect
github.com/golangci/gofmt v0.0.0-20240816233607-d8596aa466a9 // indirect
github.com/golangci/misspell v0.6.0 // indirect
Expand Down Expand Up @@ -128,7 +133,7 @@ require (
github.com/karamaru-alpha/copyloopvar v1.1.0 // indirect
github.com/kisielk/errcheck v1.7.0 // indirect
github.com/kkHAIKE/contextcheck v1.1.5 // indirect
github.com/klauspost/compress v1.17.3 // indirect
github.com/klauspost/compress v1.17.9 // indirect
github.com/kulti/thelper v0.6.3 // indirect
github.com/kunwardeep/paralleltest v1.0.10 // indirect
github.com/kyoh86/exportloopref v0.1.11 // indirect
Expand All @@ -145,11 +150,11 @@ require (
github.com/mattn/go-colorable v0.1.13 // indirect
github.com/mattn/go-isatty v0.0.20 // indirect
github.com/mattn/go-runewidth v0.0.15 // indirect
github.com/matttproud/golang_protobuf_extensions v1.0.1 // indirect
github.com/mgechev/revive v1.3.9 // indirect
github.com/mitchellh/go-homedir v1.1.0 // indirect
github.com/mitchellh/mapstructure v1.5.0 // indirect
github.com/moricho/tparallel v0.3.2 // indirect
github.com/munnerz/goautoneg v0.0.0-20191010083416-a7dc8b61c822 // indirect
github.com/nabbl/piper-bin-macos v0.0.0-20240805085459-7f1b1df8c68d // indirect
github.com/nakabonne/nestif v0.3.1 // indirect
github.com/nishanths/exhaustive v0.12.0 // indirect
Expand All @@ -160,10 +165,10 @@ require (
github.com/pkg/errors v0.9.1 // indirect
github.com/pmezard/go-difflib v1.0.1-0.20181226105442-5d4384ee4fb2 // indirect
github.com/polyfloyd/go-errorlint v1.6.0 // indirect
github.com/prometheus/client_golang v1.12.1 // indirect
github.com/prometheus/client_model v0.2.0 // indirect
github.com/prometheus/common v0.32.1 // indirect
github.com/prometheus/procfs v0.7.3 // indirect
github.com/prometheus/client_golang v1.20.5 // indirect
github.com/prometheus/client_model v0.6.1 // indirect
github.com/prometheus/common v0.61.0 // indirect
github.com/prometheus/procfs v0.15.1 // indirect
github.com/quasilyte/go-ruleguard v0.4.2 // indirect
github.com/quasilyte/go-ruleguard/dsl v0.3.22 // indirect
github.com/quasilyte/gogrep v0.5.0 // indirect
Expand Down Expand Up @@ -212,6 +217,9 @@ require (
gitlab.com/bosi/decorder v0.4.2 // indirect
go-simpler.org/musttag v0.12.2 // indirect
go-simpler.org/sloglint v0.7.2 // indirect
go.opentelemetry.io/auto/sdk v1.1.0 // indirect
go.opentelemetry.io/otel/metric v1.34.0 // indirect
go.opentelemetry.io/otel/trace v1.34.0 // indirect
go.uber.org/atomic v1.9.0 // indirect
go.uber.org/automaxprocs v1.5.3 // indirect
go.uber.org/multierr v1.9.0 // indirect
Expand All @@ -224,7 +232,7 @@ require (
golang.org/x/text v0.21.0 // indirect
golang.org/x/tools v0.24.0 // indirect
google.golang.org/genproto/googleapis/rpc v0.0.0-20240730163845-b1a4ccb954bf // indirect
google.golang.org/protobuf v1.34.2 // indirect
google.golang.org/protobuf v1.36.3 // indirect
gopkg.in/ini.v1 v1.67.0 // indirect
gopkg.in/yaml.v2 v2.4.0 // indirect
gopkg.in/yaml.v3 v3.0.1 // indirect
Expand Down
Loading
Loading