ClusterCockpit/cc-metric-collector
1
0
Fork 0
mirror of https://github.com/ClusterCockpit/cc-metric-collector.git synced 2025-04-05 21:25:55 +02:00
Code Issues Packages Projects Releases Wiki Activity

add only_metrics, diff_values and derived_values. docs: clarify filter logic, consistency for list

Browse Source
This commit is contained in:
brinkcoder 2025-03-05 01:30:41 +01:00
parent 0e7b4fc936
commit 170a358d79
3 changed files with 168 additions and 109 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

69
collectors/nfs3Metric.md
View File

@ -1,39 +1,52 @@
## `nfs3stat` collector ## `nfs3stat` collector
```json ```json
"nfs3stat": { "nfs3stat": {
"nfsstat" : "/path/to/nfsstat", "nfsstat": "/path/to/nfsstat",
"exclude_metrics": [ "exclude_metrics": [
"nfs3_total" "total"
] ],
"only_metrics": [
"read_diff"
],
"send_abs_values": true,
"send_diff_values": true,
"send_derived_values": true
} }
``` ```
The `nfs3stat` collector reads data from `nfsstat` command and outputs a handful **node** metrics. If a metric is not required, it can be excluded from forwarding it to the sink. There is currently no possibility to get the metrics per mount point. The `nfs3stat` collector reads data from `nfsstat` command and outputs a handful **node** metrics.
Both filtering mechanisms are supported:
- `exclude_metrics`: Excludes the specified metrics. Uses base metric names without the nfs3_ prefix.
- `only_metrics`: If provided, only the listed metrics are collected. This takes precedence over `exclude_metrics`.
Metrics: **Absolute Metrics:**
* `nfs3_total` - `nfs3_total`
* `nfs3_null` - `nfs3_null`
* `nfs3_getattr` - `nfs3_getattr`
* `nfs3_setattr` - `nfs3_setattr`
* `nfs3_lookup` - `nfs3_lookup`
* `nfs3_access` - `nfs3_access`
* `nfs3_readlink` - `nfs3_readlink`
* `nfs3_read` - `nfs3_read`
* `nfs3_write` - `nfs3_write`
* `nfs3_create` - `nfs3_create`
* `nfs3_mkdir` - `nfs3_mkdir`
* `nfs3_symlink` - `nfs3_symlink`
* `nfs3_remove` - `nfs3_remove`
* `nfs3_rmdir` - `nfs3_rmdir`
* `nfs3_rename` - `nfs3_rename`
* `nfs3_link` - `nfs3_link`
* `nfs3_readdir` - `nfs3_readdir`
* `nfs3_readdirplus` - `nfs3_readdirplus`
* `nfs3_fsstat` - `nfs3_fsstat`
* `nfs3_fsinfo` - `nfs3_fsinfo`
* `nfs3_pathconf` - `nfs3_pathconf`
* `nfs3_commit` - `nfs3_commit`
**Diff Metrics:**
For each metric, if `send_diff_values` is enabled, the collector computes the difference (current value minus previous value) and sends it with the suffix `_diff`.
**Derived Metrics:**
For each metric, if `send_derived_values` is enabled, the collector computes the rate (difference divided by the time interval) and sends it with the suffix `_rate`.

114
collectors/nfs4Metric.md
View File

