Provide an option to change the latency metric name. (cloudprober#669)

PiperOrigin-RevId: 401625320
jumpojoy · Oct 7, 2021 · 9b743cb · 9b743cb
1 parent b5860e3
commit 9b743cb
Show file tree

Hide file tree

Showing 11 changed files with 151 additions and 104 deletions.
diff --git a/probes/dns/dns.go b/probes/dns/dns.go
@@ -91,14 +91,15 @@ type probeRunResult struct {
 	latency           metrics.Value
 	timeouts          metrics.Int
 	validationFailure *metrics.Map
+	latencyMetricName string
 }
 
 // Metrics converts probeRunResult into metrics.EventMetrics object
 func (prr probeRunResult) Metrics() *metrics.EventMetrics {
 	return metrics.NewEventMetrics(time.Now()).
 		AddMetric("total", &prr.total).
 		AddMetric("success", &prr.success).
-		AddMetric("latency", prr.latency).
+		AddMetric(prr.latencyMetricName, prr.latency).
 		AddMetric("timeouts", &prr.timeouts).
 		AddMetric("validation_failure", prr.validationFailure)
 }
@@ -217,6 +218,7 @@ func (p *Probe) runProbe(resultsChan chan<- statskeeper.ProbeResult, resolveF re
 
 			result := probeRunResult{
 				target:            target.Name,
+				latencyMetricName: p.opts.LatencyMetricName,
 				validationFailure: validators.ValidationFailureMap(p.opts.Validators),
 			}
 

diff --git a/probes/external/external.go b/probes/external/external.go
@@ -340,7 +340,7 @@ func (p *Probe) defaultMetrics(target string, result *result) *metrics.EventMetr
 	em := metrics.NewEventMetrics(time.Now()).
 		AddMetric("success", metrics.NewInt(result.success)).
 		AddMetric("total", metrics.NewInt(result.total)).
-		AddMetric("latency", result.latency).
+		AddMetric(p.opts.LatencyMetricName, result.latency).
 		AddLabel("ptype", "external").
 		AddLabel("probe", p.name).
 		AddLabel("dst", target)

diff --git a/probes/external/external_test.go b/probes/external/external_test.go
@@ -188,9 +188,10 @@ func createTestProbe(cmd string) *Probe {
 	}
 
 	p.Init("testProbe", &options.Options{
-		ProbeConf:  probeConf,
-		Timeout:    1 * time.Second,
-		LogMetrics: func(em *metrics.EventMetrics) {},
+		ProbeConf:         probeConf,
+		Timeout:           1 * time.Second,
+		LogMetrics:        func(em *metrics.EventMetrics) {},
+		LatencyMetricName: "latency",
 	})
 
 	return p

diff --git a/probes/external/serverutils/serverutils.go b/probes/external/serverutils/serverutils.go
@@ -105,8 +105,7 @@ func WriteMessage(pb proto.Message, w io.Writer) error {
 // make use of it. Example usage:
 //	import (
 //		serverpb "github.com/google/cloudprober/probes/external/proto"
-//    		"github.com/google/cloudprober/probes/external/serverutils"
-//		"google.golang.org/protobuf/proto"
+//		"github.com/google/cloudprober/probes/external/serverutils"
 //	)
 //	func runProbe(opts []*cppb.ProbeRequest_Option) {
 //  	...

diff --git a/probes/grpc/grpc.go b/probes/grpc/grpc.go
@@ -346,7 +346,7 @@ func (p *Probe) Start(ctx context.Context, dataChan chan *metrics.EventMetrics)
 			em := metrics.NewEventMetrics(ts).
 				AddMetric("total", result.total.Clone()).
 				AddMetric("success", result.success.Clone()).
-				AddMetric("latency", result.latency.Clone()).
+				AddMetric(p.opts.LatencyMetricName, result.latency.Clone()).
 				AddMetric("connecterrors", result.connectErrors.Clone()).
 				AddLabel("ptype", "grpc").
 				AddLabel("probe", p.name).

diff --git a/probes/http/http.go b/probes/http/http.go
@@ -381,7 +381,7 @@ func (p *Probe) exportMetrics(ts time.Time, result *probeResult, targetName stri
 	em := metrics.NewEventMetrics(ts).
 		AddMetric("total", metrics.NewInt(result.total)).
 		AddMetric("success", metrics.NewInt(result.success)).
-		AddMetric("latency", result.latency).
+		AddMetric(p.opts.LatencyMetricName, result.latency).
 		AddMetric("timeouts", metrics.NewInt(result.timeouts)).
 		AddMetric("resp-code", result.respCodes).
 		AddLabel("ptype", "http").

diff --git a/probes/options/options.go b/probes/options/options.go
@@ -40,6 +40,7 @@ type Options struct {
 	ProbeConf           interface{} // Probe-type specific config
 	LatencyDist         *metrics.Distribution
 	LatencyUnit         time.Duration
+	LatencyMetricName   string
 	Validators          []*validators.Validator
 	SourceIP            net.IP
 	IPVersion           int
@@ -113,9 +114,10 @@ func getSourceIPFromConfig(p *configpb.ProbeDef, l *logger.Logger) (net.IP, erro
 // global params.
 func BuildProbeOptions(p *configpb.ProbeDef, ldLister endpoint.Lister, globalTargetsOpts *targetspb.GlobalTargetsOptions, l *logger.Logger) (*Options, error) {
 	opts := &Options{
-		Interval:  time.Duration(p.GetIntervalMsec()) * time.Millisecond,
-		Timeout:   time.Duration(p.GetTimeoutMsec()) * time.Millisecond,
-		IPVersion: ipv(p.IpVersion),
+		Interval:          time.Duration(p.GetIntervalMsec()) * time.Millisecond,
+		Timeout:           time.Duration(p.GetTimeoutMsec()) * time.Millisecond,
+		IPVersion:         ipv(p.IpVersion),
+		LatencyMetricName: p.GetLatencyMetricName(),
 	}
 
 	var err error

diff --git a/probes/ping/ping.go b/probes/ping/ping.go
@@ -476,7 +476,7 @@ func (p *Probe) Start(ctx context.Context, dataChan chan *metrics.EventMetrics)
 			em := metrics.NewEventMetrics(ts).
 				AddMetric("total", metrics.NewInt(result.sent)).
 				AddMetric("success", metrics.NewInt(result.rcvd)).
-				AddMetric("latency", result.latency).
+				AddMetric(p.opts.LatencyMetricName, result.latency).
 				AddLabel("ptype", "ping").
 				AddLabel("probe", p.name).
 				AddLabel("dst", target.Name)