/*
Copyright 2016 The Kubernetes 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 restclient

import (
	"context"
	"fmt"
	"math"
	"net/url"
	"time"

	"k8s.io/client-go/tools/metrics"
	k8smetrics "k8s.io/component-base/metrics"
	"k8s.io/component-base/metrics/legacyregistry"
)

var (
	// requestLatency is a Prometheus Histogram metric type partitioned by
	// "verb", and "host" labels. It is used for the rest client latency metrics.
	requestLatency = k8smetrics.NewHistogramVec(
		&k8smetrics.HistogramOpts{
			Name:           "rest_client_request_duration_seconds",
			Help:           "Request latency in seconds. Broken down by verb, and host.",
			StabilityLevel: k8smetrics.ALPHA,
			Buckets:        []float64{0.005, 0.025, 0.1, 0.25, 0.5, 1.0, 2.0, 4.0, 8.0, 15.0, 30.0, 60.0},
		},
		[]string{"verb", "host"},
	)

	// resolverLatency is a Prometheus Histogram metric type partitioned by
	// "host" labels. It is used for the rest client DNS resolver latency metrics.
	resolverLatency = k8smetrics.NewHistogramVec(
		&k8smetrics.HistogramOpts{
			Name:           "rest_client_dns_resolution_duration_seconds",
			Help:           "DNS resolver latency in seconds. Broken down by host.",
			StabilityLevel: k8smetrics.ALPHA,
			Buckets:        []float64{0.005, 0.025, 0.1, 0.25, 0.5, 1.0, 2.0, 4.0, 8.0, 15.0, 30.0},
		},
		[]string{"host"},
	)

	requestSize = k8smetrics.NewHistogramVec(
		&k8smetrics.HistogramOpts{
			Name:           "rest_client_request_size_bytes",
			Help:           "Request size in bytes. Broken down by verb and host.",
			StabilityLevel: k8smetrics.ALPHA,
			// 64 bytes to 16MB
			Buckets: []float64{64, 256, 512, 1024, 4096, 16384, 65536, 262144, 1048576, 4194304, 16777216},
		},
		[]string{"verb", "host"},
	)

	responseSize = k8smetrics.NewHistogramVec(
		&k8smetrics.HistogramOpts{
			Name:           "rest_client_response_size_bytes",
			Help:           "Response size in bytes. Broken down by verb and host.",
			StabilityLevel: k8smetrics.ALPHA,
			// 64 bytes to 16MB
			Buckets: []float64{64, 256, 512, 1024, 4096, 16384, 65536, 262144, 1048576, 4194304, 16777216},
		},
		[]string{"verb", "host"},
	)

	rateLimiterLatency = k8smetrics.NewHistogramVec(
		&k8smetrics.HistogramOpts{
			Name:           "rest_client_rate_limiter_duration_seconds",
			Help:           "Client side rate limiter latency in seconds. Broken down by verb, and host.",
			StabilityLevel: k8smetrics.ALPHA,
			Buckets:        []float64{0.005, 0.025, 0.1, 0.25, 0.5, 1.0, 2.0, 4.0, 8.0, 15.0, 30.0, 60.0},
		},
		[]string{"verb", "host"},
	)

	requestResult = k8smetrics.NewCounterVec(
		&k8smetrics.CounterOpts{
			Name:           "rest_client_requests_total",
			StabilityLevel: k8smetrics.ALPHA,
			Help:           "Number of HTTP requests, partitioned by status code, method, and host.",
		},
		[]string{"code", "method", "host"},
	)

	requestRetry = k8smetrics.NewCounterVec(
		&k8smetrics.CounterOpts{
			Name:           "rest_client_request_retries_total",
			StabilityLevel: k8smetrics.ALPHA,
			Help:           "Number of request retries, partitioned by status code, verb, and host.",
		},
		[]string{"code", "verb", "host"},
	)

	execPluginCertTTLAdapter = &expiryToTTLAdapter{}

	execPluginCertTTL = k8smetrics.NewGaugeFunc(
		&k8smetrics.GaugeOpts{
			Name: "rest_client_exec_plugin_ttl_seconds",
			Help: "Gauge of the shortest TTL (time-to-live) of the client " +
				"certificate(s) managed by the auth exec plugin. The value " +
				"is in seconds until certificate expiry (negative if " +
				"already expired). If auth exec plugins are unused or manage no " +
				"TLS certificates, the value will be +INF.",
			StabilityLevel: k8smetrics.ALPHA,
		},
		func() float64 {
			if execPluginCertTTLAdapter.e == nil {
				return math.Inf(1)
			}
			return execPluginCertTTLAdapter.e.Sub(time.Now()).Seconds()
		},
	)

	execPluginCertRotation = k8smetrics.NewHistogram(
		&k8smetrics.HistogramOpts{
			Name: "rest_client_exec_plugin_certificate_rotation_age",
			Help: "Histogram of the number of seconds the last auth exec " +
				"plugin client certificate lived before being rotated. " +
				"If auth exec plugin client certificates are unused, " +
				"histogram will contain no data.",
			// There are three sets of ranges these buckets intend to capture:
			//   - 10-60 minutes: captures a rotation cadence which is
			//     happening too quickly.
			//   - 4 hours - 1 month: captures an ideal rotation cadence.
			//   - 3 months - 4 years: captures a rotation cadence which is
			//     is probably too slow or much too slow.
			StabilityLevel: k8smetrics.ALPHA,
			Buckets: []float64{
				600,       // 10 minutes
				1800,      // 30 minutes
				3600,      // 1  hour
				14400,     // 4  hours
				86400,     // 1  day
				604800,    // 1  week
				2592000,   // 1  month
				7776000,   // 3  months
				15552000,  // 6  months
				31104000,  // 1  year
				124416000, // 4  years
			},
		},
	)

	execPluginCalls = k8smetrics.NewCounterVec(
		&k8smetrics.CounterOpts{
			StabilityLevel: k8smetrics.ALPHA,
			Name:           "rest_client_exec_plugin_call_total",
			Help: "Number of calls to an exec plugin, partitioned by the type of " +
				"event encountered (no_error, plugin_execution_error, plugin_not_found_error, " +
				"client_internal_error) and an optional exit code. The exit code will " +
				"be set to 0 if and only if the plugin call was successful.",
		},
		[]string{"code", "call_status"},
	)

	execPluginPolicyCalls = k8smetrics.NewCounterVec(
		&k8smetrics.CounterOpts{
			StabilityLevel: k8smetrics.ALPHA,
			Name:           "rest_client_exec_plugin_policy_call_total",
			Help: "Number of comparisons of an exec plugin to the plugin policy " +
				"and allowlist (if any), partitioned by whether or not the policy " +
				"permits the plugin",
		},
		[]string{"allowed", "denied"},
	)

	transportCacheEntries = k8smetrics.NewGauge(
		&k8smetrics.GaugeOpts{
			Name:           "rest_client_transport_cache_entries",
			StabilityLevel: k8smetrics.ALPHA,
			Help:           "Number of transport entries in the internal cache.",
		},
	)

	transportCacheCalls = k8smetrics.NewCounterVec(
		&k8smetrics.CounterOpts{
			Name:           "rest_client_transport_create_calls_total",
			StabilityLevel: k8smetrics.ALPHA,
			Help: "Number of calls to get a new transport, partitioned by the result of the operation " +
				"hit: obtained from the cache, miss: created and added to the cache, miss-gc: recreated and added back to the cache after being garbage collected, uncacheable: created and not cached",
		},
		[]string{"result"},
	)

	transportCAReloads = k8smetrics.NewCounterVec(
		&k8smetrics.CounterOpts{
			Name:           "rest_client_transport_ca_reload_total",
			StabilityLevel: k8smetrics.ALPHA,
			Help:           "Number of times a CA reload is attempted, partitioned by the result and reason for the reload attempt",
		},
		[]string{"result", "reason"},
	)

	transportCertRotationGCCalls = k8smetrics.NewCounter(
		&k8smetrics.CounterOpts{
			Name:           "rest_client_transport_cert_rotation_gc_calls_total",
			StabilityLevel: k8smetrics.ALPHA,
			Help:           "Number of times a cert rotation goroutine cancel func is called via GC cleanup of the associated transport",
		},
	)

	transportCacheGCCalls = k8smetrics.NewCounterVec(
		&k8smetrics.CounterOpts{
			Name:           "rest_client_transport_cache_gc_calls_total",
			StabilityLevel: k8smetrics.ALPHA,
			Help:           "Number of times a GC cleanup attempts to delete a transport cache entry, partitioned by the result: deleted, skipped",
		},
		[]string{"result"},
	)
)

// init installs the adapter pointers (RequestLatency,
// ClientCertExpiry, etc.) into client-go/tools/metrics and supplies
// a RegisterFn callback that performs the legacyregistry.MustRegister calls.
// The callback fires from metrics.EnsureRegistered which rest.RESTClientForConfigAndClient
// invokes at first rest client construction.
func init() {
	metrics.Register(metrics.RegisterOpts{
		ClientCertExpiry:             execPluginCertTTLAdapter,
		ClientCertRotationAge:        &rotationAdapter{m: execPluginCertRotation},
		RequestLatency:               &latencyAdapter{m: requestLatency},
		ResolverLatency:              &resolverLatencyAdapter{m: resolverLatency},
		RequestSize:                  &sizeAdapter{m: requestSize},
		ResponseSize:                 &sizeAdapter{m: responseSize},
		RateLimiterLatency:           &latencyAdapter{m: rateLimiterLatency},
		RequestResult:                &resultAdapter{requestResult},
		RequestRetry:                 &retryAdapter{requestRetry},
		ExecPluginCalls:              &callsAdapter{m: execPluginCalls},
		ExecPluginPolicyCalls:        &policyAdapter{m: execPluginPolicyCalls},
		TransportCacheEntries:        &transportCacheAdapter{m: transportCacheEntries},
		TransportCreateCalls:         &transportCacheCallsAdapter{m: transportCacheCalls},
		TransportCAReloads:           &transportCAReloadsAdapter{m: transportCAReloads},
		TransportCertRotationGCCalls: &transportCertRotationGCCallsAdapter{m: transportCertRotationGCCalls},
		TransportCacheGCCalls:        &transportCacheGCCallsAdapter{m: transportCacheGCCalls},
		RegisterFn: func() {
			legacyregistry.MustRegister(requestLatency)
			legacyregistry.MustRegister(requestSize)
			legacyregistry.MustRegister(responseSize)
			legacyregistry.MustRegister(rateLimiterLatency)
			legacyregistry.MustRegister(requestResult)
			legacyregistry.MustRegister(requestRetry)
			legacyregistry.RawMustRegister(execPluginCertTTL)
			legacyregistry.MustRegister(execPluginCertRotation)
			legacyregistry.MustRegister(execPluginCalls)
			legacyregistry.MustRegister(transportCacheEntries)
			legacyregistry.MustRegister(transportCacheCalls)
			legacyregistry.MustRegister(transportCAReloads)
			legacyregistry.MustRegister(transportCertRotationGCCalls)
			legacyregistry.MustRegister(transportCacheGCCalls)
		},
	})
}

type latencyAdapter struct {
	m *k8smetrics.HistogramVec
}

func (l *latencyAdapter) Observe(ctx context.Context, verb string, u url.URL, latency time.Duration) {
	metrics.EnsureRegistered()
	l.m.WithContext(ctx).WithLabelValues(verb, u.Host).Observe(latency.Seconds())
}

type resolverLatencyAdapter struct {
	m *k8smetrics.HistogramVec
}

func (l *resolverLatencyAdapter) Observe(ctx context.Context, host string, latency time.Duration) {
	metrics.EnsureRegistered()
	l.m.WithContext(ctx).WithLabelValues(host).Observe(latency.Seconds())
}

type sizeAdapter struct {
	m *k8smetrics.HistogramVec
}

func (s *sizeAdapter) Observe(ctx context.Context, verb string, host string, size float64) {
	metrics.EnsureRegistered()
	s.m.WithContext(ctx).WithLabelValues(verb, host).Observe(size)
}

type resultAdapter struct {
	m *k8smetrics.CounterVec
}

func (r *resultAdapter) Increment(ctx context.Context, code, method, host string) {
	metrics.EnsureRegistered()
	r.m.WithContext(ctx).WithLabelValues(code, method, host).Inc()
}

type expiryToTTLAdapter struct {
	e *time.Time
}

func (e *expiryToTTLAdapter) Set(expiry *time.Time) {
	metrics.EnsureRegistered()
	e.e = expiry
}

type rotationAdapter struct {
	m *k8smetrics.Histogram
}

func (r *rotationAdapter) Observe(d time.Duration) {
	metrics.EnsureRegistered()
	r.m.Observe(d.Seconds())
}

type callsAdapter struct {
	m *k8smetrics.CounterVec
}

func (r *callsAdapter) Increment(code int, callStatus string) {
	metrics.EnsureRegistered()
	r.m.WithLabelValues(fmt.Sprintf("%d", code), callStatus).Inc()
}

type policyAdapter struct {
	m *k8smetrics.CounterVec
}

func (r *policyAdapter) Increment(status string) {
	metrics.EnsureRegistered()
	r.m.WithLabelValues(status).Inc()
}

type retryAdapter struct {
	m *k8smetrics.CounterVec
}

func (r *retryAdapter) IncrementRetry(ctx context.Context, code, method, host string) {
	metrics.EnsureRegistered()
	r.m.WithContext(ctx).WithLabelValues(code, method, host).Inc()
}

type transportCacheAdapter struct {
	m *k8smetrics.Gauge
}

func (t *transportCacheAdapter) Observe(value int) {
	metrics.EnsureRegistered()
	t.m.Set(float64(value))
}

type transportCacheCallsAdapter struct {
	m *k8smetrics.CounterVec
}

func (t *transportCacheCallsAdapter) Increment(result string) {
	metrics.EnsureRegistered()
	t.m.WithLabelValues(result).Inc()
}

type transportCAReloadsAdapter struct {
	m *k8smetrics.CounterVec
}

func (t *transportCAReloadsAdapter) Increment(result, reason string) {
	metrics.EnsureRegistered()
	t.m.WithLabelValues(result, reason).Inc()
}

type transportCertRotationGCCallsAdapter struct {
	m *k8smetrics.Counter
}

func (t *transportCertRotationGCCallsAdapter) Increment() {
	metrics.EnsureRegistered()
	t.m.Inc()
}

type transportCacheGCCallsAdapter struct {
	m *k8smetrics.CounterVec
}

func (t *transportCacheGCCallsAdapter) Increment(result string) {
	metrics.EnsureRegistered()
	t.m.WithLabelValues(result).Inc()
}