3a055cc2f5
This was done by running the following command twice: ```bash grep -Ri "github.com/jetstack/cert-manager" . | \ cut -d":" -f1 | \ sort | \ uniq | \ xargs sed -i "s/github.com\/jetstack\/cert-manager/github.com\/cert-manager\/cert-manager/" ``` Signed-off-by: Ashley Davis <ashley.davis@jetstack.io>
103 lines
2.9 KiB
Go
103 lines
2.9 KiB
Go
/*
|
|
Copyright 2020 The cert-manager 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 client
|
|
|
|
import (
|
|
"fmt"
|
|
"net/http"
|
|
"strings"
|
|
"time"
|
|
|
|
"github.com/cert-manager/cert-manager/pkg/metrics"
|
|
)
|
|
|
|
// This file implements a custom instrumented HTTP client round tripper that
|
|
// exposes prometheus metrics for each endpoint called.
|
|
//
|
|
// We implement this as part of the HTTP client to ensure we don't miss any
|
|
// calls made to the ACME server caused by retries in the underlying ACME
|
|
// library.
|
|
|
|
// Transport is a http.RoundTripper that collects Prometheus metrics of every
|
|
// request it processes. It allows to be configured with callbacks that process
|
|
// request path and query into a suitable label value.
|
|
type Transport struct {
|
|
metrics *metrics.Metrics
|
|
|
|
wrappedRT http.RoundTripper
|
|
}
|
|
|
|
// NewInstrumentedClient takes a *http.Client and returns a *http.Client that
|
|
// has its RoundTripper wrapped with instrumentation.
|
|
func NewInstrumentedClient(metrics *metrics.Metrics, client *http.Client) *http.Client {
|
|
// If next client is not defined we'll use http.DefaultClient.
|
|
if client == nil {
|
|
client = http.DefaultClient
|
|
}
|
|
|
|
if client.Transport == nil {
|
|
client.Transport = http.DefaultTransport
|
|
}
|
|
|
|
client.Transport = &Transport{
|
|
wrappedRT: client.Transport,
|
|
metrics: metrics,
|
|
}
|
|
|
|
return client
|
|
}
|
|
|
|
// RoundTrip implements http.RoundTripper. It forwards the request to the
|
|
// wrapped RoundTripper and measures the time it took in Prometheus summary.
|
|
func (it *Transport) RoundTrip(req *http.Request) (*http.Response, error) {
|
|
statusCode := 999
|
|
|
|
// Remember the current time.
|
|
start := time.Now()
|
|
|
|
// Make the request using the wrapped RoundTripper.
|
|
resp, err := it.wrappedRT.RoundTrip(req)
|
|
if resp != nil {
|
|
statusCode = resp.StatusCode
|
|
}
|
|
|
|
labels := []string{
|
|
req.URL.Scheme,
|
|
req.URL.Host,
|
|
pathProcessor(req.URL.Path),
|
|
req.Method,
|
|
fmt.Sprintf("%d", statusCode),
|
|
}
|
|
// Observe the time it took to make the request.
|
|
it.metrics.ObserveACMERequestDuration(time.Since(start), labels...)
|
|
it.metrics.IncrementACMERequestCount(labels...)
|
|
|
|
// return the response and error reported from the next RoundTripper.
|
|
return resp, err
|
|
}
|
|
|
|
// pathProcessor will trim the provided path to only include the first 2
|
|
// segments in order to reduce the number of prometheus labels generated
|
|
func pathProcessor(path string) string {
|
|
p := strings.Split(path, "/")
|
|
// only record the first two path segments as a prometheus label value
|
|
if len(p) > 3 {
|
|
p = p[:3]
|
|
}
|
|
return strings.Join(p, "/")
|
|
}
|