feat: deprecate SetupMetrics and migrate to SetupMetricsOptions (#258)

## What does this PR do?

instead of breasking the method signature move to arg options

## Why is it important?

to account for consumers and older branches

## Checklist

<!-- Mandatory
Add a checklist of things that are required to be reviewed in order to
have the PR approved

List here all the items you have verified BEFORE sending this PR. Please
DO NOT remove any item, striking through those that do not apply. (Just
in case, strikethrough uses two tildes. ~~Scratch this.~~)
-->

- [ ] My code follows the style guidelines of this project
- [ ] I have commented my code, particularly in hard-to-understand areas
- [ ] I have added tests that prove my fix is effective or that my
feature works
- [ ] I have added an entry in `CHANGELOG.md`

## Author's Checklist

<!-- Recommended
Add a checklist of things that are required to be reviewed in order to
have the PR approved
-->
- [ ]

## Related issues

<!-- Recommended
Link related issues below. Insert the issue link or reference after the
word "Closes" if merging this should automatically close it.

- Closes #123
- Relates #123
- Requires #123
- Superseds #123
-->
-

---------

Co-authored-by: Khushi Jain <[email protected]>
Co-authored-by: Vihas Makwana <[email protected]>

Author: 3 people

go.mod

@@ -10,6 +10,7 @@ require (
 	github.com/elastic/go-sysinfo v1.14.1
 	github.com/elastic/go-windows v1.0.1
 	github.com/elastic/gosigar v0.14.2
+	github.com/gofrs/uuid/v5 v5.2.0
 	github.com/magefile/mage v1.15.0
 	github.com/shirou/gopsutil/v4 v4.24.7
 	github.com/stretchr/testify v1.9.0

go.sum

@@ -46,6 +46,8 @@ github.com/go-ole/go-ole v1.2.6 h1:/Fpf6oFPoeFik9ty7siob0G6Ke8QvQEuVcuChpwXzpY=
 github.com/go-ole/go-ole v1.2.6/go.mod h1:pprOEPIfldk/42T2oK7lQ4v4JSDwmV0As9GaiUsvbm0=
 github.com/gobuffalo/here v0.6.0 h1:hYrd0a6gDmWxBM4TnrGw8mQg24iSVoIkHEk7FodQcBI=
 github.com/gobuffalo/here v0.6.0/go.mod h1:wAG085dHOYqUpf+Ap+WOdrPTp5IYcDAs/x7PLa8Y5fM=
+github.com/gofrs/uuid/v5 v5.2.0 h1:qw1GMx6/y8vhVsx626ImfKMuS5CvJmhIKKtuyvfajMM=
+github.com/gofrs/uuid/v5 v5.2.0/go.mod h1:CDOjlDMVAtN56jqyRUZh58JT31Tiw7/oQyEXZV+9bD8=
 github.com/gogo/protobuf v1.3.2 h1:Ov1cvc58UF3b5XjBnZv7+opcTcQFZebYjWzi34vdm4Q=
 github.com/gogo/protobuf v1.3.2/go.mod h1:P1XiOD3dCwIKUDQYPy72D8LYyHL2YPYrpS2s69NZV8Q=
 github.com/google/go-cmp v0.2.0/go.mod h1:oXzfMopK8JAjlY9xF4vHSVASa0yLyX7SntLO5aqRK0M=

report/metrics_common.go

@@ -19,12 +19,25 @@ package report
 
 import (
 	"time"
+
+	"github.com/gofrs/uuid/v5"
 )
 
 var (
-	startTime time.Time
+	ephemeralID uuid.UUID
+	startTime   time.Time
 )
 
 func init() {
 	startTime = time.Now()
+
+	ephemeralID, _ = uuid.NewV4()
+}
+
+// EphemeralID returns generated EphemeralID
+//
+// Deprecated: generate your own EphemeralID
+func EphemeralID() uuid.UUID {
+	return ephemeralID
+
 }

report/metrics_report_test.go

@@ -32,7 +32,14 @@ import (
 func TestSystemMetricsReport(t *testing.T) {
 	systemMetrics := monitoring.NewRegistry()
 	processMetrics := monitoring.NewRegistry()
-	err := SetupMetrics(logptest.NewTestingLogger(t, ""), "TestSys", "test", "", systemMetrics, processMetrics)
+	err := SetupMetricsOptions(MetricOptions{
+		Name:           t.Name(),
+		Version:        "test",
+		EphemeralID:    "",
+		SystemMetrics:  systemMetrics,
+		ProcessMetrics: processMetrics,
+		Logger:         logptest.NewTestingLogger(t, ""),
+	})
 	require.NoError(t, err)
 
 	var gotCPU, gotMem, gotInfo atomic.Bool

report/setup.go

@@ -40,30 +40,44 @@ var (
 const monitoringCgroupsHierarchyOverride = "LIBBEAT_MONITORING_CGROUPS_HIERARCHY_OVERRIDE"
 
 // SetupMetrics creates a basic suite of metrics handlers for monitoring, including build info and system resources
-func SetupMetrics(logger *logp.Logger, name, version, ephemeralID string, systemMetrics *monitoring.Registry, processMetrics *monitoring.Registry) error {
-	monitoring.NewFunc(systemMetrics, "cpu", ReportSystemCPUUsage, monitoring.Report)
+//
+// Deprecated: use SetupMetricsOptions
+func SetupMetrics(logger *logp.Logger, name, version string) error {
+	return SetupMetricsOptions(MetricOptions{
+		Name:           name,
+		Version:        version,
+		EphemeralID:    ephemeralID.String(),
+		Logger:         logger,
+		SystemMetrics:  monitoring.Default.GetOrCreateRegistry("system"),
+		ProcessMetrics: monitoring.Default.GetOrCreateRegistry("beat"),
+	})
+}
+
+// SetupMetricsOptions performs creation of metrics handlers using specified options.
+func SetupMetricsOptions(opts MetricOptions) error {
+	monitoring.NewFunc(opts.SystemMetrics, "cpu", ReportSystemCPUUsage, monitoring.Report)
 
-	name = processName(name)
+	opts.Name = processName(opts.Name)
 	processStats = &process.Stats{
-		Procs:        []string{name},
+		Procs:        []string{opts.Name},
 		EnvWhitelist: nil,
 		CPUTicks:     true,
 		CacheCmdLine: true,
 		IncludeTop:   process.IncludeTopConfig{},
-		Logger:       logger,
+		Logger:       opts.Logger,
 	}
 
 	err := processStats.Init()
 	if err != nil {
 		return fmt.Errorf("failed to init process stats for agent: %w", err)
 	}
 
-	monitoring.NewFunc(processMetrics, "memstats", MemStatsReporter(logger, processStats), monitoring.Report)
-	monitoring.NewFunc(processMetrics, "cpu", InstanceCPUReporter(logger, processStats), monitoring.Report)
-	monitoring.NewFunc(processMetrics, "runtime", ReportRuntime, monitoring.Report)
-	monitoring.NewFunc(processMetrics, "info", infoReporter(name, version, ephemeralID), monitoring.Report)
+	monitoring.NewFunc(opts.ProcessMetrics, "memstats", MemStatsReporter(opts.Logger, processStats), monitoring.Report)
+	monitoring.NewFunc(opts.ProcessMetrics, "cpu", InstanceCPUReporter(opts.Logger, processStats), monitoring.Report)
+	monitoring.NewFunc(opts.ProcessMetrics, "runtime", ReportRuntime, monitoring.Report)
+	monitoring.NewFunc(opts.ProcessMetrics, "info", infoReporter(opts.Name, opts.Version, opts.EphemeralID), monitoring.Report)
 
-	setupPlatformSpecificMetrics(logger, processStats, systemMetrics, processMetrics)
+	setupPlatformSpecificMetrics(opts.Logger, processStats, opts.SystemMetrics, opts.ProcessMetrics)
 
 	return nil
 }

report/setup_common.go

@@ -0,0 +1,32 @@
+// Licensed to Elasticsearch B.V. under one or more contributor
+// license agreements. See the NOTICE file distributed with
+// this work for additional information regarding copyright
+// ownership. Elasticsearch B.V. licenses this file to you under
+// the Apache License, Version 2.0 (the "License"); you may
+// not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing,
+// software distributed under the License is distributed on an
+// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+// KIND, either express or implied.  See the License for the
+// specific language governing permissions and limitations
+// under the License.
+
+package report
+
+import (
+	"github.com/elastic/elastic-agent-libs/logp"
+	"github.com/elastic/elastic-agent-libs/monitoring"
+)
+
+type MetricOptions struct {
+	Name           string
+	Version        string
+	EphemeralID    string
+	Logger         *logp.Logger
+	SystemMetrics  *monitoring.Registry
+	ProcessMetrics *monitoring.Registry
+}

report/setup_other.go

@@ -23,12 +23,7 @@
 
 package report
 
-import (
-	"github.com/elastic/elastic-agent-libs/logp"
-	"github.com/elastic/elastic-agent-libs/monitoring"
-)
-
-func SetupMetrics(logger *logp.Logger, name, version, ephemeralID string, systemMetrics *monitoring.Registry, processMetrics *monitoring.Registry) error {
-	logger.Warn("Metrics not implemented for this OS.")
+func SetupMetricsOptions(opts MetricOptions) error {
+	opts.Logger.Warn("Metrics not implemented for this OS.")
 	return nil
 }