util: expose otel metrics through grpc and prometheus

This exposes the otel metrics through the environment variables for the
otel collector or through the prometheus `/metrics` endpoint through the
debug address.

Signed-off-by: Jonathan A. Sternberg <[email protected]>

cmd/buildctl/common/common.go

@@ -72,7 +72,7 @@ func ResolveClient(c *cli.Context) (*client.Client, error) {
  if span := trace.SpanFromContext(ctx); span.SpanContext().IsValid() {
  opts = append(opts, client.WithTracerProvider(span.TracerProvider()))
 
- exp, err := detect.Exporter()
+ exp, _, err := detect.Exporter()
  if err != nil {
  return nil, err
  }

cmd/buildkitd/debug.go

@@ -9,6 +9,7 @@ import (
  "time"
 
  "github.com/moby/buildkit/util/bklog"
+ "github.com/prometheus/client_golang/prometheus/promhttp"
  "golang.org/x/net/trace"
 )
 
@@ -28,6 +29,8 @@ func setupDebugHandlers(addr string) error {
  bklog.G(req.Context()).Debugf("triggered GC from debug endpoint")
  }))
 
+ m.Handle("/metrics", promhttp.Handler())
+
  // setting debugaddr is opt-in. permission is defined by listener address
  trace.AuthRequest = func(_ *http.Request) (bool, bool) {
  return true, true

cmd/buildkitd/main.go

@@ -703,7 +703,7 @@ func newController(c *cli.Context, cfg *config.Config) (*control.Controller, err
  return nil, err
  }
 
- tc, err := detect.Exporter()
+ tc, _, err := detect.Exporter()
  if err != nil {
  return nil, err
  }

go.mod

@@ -35,7 +35,7 @@ require (
  github.com/gogo/googleapis v1.4.1
  github.com/gogo/protobuf v1.3.2
  github.com/golang/protobuf v1.5.3
- github.com/google/go-cmp v0.5.9
+ github.com/google/go-cmp v0.6.0
  github.com/google/shlex v0.0.0-20191202100458-e7afc7fbc510
  github.com/grpc-ecosystem/go-grpc-middleware v1.3.0
  github.com/hashicorp/go-cleanhttp v0.5.2
@@ -59,7 +59,7 @@ require (
  github.com/pelletier/go-toml v1.9.5
  github.com/pkg/errors v0.9.1
  github.com/pkg/profile v1.5.0
- github.com/prometheus/procfs v0.9.0
+ github.com/prometheus/procfs v0.11.1
  github.com/serialx/hashring v0.0.0-20190422032157-8b2912629002
  github.com/sirupsen/logrus v1.9.3
  github.com/spdx/tools-golang v0.5.1
@@ -74,21 +74,21 @@ require (
  go.opentelemetry.io/contrib/instrumentation/google.golang.org/grpc/otelgrpc v0.45.0
  go.opentelemetry.io/contrib/instrumentation/net/http/httptrace/otelhttptrace v0.45.0
  go.opentelemetry.io/contrib/instrumentation/net/http/otelhttp v0.45.0
- go.opentelemetry.io/otel v1.19.0
+ go.opentelemetry.io/otel v1.21.0
  go.opentelemetry.io/otel/exporters/jaeger v1.17.0
  go.opentelemetry.io/otel/exporters/otlp/otlptrace v1.19.0
  go.opentelemetry.io/otel/exporters/otlp/otlptrace/otlptracegrpc v1.19.0
  go.opentelemetry.io/otel/exporters/otlp/otlptrace/otlptracehttp v1.19.0
- go.opentelemetry.io/otel/sdk v1.19.0
- go.opentelemetry.io/otel/trace v1.19.0
+ go.opentelemetry.io/otel/sdk v1.21.0
+ go.opentelemetry.io/otel/trace v1.21.0
  go.opentelemetry.io/proto/otlp v1.0.0
  golang.org/x/crypto v0.14.0
  golang.org/x/net v0.17.0
  golang.org/x/sync v0.3.0
- golang.org/x/sys v0.13.0
+ golang.org/x/sys v0.14.0
  golang.org/x/time v0.3.0
- google.golang.org/genproto/googleapis/rpc v0.0.0-20230711160842-782d3b101e98
- google.golang.org/grpc v1.58.3
+ google.golang.org/genproto/googleapis/rpc v0.0.0-20230822172742-b8732ec3820d
+ google.golang.org/grpc v1.59.0
  google.golang.org/protobuf v1.31.0
  kernel.org/pub/linux/libs/security/libcap/cap v1.2.67
 )
@@ -129,11 +129,11 @@ require (
  github.com/docker/go-events v0.0.0-20190806004212-e31b211e4f1c // indirect
  github.com/docker/go-metrics v0.0.1 // indirect
  github.com/felixge/httpsnoop v1.0.3 // indirect
- github.com/go-logr/logr v1.2.4 // indirect
+ github.com/go-logr/logr v1.3.0 // indirect
  github.com/go-logr/stdr v1.2.2 // indirect
  github.com/golang-jwt/jwt/v4 v4.4.2 // indirect
  github.com/golang/groupcache v0.0.0-20210331224755-41bb18bfe9da // indirect
- github.com/google/uuid v1.3.0 // indirect
+ github.com/google/uuid v1.3.1 // indirect
  github.com/grpc-ecosystem/grpc-gateway/v2 v2.16.0 // indirect
  github.com/hanwen/go-fuse/v2 v2.2.0 // indirect
  github.com/hashicorp/errwrap v1.1.0 // indirect
@@ -146,20 +146,28 @@ require (
  github.com/opencontainers/runc v1.1.10 // indirect
  github.com/pkg/browser v0.0.0-20210115035449-ce105d075bb4 // indirect
  github.com/pmezard/go-difflib v1.0.0 // indirect
- github.com/prometheus/client_golang v1.14.0 // indirect
- github.com/prometheus/client_model v0.3.0 // indirect
- github.com/prometheus/common v0.42.0 // indirect
+ github.com/prometheus/client_golang v1.17.0
+ github.com/prometheus/client_model v0.5.0 // indirect
+ github.com/prometheus/common v0.44.0 // indirect
  github.com/russross/blackfriday/v2 v2.1.0 // indirect
  github.com/secure-systems-lab/go-securesystemslib v0.4.0 // indirect
  github.com/shibumi/go-pathspec v1.3.0 // indirect
  github.com/vbatts/tar-split v0.11.3 // indirect
  go.opencensus.io v0.24.0 // indirect
- go.opentelemetry.io/otel/metric v1.19.0 // indirect
+ go.opentelemetry.io/otel/metric v1.21.0
  golang.org/x/mod v0.11.0 // indirect
  golang.org/x/text v0.13.0 // indirect
  golang.org/x/tools v0.10.0 // indirect
- google.golang.org/genproto v0.0.0-20230711160842-782d3b101e98 // indirect
- google.golang.org/genproto/googleapis/api v0.0.0-20230711160842-782d3b101e98 // indirect
+ google.golang.org/genproto v0.0.0-20230822172742-b8732ec3820d // indirect
+ google.golang.org/genproto/googleapis/api v0.0.0-20230822172742-b8732ec3820d // indirect
  gopkg.in/yaml.v3 v3.0.1 // indirect
  kernel.org/pub/linux/libs/security/libcap/psx v1.2.67 // indirect
 )
+
+require (
+ go.opentelemetry.io/otel/exporters/otlp/otlpmetric/otlpmetricgrpc v0.44.0
+ go.opentelemetry.io/otel/exporters/otlp/otlpmetric/otlpmetrichttp v0.44.0
+ go.opentelemetry.io/otel/sdk/metric v1.21.0
+)
+
+require go.opentelemetry.io/otel/exporters/prometheus v0.44.0