Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fixes for policystatemetrics #2285

Merged
merged 3 commits into from
Apr 2, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 12 additions & 9 deletions pkg/metrics/policystatemetrics/policystatemetrics.go
Original file line number Diff line number Diff line change
Expand Up @@ -6,22 +6,21 @@ package policystatemetrics
import (
"context"
"strings"
"time"

"github.com/cilium/tetragon/api/v1/tetragon"
"github.com/cilium/tetragon/pkg/logger"
"github.com/cilium/tetragon/pkg/metrics/consts"
"github.com/cilium/tetragon/pkg/observer"
"github.com/cilium/tetragon/pkg/sensors"
"github.com/prometheus/client_golang/prometheus"
)

type policyStateCollector struct {
descriptor *prometheus.Desc
sensorManager *sensors.Manager
descriptor *prometheus.Desc
}

func InitMetrics(registry *prometheus.Registry) {
registry.MustRegister(newPolicyStateCollector(observer.GetSensorManager()))
registry.MustRegister(newPolicyStateCollector())
}

func InitMetricsForDocs(registry *prometheus.Registry) {
Expand All @@ -30,14 +29,13 @@ func InitMetricsForDocs(registry *prometheus.Registry) {

// This metric collector converts the output of ListTracingPolicies into a few
// gauges metrics on collection. Thus, it needs a sensor manager to query.
func newPolicyStateCollector(sensorManager *sensors.Manager) *policyStateCollector {
func newPolicyStateCollector() *policyStateCollector {
return &policyStateCollector{
descriptor: prometheus.NewDesc(
prometheus.BuildFQName(consts.MetricsNamespace, "", "tracingpolicy_loaded"),
"The number of loaded tracing policy by state.",
[]string{"state"}, nil,
),
sensorManager: sensorManager,
}
}

Expand All @@ -46,11 +44,16 @@ func (c *policyStateCollector) Describe(ch chan<- *prometheus.Desc) {
}

func (c *policyStateCollector) Collect(ch chan<- prometheus.Metric) {
if c.sensorManager == nil {

sm := observer.GetSensorManager()
if sm == nil {
logger.GetLogger().Debug("failed retrieving the sensor manager: manager is nil")
return
}
list, err := c.sensorManager.ListTracingPolicies(context.Background())

ctx, cancel := context.WithTimeout(context.TODO(), 900*time.Millisecond)
defer cancel()
list, err := sm.ListTracingPolicies(ctx)
if err != nil {
logger.GetLogger().WithError(err).Warn("error listing tracing policies to collect policies state")
return
Expand Down Expand Up @@ -97,7 +100,7 @@ type policyStateZeroCollector struct {

func newPolicyStateZeroCollector() prometheus.Collector {
return &policyStateZeroCollector{
policyStateCollector: *newPolicyStateCollector(nil),
policyStateCollector: *newPolicyStateCollector(),
}
}

Expand Down
10 changes: 9 additions & 1 deletion pkg/metrics/policystatemetrics/policystatemetrics_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ import (
"strings"
"testing"

"github.com/cilium/tetragon/pkg/observer"
tus "github.com/cilium/tetragon/pkg/testutils/sensors"
"github.com/cilium/tetragon/pkg/tracingpolicy"
"github.com/prometheus/client_golang/prometheus"
Expand All @@ -30,9 +31,16 @@ tetragon_tracingpolicy_loaded{state="load_error"} %d
}

reg := prometheus.NewRegistry()

// NB(kkourt): the policy state collector uses observer.GetSensorManager() to get the sensor
// manager because in the observer tests we only initialize metrics while the observer
// changes for every test (see:
// https://github.com/cilium/tetragon/blob/22eb995b19207ac0ced2dd83950ec8e8aedd122d/pkg/observer/observertesthelper/observer_test_helper.go#L272-L276)
manager := tus.GetTestSensorManager(context.TODO(), t).Manager
observer.SetSensorManager(manager)
t.Cleanup(observer.ResetSensorManager)

collector := newPolicyStateCollector(manager)
collector := newPolicyStateCollector()
reg.Register(collector)

err := manager.AddTracingPolicy(context.TODO(), &tracingpolicy.GenericTracingPolicy{
Expand Down
12 changes: 9 additions & 3 deletions pkg/sensors/manager.go
Original file line number Diff line number Diff line change
Expand Up @@ -249,9 +249,15 @@ func (h *Manager) ListTracingPolicies(ctx context.Context) (*tetragon.ListTracin
retChan: retc,
}

h.sensorCtl <- op
err := <-retc
return op.result, err
select {
case h.sensorCtl <- op:
err := <-retc
return op.result, err

case <-ctx.Done():
return nil, ctx.Err()
}

}

func (h *Manager) RemoveSensor(ctx context.Context, sensorName string) error {
Expand Down
Loading