docstring

DataDog · Nov 22, 2023 · bf829b8 · bf829b8
1 parent dfdefb3
commit bf829b8
Show file tree

Hide file tree

Showing 3 changed files with 5 additions and 3 deletions.
diff --git a/pkg/collector/corechecks/oracle-dbm/oracle.go b/pkg/collector/corechecks/oracle-dbm/oracle.go
@@ -197,7 +197,7 @@ func (c *Check) Run() error {
 
 		if c.config.SysMetrics.Enabled {
 			log.Debugf("%s Entered sysmetrics", c.logPrompt)
-			_, err := c.SysMetrics()
+			_, err := c.sysMetrics()
 			if err != nil {
 				return fmt.Errorf("%s failed to collect sysmetrics %w", c.logPrompt, err)
 			}

diff --git a/pkg/collector/corechecks/oracle-dbm/sysmetrics.go b/pkg/collector/corechecks/oracle-dbm/sysmetrics.go
@@ -130,7 +130,9 @@ func (c *Check) sendMetric(s sender.Sender, r SysmetricsRowDB, seen map[string]b
 	}
 }
 
-func (c *Check) SysMetrics() (int64, error) {
+// sysMetrics emits sysmetrics metrics
+// It returns the number of metrics emitted and any errors encountered.
+func (c *Check) sysMetrics() (int64, error) {
 	var n int64
 	sender, err := c.GetSender()
 	if err != nil {

diff --git a/pkg/collector/corechecks/oracle-dbm/sysmetrics_test.go b/pkg/collector/corechecks/oracle-dbm/sysmetrics_test.go
@@ -14,7 +14,7 @@ import (
 )
 
 func TestSysmetrics(t *testing.T) {
-	n, err := chk.SysMetrics()
+	n, err := chk.sysMetrics()
 	assert.NoError(t, err, "failed to run sys metrics")
 	assert.Equal(t, int64(92), n)
 }