Skip to content

New kubernetes module dashboards#31591

Merged
MichaelKatsoulis merged 8 commits intoelastic:mainfrom
MichaelKatsoulis:new-kubernetes-module-dashboards
May 24, 2022
Merged

New kubernetes module dashboards#31591
MichaelKatsoulis merged 8 commits intoelastic:mainfrom
MichaelKatsoulis:new-kubernetes-module-dashboards

Conversation

@MichaelKatsoulis
Copy link
Copy Markdown
Contributor

@MichaelKatsoulis MichaelKatsoulis commented May 11, 2022

What does this PR do?

This PR modifies existing ones and add more out of the box kubernetes module dashboards as part of #31021

Why is it important?

The Kubernetes dashboards offered so far where using some fields the wrong way and also where missing a lot of important visualisations.

Checklist

  • My code follows the style guidelines of this project
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation
  • I have made corresponding change to the default configuration files
  • I have added tests that prove my fix is effective or that my feature works
  • I have added an entry in CHANGELOG.next.asciidoc or CHANGELOG-developer.next.asciidoc.

Author's Checklist

  • [ ]

How to test this PR locally

  • Create a kubernetes cluster with kind
  • Bring the stack with elastic-package stack up --version=8.3.0-SNAPSHOT -v -d
  • Run Metricbeat with image 8.3.0-SNAPSHOT in kubernetes https://www.elastic.co/guide/en/beats/metricbeat/current/running-on-kubernetes.html
  • Create metricbeat-* data view in Kibana
  • Locally switch to the PR's branch and build Metricbeat with mage build
  • Setup the dashboards with ./metricbeat setup --dashboards -E setup.dashboards.directory=./module/kubernetes/_meta/kibana/ -E setup.kibana.host=http://elastic:changeme@localhost:5601 -e -d "*"
  • Check the dashboards in Kibana
  • For the shake of this testing would be nice that the k8s cluster has some pods,deployments, statefulsets, daemonsets, jobs, cronjobs, pv, pvc, services,namespaces

Related issues

Use cases

Screenshots

Dashboards added:
overview-1
overview-2
dashboards pods
pods-1
dashboards nodes
dashboards deployments
dashboards  statefulset
dashboards volumes
dashboards jobs
dashboards cronjobs
dashboards services
dashboards PVC
dashboards PV:PVC

Logs

@MichaelKatsoulis MichaelKatsoulis requested a review from a team May 11, 2022 11:48
@MichaelKatsoulis MichaelKatsoulis requested a review from a team as a code owner May 11, 2022 11:48
@botelastic botelastic bot added needs_team Indicates that the issue/PR needs a Team:* label and removed needs_team Indicates that the issue/PR needs a Team:* label labels May 11, 2022
@MichaelKatsoulis MichaelKatsoulis removed the request for review from a team May 11, 2022 11:48
@elasticmachine
Copy link
Copy Markdown
Contributor

elasticmachine commented May 11, 2022

💚 Build Succeeded

the below badges are clickable and redirect to their specific view in the CI or DOCS
Pipeline View Test View Changes Artifacts preview preview

Expand to view the summary

Build stats

  • Start Time: 2022-05-24T16:27:21.646+0000

  • Duration: 59 min 27 sec

Test stats 🧪

Test Results
Failed 0
Passed 3534
Skipped 869
Total 4403

💚 Flaky test report

Tests succeeded.

🤖 GitHub comments

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

  • /test : Re-trigger the build.

  • /package : Generate the packages and run the E2E tests.

  • /beats-tester : Run the installation tests with beats-tester.

  • run elasticsearch-ci/docs : Re-trigger the docs validation. (use unformatted text in the comment!)

- Extend documentation about `orchestrator.cluster` fields {pull}30518[30518]
- Enhance Oracle Module: Change tablespace metricset collection period {issue}30948[30948] {pull}31259[#31259]
- Add orchestrator cluster ECS fields in kubernetes events {pull}31341[31341]
- Add new Kubernetes module dashboards {pull}31341[31341]
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Add new Kubernetes module metricbeat dashboards

maybe to change to this desc

"version": 1
},
"coreMigrationVersion": "8.3.0",
"id": "kubernetes-0a672d50-bcb1-11ec-b64f-7dd6e8e82013",
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Can the id change to sth more intuitive in order t understand dashboard file to edit?
I mean that a name kubernetes-cronjob-xxx can help us later on editing specific file.

Think if makes sense to allign filenames with ids

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

These ids are created by Kibana itself and probably have to follow such patterns.

@@ -0,0 +1,203 @@
{
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

So all dashboards created through lens initially and then exported here correct?
That is why we have this folder?

Copy link
Copy Markdown
Contributor

@gizas gizas left a comment

Choose a reason for hiding this comment

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

For the aesthitcs of dashboards we can have a group chat and maybe feedback after the comparisn of diffrent dashboards we have seen from other products.

Only for the main dashboard minor thoughts:

  • I would move memory tiles under numeric ones
  • I would change Pod reserved metrics to a comparison bar (sth more colourfull) that shows directly the health of cluster and make it our central main indicator
  • I would try to keep 3 columns

@mergify
Copy link
Copy Markdown
Contributor

mergify bot commented May 12, 2022

This pull request is now in conflicts. Could you fix it? 🙏
To fixup this pull request, you can check out it locally. See documentation: https://help.github.com/articles/checking-out-pull-requests-locally/

git fetch upstream
git checkout -b new-kubernetes-module-dashboards upstream/new-kubernetes-module-dashboards
git merge upstream/main
git push upstream new-kubernetes-module-dashboards

@gsantoro gsantoro self-requested a review May 23, 2022 11:23
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

8.3-candidate enhancement Team:Cloudnative-Monitoring Label for the Cloud Native Monitoring team

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants