Merge pull request #2007 from huanggze/dev-custom
feat: custom monitoring
This commit is contained in:
@@ -0,0 +1,99 @@
|
||||
package prometheus
|
||||
|
||||
import (
|
||||
"fmt"
|
||||
"github.com/prometheus/common/model"
|
||||
"github.com/prometheus/prometheus/promql"
|
||||
"github.com/prometheus/prometheus/storage/metric"
|
||||
"kubesphere.io/kubesphere/pkg/models/monitoring/expressions"
|
||||
)
|
||||
|
||||
func init() {
|
||||
expressions.Register("prometheus", labelReplace)
|
||||
}
|
||||
|
||||
func labelReplace(input, ns string) (string, error) {
|
||||
root, err := promql.ParseExpr(input)
|
||||
if err != nil {
|
||||
return "", err
|
||||
}
|
||||
|
||||
SetRecursive(root, ns)
|
||||
if err != nil {
|
||||
return "", err
|
||||
}
|
||||
|
||||
return root.String(), nil
|
||||
}
|
||||
|
||||
// Inspired by https://github.com/openshift/prom-label-proxy
|
||||
func SetRecursive(node promql.Node, namespace string) (err error) {
|
||||
switch n := node.(type) {
|
||||
case *promql.EvalStmt:
|
||||
if err := SetRecursive(n.Expr, namespace); err != nil {
|
||||
return err
|
||||
}
|
||||
case promql.Expressions:
|
||||
for _, e := range n {
|
||||
if err := SetRecursive(e, namespace); err != nil {
|
||||
return err
|
||||
}
|
||||
}
|
||||
case *promql.AggregateExpr:
|
||||
if err := SetRecursive(n.Expr, namespace); err != nil {
|
||||
return err
|
||||
}
|
||||
case *promql.BinaryExpr:
|
||||
if err := SetRecursive(n.LHS, namespace); err != nil {
|
||||
return err
|
||||
}
|
||||
if err := SetRecursive(n.RHS, namespace); err != nil {
|
||||
return err
|
||||
}
|
||||
case *promql.Call:
|
||||
if err := SetRecursive(n.Args, namespace); err != nil {
|
||||
return err
|
||||
}
|
||||
case *promql.ParenExpr:
|
||||
if err := SetRecursive(n.Expr, namespace); err != nil {
|
||||
return err
|
||||
}
|
||||
case *promql.UnaryExpr:
|
||||
if err := SetRecursive(n.Expr, namespace); err != nil {
|
||||
return err
|
||||
}
|
||||
case *promql.NumberLiteral, *promql.StringLiteral:
|
||||
// nothing to do
|
||||
case *promql.MatrixSelector:
|
||||
n.LabelMatchers = enforceLabelMatchers(n.LabelMatchers, namespace)
|
||||
case *promql.VectorSelector:
|
||||
n.LabelMatchers = enforceLabelMatchers(n.LabelMatchers, namespace)
|
||||
default:
|
||||
return fmt.Errorf("promql.Walk: unhandled node type %T", node)
|
||||
}
|
||||
return err
|
||||
}
|
||||
|
||||
func enforceLabelMatchers(matchers metric.LabelMatchers, namespace string) metric.LabelMatchers {
|
||||
var found bool
|
||||
for i, m := range matchers {
|
||||
if m.Name == "namespace" {
|
||||
matchers[i] = &metric.LabelMatcher{
|
||||
Name: "namespace",
|
||||
Type: metric.Equal,
|
||||
Value: model.LabelValue(namespace),
|
||||
}
|
||||
found = true
|
||||
break
|
||||
}
|
||||
}
|
||||
|
||||
if !found {
|
||||
matchers = append(matchers, &metric.LabelMatcher{
|
||||
Name: "namespace",
|
||||
Type: metric.Equal,
|
||||
Value: model.LabelValue(namespace),
|
||||
})
|
||||
}
|
||||
return matchers
|
||||
}
|
||||
@@ -0,0 +1,51 @@
|
||||
package prometheus
|
||||
|
||||
import (
|
||||
"fmt"
|
||||
"github.com/google/go-cmp/cmp"
|
||||
"testing"
|
||||
)
|
||||
|
||||
func TestLabelReplace(t *testing.T) {
|
||||
tests := []struct {
|
||||
expr string
|
||||
expected string
|
||||
expectedErr bool
|
||||
}{
|
||||
{
|
||||
expr: "up",
|
||||
expected: `up{namespace="default"}`,
|
||||
expectedErr: false,
|
||||
},
|
||||
{
|
||||
expr: `up{namespace="random"}`,
|
||||
expected: `up{namespace="default"}`,
|
||||
expectedErr: false,
|
||||
},
|
||||
{
|
||||
expr: `up{namespace="random"} + up{job="test"}`,
|
||||
expected: `up{namespace="default"} + up{job="test",namespace="default"}`,
|
||||
expectedErr: false,
|
||||
},
|
||||
{
|
||||
expr: `@@@@`,
|
||||
expectedErr: true,
|
||||
},
|
||||
}
|
||||
|
||||
for i, tt := range tests {
|
||||
t.Run(fmt.Sprintf("%d", i), func(t *testing.T) {
|
||||
result, err := labelReplace(tt.expr, "default")
|
||||
if err != nil {
|
||||
if !tt.expectedErr {
|
||||
t.Fatal(err)
|
||||
}
|
||||
return
|
||||
}
|
||||
|
||||
if diff := cmp.Diff(result, tt.expected); diff != "" {
|
||||
t.Fatalf("%T differ (-got, +want): %s", tt.expected, diff)
|
||||
}
|
||||
})
|
||||
}
|
||||
}
|
||||
9
pkg/models/monitoring/expressions/registry.go
Normal file
9
pkg/models/monitoring/expressions/registry.go
Normal file
@@ -0,0 +1,9 @@
|
||||
package expressions
|
||||
|
||||
type labelReplaceFn func(expr, ns string) (string, error)
|
||||
|
||||
var ReplaceNamespaceFns = make(map[string]labelReplaceFn)
|
||||
|
||||
func Register(name string, fn labelReplaceFn) {
|
||||
ReplaceNamespaceFns[name] = fn
|
||||
}
|
||||
@@ -19,15 +19,17 @@
|
||||
package monitoring
|
||||
|
||||
import (
|
||||
"kubesphere.io/kubesphere/pkg/models/monitoring/expressions"
|
||||
"kubesphere.io/kubesphere/pkg/simple/client/monitoring"
|
||||
"time"
|
||||
)
|
||||
|
||||
type MonitoringOperator interface {
|
||||
GetMetrics(stmts []string, time time.Time) Metrics
|
||||
GetMetricsOverTime(stmts []string, start, end time.Time, step time.Duration) Metrics
|
||||
GetMetric(expr, namespace string, time time.Time) (monitoring.Metric, error)
|
||||
GetMetricOverTime(expr, namespace string, start, end time.Time, step time.Duration) (monitoring.Metric, error)
|
||||
GetNamedMetrics(metrics []string, time time.Time, opt monitoring.QueryOption) Metrics
|
||||
GetNamedMetricsOverTime(metrics []string, start, end time.Time, step time.Duration, opt monitoring.QueryOption) Metrics
|
||||
GetMetadata(namespace string) Metadata
|
||||
}
|
||||
|
||||
type monitoringOperator struct {
|
||||
@@ -38,14 +40,28 @@ func NewMonitoringOperator(client monitoring.Interface) MonitoringOperator {
|
||||
return &monitoringOperator{client}
|
||||
}
|
||||
|
||||
// TODO(huanggze): reserve for custom monitoring
|
||||
func (mo monitoringOperator) GetMetrics(stmts []string, time time.Time) Metrics {
|
||||
panic("implement me")
|
||||
func (mo monitoringOperator) GetMetric(expr, namespace string, time time.Time) (monitoring.Metric, error) {
|
||||
// Different monitoring backend implementations have different ways to enforce namespace isolation.
|
||||
// Each implementation should register itself to `ReplaceNamespaceFns` during init().
|
||||
// We hard code "prometheus" here because we only support this datasource so far.
|
||||
// In the future, maybe the value should be returned from a method like `mo.c.GetMonitoringServiceName()`.
|
||||
expr, err := expressions.ReplaceNamespaceFns["prometheus"](expr, namespace)
|
||||
if err != nil {
|
||||
return monitoring.Metric{}, err
|
||||
}
|
||||
return mo.c.GetMetric(expr, time), nil
|
||||
}
|
||||
|
||||
// TODO(huanggze): reserve for custom monitoring
|
||||
func (mo monitoringOperator) GetMetricsOverTime(stmts []string, start, end time.Time, step time.Duration) Metrics {
|
||||
panic("implement me")
|
||||
func (mo monitoringOperator) GetMetricOverTime(expr, namespace string, start, end time.Time, step time.Duration) (monitoring.Metric, error) {
|
||||
// Different monitoring backend implementations have different ways to enforce namespace isolation.
|
||||
// Each implementation should register itself to `ReplaceNamespaceFns` during init().
|
||||
// We hard code "prometheus" here because we only support this datasource so far.
|
||||
// In the future, maybe the value should be returned from a method like `mo.c.GetMonitoringServiceName()`.
|
||||
expr, err := expressions.ReplaceNamespaceFns["prometheus"](expr, namespace)
|
||||
if err != nil {
|
||||
return monitoring.Metric{}, err
|
||||
}
|
||||
return mo.c.GetMetricOverTime(expr, start, end, step), nil
|
||||
}
|
||||
|
||||
func (mo monitoringOperator) GetNamedMetrics(metrics []string, time time.Time, opt monitoring.QueryOption) Metrics {
|
||||
@@ -57,3 +73,8 @@ func (mo monitoringOperator) GetNamedMetricsOverTime(metrics []string, start, en
|
||||
ress := mo.c.GetNamedMetricsOverTime(metrics, start, end, step, opt)
|
||||
return Metrics{Results: ress}
|
||||
}
|
||||
|
||||
func (mo monitoringOperator) GetMetadata(namespace string) Metadata {
|
||||
data := mo.c.GetMetadata(namespace)
|
||||
return Metadata{Data: data}
|
||||
}
|
||||
|
||||
@@ -8,3 +8,7 @@ type Metrics struct {
|
||||
TotalPages int `json:"total_page,omitempty" description:"total number of pages"`
|
||||
TotalItems int `json:"total_item,omitempty" description:"page size"`
|
||||
}
|
||||
|
||||
type Metadata struct {
|
||||
Data []monitoring.Metadata `json:"data" description:"actual array of results"`
|
||||
}
|
||||
|
||||
Reference in New Issue
Block a user