@ -1,62 +1,76 @@
## `nfs4stat` collector ## `nfs4stat` collector
```json ```json
"nfs4stat": { "nfs4stat": {
"nfsstat" : "/path/to/nfsstat", "nfsstat": "/path/to/nfsstat",
"exclude_metrics": [ "exclude_metrics": [
"nfs4_total" "total"
] ],
"only_metrics": [
"read"
],
"send_abs_values": true,
"send_diff_values": true,
"send_derived_values": true
} }
``` ```
The `nfs4stat` collector reads data from `nfsstat` command and outputs a handful **node** metrics. If a metric is not required, it can be excluded from forwarding it to the sink. There is currently no possibility to get the metrics per mount point. The `nfs4stat` collector reads data from `nfsstat` command and outputs a handful **node** metrics.
Both filtering mechanisms are supported:
- `exclude_metrics`: Excludes the specified metrics. Uses base metric names without the nfs4_ prefix.
- `only_metrics`: If provided, only the listed metrics are collected. This takes precedence over `exclude_metrics`.
Metrics: **Absolute Metrics:**
* `nfs4_total` - `nfs4_total`
* `nfs4_null` - `nfs4_null`
* `nfs4_read` - `nfs4_read`
* `nfs4_write` - `nfs4_write`
* `nfs4_commit` - `nfs4_commit`
* `nfs4_open` - `nfs4_open`
* `nfs4_open_conf` - `nfs4_open_conf`
* `nfs4_open_noat` - `nfs4_open_noat`
* `nfs4_open_dgrd` - `nfs4_open_dgrd`
* `nfs4_close` - `nfs4_close`
* `nfs4_setattr` - `nfs4_setattr`
* `nfs4_fsinfo` - `nfs4_fsinfo`
* `nfs4_renew` - `nfs4_renew`
* `nfs4_setclntid` - `nfs4_setclntid`
* `nfs4_confirm` - `nfs4_confirm`
* `nfs4_lock` - `nfs4_lock`
* `nfs4_lockt` - `nfs4_lockt`
* `nfs4_locku` - `nfs4_locku`
* `nfs4_access` - `nfs4_access`
* `nfs4_getattr` - `nfs4_getattr`
* `nfs4_lookup` - `nfs4_lookup`
* `nfs4_lookup_root` - `nfs4_lookup_root`
* `nfs4_remove` - `nfs4_remove`
* `nfs4_rename` - `nfs4_rename`
* `nfs4_link` - `nfs4_link`
* `nfs4_symlink` - `nfs4_symlink`
* `nfs4_create` - `nfs4_create`
* `nfs4_pathconf` - `nfs4_pathconf`
* `nfs4_statfs` - `nfs4_statfs`
* `nfs4_readlink` - `nfs4_readlink`
* `nfs4_readdir` - `nfs4_readdir`
* `nfs4_server_caps` - `nfs4_server_caps`
* `nfs4_delegreturn` - `nfs4_delegreturn`
* `nfs4_getacl` - `nfs4_getacl`
* `nfs4_setacl` - `nfs4_setacl`
* `nfs4_rel_lkowner` - `nfs4_rel_lkowner`
* `nfs4_exchange_id` - `nfs4_exchange_id`
* `nfs4_create_session` - `nfs4_create_session`
* `nfs4_destroy_session` - `nfs4_destroy_session`
* `nfs4_sequence` - `nfs4_sequence`
* `nfs4_get_lease_time` - `nfs4_get_lease_time`
* `nfs4_reclaim_comp` - `nfs4_reclaim_comp`
* `nfs4_secinfo_no` - `nfs4_secinfo_no`
* `nfs4_bind_conn_to_ses` - `nfs4_bind_conn_to_ses`
- `nfs4_seek`
**Diff Metrics:**
For each metric, if `send_diff_values` is enabled, the collector computes the difference and sends it with the suffix `_diff`.
**Derived Metrics:**
For each metric, if `send_derived_values` is enabled, the collector computes the rate (difference divided by the time interval) and sends it with the suffix `_rate`.

94
collectors/nfsMetric.go
View File

