Skip to content

Commit

Permalink
Rename log_explorer and observability_log_explorer plugins (#175510)
Browse files Browse the repository at this point in the history
- Rename `log_explorer` to `logs_explorer` and move it to an
`observability_solution` subfolder
- Rename `observability_log_explorer` to `observability_logs_explorer`
and move it to an `observability_solution` subfolder
- Use `renameFromRoot` to rename old configs 

Related to #171991 and
#170759

This PR is mostly focused on renaming the plugins, follow ups will be
created to change mentions of `log explorer`, `logExplorer` etc.

---------

Co-authored-by: kibanamachine <[email protected]>
Co-authored-by: Marco Antonio Ghiani <[email protected]>
  • Loading branch information
3 people authored Jan 26, 2024
1 parent 27b34d5 commit 35e7325
Show file tree
Hide file tree
Showing 245 changed files with 183 additions and 241 deletions.
2 changes: 1 addition & 1 deletion .buildkite/scripts/steps/storybooks/build_and_upload.ts
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ const STORYBOOKS = [
'dashboard_enhanced',
'dashboard',
'data',
'log_explorer',
'logs_explorer',
'embeddable',
'expression_error',
'expression_image',
Expand Down
5 changes: 3 additions & 2 deletions .github/CODEOWNERS
Validating CODEOWNERS rules …
Original file line number Diff line number Diff line change
Expand Up @@ -499,9 +499,9 @@ packages/kbn-lint-ts-projects-cli @elastic/kibana-operations
x-pack/plugins/lists @elastic/security-detection-engine
examples/locator_examples @elastic/appex-sharedux
examples/locator_explorer @elastic/appex-sharedux
x-pack/plugins/log_explorer @elastic/obs-ux-logs-team
packages/kbn-logging @elastic/kibana-core
packages/kbn-logging-mocks @elastic/kibana-core
x-pack/plugins/observability_solution/logs_explorer @elastic/obs-ux-logs-team
x-pack/plugins/logs_shared @elastic/obs-ux-logs-team
x-pack/plugins/logstash @elastic/logstash
packages/kbn-managed-content-badge @elastic/kibana-visualizations
Expand Down Expand Up @@ -571,7 +571,7 @@ x-pack/packages/observability/alert_details @elastic/obs-ux-management-team
x-pack/packages/observability/alerting_test_data @elastic/obs-ux-management-team
x-pack/test/cases_api_integration/common/plugins/observability @elastic/response-ops
x-pack/packages/observability/get_padded_alert_time_range_util @elastic/obs-ux-management-team
x-pack/plugins/observability_log_explorer @elastic/obs-ux-logs-team
x-pack/plugins/observability_solution/observability_logs_explorer @elastic/obs-ux-logs-team
x-pack/plugins/observability_onboarding @elastic/obs-ux-logs-team
x-pack/plugins/observability @elastic/obs-ux-management-team
x-pack/plugins/observability_shared @elastic/observability-ui
Expand Down Expand Up @@ -1534,6 +1534,7 @@ x-pack/plugins/security_solution/common/api/entity_analytics @elastic/security-e
/x-pack/plugins/security_solution/**/*.scss @elastic/security-design
/x-pack/plugins/security_solution_ess/**/*.scss @elastic/security-design
/x-pack/plugins/security_solution_serverless/**/*.scss @elastic/security-design
/x-pack/plugins/observability_solution/logs_explorer/**/*.scss @elastic/observability-design

# Logstash
#CC# /x-pack/plugins/logstash/ @elastic/logstash
Expand Down
2 changes: 1 addition & 1 deletion config/serverless.es.yml
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ xpack.apm.enabled: false

xpack.cloudSecurityPosture.enabled: false
xpack.infra.enabled: false
xpack.observabilityLogExplorer.enabled: false
xpack.observabilityLogsExplorer.enabled: false
xpack.observability.enabled: false
xpack.securitySolution.enabled: false
xpack.serverless.observability.enabled: false
Expand Down
2 changes: 1 addition & 1 deletion config/serverless.security.yml
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
enterpriseSearch.enabled: false
xpack.apm.enabled: false
xpack.infra.enabled: false
xpack.observabilityLogExplorer.enabled: false
xpack.observabilityLogsExplorer.enabled: false
xpack.observability.enabled: false

## Cloud settings
Expand Down
6 changes: 3 additions & 3 deletions docs/developer/plugin-list.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -647,7 +647,7 @@ the infrastructure monitoring use-case within Kibana.
using the CURL scripts in the scripts folder.
|{kib-repo}blob/{branch}/x-pack/plugins/log_explorer/README.md[logExplorer]
|{kib-repo}blob/{branch}/x-pack/plugins/observability_solution/logs_explorer/README.md[logsExplorer]
|This plugin is home to the <LogExplorer /> component and related types. It implements several of the underlying concepts that the Observability Log Explorer app builds upon.
Expand Down Expand Up @@ -692,8 +692,8 @@ Elastic.
|This document gives an overview of the features of the Observability AI Assistant at the time of writing, and how to use them. At a high level, the Observability AI Assistant offers contextual insights, and a chat functionality that we enrich with function calling, allowing the LLM to hook into the user's data. We also allow the LLM to store things it considers new information as embeddings into Elasticsearch, and query this knowledge base when it decides it needs more information, using ELSER.
|{kib-repo}blob/{branch}/x-pack/plugins/observability_log_explorer/README.md[observabilityLogExplorer]
|This plugin provides an app based on the LogExplorer component from the log_explorer plugin, but adds observability-specific affordances.
|{kib-repo}blob/{branch}/x-pack/plugins/observability_solution/observability_logs_explorer/README.md[observabilityLogsExplorer]
|This plugin provides an app based on the LogExplorer component from the logs_explorer plugin, but adds observability-specific affordances.
|{kib-repo}blob/{branch}/x-pack/plugins/observability_onboarding/README.md[observabilityOnboarding]
Expand Down
4 changes: 2 additions & 2 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -521,9 +521,9 @@
"@kbn/lists-plugin": "link:x-pack/plugins/lists",
"@kbn/locator-examples-plugin": "link:examples/locator_examples",
"@kbn/locator-explorer-plugin": "link:examples/locator_explorer",
"@kbn/log-explorer-plugin": "link:x-pack/plugins/log_explorer",
"@kbn/logging": "link:packages/kbn-logging",
"@kbn/logging-mocks": "link:packages/kbn-logging-mocks",
"@kbn/logs-explorer-plugin": "link:x-pack/plugins/observability_solution/logs_explorer",
"@kbn/logs-shared-plugin": "link:x-pack/plugins/logs_shared",
"@kbn/logstash-plugin": "link:x-pack/plugins/logstash",
"@kbn/managed-content-badge": "link:packages/kbn-managed-content-badge",
Expand Down Expand Up @@ -588,7 +588,7 @@
"@kbn/observability-alerting-test-data": "link:x-pack/packages/observability/alerting_test_data",
"@kbn/observability-fixtures-plugin": "link:x-pack/test/cases_api_integration/common/plugins/observability",
"@kbn/observability-get-padded-alert-time-range-util": "link:x-pack/packages/observability/get_padded_alert_time_range_util",
"@kbn/observability-log-explorer-plugin": "link:x-pack/plugins/observability_log_explorer",
"@kbn/observability-logs-explorer-plugin": "link:x-pack/plugins/observability_solution/observability_logs_explorer",
"@kbn/observability-onboarding-plugin": "link:x-pack/plugins/observability_onboarding",
"@kbn/observability-plugin": "link:x-pack/plugins/observability",
"@kbn/observability-shared-plugin": "link:x-pack/plugins/observability_shared",
Expand Down
4 changes: 2 additions & 2 deletions packages/kbn-optimizer/limits.yml
Original file line number Diff line number Diff line change
Expand Up @@ -90,7 +90,7 @@ pageLoadAssetSize:
licensing: 29004
links: 44490
lists: 22900
logExplorer: 50000
logsExplorer: 50000
logsShared: 281060
logstash: 53548
management: 46112
Expand All @@ -105,7 +105,7 @@ pageLoadAssetSize:
noDataPage: 5000
observability: 115443
observabilityAIAssistant: 25000
observabilityLogExplorer: 46650
observabilityLogsExplorer: 46650
observabilityOnboarding: 19573
observabilityShared: 72039
osquery: 107090
Expand Down
2 changes: 1 addition & 1 deletion src/dev/storybook/aliases.ts
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ export const storybookAliases = {
infra: 'x-pack/plugins/infra/.storybook',
kibana_react: 'src/plugins/kibana_react/.storybook',
lists: 'x-pack/plugins/lists/.storybook',
log_explorer: 'x-pack/plugins/log_explorer/.storybook',
logs_explorer: 'x-pack/plugins/observability_solution/logs_explorer/.storybook',
management: 'packages/kbn-management/storybook/config',
observability: 'x-pack/plugins/observability/.storybook',
observability_ai_assistant: 'x-pack/plugins/observability_ai_assistant/.storybook',
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -331,7 +331,7 @@ export default function ({ getService }: PluginFunctionalProviderContext) {
'xpack.observability.unsafe.alertDetails.observability.enabled (boolean)',
'xpack.observability.unsafe.thresholdRule.enabled (any)', // conditional, is actually a boolean
'xpack.observability_onboarding.ui.enabled (boolean)',
'xpack.observabilityLogExplorer.navigation.showAppLink (any)', // conditional, is actually a boolean
'xpack.observabilityLogsExplorer.navigation.showAppLink (any)', // conditional, is actually a boolean
];
// We don't assert that actualExposedConfigKeys and expectedExposedConfigKeys are equal, because test failure messages with large
// arrays are hard to grok. Instead, we take the difference between the two arrays and assert them separately, that way it's
Expand Down
8 changes: 4 additions & 4 deletions tsconfig.base.json
Original file line number Diff line number Diff line change
Expand Up @@ -992,12 +992,12 @@
"@kbn/locator-examples-plugin/*": ["examples/locator_examples/*"],
"@kbn/locator-explorer-plugin": ["examples/locator_explorer"],
"@kbn/locator-explorer-plugin/*": ["examples/locator_explorer/*"],
"@kbn/log-explorer-plugin": ["x-pack/plugins/log_explorer"],
"@kbn/log-explorer-plugin/*": ["x-pack/plugins/log_explorer/*"],
"@kbn/logging": ["packages/kbn-logging"],
"@kbn/logging/*": ["packages/kbn-logging/*"],
"@kbn/logging-mocks": ["packages/kbn-logging-mocks"],
"@kbn/logging-mocks/*": ["packages/kbn-logging-mocks/*"],
"@kbn/logs-explorer-plugin": ["x-pack/plugins/observability_solution/logs_explorer"],
"@kbn/logs-explorer-plugin/*": ["x-pack/plugins/observability_solution/logs_explorer/*"],
"@kbn/logs-shared-plugin": ["x-pack/plugins/logs_shared"],
"@kbn/logs-shared-plugin/*": ["x-pack/plugins/logs_shared/*"],
"@kbn/logstash-plugin": ["x-pack/plugins/logstash"],
Expand Down Expand Up @@ -1136,8 +1136,8 @@
"@kbn/observability-fixtures-plugin/*": ["x-pack/test/cases_api_integration/common/plugins/observability/*"],
"@kbn/observability-get-padded-alert-time-range-util": ["x-pack/packages/observability/get_padded_alert_time_range_util"],
"@kbn/observability-get-padded-alert-time-range-util/*": ["x-pack/packages/observability/get_padded_alert_time_range_util/*"],
"@kbn/observability-log-explorer-plugin": ["x-pack/plugins/observability_log_explorer"],
"@kbn/observability-log-explorer-plugin/*": ["x-pack/plugins/observability_log_explorer/*"],
"@kbn/observability-logs-explorer-plugin": ["x-pack/plugins/observability_solution/observability_logs_explorer"],
"@kbn/observability-logs-explorer-plugin/*": ["x-pack/plugins/observability_solution/observability_logs_explorer/*"],
"@kbn/observability-onboarding-plugin": ["x-pack/plugins/observability_onboarding"],
"@kbn/observability-onboarding-plugin/*": ["x-pack/plugins/observability_onboarding/*"],
"@kbn/observability-plugin": ["x-pack/plugins/observability"],
Expand Down
4 changes: 2 additions & 2 deletions x-pack/.i18nrc.json
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@
"xpack.idxMgmt": "plugins/index_management",
"xpack.indexLifecycleMgmt": "plugins/index_lifecycle_management",
"xpack.infra": "plugins/infra",
"xpack.logExplorer": "plugins/log_explorer",
"xpack.logsExplorer": "plugins/observability_solution/logs_explorer",
"xpack.logsShared": "plugins/logs_shared",
"xpack.fleet": "plugins/fleet",
"xpack.ingestPipelines": "plugins/ingest_pipelines",
Expand All @@ -67,7 +67,7 @@
],
"xpack.monitoring": ["plugins/monitoring"],
"xpack.observability": "plugins/observability",
"xpack.observabilityLogExplorer": "plugins/observability_log_explorer",
"xpack.observabilityLogsExplorer": "plugins/observability_solution/observability_logs_explorer",
"xpack.observabilityShared": "plugins/observability_shared",
"xpack.observability_onboarding": "plugins/observability_onboarding",
"xpack.observabilityAiAssistant": "plugins/observability_ai_assistant",
Expand Down
15 changes: 0 additions & 15 deletions x-pack/plugins/log_explorer/jest.config.js

This file was deleted.

2 changes: 1 addition & 1 deletion x-pack/plugins/observability/kibana.jsonc
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@
"visualizations",
"dashboard",
"expressions",
"logExplorer",
"logsExplorer",
"licensing"
],
"optionalPlugins": [
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Log Explorer

This plugin is home to the `<LogExplorer />` component and related types. It implements several of the underlying concepts that the [Observability Log Explorer app](../observability_log_explorer) builds upon.
This plugin is home to the `<LogExplorer />` component and related types. It implements several of the underlying concepts that the [Observability Log Explorer app](../observability_solution/observability_logs_explorer) builds upon.

## Developing the `<LogExplorer />` component

Expand All @@ -13,7 +13,7 @@ The goal is for this component to be easy to consume by other Kibana plugins. Th
- If the newly depended-upon code is not bound to the Kibana plugin life-cycle, it can be factored out into a package that both plugins depend on.
- If it requires integration with the Kibana plugin life-cycle we can invert the direction of the dependency edge by offering a registration API.

We also want to make this plugin available for consumption in deployments without any observability apps. Any observability-specific concepts should therefore be implemented in the `observability_log_explorer` plugin instead.
We also want to make this plugin available for consumption in deployments without any observability apps. Any observability-specific concepts should therefore be implemented in the `observability_logs_explorer` plugin instead.

While not fully realized yet, the dependency graph would roughly resemble the following:

Expand Down
File renamed without changes.
Original file line number Diff line number Diff line change
Expand Up @@ -7,12 +7,12 @@

module.exports = {
preset: '@kbn/test',
rootDir: '../../..',
roots: ['<rootDir>/x-pack/plugins/observability_log_explorer'],
rootDir: '../../../..',
roots: ['<rootDir>/x-pack/plugins/observability_solution/logs_explorer'],
coverageDirectory:
'<rootDir>/target/kibana-coverage/jest/x-pack/plugins/observability_log_explorer',
'<rootDir>/target/kibana-coverage/jest/x-pack/plugins/observability_solution/logs_explorer',
coverageReporters: ['text', 'html'],
collectCoverageFrom: [
'<rootDir>/x-pack/plugins/observability_log_explorer/{common,public}/**/*.{ts,tsx}',
'<rootDir>/x-pack/plugins/observability_solution/logs_explorer/{common,public}/**/*.{ts,tsx}',
],
};
Original file line number Diff line number Diff line change
@@ -1,15 +1,15 @@
{
"type": "plugin",
"id": "@kbn/log-explorer-plugin",
"id": "@kbn/logs-explorer-plugin",
"owner": "@elastic/obs-ux-logs-team",
"description": "This plugin provides a LogExplorer component using the Discover customization framework, offering several affordances specifically designed for log consumption.",
"plugin": {
"id": "logExplorer",
"id": "logsExplorer",
"server": true,
"browser": true,
"configPath": [
"xpack",
"logExplorer"
"logsExplorer"
],
"requiredPlugins": [
"controls",
Expand Down
Loading

0 comments on commit 35e7325

Please sign in to comment.