Fix the irregular and typo on prometheus module. (#25726) (#26488)

(cherry picked from commit 4c43996) Co-authored-by: Shoothzj <[email protected]>
elastic · Jun 24, 2021 · 40d7062 · 40d7062
1 parent 74e273a
commit 40d7062
Show file tree

Hide file tree

Showing 4 changed files with 5 additions and 5 deletions.
diff --git a/metricbeat/module/prometheus/collector/collector.go b/metricbeat/module/prometheus/collector/collector.go
@@ -62,14 +62,14 @@ type PromEventsGenerator interface {
 	// Start must be called before using the generator
 	Start()
 
-	// converts a Prometheus metric family into a list of PromEvents
+	// GeneratePromEvents converts a Prometheus metric family into a list of PromEvents
 	GeneratePromEvents(mf *dto.MetricFamily) []PromEvent
 
 	// Stop must be called when the generator won't be used anymore
 	Stop()
 }
 
-// PromEventsGeneratorFactory creates a PromEventsGenerator when instanciating a metricset
+// PromEventsGeneratorFactory creates a PromEventsGenerator when instantiating a MetricSet
 type PromEventsGeneratorFactory func(ms mb.BaseMetricSet) (PromEventsGenerator, error)
 
 // MetricSet for fetching prometheus data

diff --git a/metricbeat/module/prometheus/collector/data.go b/metricbeat/module/prometheus/collector/data.go
@@ -49,7 +49,7 @@ type promEventGenerator struct{}
 func (p *promEventGenerator) Start() {}
 func (p *promEventGenerator) Stop()  {}
 
-// DefaultPromEventsGenerator stores all Prometheus metrics using
+// GeneratePromEvents DefaultPromEventsGenerator stores all Prometheus metrics using
 // only double field type in Elasticsearch.
 func (p *promEventGenerator) GeneratePromEvents(mf *dto.MetricFamily) []PromEvent {
 	var events []PromEvent

diff --git a/metricbeat/module/prometheus/query/data.go b/metricbeat/module/prometheus/query/data.go
@@ -69,7 +69,7 @@ type instantVectorResult struct {
 	Vector []interface{}     `json:"value"`
 }
 
-// InstantVectorResponse is for "vector" type from Prometheus Query API Request
+// RangeVectorResponse is for "vector" type from Prometheus Query API Request
 // rangeVectorResult format:
 // [
 //  {

diff --git a/metricbeat/module/prometheus/remote_write/remote_write.go b/metricbeat/module/prometheus/remote_write/remote_write.go
@@ -44,7 +44,7 @@ type RemoteWriteEventsGenerator interface {
 	// Start must be called before using the generator
 	Start()
 
-	// converts Prometheus Samples to a map of mb.Event
+	// GenerateEvents converts Prometheus Samples to a map of mb.Event
 	GenerateEvents(metrics model.Samples) map[string]mb.Event
 
 	// Stop must be called when the generator won't be used anymore