Remove usage of internal for resourcetuner.go

Author: yuandrew

contrib/resourcetuner/resourcetuner.go

@@ -3,18 +3,24 @@ package resourcetuner
 import (
 	"context"
 	"errors"
-	"go.temporal.io/sdk/internal/common/metrics"
 	"runtime"
 	"sync"
 	"time"
 
 	"github.com/shirou/gopsutil/v4/cpu"
 	"github.com/shirou/gopsutil/v4/mem"
 	"go.einride.tech/pid"
+	"go.temporal.io/sdk/client"
 	"go.temporal.io/sdk/log"
 	"go.temporal.io/sdk/worker"
 )
 
+// Metric names emitted by the resource-based tuner
+const (
+	ResourceSlotsCPUUsage = "temporal_resource_slots_cpu_usage"
+	ResourceSlotsMemUsage = "temporal_resource_slots_mem_usage"
+)
+
 type ResourceBasedTunerOptions struct {
 	// TargetMem is the target overall system memory usage as value 0 and 1 that the controller will
 	// attempt to maintain. Must be set nonzero.
@@ -277,7 +283,7 @@ func NewResourceController(options ResourceControllerOptions) *ResourceControlle
 	}
 }
 
-func (rc *ResourceController) pidDecision(logger log.Logger, metricsHandler metrics.Handler) (bool, error) {
+func (rc *ResourceController) pidDecision(logger log.Logger, metricsHandler client.MetricsHandler) (bool, error) {
 	rc.mu.Lock()
 	defer rc.mu.Unlock()
 
@@ -316,12 +322,12 @@ func (rc *ResourceController) pidDecision(logger log.Logger, metricsHandler metr
 		rc.cpuPid.State.ControlSignal > rc.options.CpuOutputThreshold, nil
 }
 
-func (rc *ResourceController) publishResourceMetrics(metricsHandler metrics.Handler, memUsage, cpuUsage float64) {
+func (rc *ResourceController) publishResourceMetrics(metricsHandler client.MetricsHandler, memUsage, cpuUsage float64) {
 	if metricsHandler == nil {
 		return
 	}
-	metricsHandler.Gauge(metrics.ResourceSlotsMemUsage).Update(memUsage * 100)
-	metricsHandler.Gauge(metrics.ResourceSlotsCPUUsage).Update(cpuUsage * 100)
+	metricsHandler.Gauge(ResourceSlotsMemUsage).Update(memUsage * 100)
+	metricsHandler.Gauge(ResourceSlotsCPUUsage).Update(cpuUsage * 100)
 }
 
 type psUtilSystemInfoSupplier struct {

contrib/resourcetuner/resourcetuner_test.go

@@ -1,11 +1,12 @@
 package resourcetuner
 
 import (
-	"go.temporal.io/sdk/internal/common/metrics"
 	"testing"
 
 	"github.com/stretchr/testify/assert"
-	"go.temporal.io/sdk/internal/log"
+	"go.temporal.io/sdk/client"
+	"go.temporal.io/sdk/internal/common/metrics"
+	"go.temporal.io/sdk/log"
 )
 
 type FakeSystemInfoSupplier struct {
@@ -22,8 +23,8 @@ func (f FakeSystemInfoSupplier) GetCpuUsage(_ *SystemInfoContext) (float64, erro
 }
 
 func TestPidDecisions(t *testing.T) {
-	logger := &log.NoopLogger{}
-	metricsHandler := metrics.NopHandler
+	logger := log.NewNopLogger()
+	metricsHandler := client.MetricsNopHandler
 	fakeSupplier := &FakeSystemInfoSupplier{memUse: 0.5, cpuUse: 0.5}
 	rcOpts := DefaultResourceControllerOptions()
 	rcOpts.MemTargetPercent = 0.8
@@ -66,7 +67,7 @@ func TestPidDecisions(t *testing.T) {
 }
 
 func TestPidDecisionEmitsUsageMetrics(t *testing.T) {
-	logger := &log.NoopLogger{}
+	logger := log.NewNopLogger()
 	metricsHandler := metrics.NewCapturingHandler()
 	fakeSupplier := &FakeSystemInfoSupplier{memUse: 0.25, cpuUse: 0.75}
 
@@ -85,8 +86,8 @@ func TestPidDecisionEmitsUsageMetrics(t *testing.T) {
 		gaugesByName[gauge.Name] = gauge.Value()
 	}
 
-	assert.Equal(t, 25.0, gaugesByName[metrics.ResourceSlotsMemUsage])
-	assert.Equal(t, 75.0, gaugesByName[metrics.ResourceSlotsCPUUsage])
+	assert.Equal(t, 25.0, gaugesByName[ResourceSlotsMemUsage])
+	assert.Equal(t, 75.0, gaugesByName[ResourceSlotsCPUUsage])
 
 	fakeSupplier.memUse = 0.7
 	fakeSupplier.cpuUse = 0.9
@@ -101,6 +102,6 @@ func TestPidDecisionEmitsUsageMetrics(t *testing.T) {
 		gaugesByName[gauge.Name] = gauge.Value()
 	}
 
-	assert.Equal(t, 70.0, gaugesByName[metrics.ResourceSlotsMemUsage])
-	assert.Equal(t, 90.0, gaugesByName[metrics.ResourceSlotsCPUUsage])
+	assert.Equal(t, 70.0, gaugesByName[ResourceSlotsMemUsage])
+	assert.Equal(t, 90.0, gaugesByName[ResourceSlotsCPUUsage])
 }

internal/common/metrics/constants.go

@@ -40,8 +40,6 @@ const (
 	WorkerStartCounter       = TemporalMetricsPrefix + "worker_start"
 	WorkerTaskSlotsAvailable = TemporalMetricsPrefix + "worker_task_slots_available"
 	WorkerTaskSlotsUsed      = TemporalMetricsPrefix + "worker_task_slots_used"
-	ResourceSlotsCPUUsage    = TemporalMetricsPrefix + "resource_slots_cpu_usage"
-	ResourceSlotsMemUsage    = TemporalMetricsPrefix + "resource_slots_mem_usage"
 	PollerStartCounter       = TemporalMetricsPrefix + "poller_start"
 	NumPoller                = TemporalMetricsPrefix + "num_pollers"
 

log/noop.go

@@ -0,0 +1,16 @@
+package log
+
+// NewNopLogger creates a Logger implementation that discards all log messages.
+// This is useful for testing or when logging is not desired.
+func NewNopLogger() Logger {
+	return nopLogger{}
+}
+
+type nopLogger struct{}
+
+func (nopLogger) Debug(string, ...interface{}) {}
+func (nopLogger) Info(string, ...interface{})  {}
+func (nopLogger) Warn(string, ...interface{})  {}
+func (nopLogger) Error(string, ...interface{}) {}
+func (nopLogger) With(...interface{}) Logger   { return nopLogger{} }
+func (nopLogger) WithCallerSkip(int) Logger    { return nopLogger{} }