server: use docker/go-metrics utilities for prometheus, add "no_metrics" build-tag #1659
+89
−24
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,41 @@ | ||
| //go:build !no_metrics | ||
| // +build !no_metrics | ||
|
|
||
| package server | ||
|
|
||
| import ( | ||
| "net/http" | ||
|
|
||
| "github.com/docker/go-metrics" | ||
| "github.com/gorilla/mux" | ||
| ) | ||
|
|
||
| // namespacePrefix is the namespace prefix used for prometheus metrics. | ||
| const namespacePrefix = "notary_server" | ||
|
|
||
| // Server uses handlers.Changefeed for two separate routes. It's not allowed | ||
| // to register twice ("duplicate metrics collector registration attempted"), | ||
| // so checking if it's already instrumented, otherwise skip. | ||
| var instrumented = map[string]struct{}{} | ||
|
|
||
| // instrumentedHandler instruments a server handler for monitoring with prometheus. | ||
| func instrumentedHandler(handlerName string, handler http.Handler) http.Handler { | ||
| if _, registered := instrumented[handlerName]; registered { | ||
| // handler for this operation is already registered. | ||
| return handler | ||
| } | ||
| instrumented[handlerName] = struct{}{} | ||
|
|
||
| // Preserve the old situation, which used ConstLabels: "operation: <operation>" | ||
| // for metrics, but ConstLabels in go-metrics are per-namespace, and use | ||
| // ConstLabels: "handler: <handlerName>" (we pass operationName as handlerName). | ||
| namespace := metrics.NewNamespace(namespacePrefix, "http", metrics.Labels{"operation": handlerName}) | ||
| httpMetrics := namespace.NewDefaultHttpMetrics(handlerName) | ||
|
Comment on lines
+29
to
+33
There was a problem hiding this comment. New situation will have two labels; "old" ( |
||
| metrics.Register(namespace) | ||
| return metrics.InstrumentHandler(httpMetrics, handler) | ||
| } | ||
|
|
||
| // handleMetricsEndpoint registers the /metrics endpoint. | ||
| func handleMetricsEndpoint(r *mux.Router) { | ||
| r.Methods("GET").Path("/metrics").Handler(metrics.Handler()) | ||
| } | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,14 @@ | ||
| //go:build no_metrics | ||
| // +build no_metrics | ||
|
|
||
| package server | ||
|
|
||
| import "net/http" | ||
|
|
||
| // instrumentedHandler instruments a server handler for monitoring with prometheus. | ||
| func instrumentedHandler(_ string, handler http.Handler) http.Handler { | ||
| return handler | ||
| } | ||
|
|
||
| // handleMetricsEndpoint registers the /metrics endpoint. | ||
| func handleMetricsEndpoint(r *interface{}) {} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,25 @@ | ||
| //go:build !no_metrics | ||
| // +build !no_metrics | ||
|
|
||
| package server | ||
|
|
||
| import ( | ||
| "context" | ||
| "net/http" | ||
| "net/http/httptest" | ||
| "testing" | ||
|
|
||
| "github.com/stretchr/testify/require" | ||
| "github.com/theupdateframework/notary/tuf/signed" | ||
| ) | ||
|
|
||
| func TestMetricsEndpoint(t *testing.T) { | ||
| handler := RootHandler(context.Background(), nil, signed.NewEd25519(), | ||
| nil, nil, nil) | ||
| ts := httptest.NewServer(handler) | ||
| defer ts.Close() | ||
|
|
||
| res, err := http.Get(ts.URL + "/metrics") | ||
| require.NoError(t, err) | ||
| require.Equal(t, http.StatusOK, res.StatusCode) | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Had to add this to prevent the
handlers.Changefeedbeing registered twice; it's used for two endpoints, bot usingChangefeedas handlerName / operationName. Double check if it still works as expected with this.