Fix visualizations on the Kubernetes overview dashboard by tetianakravchenko · Pull Request #2151 · elastic/integrations

tetianakravchenko · 2021-11-10T15:13:47Z

Signed-off-by: Tetiana Kravchenko tetiana.kravchenko@elastic.co

What does this PR do?

There are two visualizations on the [Metrics Kubernetes] Overview dashboard with 2 broken visualizations (Desired Pods and Unavailable Pods), reason for that: index pattern is overridden (they have "yes" checked), but series_Index_pattern is not specified:

(note that in the picture as an index_pattern was picked logs-*)

index pattern shouldn't be overridden.

Checklist

I have reviewed tips for building integrations and this pull request is aligned with them.
I have verified that all data streams collect metrics or logs.
I have added an entry to my package's changelog.yml file.
If I'm introducing a new feature, I have modified the Kibana version constraint in my package's manifest.yml file to point to the latest Elastic stack release (e.g. ^7.13.0).

Author's Checklist

[ ]

How to test this PR locally

Related issues

Closes Visualizations on the Kubernetes overview dashboard override index but shouldn't beats#28792

Screenshots

Add here screenshots presenting:

Kibana UI forms presenting configuration options exposed by the integration:
local setup:

…ide_index_pattern Signed-off-by: Tetiana Kravchenko <tetiana.kravchenko@elastic.co>

elasticmachine · 2021-11-10T15:21:37Z

💚 Build Succeeded

the below badges are clickable and redirect to their specific view in the CI or DOCS

Expand to view the summary

Build stats

Start Time: 2021-11-11T14:28:01.713+0000
Duration: 31 min 30 sec
Commit: 2978a9f

Test stats 🧪

Test	Results
Failed	0
Passed	114
Skipped	0
Total	114

🤖 GitHub comments

To re-run your PR in the CI, just comment with:

/test : Re-trigger the build.

Signed-off-by: Tetiana Kravchenko <tetiana.kravchenko@elastic.co>

MichaelKatsoulis · 2021-11-11T08:05:02Z

@tetianakravchenko I noticed there is another visualisation with override_index_pattern: 1. It is the Available pods. Why not changing that one too?

tetianakravchenko · 2021-11-11T09:03:41Z

@MichaelKatsoulis for consistency I can adjust this visualisation as well. the reason why it works:
index pattern is actually defined:

it is defined here - code

MichaelKatsoulis · 2021-11-11T09:53:57Z

@MichaelKatsoulis for consistency I can adjust this visualisation as well. the reason why it works: index pattern is

Ok. Thanks for the explanation. I would add it for consistency as you said.

MichaelKatsoulis · 2021-11-11T09:54:47Z

packages/kubernetes/changelog.yml

 # newer versions go on top
+- version: "1.4.1"
+  changes:
+    - description: Fix visualizations on the Kubernetes overview dashboard


nit: The description does not reflect what was fixed

ChrsMark

👍🏼

…description Signed-off-by: Tetiana Kravchenko <tetiana.kravchenko@elastic.co>

tetianakravchenko · 2021-11-11T13:54:51Z

packages/kubernetes/kibana/visualization/kubernetes-da1ff7c0-30ed-11e7-b9e5-2b5b07213ab3.json

                        "seperate_axis": 0,
-                        "series_index_pattern": "*",
                        "series_interval": "10s",
-                        "series_time_field": "@timestamp",


@MichaelKatsoulis @ChrsMark fyi: I've also removed this field to align all 3 visualisations: Desired pods, Available Pods and Unavailable Pods.
as I understand it is a default value anyway:

(update) note: this field was removed from 2 out of 3 visualisations: Available pods [Metrics Kubernetes] and Desired pods [Metrics Kubernetes] - there was no such field in Unavailable pods [Metrics Kubernetes]

Hmm, I'm not sure about what this field is doing. Could you provide more context?

@ChrsMark not sure where is the best place to verify: from https://github.com/elastic/kibana/blob/main/src/plugins/vis_types/timeseries/server/lib/vis_data/get_interval_and_timefield.ts#L28: timeField will be set to series.series_time_field if override_index_pattern is set to true, in other case - will be set to panel.time_field, which is set for visualisations, touched in this PR (one of them:

integrations/packages/kubernetes/kibana/visualization/kubernetes-da1ff7c0-30ed-11e7-b9e5-2b5b07213ab3.json

Line 75 in 2978a9f

"time_field": "@timestamp",

)

Ok, but why we remove it here? Is it related to to the issue that this PR solves or it is just an extra improvement? I'm trying to understand what will actually be different with this change and why it was like this in the past.

no, it is not related to the issue. It was removed to make those 3 visualisations configs consistent:

see this comment - so now Desired pods, Available pods and Unavailable pods have the same settings: no data view override, no override of index, no override of time field

@ChrsMark I am not sure why it was added here initially, see initial PR #70, all those setting seems to be not changed after the first PR:
"Unavailable pods [Metrics Kubernetes] ECS": has override enabled, neither series_time_field nor series_index_pattern are set
"Available pods [Metrics Kubernetes] ECS": has override enabled, both "series_index_pattern" and "series_time_field" are set
"Desired pods [Metrics Kubernetes] ECS": has override enabled. "series_time_field": "@timestamp" is set, no series_index_pattern
maybe you remember why it was set this way?

