3pp-mirror/pomerium
1
0
Fork 0
mirror of https://github.com/pomerium/pomerium.git synced 2025-06-06 21:04:39 +02:00
Code Issues Projects Releases Packages Wiki Activity

Fix checksum integer overflow in metrics

Browse source
This commit is contained in:
Travis Groth 2019-07-22 18:09:37 -04:00
parent 29eee409ef
commit 087f8fe84f
4 changed files with 23 additions and 13 deletions
Download patch file Download diff file Expand all files Collapse all files

8
cmd/pomerium/main.go
View file

@ -213,11 +213,13 @@ func parseOptions(configFile string) (*config.Options, error) {
metrics.AddPolicyCountCallback(o.Services, func() int64 { metrics.AddPolicyCountCallback(o.Services, func() int64 {
return int64(len(o.Policies)) return int64(len(o.Policies))
}) })
checksumInt, err := strconv.ParseInt(fmt.Sprintf("0x%s", o.Checksum()), 0, 64)
checksumDec, err := strconv.ParseUint(o.Checksum(), 16, 64)
if err != nil { if err != nil {
log.Warn().Err(err).Msg("Could not parse config checksum into integer") log.Warn().Err(err).Msg("Could not parse config checksum into decimal")
} }
metrics.SetConfigChecksum(o.Services, checksumInt) metrics.SetConfigChecksum(o.Services, checksumDec)
return o, nil return o, nil
} }

10
internal/metrics/helpers_test.go
View file

@ -36,7 +36,15 @@ func testDataRetrieval(v *view.View, t *testing.T, want string) {
} }
} }
func testMetricRetrieval(metrics []*metricdata.Metric, t *testing.T, labels []metricdata.LabelValue, value int64, name string) { func testMetricRetrieval(metrics []*metricdata.Metric, t *testing.T, labels []metricdata.LabelValue, value interface{}, name string) {
switch value.(type) {
case int64:
case float64:
case uint64:
default:
t.Errorf("Got an unexpected type for value: %T", value)
}
found := false found := false
for _, metric := range metrics { for _, metric := range metrics {
if metric.Descriptor.Name != name { if metric.Descriptor.Name != name {

12
internal/metrics/info.go
View file

@ -76,7 +76,7 @@ type metricRegistry struct {
registry *metric.Registry registry *metric.Registry
buildInfo *metric.Int64Gauge buildInfo *metric.Int64Gauge
policyCount *metric.Int64DerivedGauge policyCount *metric.Int64DerivedGauge
configChecksum *metric.Int64Gauge configChecksum *metric.Float64Gauge
sync.Once sync.Once
} }
@ -99,8 +99,8 @@ func (r *metricRegistry) init() {
log.Error().Err(err).Msg("internal/metrics: failed to register build info metric") log.Error().Err(err).Msg("internal/metrics: failed to register build info metric")
} }
r.configChecksum, err = r.registry.AddInt64Gauge("config_checksum_int64", r.configChecksum, err = r.registry.AddFloat64Gauge("config_checksum_decimal",
metric.WithDescription("Config checksum represented in int64 notation"), metric.WithDescription("Config checksum represented in decimal notation"),
metric.WithLabelKeys("service"), metric.WithLabelKeys("service"),
) )
if err != nil { if err != nil {
@ -149,7 +149,7 @@ func RegisterInfoMetrics() {
metricproducer.GlobalManager().AddProducer(registry.registry) metricproducer.GlobalManager().AddProducer(registry.registry)
} }
func (r *metricRegistry) setConfigChecksum(service string, checksum int64) { func (r *metricRegistry) setConfigChecksum(service string, checksum uint64) {
if r.configChecksum == nil { if r.configChecksum == nil {
return return
} }
@ -157,12 +157,12 @@ func (r *metricRegistry) setConfigChecksum(service string, checksum int64) {
if err != nil { if err != nil {
log.Error().Err(err).Msg("internal/metrics: failed to get config checksum metric") log.Error().Err(err).Msg("internal/metrics: failed to get config checksum metric")
} }
m.Set(checksum) m.Set(float64(checksum))
} }
// SetConfigChecksum creates the configuration checksum metric. You must call RegisterInfoMetrics to // SetConfigChecksum creates the configuration checksum metric. You must call RegisterInfoMetrics to
// have this exported // have this exported
func SetConfigChecksum(service string, checksum int64) { func SetConfigChecksum(service string, checksum uint64) {
registry.setConfigChecksum(service, checksum) registry.setConfigChecksum(service, checksum)
} }

6
internal/metrics/info_test.go
View file

@ -49,7 +49,7 @@ func Test_SetBuildInfo(t *testing.T) {
} }
SetBuildInfo("test_service") SetBuildInfo("test_service")
testMetricRetrieval(registry.registry.Read(), t, wantLabels, 1, "build_info") testMetricRetrieval(registry.registry.Read(), t, wantLabels, int64(1), "build_info")
} }
func Test_AddPolicyCountCallback(t *testing.T) { func Test_AddPolicyCountCallback(t *testing.T) {
@ -65,11 +65,11 @@ func Test_AddPolicyCountCallback(t *testing.T) {
func Test_SetConfigChecksum(t *testing.T) { func Test_SetConfigChecksum(t *testing.T) {
registry = newMetricRegistry() registry = newMetricRegistry()
wantValue := int64(42) wantValue := uint64(42)
wantLabels := []metricdata.LabelValue{{Value: "test_service", Present: true}} wantLabels := []metricdata.LabelValue{{Value: "test_service", Present: true}}
SetConfigChecksum("test_service", wantValue) SetConfigChecksum("test_service", wantValue)
testMetricRetrieval(registry.registry.Read(), t, wantLabels, wantValue, "config_checksum_int64") testMetricRetrieval(registry.registry.Read(), t, wantLabels, float64(wantValue), "config_checksum_decimal")
} }
func Test_RegisterInfoMetrics(t *testing.T) { func Test_RegisterInfoMetrics(t *testing.T) {