Skip to content

ROX-32873: Metrics for process arguments #18794

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.

Sign up for GitHub

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

Open
JoukoVirtanen wants to merge 11 commits into
base: master
Choose a base branch
from
+43 −0
Open

ROX-32873: Metrics for process arguments #18794

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
11 commits
Select commit Hold shift + click to select a range
2a4c7c2
X-Smart-Branch-Parent: master
JoukoVirtanen Mar 11, 2026
70007d6
Added metrics for histogram of argument length, total bytes of argume…
JoukoVirtanen Feb 1, 2026
5f98b79
Removed a redundant metric
JoukoVirtanen Feb 4, 2026
84026e7
Removed recordProcessIndicatorAdded
JoukoVirtanen Feb 10, 2026
9a04b18
Added a metric for the number of characters in arguments
JoukoVirtanen Mar 3, 2026
ea58b3e
Removed processIndicatorsAddedCounter
JoukoVirtanen Mar 4, 2026
b33b185
Removed process_args_size_bytes metric
JoukoVirtanen Mar 8, 2026
1d3e13b
Renamed process_args_size_chars to process_upserted_args_size
JoukoVirtanen Mar 8, 2026
3ce4c0a
The metric takes in the cluster id as a parameter
JoukoVirtanen Mar 8, 2026
0758d89
Process arguments lengths are now specified by cluster and namespace
JoukoVirtanen Mar 12, 2026
ccc26a8
There is just one histogram for central. Argument lengths are still b…
JoukoVirtanen Mar 13, 2026
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
1 change: 1 addition & 0 deletions central/processindicator/datastore/datastore_impl.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -98,6 +98,7 @@ func (ds *datastoreImpl) AddProcessIndicators(ctx context.Context, indicators ..
return err
}
} else {
recordProcessIndicatorsBatchAdded(identifierBatch)
log.Debugf("successfully added a batch of %d process indicators", len(identifierBatch))
}
}
Expand Down
42 changes: 42 additions & 0 deletions central/processindicator/datastore/metrics.go
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,10 @@
package datastore

import (
"unicode/utf8"

"github.com/prometheus/client_golang/prometheus"
"github.com/stackrox/rox/generated/storage"
"github.com/stackrox/rox/pkg/metrics"
)

Expand All @@ -26,6 +29,21 @@ var (
Name: "process_pruning_cache_misses",
Help: "Number of times we miss the cache, and have to evaluate, when trying to prune processes",
})

processUpsertedArgsSizeHistogram = prometheus.NewHistogram(prometheus.HistogramOpts{
Namespace: metrics.PrometheusNamespace,
Subsystem: metrics.CentralSubsystem.String(),
Name: "process_upserted_args_size",
Help: "Distribution of process argument sizes in characters for upserted indicators",
Buckets: []float64{0, 128, 256, 512, 1024, 2048, 4096, 8192, 16384, 32768, 65536},
})

processUpsertedArgsSizeTotal = prometheus.NewCounterVec(prometheus.CounterOpts{
Namespace: metrics.PrometheusNamespace,
Subsystem: metrics.CentralSubsystem.String(),
Name: "process_upserted_args_size_total",
Help: "Total process argument sizes in characters by cluster and namespace",
}, []string{"cluster", "namespace"})
)

func incrementPrunedProcessesMetric(num int) {
Expand All @@ -40,10 +58,34 @@ func incrementProcessPruningCacheMissesMetric() {
processPruningCacheMisses.Inc()
}

// getProcessArgsSizeChars safely calculates the size of process args in characters (runes).
// Returns 0 if signal or args are nil/empty.
func getProcessArgsSizeChars(indicator *storage.ProcessIndicator) int {
if indicator == nil || indicator.GetSignal() == nil {
return 0
}
return utf8.RuneCountInString(indicator.GetSignal().GetArgs())
}

// recordProcessIndicatorsBatchAdded records metrics for a batch of process indicators successfully written to DB.
func recordProcessIndicatorsBatchAdded(indicators []*storage.ProcessIndicator) {
for _, indicator := range indicators {
argsSizeChars := getProcessArgsSizeChars(indicator)
clusterID := indicator.GetClusterId()
namespace := indicator.GetNamespace()

processUpsertedArgsSizeHistogram.Observe(float64(argsSizeChars))

processUpsertedArgsSizeTotal.WithLabelValues(clusterID, namespace).Add(float64(argsSizeChars))
}
}

func init() {
prometheus.MustRegister(
prunedProcesses,
processPruningCacheHits,
processPruningCacheMisses,
processUpsertedArgsSizeHistogram,
processUpsertedArgsSizeTotal,
)
}
Loading