Makes spaces optional in observability plugin

[jasonrhodes]

Summary

This PR makes spaces optional in the "observability" plugin as requested in #149687

To test this, use the following setting in your kibana.yml config file:

xpack.spaces.enabled: false

When you log in, there will be no spaces choice.

[jasonrhodes]

So testing this has proven to be complicated. When I open the Kibana UI with this PR change, I don't see observability in the navigation at all.

At first, I thought this might be because we depend on a plugin which still depends on "spaces", but the Kibana log output doesn't indicate that. As seen here, "observability" is included in the array of 124 plugins that started.

[2023-02-15T14:49:42.005-05:00][INFO ][node] Kibana process configured with roles: [background_tasks, ui]
 np bld    log   [14:49:49.690] [info][@kbn/optimizer] [22/152] initial bundle builds complete
[2023-02-15T14:49:53.861-05:00][INFO ][plugins-service] Plugin "apm" has been disabled since the following direct or transitive dependencies are missing, disabled, or have incompatible types: [infra]
[2023-02-15T14:49:53.863-05:00][INFO ][plugins-service] Plugin "cloudDefend" has been disabled since the following direct or transitive dependencies are missing, disabled, or have incompatible types: [fleet]
[2023-02-15T14:49:53.863-05:00][INFO ][plugins-service] Plugin "cloudChat" is disabled.
[2023-02-15T14:49:53.863-05:00][INFO ][plugins-service] Plugin "cloudExperiments" is disabled.
[2023-02-15T14:49:53.863-05:00][INFO ][plugins-service] Plugin "cloudFullStory" is disabled.
[2023-02-15T14:49:53.863-05:00][INFO ][plugins-service] Plugin "cloudGainsight" is disabled.
[2023-02-15T14:49:53.864-05:00][INFO ][plugins-service] Plugin "cloudSecurityPosture" has been disabled since the following direct or transitive dependencies are missing, disabled, or have incompatible types: [fleet]
[2023-02-15T14:49:53.866-05:00][INFO ][plugins-service] Plugin "enterpriseSearch" has been disabled since the following direct or transitive dependencies are missing, disabled, or have incompatible types: [spaces, infra]
[2023-02-15T14:49:53.866-05:00][INFO ][plugins-service] Plugin "fleet" has been disabled since the following direct or transitive dependencies are missing, disabled, or have incompatible types: [spaces]
[2023-02-15T14:49:53.868-05:00][INFO ][plugins-service] Plugin "infra" has been disabled since the following direct or transitive dependencies are missing, disabled, or have incompatible types: [spaces]
[2023-02-15T14:49:53.876-05:00][INFO ][plugins-service] Plugin "profiling" is disabled.
[2023-02-15T14:49:53.880-05:00][INFO ][plugins-service] Plugin "securitySolution" has been disabled since the following direct or transitive dependencies are missing, disabled, or have incompatible types: [cloudSecurityPosture]
[2023-02-15T14:49:53.881-05:00][INFO ][plugins-service] Plugin "spaces" is disabled.
[2023-02-15T14:49:53.882-05:00][INFO ][plugins-service] Plugin "synthetics" has been disabled since the following direct or transitive dependencies are missing, disabled, or have incompatible types: [spaces]
[2023-02-15T14:49:53.885-05:00][INFO ][plugins-service] Plugin "ux" has been disabled since the following direct or transitive dependencies are missing, disabled, or have incompatible types: [infra, apm]
[2023-02-15T14:49:53.925-05:00][INFO ][http.server.Preboot] http server running at http://localhost:5601/local
[2023-02-15T14:49:53.997-05:00][INFO ][plugins-system.preboot] Setting up [1] plugins: [interactiveSetup]
[2023-02-15T14:49:54.014-05:00][WARN ][config.deprecation] The default mechanism for Reporting privileges will work differently in future versions, which will affect the behavior of this cluster. Set "xpack.reporting.roles.enabled" to "false" to adopt the future behavior before upgrading.
[2023-02-15T14:49:54.138-05:00][INFO ][plugins-system.standard] Setting up [124] plugins: [translations,monitoringCollection,licensing,globalSearch,globalSearchProviders,features,mapsEms,licenseApiGuard,customBranding,eventLog,usageCollection,taskManager,cloud,guidedOnboarding,telemetryCollectionManager,telemetryCollectionXpack,kibanaUsageCollection,share,screenshotMode,banners,newsfeed,ftrApis,fieldFormats,expressions,screenshotting,dataViews,charts,esUiShared,customIntegrations,home,searchprofiler,painlessLab,grokdebugger,management,security,snapshotRestore,lists,indexManagement,remoteClusters,crossClusterReplication,indexLifecycleManagement,encryptedSavedObjects,actions,notifications,telemetry,licenseManagement,files,cloudDataMigration,advancedSettings,console,contentManagement,bfetch,data,watcher,upgradeAssistant,fileUpload,ingestPipelines,ecsDataQualityDashboard,alerting,unifiedSearch,unifiedFieldList,savedSearch,savedObjects,graph,savedObjectsTagging,savedObjectsManagement,eventAnnotation,embeddable,reporting,uiActionsEnhanced,presentationUtil,expressionShape,expressionRevealImage,expressionRepeatImage,expressionMetric,expressionImage,controls,dataViewFieldEditor,triggersActionsUi,transform,stackConnectors,stackAlerts,ruleRegistry,visualizations,canvas,visTypeXy,visTypeVislib,visTypeVega,visTypeTimeseries,rollup,visTypeTimelion,visTypeTagcloud,visTypeTable,visTypeMetric,visTypeHeatmap,visTypeMarkdown,dashboard,dashboardEnhanced,expressionXY,expressionTagcloud,expressionPartitionVis,visTypePie,expressionMetricVis,expressionLegacyMetricVis,expressionHeatmap,expressionGauge,lens,maps,cases,timelines,sessionView,kubernetesSecurity,threatIntelligence,aiops,discover,osquery,observability,monitoring,logstash,discoverEnhanced,dataVisualizer,ml,visTypeGauge,dataViewManagement]

