linkerd
/
linkerd2
mirror of https://github.com/linkerd/linkerd2.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Add validation to ensure stat time window is at least 15s (#3720) 

* Add stat time window minimum of 10s

Signed-off-by: zaharidichev <zaharidichev@gmail.com>

* Address comments

Signed-off-by: zaharidichev <zaharidichev@gmail.com>
This commit is contained in:
Zahari Dichev 2019-12-04 08:12:01 +02:00 committed by GitHub
parent 78ed5f8883
commit e5f75a8c3d
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
3 changed files with 21 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
cli/cmd/stat.go
View File

@ -169,7 +169,7 @@ If no resource name is specified, displays stats about all resources of the spec
}
cmd.PersistentFlags().StringVarP(&options.namespace, "namespace", "n", options.namespace, "Namespace of the specified resource")
cmd.PersistentFlags().StringVarP(&options.timeWindow, "time-window", "t", options.timeWindow, "Stat window (for example: \"10s\", \"1m\", \"10m\", \"1h\")")
cmd.PersistentFlags().StringVarP(&options.timeWindow, "time-window", "t", options.timeWindow, "Stat window (for example: \"15s\", \"1m\", \"10m\", \"1h\"). Needs to be at least 15s.")
cmd.PersistentFlags().StringVar(&options.toResource, "to", options.toResource, "If present, restricts outbound stats to the specified resource name")
cmd.PersistentFlags().StringVar(&options.toNamespace, "to-namespace", options.toNamespace, "Sets the namespace used to lookup the \"--to\" resource; by default the current \"--namespace\" is used")
cmd.PersistentFlags().StringVar(&options.fromResource, "from", options.fromResource, "If present, restricts outbound stats from the specified resource name")

12
cli/cmd/stat_test.go
View File

@ -191,6 +191,18 @@ func TestStat(t *testing.T) {
t.Fatalf("Expected error [%s] instead got [%s]", expectedError, err)
}
})
t.Run("Returns an error if --time-window is not more than 15s", func(t *testing.T) {
options := newStatOptions()
options.timeWindow = "10s"
args := []string{"ns/bar"}
expectedError := "metrics time window needs to be at least 15s"
_, err := buildStatSummaryRequests(args, options)
if err == nil || err.Error() != expectedError {
t.Fatalf("Expected error [%s] instead got [%s]", expectedError, err)
}
})
}
func testStatCall(exp paramsExp, resourceType string, t *testing.T) {

10
controller/api/util/api_utils.go
View File

@ -21,7 +21,8 @@ import (
*/
var (
defaultMetricTimeWindow = "1m"
defaultMetricTimeWindow = "1m"
metricTimeWindowLowerBound = time.Second * 15 //the window value needs to equal or larger than that
// ValidTargets specifies resource types allowed as a target:
// target resource on an inbound query
@ -145,10 +146,15 @@ func GRPCError(err error) error {
func BuildStatSummaryRequest(p StatsSummaryRequestParams) (*pb.StatSummaryRequest, error) {
window := defaultMetricTimeWindow
if p.TimeWindow != "" {
_, err := time.ParseDuration(p.TimeWindow)
w, err := time.ParseDuration(p.TimeWindow)
if err != nil {
return nil, err
}
if w < metricTimeWindowLowerBound {
return nil, errors.New("metrics time window needs to be at least 15s")
}
window = p.TimeWindow
}