Register uiSettings on New Platform (#64015)
This now requires us to define a schema for each setting, which is a little redundant given that we also have to type the useUiSetting calls; this might be an issue between kibana-react and new UiSettings changes.
This commit is contained in:
Ryland Herrick
GitHub
parent
0266a5c447
commit
5a55c9a8f6
3 changed files with 145 additions and 112 deletions
|
|
@ -11,24 +11,7 @@ import { Root } from 'joi';
|
|||
// eslint-disable-next-line @kbn/eslint/no-restricted-paths
|
||||
import { savedObjectMappings } from '../../../plugins/siem/server/saved_objects';
|
||||
|
||||
import {
|
||||
APP_ID,
|
||||
APP_NAME,
|
||||
DEFAULT_INDEX_KEY,
|
||||
DEFAULT_ANOMALY_SCORE,
|
||||
DEFAULT_SIEM_TIME_RANGE,
|
||||
DEFAULT_SIEM_REFRESH_INTERVAL,
|
||||
DEFAULT_INTERVAL_PAUSE,
|
||||
DEFAULT_INTERVAL_VALUE,
|
||||
DEFAULT_FROM,
|
||||
DEFAULT_TO,
|
||||
ENABLE_NEWS_FEED_SETTING,
|
||||
NEWS_FEED_URL_SETTING,
|
||||
NEWS_FEED_URL_SETTING_DEFAULT,
|
||||
IP_REPUTATION_LINKS_SETTING,
|
||||
IP_REPUTATION_LINKS_SETTING_DEFAULT,
|
||||
DEFAULT_INDEX_PATTERN,
|
||||
} from '../../../plugins/siem/common/constants';
|
||||
import { APP_ID, APP_NAME } from '../../../plugins/siem/common/constants';
|
||||
import { DEFAULT_APP_CATEGORIES } from '../../../../src/core/utils';
|
||||
|
||||
// eslint-disable-next-line @typescript-eslint/no-explicit-any
|
||||
|
|
@ -63,100 +46,6 @@ export const siem = (kibana: any) => {
|
|||
category: DEFAULT_APP_CATEGORIES.security,
|
||||
},
|
||||
],
|
||||
uiSettingDefaults: {
|
||||
[DEFAULT_SIEM_REFRESH_INTERVAL]: {
|
||||
type: 'json',
|
||||
name: i18n.translate('xpack.siem.uiSettings.defaultRefreshIntervalLabel', {
|
||||
defaultMessage: 'Time filter refresh interval',
|
||||
}),
|
||||
value: `{
|
||||
"pause": ${DEFAULT_INTERVAL_PAUSE},
|
||||
"value": ${DEFAULT_INTERVAL_VALUE}
|
||||
}`,
|
||||
description: i18n.translate('xpack.siem.uiSettings.defaultRefreshIntervalDescription', {
|
||||
defaultMessage:
|
||||
'<p>Default refresh interval for the SIEM time filter, in milliseconds.</p>',
|
||||
}),
|
||||
category: ['siem'],
|
||||
requiresPageReload: true,
|
||||
},
|
||||
[DEFAULT_SIEM_TIME_RANGE]: {
|
||||
type: 'json',
|
||||
name: i18n.translate('xpack.siem.uiSettings.defaultTimeRangeLabel', {
|
||||
defaultMessage: 'Time filter period',
|
||||
}),
|
||||
value: `{
|
||||
"from": "${DEFAULT_FROM}",
|
||||
"to": "${DEFAULT_TO}"
|
||||
}`,
|
||||
description: i18n.translate('xpack.siem.uiSettings.defaultTimeRangeDescription', {
|
||||
defaultMessage: '<p>Default period of time in the SIEM time filter.</p>',
|
||||
}),
|
||||
category: ['siem'],
|
||||
requiresPageReload: true,
|
||||
},
|
||||
[DEFAULT_INDEX_KEY]: {
|
||||
name: i18n.translate('xpack.siem.uiSettings.defaultIndexLabel', {
|
||||
defaultMessage: 'Elasticsearch indices',
|
||||
}),
|
||||
value: DEFAULT_INDEX_PATTERN,
|
||||
description: i18n.translate('xpack.siem.uiSettings.defaultIndexDescription', {
|
||||
defaultMessage:
|
||||
'<p>Comma-delimited list of Elasticsearch indices from which the SIEM app collects events.</p>',
|
||||
}),
|
||||
category: ['siem'],
|
||||
requiresPageReload: true,
|
||||
},
|
||||
[DEFAULT_ANOMALY_SCORE]: {
|
||||
name: i18n.translate('xpack.siem.uiSettings.defaultAnomalyScoreLabel', {
|
||||
defaultMessage: 'Anomaly threshold',
|
||||
}),
|
||||
value: 50,
|
||||
type: 'number',
|
||||
description: i18n.translate('xpack.siem.uiSettings.defaultAnomalyScoreDescription', {
|
||||
defaultMessage:
|
||||
'<p>Value above which Machine Learning job anomalies are displayed in the SIEM app.</p><p>Valid values: 0 to 100.</p>',
|
||||
}),
|
||||
category: ['siem'],
|
||||
requiresPageReload: true,
|
||||
},
|
||||
[ENABLE_NEWS_FEED_SETTING]: {
|
||||
name: i18n.translate('xpack.siem.uiSettings.enableNewsFeedLabel', {
|
||||
defaultMessage: 'News feed',
|
||||
}),
|
||||
value: true,
|
||||
description: i18n.translate('xpack.siem.uiSettings.enableNewsFeedDescription', {
|
||||
defaultMessage: '<p>Enables the News feed</p>',
|
||||
}),
|
||||
type: 'boolean',
|
||||
category: ['siem'],
|
||||
requiresPageReload: true,
|
||||
},
|
||||
[NEWS_FEED_URL_SETTING]: {
|
||||
name: i18n.translate('xpack.siem.uiSettings.newsFeedUrl', {
|
||||
defaultMessage: 'News feed URL',
|
||||
}),
|
||||
value: NEWS_FEED_URL_SETTING_DEFAULT,
|
||||
description: i18n.translate('xpack.siem.uiSettings.newsFeedUrlDescription', {
|
||||
defaultMessage: '<p>News feed content will be retrieved from this URL</p>',
|
||||
}),
|
||||
category: ['siem'],
|
||||
requiresPageReload: true,
|
||||
},
|
||||
[IP_REPUTATION_LINKS_SETTING]: {
|
||||
name: i18n.translate('xpack.siem.uiSettings.ipReputationLinks', {
|
||||
defaultMessage: 'IP Reputation Links',
|
||||
}),
|
||||
value: IP_REPUTATION_LINKS_SETTING_DEFAULT,
|
||||
type: 'json',
|
||||
description: i18n.translate('xpack.siem.uiSettings.ipReputationLinksDescription', {
|
||||
defaultMessage:
|
||||
'Array of URL templates to build the list of reputation URLs to be displayed on the IP Details page.',
|
||||
}),
|
||||
category: ['siem'],
|
||||
requiresPageReload: true,
|
||||
},
|
||||
},
|
||||
mappings: savedObjectMappings,
|
||||
},
|
||||
config(Joi: Root) {
|
||||
|
|
|
|||
|
|
@ -42,6 +42,7 @@ import {
|
|||
} from './saved_objects';
|
||||
import { SiemClientFactory } from './client';
|
||||
import { createConfig$, ConfigType } from './config';
|
||||
import { initUiSettings } from './ui_settings';
|
||||
|
||||
export { CoreSetup, CoreStart };
|
||||
|
||||
|
|
@ -86,6 +87,8 @@ export class Plugin {
|
|||
);
|
||||
}
|
||||
|
||||
initUiSettings(core.uiSettings);
|
||||
|
||||
const router = core.http.createRouter();
|
||||
core.http.registerRouteHandlerContext(this.name, (context, request, response) => ({
|
||||
getSiemClient: () => this.siemClientFactory.create(request),
|
||||
|
|
|
|||
141
x-pack/plugins/siem/server/ui_settings.ts
Normal file
141
x-pack/plugins/siem/server/ui_settings.ts
Normal file
|
|
@ -0,0 +1,141 @@
|
|||
/*
|
||||
* Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one
|
||||
* or more contributor license agreements. Licensed under the Elastic License;
|
||||
* you may not use this file except in compliance with the Elastic License.
|
||||
*/
|
||||
|
||||
import { i18n } from '@kbn/i18n';
|
||||
import { schema } from '@kbn/config-schema';
|
||||
|
||||
import { CoreSetup } from '../../../../src/core/server';
|
||||
import {
|
||||
DEFAULT_INDEX_KEY,
|
||||
DEFAULT_INDEX_PATTERN,
|
||||
DEFAULT_ANOMALY_SCORE,
|
||||
DEFAULT_SIEM_TIME_RANGE,
|
||||
DEFAULT_SIEM_REFRESH_INTERVAL,
|
||||
DEFAULT_INTERVAL_PAUSE,
|
||||
DEFAULT_INTERVAL_VALUE,
|
||||
DEFAULT_FROM,
|
||||
DEFAULT_TO,
|
||||
ENABLE_NEWS_FEED_SETTING,
|
||||
NEWS_FEED_URL_SETTING,
|
||||
NEWS_FEED_URL_SETTING_DEFAULT,
|
||||
IP_REPUTATION_LINKS_SETTING,
|
||||
IP_REPUTATION_LINKS_SETTING_DEFAULT,
|
||||
} from '../common/constants';
|
||||
|
||||
export const initUiSettings = (uiSettings: CoreSetup['uiSettings']) => {
|
||||
uiSettings.register({
|
||||
[DEFAULT_SIEM_REFRESH_INTERVAL]: {
|
||||
type: 'json',
|
||||
name: i18n.translate('xpack.siem.uiSettings.defaultRefreshIntervalLabel', {
|
||||
defaultMessage: 'Time filter refresh interval',
|
||||
}),
|
||||
value: `{
|
||||
"pause": ${DEFAULT_INTERVAL_PAUSE},
|
||||
"value": ${DEFAULT_INTERVAL_VALUE}
|
||||
}`,
|
||||
description: i18n.translate('xpack.siem.uiSettings.defaultRefreshIntervalDescription', {
|
||||
defaultMessage:
|
||||
'<p>Default refresh interval for the SIEM time filter, in milliseconds.</p>',
|
||||
}),
|
||||
category: ['siem'],
|
||||
requiresPageReload: true,
|
||||
schema: schema.object({
|
||||
value: schema.number(),
|
||||
pause: schema.boolean(),
|
||||
}),
|
||||
},
|
||||
[DEFAULT_SIEM_TIME_RANGE]: {
|
||||
type: 'json',
|
||||
name: i18n.translate('xpack.siem.uiSettings.defaultTimeRangeLabel', {
|
||||
defaultMessage: 'Time filter period',
|
||||
}),
|
||||
value: `{
|
||||
"from": "${DEFAULT_FROM}",
|
||||
"to": "${DEFAULT_TO}"
|
||||
}`,
|
||||
description: i18n.translate('xpack.siem.uiSettings.defaultTimeRangeDescription', {
|
||||
defaultMessage: '<p>Default period of time in the SIEM time filter.</p>',
|
||||
}),
|
||||
category: ['siem'],
|
||||
requiresPageReload: true,
|
||||
schema: schema.object({
|
||||
from: schema.string(),
|
||||
to: schema.string(),
|
||||
}),
|
||||
},
|
||||
[DEFAULT_INDEX_KEY]: {
|
||||
name: i18n.translate('xpack.siem.uiSettings.defaultIndexLabel', {
|
||||
defaultMessage: 'Elasticsearch indices',
|
||||
}),
|
||||
value: DEFAULT_INDEX_PATTERN,
|
||||
description: i18n.translate('xpack.siem.uiSettings.defaultIndexDescription', {
|
||||
defaultMessage:
|
||||
'<p>Comma-delimited list of Elasticsearch indices from which the SIEM app collects events.</p>',
|
||||
}),
|
||||
category: ['siem'],
|
||||
requiresPageReload: true,
|
||||
schema: schema.arrayOf(schema.string()),
|
||||
},
|
||||
[DEFAULT_ANOMALY_SCORE]: {
|
||||
name: i18n.translate('xpack.siem.uiSettings.defaultAnomalyScoreLabel', {
|
||||
defaultMessage: 'Anomaly threshold',
|
||||
}),
|
||||
value: 50,
|
||||
type: 'number',
|
||||
description: i18n.translate('xpack.siem.uiSettings.defaultAnomalyScoreDescription', {
|
||||
defaultMessage:
|
||||
'<p>Value above which Machine Learning job anomalies are displayed in the SIEM app.</p><p>Valid values: 0 to 100.</p>',
|
||||
}),
|
||||
category: ['siem'],
|
||||
requiresPageReload: true,
|
||||
schema: schema.number(),
|
||||
},
|
||||
[ENABLE_NEWS_FEED_SETTING]: {
|
||||
name: i18n.translate('xpack.siem.uiSettings.enableNewsFeedLabel', {
|
||||
defaultMessage: 'News feed',
|
||||
}),
|
||||
value: true,
|
||||
description: i18n.translate('xpack.siem.uiSettings.enableNewsFeedDescription', {
|
||||
defaultMessage: '<p>Enables the News feed</p>',
|
||||
}),
|
||||
type: 'boolean',
|
||||
category: ['siem'],
|
||||
requiresPageReload: true,
|
||||
schema: schema.boolean(),
|
||||
},
|
||||
[NEWS_FEED_URL_SETTING]: {
|
||||
name: i18n.translate('xpack.siem.uiSettings.newsFeedUrl', {
|
||||
defaultMessage: 'News feed URL',
|
||||
}),
|
||||
value: NEWS_FEED_URL_SETTING_DEFAULT,
|
||||
description: i18n.translate('xpack.siem.uiSettings.newsFeedUrlDescription', {
|
||||
defaultMessage: '<p>News feed content will be retrieved from this URL</p>',
|
||||
}),
|
||||
category: ['siem'],
|
||||
requiresPageReload: true,
|
||||
schema: schema.string(),
|
||||
},
|
||||
[IP_REPUTATION_LINKS_SETTING]: {
|
||||
name: i18n.translate('xpack.siem.uiSettings.ipReputationLinks', {
|
||||
defaultMessage: 'IP Reputation Links',
|
||||
}),
|
||||
value: IP_REPUTATION_LINKS_SETTING_DEFAULT,
|
||||
type: 'json',
|
||||
description: i18n.translate('xpack.siem.uiSettings.ipReputationLinksDescription', {
|
||||
defaultMessage:
|
||||
'Array of URL templates to build the list of reputation URLs to be displayed on the IP Details page.',
|
||||
}),
|
||||
category: ['siem'],
|
||||
requiresPageReload: true,
|
||||
schema: schema.arrayOf(
|
||||
schema.object({
|
||||
name: schema.string(),
|
||||
url_template: schema.string(),
|
||||
})
|
||||
),
|
||||
},
|
||||
});
|
||||
};
|
||||
Loading…
Reference in a new issue