github-mirrors/kibana
1
0
Fork 0
mirror of https://github.com/elastic/kibana.git synced 2025-04-23 01:13:23 -04:00
Code Issues Projects Releases Packages Wiki Activity

[Logs UI] Migrate usages of defineInternalSourceConfiguration to defineInternalLogView with new LogViewService (#147673)

Browse source 
## 📝  Summary

Closes https://github.com/elastic/kibana/issues/129080

With the introduction of the "log view" concept in
https://github.com/elastic/kibana/pull/125014, this PR migrates all
usages of the previous `defineInternalSourceConfiguration` function in
the infra plugin's setup() contract to the new
`logViews.defineInternalLogView` function on the contract.

This affects `enterprise_search`, `monitoring` and `upgrade_assistant`
plugins.

**N.B.** As these usages were not following the same restrictive
configuration for the attributes we have now defined in the
`.defineInternalLogView` method, I made the `logViewAttributes` passed
to `logViews.defineInternalLogView` merge with the
`defaultLogViewAttributes`.

Co-authored-by: Marco Antonio Ghiani <marcoantonio.ghiani@elastic.co>
Co-authored-by: Kibana Machine <42973632+kibanamachine@users.noreply.github.com>
This commit is contained in:
Marco Antonio Ghiani 2022-12-29 09:02:11 +01:00 • committed by GitHub
parent 494d3599c2
commit 57934183eb
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
6 changed files with 16 additions and 15 deletions
Download patch file Download diff file Expand all files Collapse all files

18
x-pack/plugins/enterprise_search/server/plugin.ts
View file

@ -237,28 +237,28 @@ export class EnterpriseSearchPlugin implements Plugin {
* Register logs source configuration, used by LogStream components
* @see https://github.com/elastic/kibana/blob/main/x-pack/plugins/infra/public/components/log_stream/log_stream.stories.mdx#with-a-source-configuration
*/
infra.defineInternalSourceConfiguration(ENTERPRISE_SEARCH_RELEVANCE_LOGS_SOURCE_ID, {
name: 'Enterprise Search Search Relevance Logs',
infra.logViews.defineInternalLogView(ENTERPRISE_SEARCH_RELEVANCE_LOGS_SOURCE_ID, {
logIndices: {
type: 'index_name',
indexName: 'logs-app_search.search_relevance_suggestions-*',
type: 'index_name',
},
name: 'Enterprise Search Search Relevance Logs',
});
infra.defineInternalSourceConfiguration(ENTERPRISE_SEARCH_AUDIT_LOGS_SOURCE_ID, {
name: 'Enterprise Search Audit Logs',
infra.logViews.defineInternalLogView(ENTERPRISE_SEARCH_AUDIT_LOGS_SOURCE_ID, {
logIndices: {
type: 'index_name',
indexName: 'logs-enterprise_search*',
type: 'index_name',
},
name: 'Enterprise Search Audit Logs',
});
infra.defineInternalSourceConfiguration(ENTERPRISE_SEARCH_ANALYTICS_LOGS_SOURCE_ID, {
name: 'Enterprise Search Behaviorial Analytics Logs',
infra.logViews.defineInternalLogView(ENTERPRISE_SEARCH_ANALYTICS_LOGS_SOURCE_ID, {
logIndices: {
type: 'index_name',
indexName: 'logs-elastic_analytics.events-*',
type: 'index_name',
},
name: 'Enterprise Search Behaviorial Analytics Logs',
});
/**

1
x-pack/plugins/infra/common/log_views/types.ts
View file

@ -72,6 +72,7 @@ export const logViewAttributesRT = rt.strict({
logIndices: logIndexReferenceRT,
logColumns: rt.array(logViewColumnConfigurationRT),
});
export type LogViewAttributes = rt.TypeOf<typeof logViewAttributesRT>;
export const logViewRT = rt.exact(

6
x-pack/plugins/infra/server/services/log_views/log_views_service.ts
View file

@ -11,7 +11,7 @@ import {
Logger,
SavedObjectsClientContract,
} from '@kbn/core/server';
import { LogView, LogViewAttributes } from '../../../common/log_views';
import { defaultLogViewAttributes, LogView, LogViewAttributes } from '../../../common/log_views';
import { LogViewsClient } from './log_views_client';
import { LogViewsServiceSetup, LogViewsServiceStart, LogViewsServiceStartDeps } from './types';
@ -24,11 +24,11 @@ export class LogViewsService {
const { internalLogViews } = this;
return {
defineInternalLogView(logViewId: string, logViewAttributes: LogViewAttributes) {
defineInternalLogView(logViewId: string, logViewAttributes: Partial<LogViewAttributes>) {
internalLogViews.set(logViewId, {
id: logViewId,
origin: 'internal',
attributes: logViewAttributes,
attributes: { ...defaultLogViewAttributes, ...logViewAttributes },
updatedAt: Date.now(),
});
},

2
x-pack/plugins/infra/server/services/log_views/types.ts
View file

@ -30,7 +30,7 @@ export interface LogViewsServiceStartDeps {
}
export interface LogViewsServiceSetup {
defineInternalLogView(logViewId: string, logViewAttributes: LogViewAttributes): void;
defineInternalLogView(logViewId: string, logViewAttributes: Partial<LogViewAttributes>): void;
}
export interface LogViewsServiceStart {

2
x-pack/plugins/monitoring/server/lib/logs/init_infra_source.ts
View file

@ -18,7 +18,7 @@ export const initInfraSource = (config: MonitoringConfig, infraPlugin: InfraPlug
ccs: CCS_REMOTE_PATTERN,
});
infraPlugin.defineInternalSourceConfiguration(INFRA_SOURCE_ID, {
infraPlugin.logViews.defineInternalLogView(INFRA_SOURCE_ID, {
name: 'Elastic Stack Logs',
logIndices: {
type: 'index_name',

2
x-pack/plugins/upgrade_assistant/server/plugin.ts
View file

@ -106,7 +106,7 @@ export class UpgradeAssistantServerPlugin implements Plugin {
// We need to initialize the deprecation logs plugin so that we can
// navigate from this app to the observability app using a source_id.
infra?.defineInternalSourceConfiguration(DEPRECATION_LOGS_SOURCE_ID, {
infra?.logViews.defineInternalLogView(DEPRECATION_LOGS_SOURCE_ID, {
name: 'deprecationLogs',
description: 'deprecation logs',
logIndices: {