Interestingly, the "Dashboards" app appears in the left-hand nav, but doesn't load.

To debug, I placed debug log messages throughout the setup() method in the public/plugin.ts file in the observability plugin. When I undo the space configuration change (comment out this line # xpack.spaces.enabled: false), Dashboards looks happier in the UI.

And the Observability section returns to the navigation. The main difference appears to be something to do with observables being used to register navigation elements. I am logging out deepLinks and otherLinks from within the map in this section: https://github.com/jasonrhodes/kibana/blob/obs-optional-spaces/x-pack/plugins/observability/public/plugin.ts#L267-L310

When spaces isn't disabled (behavior from before this PR), I get the following logs:

temporaryDebugLog.ts:11 [JR TEMP DEBUG] [3:23:53 PM] deepLinks [{"id":"alerts","title":"Alerts","order":8001,"path":"/alerts","navLinkStatus":1,"deepLinks":[{"id":"rules","title":"Rules","path":"/alerts/rules","navLinkStatus":3}]},{"title":"Cases","order":8003,"navLinkStatus":1,"id":"cases","path":"/cases","deepLinks":[{"title":"Create New Case","navLinkStatus":3,"searchable":false,"id":"cases_create","path":"/cases/create"},{"title":"Configure Cases","navLinkStatus":3,"searchable":false,"id":"cases_configure","path":"/cases/configure"}]}]
temporaryDebugLog.ts:11 [JR TEMP DEBUG] [3:23:53 PM] otherLinks [{"app":"observability-overview","label":"Alerts","path":"/alerts"},{"app":"observability-overview","label":"Cases","path":"/cases"}]

When spaces is disabled via config, deepLinks is almost exactly the same, but otherLinks is an empty array.

temporaryDebugLog.ts:11 [JR TEMP DEBUG] [3:25:53 PM] deepLinks [{"id":"alerts","title":"Alerts","order":8001,"path":"/alerts","navLinkStatus":3,"deepLinks":[{"id":"rules","title":"Rules","path":"/alerts/rules","navLinkStatus":3}]},{"title":"Cases","order":8003,"navLinkStatus":3,"id":"cases","path":"/cases","deepLinks":[{"title":"Create New Case","navLinkStatus":3,"searchable":false,"id":"cases_create","path":"/cases/create"},{"title":"Configure Cases","navLinkStatus":3,"searchable":false,"id":"cases_configure","path":"/cases/configure"}]}]
temporaryDebugLog.ts:11 [JR TEMP DEBUG] [3:25:53 PM] otherLinks []

I need to continue this investigation later about what causes otherLinks to disappear in this scenario.

[jasonrhodes]

Update: The observability plugin does a check to see if at least one of the main observability sections is available and if none of them are, the top-level Observability pages (overview, alerts, cases, etc) are not shown in the navigation at all.

However, since I created this PR, it appears as though other observability apps have already merged their spaces-optional changes, so after having merged those changes in, it should be possible to test these changes in this PR now.

[simianhacker]

Tested this against edge-oblt data and the "Observability Overview Page" fails because the uptime capabilities are not available here:

kibana/x-pack/plugins/observability/public/pages/overview/containers/overview_page/helpers/use_metrics.ts

Line 32 in 27f2eee

if (capabilities[feature].show === false) {

We should change that line to:

if (capabilities[feature] && capabilities[feature].show === false) {

Since missing features (plugins) won't be available in the capabilities object.

[jasonrhodes]

Good catch, @simianhacker -- I've pushed a fix for that null pointer issue. I'm not sure if we use those track metric telemetry values at all, but just in case, I wanted to track the two scenarios (capability totally missing vs. capability explicitly set as show: false).

I'm still investigating an issue with the infra plugin where the empty state screens change when spaces are disabled.

[simianhacker]

Here is what the Observability Overview page looks like with xpack.spaces.enabled: false:

As you can see all of the solution (plugins) are missing from the navigation and the page is not populated with data. Here is what it looks like without Spaces disabled:

@jasonrhodes Is this the expected behavior for this pr?

[jasonrhodes]

@simianhacker Looks like the required spaces dependency for the "infra" plugin was accidentally re-introduced in a bad merge, causing what you saw in the UI for this branch. That's now been fixed and merged into this branch as well. This is what I see locally when I have spaces disabled:

[simianhacker]

Everything is working as expected now... Thanks @jasonrhodes!

[jasonrhodes]

@elasticmachine merge upstream

[kibana-ci]

💚 Build Succeeded

• Buildkite Build
• Commit: bcfc6c4

Metrics [docs]

Page load bundle

Size of the bundles that are downloaded on every page load. Target size is below 100kb

id	before	after	diff
observability	89.0KB	89.1KB	+102.0B

Unknown metric groups

ESLint disabled line counts

id	before	after	diff
securitySolution	428	430	+2

Total ESLint disabled count

id	before	after	diff
securitySolution	506	508	+2

History

• 💔 Build #111174 failed 95c5e53
• 💔 Build #110697 failed f4c2841
• 💚 Build #110121 succeeded 5a532f0
• 💚 Build #110094 succeeded 4c9fdb8
• 💚 Build #109687 succeeded cd80364
• 💚 Build #109330 succeeded a237d4c

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