-
Notifications
You must be signed in to change notification settings - Fork 2.1k
/
throttle_metric.go
119 lines (91 loc) · 3.89 KB
/
throttle_metric.go
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
/*
Copyright 2023 The Vitess 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.
*/
// This codebase originates from https://github.com/github/freno, See https://github.com/github/freno/blob/master/LICENSE
/*
MIT License
Copyright (c) 2017 GitHub
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
*/
package base
import (
"errors"
"strings"
)
// MetricResult is what we expect our probes to return. This can be a numeric result, or
// a special type of result indicating more meta-information
type MetricResult interface {
Get() (float64, error)
}
// MetricResultFunc is a function that returns a metric result
type MetricResultFunc func() (metricResult MetricResult, threshold float64)
// ErrThresholdExceeded is the common error one may get checking on metric result
var ErrThresholdExceeded = errors.New("Threshold exceeded")
var errNoResultYet = errors.New("Metric not collected yet")
// ErrNoSuchMetric is for when a user requests a metric by an unknown metric name
var ErrNoSuchMetric = errors.New("No such metric")
// ErrInvalidCheckType is an internal error indicating an unknown check type
var ErrInvalidCheckType = errors.New("Unknown throttler check type")
// IsDialTCPError sees if the given error indicates a TCP issue
func IsDialTCPError(e error) bool {
if e == nil {
return false
}
return strings.HasPrefix(e.Error(), "dial tcp")
}
type noHostsMetricResult struct{}
// Get implements MetricResult
func (metricResult *noHostsMetricResult) Get() (float64, error) {
return 0, nil
}
// NoHostsMetricResult is a result indicating "no hosts"
var NoHostsMetricResult = &noHostsMetricResult{}
type noMetricResultYet struct{}
// Get implements MetricResult
func (metricResult *noMetricResultYet) Get() (float64, error) {
return 0, errNoResultYet
}
// NoMetricResultYet is a result indicating "no data"
var NoMetricResultYet = &noMetricResultYet{}
type noSuchMetric struct{}
// Get implements MetricResult
func (metricResult *noSuchMetric) Get() (float64, error) {
return 0, ErrNoSuchMetric
}
// NoSuchMetric is a metric results for an unknown metric name
var NoSuchMetric = &noSuchMetric{}
// simpleMetricResult is a result with float value
type simpleMetricResult struct {
Value float64
}
// NewSimpleMetricResult creates a simpleMetricResult
func NewSimpleMetricResult(value float64) MetricResult {
return &simpleMetricResult{Value: value}
}
// Get implements MetricResult
func (metricResult *simpleMetricResult) Get() (float64, error) {
return metricResult.Value, nil
}