Skip to content

Add client-only message/byte metrics and use them in Network Usage Detail #329

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

Merged
alexbozhenko merged 7 commits into from
May 20, 2026
Merged

Add client-only message/byte metrics and use them in Network Usage Detail #329

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
c34274e
add new metrics
alexbozhenko Feb 25, 2026
b9ef52a
fix merge artifact
alexbozhenko May 14, 2026
0c0c9bc
rename counters
alexbozhenko May 14, 2026
6b4a24e
fix comment
alexbozhenko May 14, 2026
6744407
add test for new metrics
alexbozhenko May 15, 2026
49af316
nit dashboard fixes
alexbozhenko May 15, 2026
e3cdb0f
upd go deps
alexbozhenko May 20, 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
104 changes: 58 additions & 46 deletions docker-compose/grafana/provisioning/dashboards/nats-surveyor-dashboard.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@
"liveNow": false,
"panels": [
{
"description": "Combined messages received by all servers",
"description": "Aggregate messages received by all servers from clients, routes, gateways and leafnodes",
"fieldConfig": {
"defaults": {
"color": {
Expand Down Expand Up @@ -101,7 +101,7 @@
}
},
{
"description": "Combined messages sent by all servers",
"description": "Aggregate messages sent by all servers to clients, routes, gateways and leafnodes",
"fieldConfig": {
"defaults": {
"color": {
Expand Down Expand Up @@ -175,7 +175,7 @@
}
},
{
"description": "Combined bytes received by all servers",
"description": "Aggregate bytes received by all servers from clients, routes, gateways and leafnodes",
"fieldConfig": {
"defaults": {
"color": {
Expand Down Expand Up @@ -249,7 +249,7 @@
}
},
{
"description": "Combined bytes sent by all servers",
"description": "Aggregate bytes sent by all servers to clients, routes, gateways and leafnodes",
"fieldConfig": {
"defaults": {
"color": {
Expand Down Expand Up @@ -2214,7 +2214,7 @@
"type": "timeseries"
},
{
"description": "Combined total messages for all servers",
"description": "Aggregate messages across all servers and all connection types: clients, routes, gateways and leafnodes",
"fieldConfig": {
"defaults": {
"color": {
Expand Down Expand Up @@ -2310,7 +2310,7 @@
}
},
{
"description": "Combined cluster network usage",
"description": "Aggregate network usage across all servers and all connection types: clients, routes, gateways and leafnodes",
"fieldConfig": {
"defaults": {
"color": {
Expand Down Expand Up @@ -3905,14 +3905,14 @@
"id": 24,
"panels": [
{
"description": "Data sent per second",
"description": "Messages/s sent by servers to client connections (excludes routes, gateways, leafnodes)",
"fieldConfig": {
"defaults": {
"color": {
"mode": "palette-classic"
},
"custom": {
"axisLabel": "",
"axisLabel": "msgs/s",
"axisPlacement": "auto",
"barAlignment": 0,
"drawStyle": "line",
Expand All @@ -3930,7 +3930,7 @@
"type": "linear"
},
"showPoints": "never",
"spanNulls": true,
"spanNulls": false,
"stacking": {
"group": "A",
"mode": "none"
Expand All @@ -3954,17 +3954,17 @@
}
]
},
"unit": "Bps"
"unit": "short"
},
"overrides": []
},
"gridPos": {
"h": 7,
"h": 9,
"w": 12,
"x": 0,
"y": 9
},
"id": 26,
"id": 68,
"interval": "",
"options": {
"legend": {
Expand All @@ -3975,32 +3975,35 @@
"min"
],
"displayMode": "table",
"placement": "bottom"
"placement": "bottom",
"sortBy": "Name",
"sortDesc": false
},
"tooltip": {
"mode": "single"
"mode": "multi",
"sort": "none"
}
},
"pluginVersion": "8.3.4",
"targets": [
{
"expr": "rate(nats_core_sent_bytes{server_cluster=~\"$cluster\"}[1m])",
"expr": "rate(nats_core_sent_to_client_msgs_total{server_cluster=~\"$cluster\"}[1m])",
"legendFormat": "{{server_name}}",
"refId": "A"
}
],
"title": "Bytes Sent",
"title": "Messages Sent to Clients",
"type": "timeseries"
},
{
"description": "Data received per second",
"description": "Messages/s received by servers from client connections (excludes routes, gateways, leafnodes)",
"fieldConfig": {
"defaults": {
"color": {
"mode": "palette-classic"
},
"custom": {
"axisLabel": "",
"axisLabel": "msgs/s",
"axisPlacement": "auto",
"barAlignment": 0,
"drawStyle": "line",
Expand All @@ -4018,7 +4021,7 @@
"type": "linear"
},
"showPoints": "never",
"spanNulls": true,
"spanNulls": false,
"stacking": {
"group": "A",
"mode": "none"
Expand All @@ -4042,17 +4045,17 @@
}
]
},
"unit": "Bps"
"unit": "short"
},
"overrides": []
},
"gridPos": {
"h": 7,
"h": 9,
"w": 12,
"x": 12,
"y": 9
},
"id": 27,
"id": 69,
"interval": "",
"options": {
"legend": {
Expand All @@ -4063,25 +4066,28 @@
"min"
],
"displayMode": "table",
"placement": "bottom"
"placement": "bottom",
"sortBy": "Name",
"sortDesc": false
},
"tooltip": {
"mode": "single"
"mode": "multi",
"sort": "none"
}
},
"pluginVersion": "8.3.4",
"targets": [
{
"expr": "rate(nats_core_recv_bytes{server_cluster=~\"$cluster\"}[1m])",
"expr": "rate(nats_core_recv_from_client_msgs_total{server_cluster=~\"$cluster\"}[1m])",
"legendFormat": "{{server_name}}",
"refId": "A"
}
],
"title": "Bytes Received",
"title": "Messages Received from Clients",
"type": "timeseries"
},
{
"description": "Messages sent per second",
"description": "Bytes/s sent by servers to client connections (excludes routes, gateways, leafnodes)",
"fieldConfig": {
"defaults": {
"color": {
Expand All @@ -4106,7 +4112,7 @@
"type": "linear"
},
"showPoints": "never",
"spanNulls": true,
"spanNulls": false,
"stacking": {
"group": "A",
"mode": "none"
Expand All @@ -4130,17 +4136,17 @@
}
]
},
"unit": "short"
"unit": "Bps"
},
"overrides": []
},
"gridPos": {
"h": 7,
"h": 9,
"w": 12,
"x": 0,
"y": 16
"y": 18
},
"id": 68,
"id": 26,
"interval": "",
"options": {
"legend": {
Expand All @@ -4151,25 +4157,28 @@
"min"
],
"displayMode": "table",
"placement": "bottom"
"placement": "bottom",
"sortBy": "Name",
"sortDesc": false
},
"tooltip": {
"mode": "single"
"mode": "multi",
"sort": "none"
}
},
"pluginVersion": "8.3.4",
"targets": [
{
"expr": "rate(nats_core_sent_msgs_count{server_cluster=~\"$cluster\"}[1m])",
"expr": "rate(nats_core_sent_to_client_bytes_total{server_cluster=~\"$cluster\"}[1m])",
"legendFormat": "{{server_name}}",
"refId": "A"
}
],
"title": "Messages Sent",
"title": "Bytes Sent to Clients",
"type": "timeseries"
},
{
"description": "Messages received per second",
"description": "Bytes/s received by servers from client connections (excludes routes, gateways, leafnodes)",
"fieldConfig": {
"defaults": {
"color": {
Expand All @@ -4194,7 +4203,7 @@
"type": "linear"
},
"showPoints": "never",
"spanNulls": true,
"spanNulls": false,
"stacking": {
"group": "A",
"mode": "none"
Expand All @@ -4218,17 +4227,17 @@
}
]
},
"unit": "short"
"unit": "Bps"
},
"overrides": []
},
"gridPos": {
"h": 7,
"h": 9,
"w": 12,
"x": 12,
"y": 16
"y": 18
},
"id": 69,
"id": 27,
"interval": "",
"options": {
"legend": {
Expand All @@ -4239,21 +4248,24 @@
"min"
],
"displayMode": "table",
"placement": "bottom"
"placement": "bottom",
"sortBy": "Name",
"sortDesc": false
},
"tooltip": {
"mode": "single"
"mode": "multi",
"sort": "none"
}
},
"pluginVersion": "8.3.4",
"targets": [
{
"expr": "rate(nats_core_recv_msgs_count{server_cluster=~\"$cluster\"}[1m])",
"expr": "rate(nats_core_recv_from_client_bytes_total{server_cluster=~\"$cluster\"}[1m])",
"legendFormat": "{{server_name}}",
"refId": "A"
}
],
"title": "Messages Received",
"title": "Bytes Received from Clients",
"type": "timeseries"
}
],
Expand Down
4 changes: 2 additions & 2 deletions go.mod
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ require (
github.com/fsnotify/fsnotify v1.10.1
github.com/klauspost/compress v1.18.6
github.com/nats-io/jsm.go v0.4.1
github.com/nats-io/nats-server/v2 v2.14.0
github.com/nats-io/nats-server/v2 v2.14.1
github.com/nats-io/nats.go v1.52.0
github.com/nats-io/nuid v1.0.1
github.com/prometheus/client_golang v1.23.2
Expand Down Expand Up @@ -38,7 +38,7 @@ require (
github.com/munnerz/goautoneg v0.0.0-20191010083416-a7dc8b61c822 // indirect
github.com/nats-io/jwt/v2 v2.8.1 // indirect
github.com/nats-io/nkeys v0.4.15 // indirect
github.com/pelletier/go-toml/v2 v2.2.4 // indirect
github.com/pelletier/go-toml/v2 v2.3.1 // indirect
github.com/pmezard/go-difflib v1.0.0 // indirect
github.com/prometheus/procfs v0.20.1 // indirect
github.com/sagikazarmark/locafero v0.12.0 // indirect
Expand Down
6 changes: 4 additions & 2 deletions go.sum
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49,8 +49,8 @@ github.com/nats-io/jsm.go v0.4.1 h1:hT0Ksd8Jk5wg9uZKiM5EMAJwSoC8zAu1ivPVB5UA9cI=
github.com/nats-io/jsm.go v0.4.1/go.mod h1:rWdrAnJSsCBjjeGbkSvMCB17oPTn+A5kXidixqn0M/E=
github.com/nats-io/jwt/v2 v2.8.1 h1:V0xpGuD/N8Mi+fQNDynXohVvp7ZztevW5io8CUWlPmU=
github.com/nats-io/jwt/v2 v2.8.1/go.mod h1:nWnOEEiVMiKHQpnAy4eXlizVEtSfzacZ1Q43LIRavZg=
github.com/nats-io/nats-server/v2 v2.14.0 h1:+8q0HrDFotwLLcGH/legOEOnowunhK+aZ4GYBIWpQlM=
github.com/nats-io/nats-server/v2 v2.14.0/go.mod h1:ImVUUDvfClJbb6cuJQRc1VmgDCXKM5ds0OoiG9MVOKo=
github.com/nats-io/nats-server/v2 v2.14.1 h1:wXs/a5fw9Hzm3CvuzLxGeIwpjPulSa7gMT3eSuhGkcg=
github.com/nats-io/nats-server/v2 v2.14.1/go.mod h1:4N17zLpuS7WMbG8T9gsE2B7z9hC9PraPyulVBfpK6nU=
github.com/nats-io/nats.go v1.52.0 h1:n3avV4VBsCgsdwh71TppsTwtv+QdPs7ntSKM8qJLGsc=
github.com/nats-io/nats.go v1.52.0/go.mod h1:26HypzazeOkyO3/mqd1zZd53STJN0EjCYF9Uy2ZOBno=
github.com/nats-io/nkeys v0.4.15 h1:JACV5jRVO9V856KOapQ7x+EY8Jo3qw1vJt/9Jpwzkk4=
Expand All @@ -63,6 +63,8 @@ github.com/onsi/gomega v1.39.1 h1:1IJLAad4zjPn2PsnhH70V4DKRFlrCzGBNrNaru+Vf28=
github.com/onsi/gomega v1.39.1/go.mod h1:hL6yVALoTOxeWudERyfppUcZXjMwIMLnuSfruD2lcfg=
github.com/pelletier/go-toml/v2 v2.2.4 h1:mye9XuhQ6gvn5h28+VilKrrPoQVanw5PMw/TB0t5Ec4=
github.com/pelletier/go-toml/v2 v2.2.4/go.mod h1:2gIqNv+qfxSVS7cM2xJQKtLSTLUE9V8t9Stt+h56mCY=
github.com/pelletier/go-toml/v2 v2.3.1 h1:MYEvvGnQjeNkRF1qUuGolNtNExTDwct51yp7olPtrEc=
github.com/pelletier/go-toml/v2 v2.3.1/go.mod h1:2gIqNv+qfxSVS7cM2xJQKtLSTLUE9V8t9Stt+h56mCY=
github.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZbAQM=
github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4=
github.com/prometheus/client_golang v1.23.2 h1:Je96obch5RDVy3FDMndoUsjAhG5Edi49h0RJWRi/o0o=
Expand Down
Loading