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

Add a fully-featured dashboard for Enterprise Search #28415

Merged
merged 6 commits into from
Oct 19, 2021

Conversation

kovyrin
Copy link
Contributor

@kovyrin kovyrin commented Oct 13, 2021

What does this PR do?

This PR adds a fully-featured Kibana dashboard to be used with the new Enterprise Search module for metricbeat.
See the Screenshots section below for an example screenshot.

Why is it important?

Enterprise Search users need to be able to visualize the metrics produced by the new Enterprise Search metricbeat module. Since the Stack Monitoring integration is unlikely to land in 7.16 (elastic/kibana#114303), we want to ship the Kibana dashboard version of the same visualizations to make it easier to our users to consume new metrics in an efficient way.

Checklist

  • My code follows the style guidelines of this project
  • 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

  • Tested the new dashboard by importing it via the metricbeat setup command

How to test this PR locally

  1. Go to x-pack/metricbeat
  2. Build metricbeat via mage build
  3. Import the dashboards:
./metricbeat setup --dashboards -E setup.dashboards.enabled=true -E setup.dashboards.always_kibana=true -E setup.kibana.host=http://localhost:5601/xtu -E setup.kibana.username=elastic -E setup.kibana.password=changeme -E setup.dashboards.directory=build/kibana -e -v
  1. Run metricbeat with the enterprise search module against an Enterprise Search instance
  2. Open Kibana and see some glorious graphs!

Screenshots

localhost_5601_xtu_app_dashboards

@kovyrin kovyrin self-assigned this Oct 13, 2021
@botelastic botelastic bot added the needs_team Indicates that the issue/PR needs a Team:* label label Oct 13, 2021
@mergify
Copy link
Contributor

mergify bot commented Oct 13, 2021

This pull request does not have a backport label. Could you fix it @kovyrin? 🙏
To fixup this pull request, you need to add the backport labels for the needed
branches, such as:

  • backport-v./d./d./d is the label to automatically backport to the 7./d branch. /d is the digit

NOTE: backport-skip has been added to this pull request.

@mergify mergify bot added the backport-skip Skip notification from the automated backport with mergify label Oct 13, 2021
@kovyrin kovyrin added the Team:Integrations Label for the Integrations team label Oct 13, 2021
@elasticmachine
Copy link
Collaborator

Pinging @elastic/integrations (Team:Integrations)

@botelastic botelastic bot removed the needs_team Indicates that the issue/PR needs a Team:* label label Oct 13, 2021
@kovyrin kovyrin added the backport-v7.16.0 Automated backport with mergify label Oct 13, 2021
@mergify mergify bot removed the backport-skip Skip notification from the automated backport with mergify label Oct 13, 2021
@kovyrin kovyrin requested review from ruflin and sayden October 13, 2021 21:34
@elasticmachine
Copy link
Collaborator

elasticmachine commented Oct 13, 2021

💚 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

  • Duration: 81 min 50 sec

❕ Flaky test report

No test was executed to be analysed.

🤖 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.

Copy link
Contributor

@sayden sayden left a comment

Choose a reason for hiding this comment

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

Linting failed, I guess it's the indentation of x-pack/metricbeat/module/enterprisesearch/module.yml. Try a mage fmt update

@kovyrin kovyrin requested review from sayden and richkuz October 19, 2021 19:20
@kovyrin
Copy link
Contributor Author

kovyrin commented Oct 19, 2021

OK, CI tests pass and my local testing seems to work as well. What's the next step for getting this shipped? :-)

@kovyrin kovyrin requested a review from carlosdelest October 19, 2021 19:27
@richkuz
Copy link

richkuz commented Oct 19, 2021

I did a cursory review of the JSON file and looked at the screenshots. LGTM. 👍

I will wait for a proper build candidate and test it end-to-end after the merge.

@kovyrin
Copy link
Contributor Author

kovyrin commented Oct 19, 2021

For future reference: the file here was generated by the following command:

go run dev-tools/cmd/dashboards/export_dashboards.go -kibana http://elastic:changeme@localhost:5601 -yml x-pack/metricbeat/module/enterprisesearch/module.yml -folder x-pack/metricbeat/module/enterprisesearch

@kovyrin kovyrin merged commit 6431e41 into elastic:master Oct 19, 2021
@kovyrin kovyrin deleted the kovyrin/ent-search-new-dashboard branch October 19, 2021 19:50
mergify bot pushed a commit that referenced this pull request Oct 19, 2021
* Add a fully-featured dashboard for Enterprise Search

* Update description

* Correct title format and better description

* Re-import the dashboard from a 7.x kibana

* Switch to the default index pattern

(cherry picked from commit 6431e41)
Icedroid pushed a commit to Icedroid/beats that referenced this pull request Nov 1, 2021
* Add a fully-featured dashboard for Enterprise Search

* Update description

* Correct title format and better description

* Re-import the dashboard from a 7.x kibana

* Switch to the default index pattern
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backport-v7.16.0 Automated backport with mergify enhancement Team:Integrations Label for the Integrations team
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants