implement new runtime metrics

CHANGELOG.md

@@ -15,6 +15,7 @@ This project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.htm
 - Add support to configure views when creating MeterProvider using the config package. (#5654)
 - Add log support for the autoexport package. (#5733)
 - Add support for disabling the old runtime metrics using the `OTEL_GO_X_DEPRECATED_RUNTIME_METRICS=false` environment variable. (#5747)
+- Add new runtime metrics to `go.opentelemetry.io/contrib/instrumentation/runtime`, which are still disabled by default. (#5870)
 
 ### Fixed
 

instrumentation/runtime/options.go

@@ -0,0 +1,76 @@
+// Copyright The OpenTelemetry Authors
+// SPDX-License-Identifier: Apache-2.0
+
+package runtime // import "go.opentelemetry.io/contrib/instrumentation/runtime"
+
+import (
+	"time"
+
+	"go.opentelemetry.io/otel"
+	"go.opentelemetry.io/otel/metric"
+)
+
+// config contains optional settings for reporting runtime metrics.
+type config struct {
+	// MinimumReadMemStatsInterval sets the minimum interval
+	// between calls to runtime.ReadMemStats().  Negative values
+	// are ignored.
+	MinimumReadMemStatsInterval time.Duration
+
+	// MeterProvider sets the metric.MeterProvider.  If nil, the global
+	// Provider will be used.
+	MeterProvider metric.MeterProvider
+}
+
+// Option supports configuring optional settings for runtime metrics.
+type Option interface {
+	apply(*config)
+}
+
+// DefaultMinimumReadMemStatsInterval is the default minimum interval
+// between calls to runtime.ReadMemStats().  Use the
+// WithMinimumReadMemStatsInterval() option to modify this setting in
+// Start().
+const DefaultMinimumReadMemStatsInterval time.Duration = 15 * time.Second
+
+// WithMinimumReadMemStatsInterval sets a minimum interval between calls to
+// runtime.ReadMemStats(), which is a relatively expensive call to make
+// frequently.  This setting is ignored when `d` is negative.
+func WithMinimumReadMemStatsInterval(d time.Duration) Option {
+	return minimumReadMemStatsIntervalOption(d)
+}
+
+type minimumReadMemStatsIntervalOption time.Duration
+
+func (o minimumReadMemStatsIntervalOption) apply(c *config) {
+	if o >= 0 {
+		c.MinimumReadMemStatsInterval = time.Duration(o)
+	}
+}
+
+// WithMeterProvider sets the Metric implementation to use for
+// reporting.  If this option is not used, the global metric.MeterProvider
+// will be used.  `provider` must be non-nil.
+func WithMeterProvider(provider metric.MeterProvider) Option {
+	return metricProviderOption{provider}
+}
+
+type metricProviderOption struct{ metric.MeterProvider }
+
+func (o metricProviderOption) apply(c *config) {
+	if o.MeterProvider != nil {
+		c.MeterProvider = o.MeterProvider
+	}
+}
+
+// newConfig computes a config from the supplied Options.
+func newConfig(opts ...Option) config {
+	c := config{
+		MeterProvider:               otel.GetMeterProvider(),
+		MinimumReadMemStatsInterval: DefaultMinimumReadMemStatsInterval,
+	}
+	for _, opt := range opts {
+		opt.apply(&c)
+	}
+	return c
+}

instrumentation/runtime/runtime.go

@@ -4,9 +4,14 @@
 package runtime // import "go.opentelemetry.io/contrib/instrumentation/runtime"
 
 import (
+	"context"
+	"math"
+	"runtime/metrics"
+	"sync"
 	"time"
 
 	"go.opentelemetry.io/otel"
+	"go.opentelemetry.io/otel/attribute"
 	"go.opentelemetry.io/otel/metric"
 
 	"go.opentelemetry.io/contrib/instrumentation/runtime/internal/deprecatedruntime"
@@ -16,70 +21,18 @@ import (
 // ScopeName is the instrumentation scope name.
 const ScopeName = "go.opentelemetry.io/contrib/instrumentation/runtime"
 
-// config contains optional settings for reporting runtime metrics.
-type config struct {
-	// MinimumReadMemStatsInterval sets the minimum interval
-	// between calls to runtime.ReadMemStats().  Negative values
-	// are ignored.
-	MinimumReadMemStatsInterval time.Duration
-
-	// MeterProvider sets the metric.MeterProvider.  If nil, the global
-	// Provider will be used.
-	MeterProvider metric.MeterProvider
-}
-
-// Option supports configuring optional settings for runtime metrics.
-type Option interface {
-	apply(*config)
-}
-
-// DefaultMinimumReadMemStatsInterval is the default minimum interval
-// between calls to runtime.ReadMemStats().  Use the
-// WithMinimumReadMemStatsInterval() option to modify this setting in
-// Start().
-const DefaultMinimumReadMemStatsInterval time.Duration = 15 * time.Second
-
-// WithMinimumReadMemStatsInterval sets a minimum interval between calls to
-// runtime.ReadMemStats(), which is a relatively expensive call to make
-// frequently.  This setting is ignored when `d` is negative.
-func WithMinimumReadMemStatsInterval(d time.Duration) Option {
-	return minimumReadMemStatsIntervalOption(d)
-}
-
-type minimumReadMemStatsIntervalOption time.Duration
-
-func (o minimumReadMemStatsIntervalOption) apply(c *config) {
-	if o >= 0 {
-		c.MinimumReadMemStatsInterval = time.Duration(o)
-	}
-}
-
-// WithMeterProvider sets the Metric implementation to use for
-// reporting.  If this option is not used, the global metric.MeterProvider
-// will be used.  `provider` must be non-nil.
-func WithMeterProvider(provider metric.MeterProvider) Option {
-	return metricProviderOption{provider}
-}
-
-type metricProviderOption struct{ metric.MeterProvider }
-
-func (o metricProviderOption) apply(c *config) {
-	if o.MeterProvider != nil {
-		c.MeterProvider = o.MeterProvider
-	}
-}
-
-// newConfig computes a config from the supplied Options.
-func newConfig(opts ...Option) config {
-	c := config{
-		MeterProvider:               otel.GetMeterProvider(),
-		MinimumReadMemStatsInterval: DefaultMinimumReadMemStatsInterval,
-	}
-	for _, opt := range opts {
-		opt.apply(&c)
-	}
-	return c
-}
+const (
+	goTotalMemory       = "/memory/classes/total:bytes"
+	goMemoryReleased    = "/memory/classes/heap/released:bytes"
+	goHeapMemory        = "/memory/classes/heap/stacks:bytes"
+	goMemoryLimit       = "/gc/gomemlimit:bytes"
+	goMemoryAllocated   = "/gc/heap/allocs:bytes"
+	goMemoryAllocations = "/gc/heap/allocs:objects"
+	goMemoryGoal        = "/gc/heap/goal:bytes"
+	goGoroutines        = "/sched/goroutines:goroutines"
+	goMaxProcs          = "/sched/gomaxprocs:threads"
+	goConfigGC          = "/gc/gogc:percent"
+)
 
 // Start initializes reporting of runtime metrics using the supplied config.
 func Start(opts ...Option) error {
@@ -97,6 +50,166 @@ func Start(opts ...Option) error {
 	if x.DeprecatedRuntimeMetrics.Enabled() {
 		return deprecatedruntime.Start(meter, c.MinimumReadMemStatsInterval)
 	}
-	// TODO (#5655) Implement new runtime conventions
+	memoryUsedInstrument, err := meter.Int64ObservableUpDownCounter(
+		"go.memory.used",
+		metric.WithUnit("By"),
+		metric.WithDescription("Memory used by the Go runtime."),
+	)
+	if err != nil {
+		return err
+	}
+	memoryLimitInstrument, err := meter.Int64ObservableUpDownCounter(
+		"go.memory.limit",
+		metric.WithUnit("By"),
+		metric.WithDescription("Go runtime memory limit configured by the user, if a limit exists."),
+	)
+	if err != nil {
+		return err
+	}
+	memoryAllocatedInstrument, err := meter.Int64ObservableCounter(
+		"go.memory.allocated",
+		metric.WithUnit("By"),
+		metric.WithDescription("Memory allocated to the heap by the application."),
+	)
+	if err != nil {
+		return err
+	}
+	memoryAllocationsInstrument, err := meter.Int64ObservableCounter(
+		"go.memory.allocations",
+		metric.WithUnit("{allocation}"),
+		metric.WithDescription("Count of allocations to the heap by the application."),
+	)
+	if err != nil {
+		return err
+	}
+	memoryGCGoalInstrument, err := meter.Int64ObservableUpDownCounter(
+		"go.memory.gc.goal",
+		metric.WithUnit("By"),
+		metric.WithDescription("Heap size target for the end of the GC cycle."),
+	)
+	if err != nil {
+		return err
+	}
+	goroutineCountInstrument, err := meter.Int64ObservableUpDownCounter(
+		"go.goroutine.count",
+		metric.WithUnit("{goroutine}"),
+		metric.WithDescription("Count of live goroutines."),
+	)
+	if err != nil {
+		return err
+	}
+	processorLimitInstrument, err := meter.Int64ObservableUpDownCounter(
+		"go.processor.limit",
+		metric.WithUnit("{thread}"),
+		metric.WithDescription("The number of OS threads that can execute user-level Go code simultaneously."),
+	)
+	if err != nil {
+		return err
+	}
+	gogcConfigInstrument, err := meter.Int64ObservableUpDownCounter(
+		"go.config.gogc",
+		metric.WithUnit("%"),
+		metric.WithDescription("Heap size target percentage configured by the user, otherwise 100."),
+	)
+	if err != nil {
+		return err
+	}
+
+	otherMemoryOpt := metric.WithAttributeSet(
+		attribute.NewSet(attribute.String("go.memory.type", "other")),
+	)
+	stackMemoryOpt := metric.WithAttributeSet(
+		attribute.NewSet(attribute.String("go.memory.type", "stack")),
+	)
+	collector := newCollector(c.MinimumReadMemStatsInterval)
+	var lock sync.Mutex
+	_, err = meter.RegisterCallback(
+		func(ctx context.Context, o metric.Observer) error {
+			lock.Lock()
+			defer lock.Unlock()
+			collector.refresh()
+			stackMemory := collector.get(goHeapMemory)
+			o.ObserveInt64(memoryUsedInstrument, stackMemory, stackMemoryOpt)
+			totalMemory := collector.get(goTotalMemory) - collector.get(goMemoryReleased)
+			otherMemory := totalMemory - stackMemory
+			o.ObserveInt64(memoryUsedInstrument, otherMemory, otherMemoryOpt)
+			// Only observe the limit metric if a limit exists
+			if limit := collector.get(goMemoryLimit); limit != math.MaxInt64 {
+				o.ObserveInt64(memoryLimitInstrument, limit)
+			}
+			o.ObserveInt64(memoryAllocatedInstrument, collector.get(goMemoryAllocated))
+			o.ObserveInt64(memoryAllocationsInstrument, collector.get(goMemoryAllocations))
+			o.ObserveInt64(memoryGCGoalInstrument, collector.get(goMemoryGoal))
+			o.ObserveInt64(goroutineCountInstrument, collector.get(goGoroutines))
+			o.ObserveInt64(processorLimitInstrument, collector.get(goMaxProcs))
+			o.ObserveInt64(gogcConfigInstrument, collector.get(goConfigGC))
+			return nil
+		},
+		memoryUsedInstrument,
+		memoryLimitInstrument,
+		memoryAllocatedInstrument,
+		memoryAllocationsInstrument,
+		memoryGCGoalInstrument,
+		goroutineCountInstrument,
+		processorLimitInstrument,
+		gogcConfigInstrument,
+	)
+	if err != nil {
+		return err
+	}
+	// TODO (#5655) support go.schedule.duration
 	return nil
 }
+
+// These are the metrics we actually fetch from the go runtime.
+var runtimeMetrics = []string{
+	goTotalMemory,
+	goMemoryReleased,
+	goHeapMemory,
+	goMemoryLimit,
+	goMemoryAllocated,
+	goMemoryAllocations,
+	goMemoryGoal,
+	goGoroutines,
+	goMaxProcs,
+	goConfigGC,
+}
+
+type goCollector struct {
+	lastCollect     time.Time
+	minimumInterval time.Duration
+	// sampleBuffer is populated by runtime/metrics
+	sampleBuffer []metrics.Sample
+	// sampleMap allows us to easily get the value of a single metric
+	sampleMap map[string]*metrics.Sample
+}
+
+func newCollector(minimumInterval time.Duration) *goCollector {
+	g := &goCollector{
+		sampleBuffer: make([]metrics.Sample, 0, len(runtimeMetrics)),
+		sampleMap:    make(map[string]*metrics.Sample, len(runtimeMetrics)),
+	}
+	for _, runtimeMetric := range runtimeMetrics {
+		g.sampleBuffer = append(g.sampleBuffer, metrics.Sample{Name: runtimeMetric})
+		g.sampleMap[runtimeMetric] = &g.sampleBuffer[len(g.sampleBuffer)-1]
+	}
+	return g
+}
+
+func (g *goCollector) refresh() {
+	now := time.Now()
+	if now.Sub(g.lastCollect) < g.minimumInterval {
+		// refresh was invoked more frequently than allowed by the minimum
+		// interval. Do nothing.
+		return
+	}
+	metrics.Read(g.sampleBuffer)
+	g.lastCollect = now
+}
+
+func (g *goCollector) get(name string) int64 {
+	if s, ok := g.sampleMap[name]; ok {
+		return int64(s.Value.Uint64())
+	}
+	return 0
+}