mirror of
https://github.com/prometheus/prometheus.git
synced 2024-09-19 23:37:31 -07:00
0f760f63dd
Several things done here: - Set `max-issues-per-linter` to 0 so that we actually see all linter warnings and not just 50 per linter. (As we also set `max-same-issues` to 0, I assume this was the intention from the beginning.) - Stop using the golangci-lint default excludes (by setting `exclude-use-default: false`. Those are too generous and don't match our style conventions. (I have re-added some of the excludes explicitly in this commit. See below.) - Re-add the `errcheck` exclusion we have used so far via the defaults. - Exclude the signature requirement `govet` has for `Seek` methods because we use non-standard `Seek` methods a lot. (But we keep other requirements, while the default excludes completely disabled the check for common method segnatures.) - Exclude warnings about missing doc comments on exported symbols. (We used to be pretty adamant about doc comments, but stopped that at some point in the past. By now, we have about 500 missing doc comments. We may consider reintroducing this check, but that's outside of the scope of this commit. The default excludes of golangci-lint essentially ignore doc comments completely.) - By stop using the default excludes, we now get warnings back on malformed doc comments. That's the most impactful change in this commit. It does not enforce doc comments (again), but _if_ there is a doc comment, it has to have the recommended form. (Most of the changes in this commit are fixing this form.) - Improve wording/spelling of some comments in .golangci.yml, and remove an outdated comment. - Leave `package-comments` inactive, but add a TODO asking if we should change that. - Add a new sub-linter `comment-spacings` (and fix corresponding comments), which avoids missing spaces after the leading `//`. Signed-off-by: beorn7 <beorn@grafana.com>
76 lines
2.4 KiB
Go
76 lines
2.4 KiB
Go
// Copyright 2015 The Prometheus Authors
|
|
// Licensed 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 discovery
|
|
|
|
import (
|
|
"github.com/prometheus/client_golang/prometheus"
|
|
)
|
|
|
|
// RefreshMetricsVecs are metric vectors for the "refresh" package.
|
|
// We define them here in the "discovery" package in order to avoid a cyclic dependency between
|
|
// "discovery" and "refresh".
|
|
type RefreshMetricsVecs struct {
|
|
failuresVec *prometheus.CounterVec
|
|
durationVec *prometheus.SummaryVec
|
|
|
|
metricRegisterer MetricRegisterer
|
|
}
|
|
|
|
var _ RefreshMetricsManager = (*RefreshMetricsVecs)(nil)
|
|
|
|
func NewRefreshMetrics(reg prometheus.Registerer) RefreshMetricsManager {
|
|
m := &RefreshMetricsVecs{
|
|
failuresVec: prometheus.NewCounterVec(
|
|
prometheus.CounterOpts{
|
|
Name: "prometheus_sd_refresh_failures_total",
|
|
Help: "Number of refresh failures for the given SD mechanism.",
|
|
},
|
|
[]string{"mechanism"}),
|
|
durationVec: prometheus.NewSummaryVec(
|
|
prometheus.SummaryOpts{
|
|
Name: "prometheus_sd_refresh_duration_seconds",
|
|
Help: "The duration of a refresh in seconds for the given SD mechanism.",
|
|
Objectives: map[float64]float64{0.5: 0.05, 0.9: 0.01, 0.99: 0.001},
|
|
},
|
|
[]string{"mechanism"}),
|
|
}
|
|
|
|
// The reason we register metric vectors instead of metrics is so that
|
|
// the metrics are not visible until they are recorded.
|
|
m.metricRegisterer = NewMetricRegisterer(reg, []prometheus.Collector{
|
|
m.failuresVec,
|
|
m.durationVec,
|
|
})
|
|
|
|
return m
|
|
}
|
|
|
|
// Instantiate returns metrics out of metric vectors.
|
|
func (m *RefreshMetricsVecs) Instantiate(mech string) *RefreshMetrics {
|
|
return &RefreshMetrics{
|
|
Failures: m.failuresVec.WithLabelValues(mech),
|
|
Duration: m.durationVec.WithLabelValues(mech),
|
|
}
|
|
}
|
|
|
|
// Register implements discovery.DiscovererMetrics.
|
|
func (m *RefreshMetricsVecs) Register() error {
|
|
return m.metricRegisterer.RegisterMetrics()
|
|
}
|
|
|
|
// Unregister implements discovery.DiscovererMetrics.
|
|
func (m *RefreshMetricsVecs) Unregister() {
|
|
m.metricRegisterer.UnregisterMetrics()
|
|
}
|