Skip to content

Commit

Permalink
metrics: fix docstring names (ethereum#28923)
Browse files Browse the repository at this point in the history
  • Loading branch information
gzliudan authored and JukLee0ira committed Dec 22, 2024
1 parent ccfab15 commit b131c6e
Show file tree
Hide file tree
Showing 8 changed files with 10 additions and 10 deletions.
2 changes: 1 addition & 1 deletion metrics/counter.go
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ type CounterSnapshot interface {
Count() int64
}

// Counters hold an int64 value that can be incremented and decremented.
// Counter hold an int64 value that can be incremented and decremented.
type Counter interface {
Clear()
Dec(int64)
Expand Down
4 changes: 2 additions & 2 deletions metrics/gauge.go
Original file line number Diff line number Diff line change
Expand Up @@ -2,12 +2,12 @@ package metrics

import "sync/atomic"

// gaugeSnapshot contains a readonly int64.
// GaugeSnapshot contains a readonly int64.
type GaugeSnapshot interface {
Value() int64
}

// Gauges hold an int64 value that can be set arbitrarily.
// Gauge holds an int64 value that can be set arbitrarily.
type Gauge interface {
Snapshot() GaugeSnapshot
Update(int64)
Expand Down
2 changes: 1 addition & 1 deletion metrics/gauge_float64.go
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@ type gaugeFloat64Snapshot float64
// Value returns the value at the time the snapshot was taken.
func (g gaugeFloat64Snapshot) Value() float64 { return float64(g) }

// NilGauge is a no-op Gauge.
// NilGaugeFloat64 is a no-op Gauge.
type NilGaugeFloat64 struct{}

func (NilGaugeFloat64) Snapshot() GaugeFloat64Snapshot { return NilGaugeFloat64{} }
Expand Down
2 changes: 1 addition & 1 deletion metrics/gauge_info.go
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ type GaugeInfoSnapshot interface {
Value() GaugeInfoValue
}

// GaugeInfos hold a GaugeInfoValue value that can be set arbitrarily.
// GaugeInfo holds a GaugeInfoValue value that can be set arbitrarily.
type GaugeInfo interface {
Update(GaugeInfoValue)
Snapshot() GaugeInfoSnapshot
Expand Down
2 changes: 1 addition & 1 deletion metrics/healthcheck.go
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
package metrics

// Healthchecks hold an error value describing an arbitrary up/down status.
// Healthcheck holds an error value describing an arbitrary up/down status.
type Healthcheck interface {
Check()
Error() error
Expand Down
2 changes: 1 addition & 1 deletion metrics/histogram.go
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ type HistogramSnapshot interface {
SampleSnapshot
}

// Histograms calculate distribution statistics from a series of int64 values.
// Histogram calculates distribution statistics from a series of int64 values.
type Histogram interface {
Clear()
Update(int64)
Expand Down
2 changes: 1 addition & 1 deletion metrics/influxdb/influxdbv2.go
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ type v2Reporter struct {
write api.WriteAPI
}

// InfluxDBWithTags starts a InfluxDB reporter which will post the from the given metrics.Registry at each d interval with the specified tags
// InfluxDBV2WithTags starts a InfluxDB reporter which will post the from the given metrics.Registry at each d interval with the specified tags
func InfluxDBV2WithTags(r metrics.Registry, d time.Duration, endpoint string, token string, bucket string, organization string, namespace string, tags map[string]string) {
rep := &v2Reporter{
reg: r,
Expand Down
4 changes: 2 additions & 2 deletions metrics/sample.go
Original file line number Diff line number Diff line change
Expand Up @@ -148,13 +148,13 @@ func (NilSample) Clear() {}
func (NilSample) Snapshot() SampleSnapshot { return (*emptySnapshot)(nil) }
func (NilSample) Update(v int64) {}

// SamplePercentiles returns an arbitrary percentile of the slice of int64.
// SamplePercentile returns an arbitrary percentile of the slice of int64.
func SamplePercentile(values []int64, p float64) float64 {
return CalculatePercentiles(values, []float64{p})[0]
}

// CalculatePercentiles returns a slice of arbitrary percentiles of the slice of
// int64. This method returns interpolated results, so e.g if there are only two
// int64. This method returns interpolated results, so e.g. if there are only two
// values, [0, 10], a 50% percentile will land between them.
//
// Note: As a side-effect, this method will also sort the slice of values.
Expand Down

0 comments on commit b131c6e

Please sign in to comment.