@ -3,15 +3,12 @@ package collectors
import ( import (
"encoding/json" "encoding/json"
"fmt" "fmt"
"log"
// "os"
"os/exec" "os/exec"
"strconv" "strconv"
"strings" "strings"
"time" "time"
lp "github.com/ClusterCockpit/cc-energy-manager/pkg/cc-message" lp "github.com/ClusterCockpit/cc-lib/ccMessage"
) )
// First part contains the code for the general NfsCollector. // First part contains the code for the general NfsCollector.
@ -29,8 +26,12 @@ type nfsCollector struct {
tags map[string]string tags map[string]string
version string version string
config struct { config struct {
Nfsstats string `json:"nfsstat"` Nfsstats string `json:"nfsstat"`
ExcludeMetrics []string `json:"exclude_metrics,omitempty"` ExcludeMetrics []string `json:"exclude_metrics,omitempty"`
OnlyMetrics []string `json:"only_metrics,omitempty"`
SendAbsoluteValues bool `json:"send_abs_values,omitempty"`
SendDiffValues bool `json:"send_diff_values,omitempty"`
SendDerivedValues bool `json:"send_derived_values,omitempty"`
} }
data map[string]NfsCollectorData data map[string]NfsCollectorData
} }
@ -46,14 +47,12 @@ func (m *nfsCollector) initStats() error {
continue continue
} }
if lf[1] == m.version { if lf[1] == m.version {
// Use the base metric name (without prefix) for filtering.
name := strings.Trim(lf[3], ":") name := strings.Trim(lf[3], ":")
if _, exist := m.data[name]; !exist { if _, exist := m.data[name]; !exist {
value, err := strconv.ParseInt(lf[4], 0, 64) value, err := strconv.ParseInt(lf[4], 0, 64)
if err == nil { if err == nil {
x := m.data[name] m.data[name] = NfsCollectorData{current: value, last: value}
x.current = value
x.last = value
m.data[name] = x
} }
} }
} }
@ -89,24 +88,42 @@ func (m *nfsCollector) updateStats() error {
return err return err
} }
// shouldOutput returns true if a metric (base name + variant) should be forwarded.
// The variant is "" for absolute, "_diff" for diff, and "_rate" for derived.
// If only_metrics is set, only the metric names that exactly match (base+variant) are forwarded.
func (m *nfsCollector) shouldOutput(baseName, variant string) bool {
finalName := baseName + variant
if len(m.config.OnlyMetrics) > 0 {
for _, n := range m.config.OnlyMetrics {
if n == finalName {
return true
}
}
return false
}
for _, n := range m.config.ExcludeMetrics {
if n == finalName {
return false
}
}
return true
}
func (m *nfsCollector) MainInit(config json.RawMessage) error { func (m *nfsCollector) MainInit(config json.RawMessage) error {
m.config.Nfsstats = string(NFSSTAT_EXEC) m.config.Nfsstats = NFSSTAT_EXEC
// Read JSON configuration
if len(config) > 0 { if len(config) > 0 {
err := json.Unmarshal(config, &m.config) err := json.Unmarshal(config, &m.config)
if err != nil { if err != nil {
log.Print(err.Error())
return err return err
} }
} }
m.meta = map[string]string{ // For backwards compatibility, send_abs_values defaults to true.
"source": m.name, if !m.config.SendAbsoluteValues {
"group": "NFS", m.config.SendAbsoluteValues = true
} }
m.tags = map[string]string{ // Diff and derived default to false if not specified.
"type": "node", m.meta = map[string]string{"source": m.name, "group": "NFS"}
} m.tags = map[string]string{"type": "node"}
// Check if nfsstat is in executable search path
_, err := exec.LookPath(m.config.Nfsstats) _, err := exec.LookPath(m.config.Nfsstats)
if err != nil { if err != nil {
return fmt.Errorf("NfsCollector.Init(): Failed to find nfsstat binary '%s': %v", m.config.Nfsstats, err) return fmt.Errorf("NfsCollector.Init(): Failed to find nfsstat binary '%s': %v", m.config.Nfsstats, err)
@ -123,7 +140,6 @@ func (m *nfsCollector) Read(interval time.Duration, output chan lp.CCMessage) {
return return
} }
timestamp := time.Now() timestamp := time.Now()
m.updateStats() m.updateStats()
prefix := "" prefix := ""
switch m.version { switch m.version {
@ -134,16 +150,32 @@ func (m *nfsCollector) Read(interval time.Duration, output chan lp.CCMessage) {
default: default:
prefix = "nfs" prefix = "nfs"
} }
for name, data := range m.data { for name, data := range m.data {
if _, skip := stringArrayContains(m.config.ExcludeMetrics, name); skip { // For each metric, apply filtering based on the final output name.
continue // Absolute metric: final name = prefix + "_" + name
if m.config.SendAbsoluteValues && m.shouldOutput(name, "") {
absMsg, err := lp.NewMessage(fmt.Sprintf("%s_%s", prefix, name), m.tags, m.meta, map[string]interface{}{"value": data.current}, timestamp)
if err == nil {
absMsg.AddMeta("version", m.version)
output <- absMsg
}
} }
value := data.current - data.last if m.config.SendDiffValues && m.shouldOutput(name, "_diff") {
y, err := lp.NewMessage(fmt.Sprintf("%s_%s", prefix, name), m.tags, m.meta, map[string]interface{}{"value": value}, timestamp) diff := data.current - data.last
if err == nil { diffMsg, err := lp.NewMessage(fmt.Sprintf("%s_%s_diff", prefix, name), m.tags, m.meta, map[string]interface{}{"value": diff}, timestamp)
y.AddMeta("version", m.version) if err == nil {
output <- y diffMsg.AddMeta("version", m.version)
output <- diffMsg
}
}
if m.config.SendDerivedValues && m.shouldOutput(name, "_rate") {
diff := data.current - data.last
rate := float64(diff) / interval.Seconds()
derivedMsg, err := lp.NewMessage(fmt.Sprintf("%s_%s_rate", prefix, name), m.tags, m.meta, map[string]interface{}{"value": rate}, timestamp)
if err == nil {
derivedMsg.AddMeta("version", m.version)
output <- derivedMsg
}
} }
} }
} }
@ -162,14 +194,14 @@ type Nfs4Collector struct {
func (m *Nfs3Collector) Init(config json.RawMessage) error { func (m *Nfs3Collector) Init(config json.RawMessage) error {
m.name = "Nfs3Collector" m.name = "Nfs3Collector"
m.version = `v3` m.version = "v3"
m.setup() m.setup()
return m.MainInit(config) return m.MainInit(config)
} }
func (m *Nfs4Collector) Init(config json.RawMessage) error { func (m *Nfs4Collector) Init(config json.RawMessage) error {
m.name = "Nfs4Collector" m.name = "Nfs4Collector"
m.version = `v4` m.version = "v4"
m.setup() m.setup()
return m.MainInit(config) return m.MainInit(config)
} }