Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Support prometheus #168

Open
wants to merge 3 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion lib/middleware/middleware.go
Original file line number Diff line number Diff line change
Expand Up @@ -95,7 +95,7 @@ func StatusCounter(stats tally.Scope) func(next http.Handler) http.Handler {
return http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
recordw := &recordStatusWriter{w, false, http.StatusOK}
next.ServeHTTP(recordw, r)
tagEndpoint(stats, r).Counter(strconv.Itoa(recordw.code)).Inc(1)
tagEndpoint(stats, r).Counter("http_" + strconv.Itoa(recordw.code)).Inc(1)
})
}
}
2 changes: 1 addition & 1 deletion lib/middleware/middleware_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -145,7 +145,7 @@ func TestStatusCounter(t *testing.T) {

require.Equal(1, len(stats.Snapshot().Counters()))
for _, v := range stats.Snapshot().Counters() {
require.Equal(test.expectedStatus, v.Name())
require.Equal("http_" + test.expectedStatus, v.Name())
require.Equal(int64(5), v.Value())
require.Equal(map[string]string{
"endpoint": "foo",
Expand Down
14 changes: 11 additions & 3 deletions metrics/config.go
Original file line number Diff line number Diff line change
Expand Up @@ -15,9 +15,10 @@ package metrics

// Config defines metrics configuration.
type Config struct {
Backend string `yaml:"backend"`
Statsd StatsdConfig `yaml:"statsd"`
M3 M3Config `yaml:"m3"`
Backend string `yaml:"backend"`
Statsd StatsdConfig `yaml:"statsd"`
M3 M3Config `yaml:"m3"`
Prometheus PrometheusConfig `yaml:"prometheus"`
}

// StatsdConfig defines statsd configuration.
Expand All @@ -32,3 +33,10 @@ type M3Config struct {
Service string `yaml:"service"`
Env string `yaml:"env"`
}

// PrometheusConfig defines prometheus configuration.
type PrometheusConfig struct {
ListenAddress string `yaml:"listen_address"`
// HandlerPath if not define use default /metrics.
HandlerPath string `yaml:"handler_path"`
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The yaml config keys are camel cased in the tally package:

https://github.com/uber-go/tally/blob/f266f90e9c4d5894364039a324a05d061f2f34e2/prometheus/config.go#L33-L58

Perhaps we should prefer camel case here as well so that it's not a breaking change if we want to swap PrometheusConfig out with the tally prometheus.Configuration type in the future.

}
1 change: 1 addition & 0 deletions metrics/metrics.go
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,7 @@ func init() {
register("statsd", newStatsdScope)
register("disabled", newDisabledScope)
register("m3", newM3Scope)
register("prometheus", newPrometheusScope)
}

var _scopeFactories = make(map[string]scopeFactory)
Expand Down
42 changes: 42 additions & 0 deletions metrics/prometheus.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
// Copyright (c) 2016-2019 Uber Technologies, Inc.
//
// 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 metrics

import (
"fmt"
"io"
"time"

"github.com/uber-go/tally"
promreporter "github.com/uber-go/tally/prometheus"
)

func newPrometheusScope(config Config, cluster string) (tally.Scope, io.Closer, error) {
if config.Prometheus.ListenAddress == "" {
return nil, nil, fmt.Errorf("listen_address required for prometheus")
}

prometheusConfig := promreporter.Configuration{
HandlerPath: config.Prometheus.HandlerPath,
ListenAddress: config.Prometheus.ListenAddress,
}
r, err := prometheusConfig.NewReporter(promreporter.ConfigurationOptions{})
if err != nil {
return nil, nil, err
}
s, c := tally.NewRootScope(tally.ScopeOptions{
CachedReporter: r,
}, time.Second)
return s, c, nil
}