[APM] New Kibana platform migration plan #32894

jasonrhodes · 2019-03-11T14:23:10Z

Pending

Expose save and show capabilities to client (see https://github.com/elastic/kibana/blob/99c6396fd571074f8bc09e723ac44009c114c01b/docs/development/core/server/kibana-plugin-server.capabilitiessetup.registerprovider.md)
move all files to NP when possible
- server files ([APM] NP Migration - move plugin server files out of legacy #56830)
- Security and spaces nav controls are now available in NP: #44929
saved objects client ([APM] NP Migration - use saved object client factory from core setup #56832)
- originally located inx-pack/legacy/plugins/apm/server/lib/helpers/saved_objects_client.ts, this need to be migrated to the newly exposed API in Split legacy plugin discovery, expose SavedObjects scopedClient, wrappers, repository #48882
mount app with the NP API (as in [APM] Start moving to renderApp #52586)

Blocked

telemetry & page metrics
- ~~usage collectors will be moved to a new metrics plugin in NP collectorSets in the New Platform #46924~~ done in [Telemetry] collector set to np #51618
- ~~internal saved objects client needs to be exposed in NP Split legacy plugin discovery, expose SavedObjects scopedClient, wrappers, repository #48882~~
- blocked on migration of saved objects client ([APM] NP Migration - use saved object client factory from core setup #56832)
Telemetry banner is not available: #45428
The feature is now only registered in legacy_register_feature.ts (

kibana/x-pack/legacy/plugins/apm/public/legacy_register_feature.ts

Line 19 in bc69d6e

home.featureCatalogue.register(featureCatalogueEntry);

) which is only loaded by the old platform. The registration needs to be moved to the NP plugin

When removing the client-side shims, verify that it fixes the following issues:

Completed

injected vars - replace with config values for front-end ([APM] New platform migration: replace injected vars #44232)
- current usage: https://github.com/elastic/kibana/blob/master/x-pack/legacy/plugins/apm/index.ts#L40
- Platform issue: Add config value support in frontend to New Platform #41990
- see the platform PR: Expose whitelisted config values to client-side plugin #50641 for migration details
ui/metadata metadata.branch -> replace with packageInfo API Expose packageInfo to the new platform plugins #45262 PluginInitializerContext.env.packgeInfo.branch ([APM] NP migration packgeInfo API for branch #49237)
- current usage: https://github.com/elastic/kibana/blob/master/x-pack/legacy/plugins/apm/public /components/shared/Links/ElasticDocsLink.tsx#L12
- replace the ui/metadata import to use the packageInfo API to get the stack version
- (we actually switched to using the core.docLinks API in Use docLinks API for APM doc links #61880)
ui/registry/feature_catalogue ([APM] NP Migration feature_catalogue -> home.featureCatalogue.register #51542)
- current usage: https://github.com/elastic/kibana/blob/master/x-pack/legacy/plugins/apm/public/register_feature.js#L10
- Must add home as a plugin dependency in kibana.json
- call home.featureCatalogue.register in NP plugin setup.
- rename public/register_feature.js -> public/legacy_register_feature.js to be removed when the plugin is switched over to NP
NP plugin shim
kfetch -> core.http client ([APM] NP migration replace ui/kfetch with core.http #46548)
chrome.addBasePath -> core.http.basePath.prepend ([APM] Remove dependency on ui/chrome in favor of newer core APIs #41868)
chrome.breadcrumbs.set -> core.chrome.setBreadcrumbs ([APM] Remove dependency on ui/chrome in favor of newer core APIs #41868)
chrome.badge.set -> core.chrome.setBadge ([APM] Remove dependency on ui/chrome in favor of newer core APIs #41868)
chrome.getUiSettingsClient().get -> core.uiSettings.get ([APM] Remove dependency on ui/chrome in favor of newer core APIs #41868)
single instance of npStart.core passed down thru context on front-end ([APM] New platform migration: Lift up ui/chrome dependency #34444)
chrome.navLinkExists/getNavLinkById -> core.chrome.navLinks.update (Move Nav APIs to new platform #34490)
chrome.helpExtension.set -> core.chrome.setHelpExtension ([APM] Remove dependency on ui/chrome in favor of newer core APIs #41868)
NP router ([APM] NP migration core.http.createRouter #49238)
ui/autocomplete_providers -> DataPublicPluginStart.autocomplete.getProvider ([APM] Some miscellaneous client new platform updates #51482)
ui/capabilities -> core.application.capabilities ([APM] Some miscellaneous client new platform updates #51482)
remove ui/index_patterns ([APM] NP migration StaticIndexPattern -> IIndexPattern #51541)
- APM imports ui/index_patterns to reference the legacy type StaticIndexPattern type definition. Fix by replacing it with new type IIndexPattern which is already imported in that file.

The text was updated successfully, but these errors were encountered:

elasticmachine · 2019-03-11T14:23:12Z

Pinging @elastic/apm-ui

formgeist · 2019-06-06T15:01:53Z

@elastic/apm-ui Letting this slide to next release. It isn't due until 7.5

* Move `setHelpExtension` to plugin start method instead of plugin root * Remove 'ui/modules' import * Use new platform capabilities in useUpdateBadgeEffect * Add plugins and plugins context to new platform start * Use new platform plugins for KueryBar autocomplete provider * Add types for plugin and rename to ApmPublicPlugin * Add empty setup method to plugin * Move all context providers from App to render method * Remove some unnecessary mocks References elastic#32894.

* Move `setHelpExtension` to plugin start method instead of plugin root * Move `setHelpExtension` to a separate file * Remove 'ui/modules' import * Use new platform capabilities in useUpdateBadgeEffect * Move useUpdateBadgeEffect to a utility function called in start * Add plugins and plugins context to new platform start * Use new platform plugins for KueryBar autocomplete provider * Add types for plugin and rename to ApmPublicPlugin * Add empty setup method to plugin * Move all context providers from App to render method * Remove some unnecessary mocks References elastic#32894.

* Move `setHelpExtension` to plugin start method instead of plugin root * Move `setHelpExtension` to a separate file * Remove 'ui/modules' import * Use new platform capabilities in useUpdateBadgeEffect * Move useUpdateBadgeEffect to a utility function called in start * Add plugins and plugins context to new platform start * Use new platform plugins for KueryBar autocomplete provider * Add types for plugin and rename to ApmPublicPlugin * Add empty setup method to plugin * Move all context providers from App to render method * Remove some unnecessary mocks References #32894.

* Move `setHelpExtension` to plugin start method instead of plugin root * Move `setHelpExtension` to a separate file * Remove 'ui/modules' import * Use new platform capabilities in useUpdateBadgeEffect * Move useUpdateBadgeEffect to a utility function called in start * Add plugins and plugins context to new platform start * Use new platform plugins for KueryBar autocomplete provider * Add types for plugin and rename to ApmPublicPlugin * Add empty setup method to plugin * Move all context providers from App to render method * Remove some unnecessary mocks References elastic#32894.

* Move `setHelpExtension` to plugin start method instead of plugin root * Move `setHelpExtension` to a separate file * Remove 'ui/modules' import * Use new platform capabilities in useUpdateBadgeEffect * Move useUpdateBadgeEffect to a utility function called in start * Add plugins and plugins context to new platform start * Use new platform plugins for KueryBar autocomplete provider * Add types for plugin and rename to ApmPublicPlugin * Add empty setup method to plugin * Move all context providers from App to render method * Remove some unnecessary mocks References #32894.

* Move `setHelpExtension` to plugin start method instead of plugin root * Move `setHelpExtension` to a separate file * Remove 'ui/modules' import * Use new platform capabilities in useUpdateBadgeEffect * Move useUpdateBadgeEffect to a utility function called in start * Add plugins and plugins context to new platform start * Use new platform plugins for KueryBar autocomplete provider * Add types for plugin and rename to ApmPublicPlugin * Add empty setup method to plugin * Move all context providers from App to render method * Remove some unnecessary mocks References elastic#32894.

jasonrhodes added Team:APM All issues that need APM UI Team support [zube]: Inbox labels Mar 11, 2019

jasonrhodes changed the title ~~APM changes required to migrate to new Kibana platform~~ [APM] New Kibana platform migration plan Mar 11, 2019

alvarolobato added Meta [zube]: Impl Backlog and removed [zube]: Inbox labels Mar 13, 2019

alvarolobato added [zube]: Impl Ready and removed [zube]: Impl Backlog labels Mar 27, 2019

jasonrhodes mentioned this issue Apr 3, 2019

[APM] New platform migration: Lift up ui/chrome dependency #34444

Closed

sorenlouv added the v7.3.0 label May 9, 2019

sorenlouv removed the [zube]: Impl Ready label May 30, 2019

formgeist added [zube]: Planned for release and removed v7.3.0 [zube]: Planned for release labels Jun 6, 2019

lukeelmers mentioned this issue Sep 5, 2019

Shim ui/autocomplete_providers into legacy data plugin #44949

Closed

3 tasks

sorenlouv added [zube]: (7.6) Planned for release and removed [zube]: Impl Backlog labels Oct 22, 2019

This was referenced Oct 24, 2019

[APM] NP migration packgeInfo API for branch #49237

Closed

[APM] NP migration core.http.createRouter #49238

Closed

dgieselaar mentioned this issue Nov 21, 2019

[APM] Migrate server routes to NP #49455

Merged

smith mentioned this issue Nov 22, 2019

[APM] Some miscellaneous client new platform updates #51482

Merged

This was referenced Nov 22, 2019

[APM] NP migration StaticIndexPattern -> IIndexPattern #51541

Closed

[APM] NP Migration feature_catalogue -> home.featureCatalogue.register #51542

Closed

smith added [zube]: In Progress and removed [zube]: (7.6) Planned for release labels Nov 25, 2019

smith added the blocked label Dec 6, 2019

smith self-assigned this Dec 6, 2019

smith removed their assignment Feb 6, 2020

sorenlouv assigned ogupte Mar 4, 2020

smith added Feature:New Platform Feature:NP Migration v7.8.0 and removed Feature:New Platform labels Mar 24, 2020

ogupte mentioned this issue Apr 28, 2020

[APM] Client new platform migration #64046

Merged

ogupte closed this as completed in #64046 Apr 30, 2020

zube bot added [zube]: Done and removed [zube]: In Progress labels Apr 30, 2020

sorenlouv removed the [zube]: Done label May 6, 2020

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[APM] New Kibana platform migration plan #32894

[APM] New Kibana platform migration plan #32894

jasonrhodes commented Mar 11, 2019 •

edited by smith

Loading

elasticmachine commented Mar 11, 2019

formgeist commented Jun 6, 2019

[APM] New Kibana platform migration plan #32894

[APM] New Kibana platform migration plan #32894

Comments

jasonrhodes commented Mar 11, 2019 • edited by smith Loading

Pending

Blocked

Completed

elasticmachine commented Mar 11, 2019

formgeist commented Jun 6, 2019

jasonrhodes commented Mar 11, 2019 •

edited by smith

Loading