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

[Metricbeat] Add STAN dashboard for module #15654

Merged
merged 19 commits into from
Jan 27, 2020

Conversation

devon-kim
Copy link
Contributor

What does this PR do?

Add Kibana dashboards for the Metricbeat STAN module

Why is it important?

NATS module already has a dashboard, STAN module should have one as well for consistency in support

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

Author's Checklist

  • [ ]

Related issues

Screenshots

screenshot

Logs

N/A

@devon-kim devon-kim requested a review from a team as a code owner January 17, 2020 19:19
@devon-kim devon-kim changed the title [Metricbeat] Add dashboard for module [Metricbeat] Add STAN dashboard for module Jan 17, 2020
Copy link
Contributor

@fearful-symmetry fearful-symmetry left a comment

Choose a reason for hiding this comment

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

Looks like you need to run make update :

Error: some files are not up-to-date. Run 'mage fmt update' then review and commit the changes. Modified: [metricbeat/docs/modules/stan.asciidoc metricbeat/docs/modules_list.asciidoc]

@@ -128,6 +128,7 @@ import (
_ "github.com/elastic/beats/metricbeat/module/redis/info"
_ "github.com/elastic/beats/metricbeat/module/redis/key"
_ "github.com/elastic/beats/metricbeat/module/redis/keyspace"
_ "github.com/elastic/beats/metricbeat/module/stan"
Copy link
Member

Choose a reason for hiding this comment

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

It seems that this shouldn't be here. It will be fixed with a make update command inside /beats/metricbeat folder.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Unsure why running make check in my local repo doesn't cause this error though while Travis complains? Been driving me nuts

Copy link
Contributor Author

Choose a reason for hiding this comment

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

make update adds it back after I removed it and ran locally. Something is out of sync and even merging the PR into a local copy of master and running these updates don't reproduce the error for myself either.

Copy link
Member

@ChrsMark ChrsMark left a comment

Choose a reason for hiding this comment

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

Thanks for resolving the problem. I just left some minor suggestions regarding the naming.

Also could you please update the https://github.com/elastic/beats/blob/10c741a8d8a16de9ee317887fcf90036fa0fd214/x-pack/metricbeat/module/stan/module.yml accordingly with the proper filename and dashobard ID?

Last but not least a changelog entry would be needed (

- [Metricbeat][Istio] Add mixer metricset {pull}15696[15696]
) at Metricbeat Added section.

@devon-kim devon-kim force-pushed the stan-kibana-dashboard branch 2 times, most recently from 945b79b to ac050f6 Compare January 23, 2020 19:13
@@ -31244,7 +31244,6 @@ type: object
stan Module



Copy link
Member

Choose a reason for hiding this comment

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

This is not part of this PR right? Could we clean this?

@@ -0,0 +1,36 @@
// Licensed to Elasticsearch B.V. under one or more contributor
Copy link
Member

Choose a reason for hiding this comment

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

I don't think this file should be here? Is there any reason for adding this? I think we should clean this up.

@@ -1,7 +1,6 @@
- key: stan
title: "Stan"
description: >
stan Module
description: stan Module
Copy link
Member

@ChrsMark ChrsMark Jan 24, 2020

Choose a reason for hiding this comment

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

Is this change needed?

@ChrsMark
Copy link
Member

@devon-kim I tried to fix the problems with make check it seems to be ok now, but feel free to comment if I missed anything.

We will need an approval from @fearful-symmetry so as to enable merging.

@ChrsMark ChrsMark added needs_backport PR is waiting to be backported to other branches. v7.6.0 v7.7.0 labels Jan 24, 2020
@fearful-symmetry
Copy link
Contributor

Tests are still failing:

  error loading /go/src/github.com/elastic/beats/x-pack/metricbeat/build/system-tests/run/test_xpack_base.Test.test_dashboards/kibana/7/dashboard/Metricbeat-STAN-overview.json: returned 422 to import file: <nil>. Response: {"statusCode":422,"error":"Unprocessable Entity","message":"Document \"fbc095e0-37cc-11ea-a9c8-152a657da3ab\" has property \"visualization\" which belongs to a more recent version of Kibana (7.4.2)."}

Exiting: Failed to import dashboard: Failed to load directory /go/src/github.com/elastic/beats/x-pack/metricbeat/build/system-tests/run/test_xpack_base.Test.test_dashboards/kibana/7/dashboard:

  error loading /go/src/github.com/elastic/beats/x-pack/metricbeat/build/system-tests/run/test_xpack_base.Test.test_dashboards/kibana/7/dashboard/Metricbeat-STAN-overview.json: returned 422 to import file: <nil>. Response: {"statusCode":422,"error":"Unprocessable Entity","message":"Document \"fbc095e0-37cc-11ea-a9c8-152a657da3ab\" has property \"visualization\" which belongs to a more recent version of Kibana (7.4.2)."}

@ChrsMark
Copy link
Member

Tests are still failing:

  error loading /go/src/github.com/elastic/beats/x-pack/metricbeat/build/system-tests/run/test_xpack_base.Test.test_dashboards/kibana/7/dashboard/Metricbeat-STAN-overview.json: returned 422 to import file: <nil>. Response: {"statusCode":422,"error":"Unprocessable Entity","message":"Document \"fbc095e0-37cc-11ea-a9c8-152a657da3ab\" has property \"visualization\" which belongs to a more recent version of Kibana (7.4.2)."}

Exiting: Failed to import dashboard: Failed to load directory /go/src/github.com/elastic/beats/x-pack/metricbeat/build/system-tests/run/test_xpack_base.Test.test_dashboards/kibana/7/dashboard:

  error loading /go/src/github.com/elastic/beats/x-pack/metricbeat/build/system-tests/run/test_xpack_base.Test.test_dashboards/kibana/7/dashboard/Metricbeat-STAN-overview.json: returned 422 to import file: <nil>. Response: {"statusCode":422,"error":"Unprocessable Entity","message":"Document \"fbc095e0-37cc-11ea-a9c8-152a657da3ab\" has property \"visualization\" which belongs to a more recent version of Kibana (7.4.2)."}

ouch, thanks for noticing! I changed the problematic objects to an older version, let's see if this helps. Maybe we need to update our CI though?

@ChrsMark
Copy link
Member

@fearful-symmetry CI looks good now.

@ChrsMark ChrsMark merged commit e3588da into elastic:master Jan 27, 2020
ChrsMark pushed a commit to ChrsMark/beats that referenced this pull request Jan 27, 2020
@ChrsMark ChrsMark removed the needs_backport PR is waiting to be backported to other branches. label Jan 27, 2020
ChrsMark pushed a commit to ChrsMark/beats that referenced this pull request Jan 27, 2020
@ChrsMark ChrsMark self-assigned this Jan 28, 2020
@ChrsMark ChrsMark added the test-plan Add this PR to be manual test plan label Jan 28, 2020
@ChrsMark ChrsMark mentioned this pull request Jan 30, 2020
@ChrsMark
Copy link
Member

Some issues with the dashboard found that will be fixed by #15960.

@ChrsMark ChrsMark added the test-plan-regression Manually testing this PR found a regression label Jan 31, 2020
@ChrsMark ChrsMark added test-plan-ok This PR passed manual testing and removed test-plan-regression Manually testing this PR found a regression labels Feb 6, 2020
@ChrsMark
Copy link
Member

ChrsMark commented Feb 6, 2020

Tested this with BC5 and works as expected after changes applied on #15960

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement Metricbeat Metricbeat test-plan Add this PR to be manual test plan test-plan-ok This PR passed manual testing v7.6.0 v7.7.0
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants