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][Kibana][status] metrics is optional #20956

Conversation

afharo
Copy link
Member

@afharo afharo commented Sep 3, 2020

What does this PR do?

Kibana might not return the metrics property to the /api/status request. This PR makes that property optional in the schema.

Why is it important?

In #20772, we've noticed some flaky tests. These changes will make Metricbeat more resilient.

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

I'd say we can make it work if in the test environment, Kibana takes longer than 1 minute to start, we've seen than the first green /api/status response might not contain the metrics data (it can take Kibana up to 5s to populate it after the startup).

Related issues

Use cases

Screenshots

Logs

@afharo afharo added Metricbeat Metricbeat Feature:Stack Monitoring breaking change Team:Services (Deprecated) Label for the former Integrations-Services team release-note:breaking The content should be included as a breaking change labels Sep 3, 2020
@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 Sep 3, 2020
@afharo afharo force-pushed the metricbeat/kibana/status/metrics-is-optional branch from 6e85e5e to cc3d6e1 Compare September 3, 2020 10:53
@elasticmachine
Copy link
Collaborator

💚 Build Succeeded

Pipeline View Test View Changes Artifacts preview

Expand to view the summary

Build stats

  • Build Cause: [Pull request #20956 opened]

  • Start Time: 2020-09-03T10:54:28.117+0000

  • Duration: 75 min 47 sec

Test stats 🧪

Test Results
Failed 0
Passed 3156
Skipped 689
Total 3845

@afharo afharo marked this pull request as ready for review September 3, 2020 12:09
@elasticmachine
Copy link
Collaborator

Pinging @elastic/stack-monitoring (Stack monitoring)

@elasticmachine
Copy link
Collaborator

Pinging @elastic/integrations-services (Team:Services)

Copy link
Contributor

@ycombinator ycombinator left a comment

Choose a reason for hiding this comment

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

LGTM.

@ycombinator ycombinator added needs_backport PR is waiting to be backported to other branches. v8.0.0 v7.10.0 labels Sep 3, 2020
@afharo
Copy link
Member Author

afharo commented Sep 3, 2020

@ycombinator I noticed the team @elastic/kibana-platform is planning to migrate this endpoint to Kibana's New Platform and metrics should exist in every response in the next release. Should we still go ahead and merge this PR?
elastic/kibana#76054

@ycombinator
Copy link
Contributor

@afharo In that case let's not merge this PR.

@afharo
Copy link
Member Author

afharo commented Sep 3, 2020

I'll double confirm with them and will come back.

@ycombinator
Copy link
Contributor

I'll double confirm with them and will come back.

@afharo Any news here?

@afharo
Copy link
Member Author

afharo commented Sep 9, 2020

Yes, @joshdover is working on elastic/kibana#76054 (that triggered elastic/kibana#76730). Both PRs should eventually ensure metrics are always available.
He mentioned to me he'd close this PR once he's done with the changes and can confirm the expected behaviour 🙂 Sorry I didn't share the news with you.

@afharo
Copy link
Member Author

afharo commented Sep 17, 2020

The fix in Kibana has been merged! elastic/kibana#76054

Closing this PR.

@afharo afharo closed this Sep 17, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
breaking change Feature:Stack Monitoring Metricbeat Metricbeat needs_backport PR is waiting to be backported to other branches. release-note:breaking The content should be included as a breaking change Team:Services (Deprecated) Label for the former Integrations-Services team v7.10.0 v8.0.0
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants