Merge pull request #23 from prometheus/feature/summary/subtleties

Refresh of Histogram/Summary Behavior to Reflect Modern Expectations
This commit is contained in:
juliusv 2013-07-22 01:47:48 -07:00
commit 98fc5b23c1
9 changed files with 109 additions and 52 deletions

1
.gitignore vendored
View File

@ -23,3 +23,4 @@ _testmain.go
*~
*#
.build

View File

@ -4,4 +4,4 @@ go:
- 1.1
script:
- make -f Makefile.TRAVIS
- make -f Makefile

View File

@ -11,14 +11,53 @@
# See the License for the specific language governing permissions and
# limitations under the License.
MAKE_ARTIFACTS = search_index
OS = $(shell uname)
ARCH = $(shell uname -m)
BUILD_PATH = $(PWD)/.build
export GO_VERSION = 1.1
export GOOS = $(subst Darwin,darwin,$(subst Linux,linux,$(OS)))
export GOARCH = $(subst x86_64,amd64,$(ARCH))
export GOPKG = go$(GO_VERSION).$(GOOS)-$(GOARCH).tar.gz
export GOROOT = $(BUILD_PATH)/root/go
export GOPATH = $(BUILD_PATH)/root/gopath
export GOCC = $(GOROOT)/bin/go
export TMPDIR = /tmp
export GOENV = TMPDIR=$(TMPDIR) GOROOT=$(GOROOT) GOPATH=$(GOPATH)
export GO = $(GOENV) $(GOCC)
export GOFMT = $(GOROOT)/bin/gofmt
FULL_GOPATH = $(GOPATH)/src/github.com/prometheus/client_golang
FULL_GOPATH_BASE = $(GOPATH)/src/github.com/prometheus
MAKE_ARTIFACTS = search_index $(BUILD_PATH)
all: test
build:
$(BUILD_PATH):
mkdir -vp $(BUILD_PATH)
$(BUILD_PATH)/cache: $(BUILD_PATH)
mkdir -vp $(BUILD_PATH)/cache
$(BUILD_PATH)/root: $(BUILD_PATH)
mkdir -vp $(BUILD_PATH)/root
$(BUILD_PATH)/cache/$(GOPKG): $(BUILD_PATH)/cache
curl -o $@ http://go.googlecode.com/files/$(GOPKG)
$(GOCC): $(BUILD_PATH)/root $(BUILD_PATH)/cache/$(GOPKG)
tar -C $(BUILD_PATH)/root -xzf $(BUILD_PATH)/cache/$(GOPKG)
touch $@
build: source_path dependencies
$(MAKE) -C prometheus build
$(MAKE) -C examples build
dependencies: source_path $(GOCC)
$(GO) get github.com/matttproud/gocheck
test: build
$(MAKE) -C prometheus test
$(MAKE) -C examples test
@ -28,18 +67,24 @@ advice: test
$(MAKE) -C examples advice
format:
find . -iname '*.go' -exec gofmt -w -s=true '{}' ';'
find . -iname '*.go' | grep -v './.build/' | xargs -n1 -P1 $(GOFMT) -w -s=true
search_index:
godoc -index -write_index -index_files='search_index'
# source_path is responsible for ensuring that the builder has not done anything
# stupid like working on Prometheus outside of ${GOPATH}.
source_path:
-[ -d "$(FULL_GOPATH)" ] || { mkdir -vp $(FULL_GOPATH_BASE) ; ln -s "$(PWD)" "$(FULL_GOPATH)" ; }
[ -d "$(FULL_GOPATH)" ]
documentation: search_index
godoc -http=:6060 -index -index_files='search_index'
clean:
$(MAKE) -C examples clean
rm -f $(MAKE_ARTIFACTS)
rm -rf $(MAKE_ARTIFACTS)
find . -iname '*~' -exec rm -f '{}' ';'
find . -iname '*#' -exec rm -f '{}' ';'
.PHONY: advice build clean documentation format test
.PHONY: advice build clean documentation format source_path test

View File

@ -1,31 +0,0 @@
# Copyright 2013 Prometheus Team
# 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.
PROMETHEUS_TARGET := "${GOPATH}/src/github.com/prometheus"
all: test
preparation:
mkdir -vp $(PROMETHEUS_TARGET)
ln -sf "$(PWD)" $(PROMETHEUS_TARGET)
dependencies:
go get code.google.com/p/goprotobuf/proto
go get github.com/matttproud/gocheck
go get github.com/matttproud/golang_protobuf_extensions/ext
go get github.com/prometheus/client_model/go
test: dependencies preparation
$(MAKE) test
.PHONY: dependencies preparation test

