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

[Uptime] Add owner and description properties to Uptime's kibana.json #101963

Merged

Conversation

justinkambic
Copy link
Contributor

Summary

It's been announced that all Kibana plugins must add these fields to their kibana.json files.

I've added some initial copy here but would like feedback on how we want the plugin to show up in the Kibana developer guide.

note: the only material changes are those at the bottom. The rest of the diff is just the result of my editor auto-formatting per Prettier.

Checklist

Delete any items that are not applicable to this PR.

Risk Matrix

Delete this section if it is not applicable to this PR.

Before closing this PR, invite QA, stakeholders, and other developers to identify risks that should be tested prior to the change/feature release.

When forming the risk matrix, consider some of the following examples and how they may potentially impact the change:

Risk Probability Severity Mitigation/Notes
Multiple Spaces—unexpected behavior in non-default Kibana Space. Low High Integration tests will verify that all features are still supported in non-default Kibana Space and when user switches between spaces.
Multiple nodes—Elasticsearch polling might have race conditions when multiple Kibana nodes are polling for the same tasks. High Low Tasks are idempotent, so executing them multiple times will not result in logical error, but will degrade performance. To test for this case we add plenty of unit tests around this logic and document manual testing procedure.
Code should gracefully handle cases when feature X or plugin Y are disabled. Medium High Unit tests will verify that any feature flag or plugin combination still results in our service operational.
See more potential risk examples

For maintainers

@justinkambic justinkambic added chore v8.0.0 Team:Uptime - DEPRECATED Synthetics & RUM sub-team of Application Observability release_note:skip Skip the PR/issue when compiling release notes v7.14.0 labels Jun 10, 2021
@justinkambic justinkambic self-assigned this Jun 10, 2021
@justinkambic justinkambic requested a review from a team as a code owner June 10, 2021 20:43
@elasticmachine
Copy link
Contributor

Pinging @elastic/uptime (Team:uptime)

"name": "Uptime",
"githubTeam": "uptime"
},
"description": "This plugin visualizes data from Uptime and Elastic Synthetics, and integrates with other Observability solutions."
Copy link
Contributor

Choose a reason for hiding this comment

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

I'd just say from Synthetics and Heartbeat since data doesn't come from Uptime

Copy link
Contributor

@andrewvc andrewvc left a comment

Choose a reason for hiding this comment

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

LGTM after my minor comment is addressed.

@shahzad31
Copy link
Contributor

@elasticmachine merge upstream

@kibanamachine
Copy link
Contributor

💚 Build Succeeded

Metrics [docs]

✅ unchanged

History

To update your PR or re-run it, just comment with:
@elasticmachine merge upstream

cc @justinkambic

@shahzad31 shahzad31 merged commit 85710b3 into elastic:master Jun 14, 2021
@shahzad31 shahzad31 deleted the uptime_owner-and-description-props branch June 14, 2021 11:29
@shahzad31 shahzad31 added the auto-backport Deprecated - use backport:version if exact versions are needed label Jun 14, 2021
kibanamachine added a commit to kibanamachine/kibana that referenced this pull request Jun 14, 2021
@kibanamachine
Copy link
Contributor

💚 Backport successful

Status Branch Result
7.x

This backport PR will be merged automatically after passing CI.

kibanamachine added a commit that referenced this pull request Jun 14, 2021
…#101963) (#102041)

Co-authored-by: Shahzad <[email protected]>
Co-authored-by: Kibana Machine <[email protected]>

Co-authored-by: Justin Kambic <[email protected]>
Co-authored-by: Shahzad <[email protected]>
cuff-links pushed a commit to cuff-links/kibana that referenced this pull request Jun 15, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
auto-backport Deprecated - use backport:version if exact versions are needed chore release_note:skip Skip the PR/issue when compiling release notes Team:Uptime - DEPRECATED Synthetics & RUM sub-team of Application Observability v7.14.0 v8.0.0
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants