1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254
|
/*
Copyright 2017 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 metrics
import (
"strconv"
"time"
"github.com/prometheus/client_golang/prometheus"
commonmetrics "sigs.k8s.io/apiserver-network-proxy/konnectivity-client/pkg/common/metrics"
"sigs.k8s.io/apiserver-network-proxy/konnectivity-client/proto/client"
)
type Direction string
const (
Namespace = "konnectivity_network_proxy"
Subsystem = "agent"
// DirectionToServer indicates that the agent attempts to send a packet
// to the proxy server.
DirectionToServer Direction = "to_server"
// DirectionFromServer indicates that the agent attempts to receive a
// packet from the proxy server.
DirectionFromServer Direction = "from_server"
)
var (
// Use buckets ranging from 5 ms to 30 seconds.
latencyBuckets = []float64{0.005, 0.025, 0.1, 0.5, 2.5, 10, 30}
// Metrics provides access to all dial metrics.
Metrics = newAgentMetrics()
)
// AgentMetrics includes all the metrics of the proxy agent.
type AgentMetrics struct {
dialLatencies *prometheus.HistogramVec
serverFailures *prometheus.CounterVec
dialFailures *prometheus.CounterVec
serverConnections *prometheus.GaugeVec
serverCount prometheus.Gauge
endpointConnections *prometheus.GaugeVec
streamPackets *prometheus.CounterVec
streamErrors *prometheus.CounterVec
leaseLists *prometheus.CounterVec
leaseWatches *prometheus.CounterVec
leaseListLatencies *prometheus.HistogramVec
}
// newAgentMetrics create a new AgentMetrics, configured with default metric names.
func newAgentMetrics() *AgentMetrics {
dialLatencies := prometheus.NewHistogramVec(
prometheus.HistogramOpts{
Namespace: Namespace,
Subsystem: Subsystem,
Name: "dial_duration_seconds",
Help: "Latency of dial to the remote endpoint in seconds",
Buckets: latencyBuckets,
},
[]string{},
)
serverFailures := prometheus.NewCounterVec(
prometheus.CounterOpts{
Namespace: Namespace,
Subsystem: Subsystem,
Name: "server_connection_failure_count",
Help: "Count of failures to send to or receive from the proxy server, labeled by the direction (from_server or to_server). DEPRECATED, please use stream_events_error_total",
},
[]string{"direction"},
)
dialFailures := prometheus.NewCounterVec(
prometheus.CounterOpts{
Namespace: Namespace,
Subsystem: Subsystem,
Name: "endpoint_dial_failure_total",
Help: "Number of failures dialing the remote endpoint, by reason (example: timeout).",
},
[]string{"reason"},
)
serverConnections := prometheus.NewGaugeVec(
prometheus.GaugeOpts{
Namespace: Namespace,
Subsystem: Subsystem,
Name: "open_server_connections",
Help: "Current number of open server connections.",
},
[]string{},
)
serverCount := prometheus.NewGauge(
prometheus.GaugeOpts{
Namespace: Namespace,
Subsystem: Subsystem,
Name: "known_server_count",
Help: "Current number of servers agent is trying to connect to.",
},
)
endpointConnections := prometheus.NewGaugeVec(
prometheus.GaugeOpts{
Namespace: Namespace,
Subsystem: Subsystem,
Name: "open_endpoint_connections",
Help: "Current number of open endpoint connections.",
},
[]string{},
)
leaseLists := prometheus.NewCounterVec(
prometheus.CounterOpts{
Namespace: Namespace,
Subsystem: Subsystem,
Name: "lease_lists_total",
Help: "Count of server lease list calls made by the agent to the k8s apiserver, labeled by HTTP response code and reason",
},
[]string{"http_response_code", "reason"},
)
leaseWatches := prometheus.NewCounterVec(
prometheus.CounterOpts{
Namespace: Namespace,
Subsystem: Subsystem,
Name: "lease_watches_total",
Help: "Count of server lease watch calls made by the agent to the k8s apiserver, labeled by HTTP response code and reason",
},
[]string{"http_response_code", "reason"},
)
leaseListLatencies := prometheus.NewHistogramVec(
prometheus.HistogramOpts{
Namespace: Namespace,
Subsystem: Subsystem,
Name: "lease_list_latency_seconds",
Help: "Latency of server lease listing in seconds",
Buckets: latencyBuckets,
},
[]string{"http_response_code"},
)
streamPackets := commonmetrics.MakeStreamPacketsTotalMetric(Namespace, Subsystem)
streamErrors := commonmetrics.MakeStreamErrorsTotalMetric(Namespace, Subsystem)
prometheus.MustRegister(dialLatencies)
prometheus.MustRegister(serverFailures)
prometheus.MustRegister(dialFailures)
prometheus.MustRegister(serverConnections)
prometheus.MustRegister(endpointConnections)
prometheus.MustRegister(streamPackets)
prometheus.MustRegister(streamErrors)
prometheus.MustRegister(serverCount)
prometheus.MustRegister(leaseLists)
prometheus.MustRegister(leaseWatches)
prometheus.MustRegister(leaseListLatencies)
return &AgentMetrics{
dialLatencies: dialLatencies,
serverFailures: serverFailures,
dialFailures: dialFailures,
serverConnections: serverConnections,
endpointConnections: endpointConnections,
streamPackets: streamPackets,
streamErrors: streamErrors,
serverCount: serverCount,
leaseLists: leaseLists,
leaseWatches: leaseWatches,
leaseListLatencies: leaseListLatencies,
}
}
// Reset resets the metrics.
func (a *AgentMetrics) Reset() {
a.dialLatencies.Reset()
a.serverFailures.Reset()
a.dialFailures.Reset()
a.serverConnections.Reset()
a.endpointConnections.Reset()
a.streamPackets.Reset()
a.streamErrors.Reset()
a.leaseLists.Reset()
}
// ObserveServerFailure records a failure to send to or receive from the proxy
// server, labeled by the direction.
func (a *AgentMetrics) ObserveServerFailureDeprecated(direction Direction) {
a.serverFailures.WithLabelValues(string(direction)).Inc()
}
type DialFailureReason string
const (
DialFailureTimeout DialFailureReason = "timeout"
DialFailureUnknown DialFailureReason = "unknown"
)
// ObserveDialLatency records the latency of dial to the remote endpoint.
func (a *AgentMetrics) ObserveDialLatency(elapsed time.Duration) {
a.dialLatencies.WithLabelValues().Observe(elapsed.Seconds())
}
// ObserveDialFailure records a remote endpoint dial failure.
func (a *AgentMetrics) ObserveDialFailure(reason DialFailureReason) {
a.dialFailures.WithLabelValues(string(reason)).Inc()
}
func (a *AgentMetrics) SetServerConnectionsCount(count int) {
a.serverConnections.WithLabelValues().Set(float64(count))
}
func (a *AgentMetrics) SetServerCount(count int) {
a.serverCount.Set(float64(count))
}
func (a *AgentMetrics) ObserveLeaseList(httpCode int, reason string) {
a.leaseLists.WithLabelValues(strconv.Itoa(httpCode), reason).Inc()
}
func (a *AgentMetrics) ObserveLeaseWatch(httpCode int, reason string) {
a.leaseLists.WithLabelValues(strconv.Itoa(httpCode), reason).Inc()
}
func (a *AgentMetrics) ObserveLeaseListLatency(latency time.Duration, httpCode int) {
a.leaseListLatencies.WithLabelValues(strconv.Itoa(httpCode)).Observe(latency.Seconds())
}
// EndpointConnectionInc increments a new endpoint connection.
func (a *AgentMetrics) EndpointConnectionInc() {
a.endpointConnections.WithLabelValues().Inc()
}
// EndpointConnectionDec decrements a finished endpoint connection.
func (a *AgentMetrics) EndpointConnectionDec() {
a.endpointConnections.WithLabelValues().Dec()
}
func (a *AgentMetrics) ObservePacket(segment commonmetrics.Segment, packetType client.PacketType) {
commonmetrics.ObservePacket(a.streamPackets, segment, packetType)
}
func (a *AgentMetrics) ObserveStreamErrorNoPacket(segment commonmetrics.Segment, err error) {
commonmetrics.ObserveStreamErrorNoPacket(a.streamErrors, segment, err)
}
func (a *AgentMetrics) ObserveStreamError(segment commonmetrics.Segment, err error, packetType client.PacketType) {
commonmetrics.ObserveStreamError(a.streamErrors, segment, err, packetType)
}
|