View File

@ -18,13 +18,13 @@ all: test
build: delegator
delegator:
go build .
$(GO) build .
test: build
go test . $(GO_TEST_FLAGS)
$(GO) test . $(GO_TEST_FLAGS)
advice:
go tool vet .
$(GO) tool vet .
clean:
rm -f $(MAKE_ARTIFACTS)

View File

@ -18,13 +18,13 @@ all: test
build: random
random:
go build .
$(GO) build .
test: build
go test . $(GO_TEST_FLAGS)
$(GO) test . $(GO_TEST_FLAGS)
advice:
go tool vet .
$(GO) tool vet .
clean:
rm -f $(MAKE_ARTIFACTS)

View File

@ -18,13 +18,13 @@ all: test
build: simple
simple:
go build .
$(GO) build .
test: build
go test . $(GO_TEST_FLAGS)
$(GO) test . $(GO_TEST_FLAGS)
advice:
go tool vet .
$(GO) tool vet .
clean:
rm -f $(MAKE_ARTIFACTS)

View File

@ -13,13 +13,16 @@
all: test
build:
go build ./...
build: dependencies
$(GO) build ./...
dependencies: $(GOCC)
$(GO) get -d
test: build
go test ./... $(GO_TEST_FLAGS)
$(GO) test ./... $(GO_TEST_FLAGS)
advice:
go tool vet .
$(GO) tool vet .
.PHONY: advice build test
.PHONY: advice build dependencies test

View File

@ -13,6 +13,7 @@ import (
"math"
"strconv"
"sync"
"time"
dto "github.com/prometheus/client_model/go"
@ -54,6 +55,7 @@ type HistogramSpecification struct {
BucketBuilder BucketBuilder
ReportablePercentiles []float64
Starts []float64
PurgeInterval time.Duration
}
type Histogram interface {
@ -82,11 +84,16 @@ type histogram struct {
values map[uint64]*histogramVector
// These are the percentile values that will be reported on marshalling.
reportablePercentiles []float64
purgeInterval time.Duration
lastPurge time.Time
}
type histogramVector struct {
buckets []Bucket
labels map[string]string
sum float64
count uint64
}
func (h *histogram) Add(labels map[string]string, value float64) {
@ -124,6 +131,9 @@ func (h *histogram) Add(labels map[string]string, value float64) {
}
histogram.buckets[lastIndex].Add(value)
histogram.sum += value
histogram.count++
}
func (h *histogram) String() string {
@ -244,6 +254,8 @@ func formatFloat(value float64) string {
}
func (h *histogram) MarshalJSON() ([]byte, error) {
h.Purge()
h.mutex.RLock()
defer h.mutex.RUnlock()
@ -269,10 +281,29 @@ func (h *histogram) MarshalJSON() ([]byte, error) {
})
}
func (h *histogram) Purge() {
if h.purgeInterval == 0 {
return
}
h.mutex.Lock()
defer h.mutex.Unlock()
if time.Since(h.lastPurge) < h.purgeInterval {
return
}
h.resetAll()
h.lastPurge = time.Now()
}
func (h *histogram) ResetAll() {
h.mutex.Lock()
defer h.mutex.Unlock()
h.resetAll()
}
func (h *histogram) resetAll() {
for signature, value := range h.values {
for _, bucket := range value.buckets {
bucket.Reset()
@ -289,6 +320,8 @@ func NewHistogram(specification *HistogramSpecification) Histogram {
bucketStarts: specification.Starts,
reportablePercentiles: specification.ReportablePercentiles,
values: map[uint64]*histogramVector{},
lastPurge: time.Now(),
purgeInterval: specification.PurgeInterval,
}
return metric
@ -302,18 +335,24 @@ func NewDefaultHistogram() Histogram {
Starts: LogarithmicSizedBucketsFor(0, 4096),
BucketBuilder: AccumulatingBucketBuilder(EvictAndReplaceWith(10, AverageReducer), 50),
ReportablePercentiles: []float64{0.01, 0.05, 0.5, 0.90, 0.99},
PurgeInterval: 15 * time.Minute,
},
)
}
func (metric *histogram) dumpChildren(f *dto.MetricFamily) {
metric.Purge()
metric.mutex.RLock()
defer metric.mutex.RUnlock()
f.Type = dto.MetricType_SUMMARY.Enum()
for signature, child := range metric.values {
c := &dto.Summary{}
c := &dto.Summary{
SampleSum: proto.Float64(child.sum),
SampleCount: proto.Uint64(child.count),
}
m := &dto.Metric{
Summary: c,