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

Fix static mode operational dash for agent-logs namespace #4300

Merged
merged 9 commits into from
Jun 29, 2023
Prev Previous commit
Next Next commit
generate dash
  • Loading branch information
thampiotr committed Jun 29, 2023
commit 000aa344b85494ccecdd0591a3c0af55a39f9bbb
32 changes: 16 additions & 16 deletions example/docker-compose/grafana/dashboards/agent-operational.json
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@
"thresholds": [ ],
"timeFrom": null,
"timeShift": null,
"title": "GCs",
"title": "GCs [count/s]",
"tooltip": {
"shared": true,
"sort": 2,
Expand Down Expand Up @@ -132,7 +132,7 @@
"thresholds": [ ],
"timeFrom": null,
"timeShift": null,
"title": "Go Heap",
"title": "Go Heap In Use",
"tooltip": {
"shared": true,
"sort": 2,
Expand Down Expand Up @@ -284,7 +284,7 @@
"thresholds": [ ],
"timeFrom": null,
"timeShift": null,
"title": "CPU",
"title": "CPU Usage [time/s]",
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The only problem with including units in the title that I can think of, is that if someone edits an axis on the dashboard to have different units it might be confusing, or they'd have to update the title manually.

Wouldn't it be better to just set the unit in the Grafana settings for each axis, and then Grafana will just display them on each axis?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think if someone changes the axis, they can also change the title. I didn't put unit everywhere as it's sometimes obvious (e.g. bytes), but I think it's helpful for some less obvious charts, like CPU Usage which is "how many seconds of CPU time was used every second".

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Even in those cases I think I'd prefer to have the units on the actual axes instead of in the title. But I'm ok with having this in the title like this, it's still an improvement and I think it'll work ok.

"tooltip": {
"shared": true,
"sort": 2,
Expand Down Expand Up @@ -360,7 +360,7 @@
"thresholds": [ ],
"timeFrom": null,
"timeShift": null,
"title": "WSS",
"title": "Working Set Size",
"tooltip": {
"shared": true,
"sort": 2,
Expand All @@ -376,7 +376,7 @@
},
"yaxes": [
{
"format": "short",
"format": "decbytes",
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice! Finally we won't have to switch this manually 😄 @tpaschalis

"label": null,
"logBase": 1,
"max": null,
Expand Down Expand Up @@ -436,7 +436,7 @@
"thresholds": [ ],
"timeFrom": null,
"timeShift": null,
"title": "Bad Words",
"title": "Promtail Bad Words",
"tooltip": {
"shared": true,
"sort": 2,
Expand Down Expand Up @@ -524,7 +524,7 @@
"thresholds": [ ],
"timeFrom": null,
"timeShift": null,
"title": "RX by Pod",
"title": "Received Bytes [B/s]",
"tooltip": {
"shared": true,
"sort": 2,
Expand All @@ -540,7 +540,7 @@
},
"yaxes": [
{
"format": "short",
"format": "Bps",
"label": null,
"logBase": 1,
"max": null,
Expand Down Expand Up @@ -600,7 +600,7 @@
"thresholds": [ ],
"timeFrom": null,
"timeShift": null,
"title": "TX by Pod",
"title": "Transmitted Bytes [B/s]",
"tooltip": {
"shared": true,
"sort": 2,
Expand All @@ -616,7 +616,7 @@
},
"yaxes": [
{
"format": "short",
"format": "Bps",
"label": null,
"logBase": 1,
"max": null,
Expand Down Expand Up @@ -688,7 +688,7 @@
"thresholds": [ ],
"timeFrom": null,
"timeShift": null,
"title": "Bytes/Series/Pod",
"title": "Heap Used per Series per Pod",
"tooltip": {
"shared": true,
"sort": 2,
Expand Down Expand Up @@ -764,7 +764,7 @@
"thresholds": [ ],
"timeFrom": null,
"timeShift": null,
"title": "Bytes/Series",
"title": "Avg Heap Used per Series",
"tooltip": {
"shared": true,
"sort": 2,
Expand Down Expand Up @@ -840,7 +840,7 @@
"thresholds": [ ],
"timeFrom": null,
"timeShift": null,
"title": "Series/Pod",
"title": "Series Count per Pod",
"tooltip": {
"shared": true,
"sort": 2,
Expand Down Expand Up @@ -916,7 +916,7 @@
"thresholds": [ ],
"timeFrom": null,
"timeShift": null,
"title": "Series/Config",
"title": "Series per Config",
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

TBH I personally find / notation such as Series/Config easier to read.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It does look a bit worse when we have Heap Used /Series/Pod - looks like some kind of resource path or hierarchy. Since per fits on the screen, I'd prefer to use that.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

That's true, let's try out the "per" notation - I'd be happy with it

"tooltip": {
"shared": true,
"sort": 2,
Expand Down Expand Up @@ -992,7 +992,7 @@
"thresholds": [ ],
"timeFrom": null,
"timeShift": null,
"title": "Series",
"title": "Total Series",
"tooltip": {
"shared": true,
"sort": 2,
Expand Down Expand Up @@ -1128,7 +1128,7 @@
"useTags": false
},
{
"allValue": "grafana-agent-.*",
"allValue": ".*agent.*",
"current": {
"selected": true,
"text": "All",
Expand Down