prometheus/util/httputil/context.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 ctxParam int

var pathParam ctxParam

// 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 {
	reqCtxVal := map[string]string{
		"method": r.Method,
	}

	// r.RemoteAddr has no defined format, so don't return error if we cannot split it into IP:Port.
	ip, _, _ := net.SplitHostPort(r.RemoteAddr)
	if ip != "" {
		reqCtxVal["clientIP"] = ip
	}

	var path string
	if v := ctx.Value(pathParam); v != nil {
		path = v.(string)
		reqCtxVal["path"] = path
	}

	return promql.NewOriginContext(ctx, map[string]interface{}{
		"httpRequest": reqCtxVal,
	})
}