prometheus/util/httputil/context.go
Björn Rabenstein bc703b6456
Use struct{} as underlying type for context keys (#6965)
This is an alternative to #6963.

Signed-off-by: beorn7 <beorn@grafana.com>
2020-03-11 15:05:35 +01:00

52 lines
1.6 KiB
Go

// Copyright 2020 The Prometheus 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 httputil
import (
"context"
"net"
"net/http"
"github.com/prometheus/prometheus/promql"
)
type pathParam struct{}
// ContextWithPath returns a new context with the given path to be used later
// when logging the query.
func ContextWithPath(ctx context.Context, path string) context.Context {
return context.WithValue(ctx, pathParam{}, path)
}
// ContextFromRequest returns a new context with identifiers of
// the request to be used later when logging the query.
func ContextFromRequest(ctx context.Context, r *http.Request) context.Context {
var ip string
if r.RemoteAddr != "" {
// r.RemoteAddr has no defined format, so don't return error if we cannot split it into IP:Port.
ip, _, _ = net.SplitHostPort(r.RemoteAddr)
}
var path string
if v := ctx.Value(pathParam{}); v != nil {
path = v.(string)
}
return promql.NewOriginContext(ctx, map[string]interface{}{
"httpRequest": map[string]string{
"clientIP": ip,
"method": r.Method,
"path": path,
},
})
}