Gotcha, thanks for elaborating on this! About history, the dashboards have been imported from Beats so this one should be there for quite a long.

…rd; align visualisations with changes in elastic/integrations#2151 Signed-off-by: Tetiana Kravchenko <tetiana.kravchenko@elastic.co>

…rd (#29676) * Remove overriding of index pattern on the Kubernetes overview dashboard; align visualisations with changes in elastic/integrations#2151 Signed-off-by: Tetiana Kravchenko <tetiana.kravchenko@elastic.co> * add PR number in changelog Signed-off-by: Tetiana Kravchenko <tetiana.kravchenko@elastic.co>

…rd (#29676) * Remove overriding of index pattern on the Kubernetes overview dashboard; align visualisations with changes in elastic/integrations#2151 Signed-off-by: Tetiana Kravchenko <tetiana.kravchenko@elastic.co> * add PR number in changelog Signed-off-by: Tetiana Kravchenko <tetiana.kravchenko@elastic.co> (cherry picked from commit 896b7e4)

…ernetes overview dashboard (#29792) * Remove overriding of index pattern on the Kubernetes overview dashboard (#29676) * Remove overriding of index pattern on the Kubernetes overview dashboard; align visualisations with changes in elastic/integrations#2151 Signed-off-by: Tetiana Kravchenko <tetiana.kravchenko@elastic.co> * add PR number in changelog Signed-off-by: Tetiana Kravchenko <tetiana.kravchenko@elastic.co> (cherry picked from commit 896b7e4) * Update CHANGELOG.next.asciidoc Co-authored-by: Tetiana Kravchenko <tetiana.kravchenko@elastic.co>

fix visualizations on the Kubernetes overview dashboard: remove overr…

4b15914

…ide_index_pattern Signed-off-by: Tetiana Kravchenko <tetiana.kravchenko@elastic.co>

add pr link in changelog

95fa351

Signed-off-by: Tetiana Kravchenko <tetiana.kravchenko@elastic.co>

tetianakravchenko requested review from ChrsMark and MichaelKatsoulis November 10, 2021 16:37

bump k8s manifest version to pass check

0349782

Signed-off-by: Tetiana Kravchenko <tetiana.kravchenko@elastic.co>

MichaelKatsoulis reviewed Nov 11, 2021

View reviewed changes

MichaelKatsoulis approved these changes Nov 11, 2021

View reviewed changes

ChrsMark approved these changes Nov 11, 2021

View reviewed changes

aling visualisations: desired/available and unavailable pods; change …

2978a9f

…description Signed-off-by: Tetiana Kravchenko <tetiana.kravchenko@elastic.co>

tetianakravchenko commented Nov 11, 2021

View reviewed changes

ChrsMark approved these changes Nov 15, 2021

View reviewed changes

tetianakravchenko merged commit 4f294fd into elastic:master Nov 15, 2021

tetianakravchenko deleted the fix-28792_kubernetes_overview branch November 15, 2021 11:16

tetianakravchenko mentioned this pull request Jan 4, 2022

Remove overriding of index pattern on the Kubernetes overview dashboard elastic/beats#29676

Merged

6 tasks

Conversation

tetianakravchenko commented Nov 10, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

What does this PR do?

Checklist

Author's Checklist

How to test this PR locally

Related issues

Screenshots

Uh oh!

elasticmachine commented Nov 10, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

💚 Build Succeeded

Build stats

Test stats 🧪

🤖 GitHub comments

Uh oh!

MichaelKatsoulis commented Nov 11, 2021

Uh oh!

tetianakravchenko commented Nov 11, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

MichaelKatsoulis commented Nov 11, 2021

Uh oh!

MichaelKatsoulis Nov 11, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

tetianakravchenko Nov 11, 2021

Choose a reason for hiding this comment

Uh oh!

ChrsMark left a comment

Choose a reason for hiding this comment

Uh oh!

tetianakravchenko Nov 11, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

ChrsMark Nov 11, 2021

Choose a reason for hiding this comment

Uh oh!

tetianakravchenko Nov 11, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

ChrsMark Nov 15, 2021

Choose a reason for hiding this comment

Uh oh!

tetianakravchenko Nov 15, 2021

Choose a reason for hiding this comment

Uh oh!

tetianakravchenko Nov 15, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

ChrsMark Nov 15, 2021

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

tetianakravchenko commented Nov 10, 2021 •

edited

Loading

elasticmachine commented Nov 10, 2021 •

edited

Loading

tetianakravchenko commented Nov 11, 2021 •

edited

Loading

MichaelKatsoulis Nov 11, 2021 •

edited

Loading

tetianakravchenko Nov 11, 2021 •

edited

Loading

tetianakravchenko Nov 11, 2021 •

edited

Loading

tetianakravchenko Nov 15, 2021 •

edited

Loading