chore(agent-gateway): collapse sysmon/snmp metrics shadow flags to single enable [#3788] #3815
No reviewers
Labels
No labels
1week
2weeks
Failed compliance check
IP cameras
NATS
Possible security concern
Review effort 1/5
Review effort 2/5
Review effort 3/5
Review effort 4/5
Review effort 5/5
UI
aardvark
accessibility
amd64
api
arm64
auth
back-end
bgp
blog
bug
build
checkers
ci-cd
cleanup
cnpg
codex
core
dependencies
device-management
documentation
duplicate
dusk
ebpf
enhancement
eta 1d
eta 1hr
eta 3d
eta 3hr
feature
fieldsurvey
github_actions
go
good first issue
help wanted
invalid
javascript
k8s
log-collector
mapper
mtr
needs-triage
netflow
network-sweep
observability
oracle
otel
plug-in
proton
python
question
reddit
redhat
research
rperf
rperf-checker
rust
sdk
security
serviceradar-agent
serviceradar-agent-gateway
serviceradar-web
serviceradar-web-ng
siem
snmp
sysmon
topology
ubiquiti
wasm
wontfix
zen-engine
No milestone
No project
No assignees
1 participant
Notifications
Due date
No due date set.
Dependencies
No dependencies set.
Reference
carverauto/serviceradar!3815
Loading…
Add table
Add a link
Reference in a new issue
No description provided.
Delete branch "work/3788-collapse-metrics-shadow-flags"
Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?
What
Removes the migration-era
*_METRICS_SHADOW_ENABLEDflag aliasing for the gateway sysmon/snmp metric publishers (#3788 DELETE list / #3801 tech-debt).Why
The "shadow" framing predates the JetStream cutover: these metrics are now published on the primary
metrics.*path, not as a shadow of a primary direct-to-DB write. The fallback is also dead in practice —AGENT_GATEWAY_{SYSMON,SNMP}_METRICS_ENABLEDenv var (it resolves the*MetricsShadowEnabledvalues-key alias at template time), andvalues.yamlalready uses the newsysmonMetricsEnabled/snmpMetricsEnabledkeys.Change
runtime.exs: read onlyAGENT_GATEWAY_{SYSMON,SNMP}_METRICS_ENABLED(default"true"), dropping the*_SHADOW_ENABLED||fallback. Now matches the plugin/otlp publisher config shape.agent-gateway.yaml: drop the deprecatedelse if hasKey $gateway "*MetricsShadowEnabled"branches.Safety
Behavior-preserving for the shipped config —
helm templatestill rendersAGENT_GATEWAY_SYSMON_METRICS_ENABLED="true"andAGENT_GATEWAY_SNMP_METRICS_ENABLED="true". Repo-wide grep confirms no remainingSHADOW_ENABLED/MetricsShadowEnabledreferences.mix compileclean;runtime.exspassesmix format --check-formatted.Refs #3788, #3801
Finding: rollout docs still instruct operators to use the removed shadow terminology/knobs.
This PR removes the
*MetricsShadowEnabledHelm aliases and*_METRICS_SHADOW_ENABLEDruntime fallback, butdocs/docs/anomaly-detection.mdlines 155-159 still says to enable SNMP and sysmon shadow subjects during rollout. After this change, the supported knobs are the primary metrics enable flags, so the runbook points operators at terminology/config that no longer exists.Please update that guidance as part of the same cleanup, or explicitly call out the new
AGENT_GATEWAY_{SYSMON,SNMP}_METRICS_ENABLED/Helm values.814f1fadf3a74f12db17Addressed in the latest push (
a74f12db17e0): updateddocs/docs/anomaly-detection.mdrollout step 2 to drop the removed "shadow subjects" wording and point operators at the primary enable knobs —AGENT_GATEWAY_{SNMP,SYSMON}_METRICS_ENABLED(and thegateway.snmpMetricsEnabled/gateway.sysmonMetricsEnabledHelm values). Repo-wide grep confirms no remainingshadowreferences in the doc.