istio

1
// Copyright 2019 Istio Authors
2
//
3
// Licensed under the Apache License, Version 2.0 (the "License");
4
// you may not use this file except in compliance with the License.
5
// You may obtain a copy of the License at
6
//
7
//     http://www.apache.org/licenses/LICENSE-2.0
8
//
9
// Unless required by applicable law or agreed to in writing, software
10
// distributed under the License is distributed on an "AS IS" BASIS,
11
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12
// See the License for the specific language governing permissions and
13
// limitations under the License.
14

15
package collateral
16

17
import (
18
	"istio.io/istio/pkg/env"
19
	"istio.io/istio/pkg/monitoring"
20
)
21

22
// Predicates are a set of predicates to apply when generating collaterals.
23
type Predicates struct {
24
	SelectEnv    SelectEnvFn
25
	SelectMetric SelectMetricFn
26
}
27

28
// SelectEnvFn is a predicate function for selecting environment variables when generating collateral documents.
29
type SelectEnvFn func(env.Var) bool
30

31
// SelectMetricFn is a predicate function for selecting metrics when generating collateral documents.
32
type SelectMetricFn func(monitoring.MetricDefinition) bool
33

34
// DefaultSelectEnvFn is used to select all environment variables.
35
func DefaultSelectEnvFn(_ env.Var) bool {
36
	return true
37
}
38

39
// DefaultSelectMetricFn is used to select all metrics.
40
func DefaultSelectMetricFn(_ monitoring.MetricDefinition) bool {
41
	return true
42
}
43