-
Notifications
You must be signed in to change notification settings - Fork 8.1k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
[RAC] ALerts table in observability (#103270)
Closes #98611 ## Summary Add alerts table in Observability =>  ### Risk Matrix Delete this section if it is not applicable to this PR. Before closing this PR, invite QA, stakeholders, and other developers to identify risks that should be tested prior to the change/feature release. When forming the risk matrix, consider some of the following examples and how they may potentially impact the change: | Risk | Probability | Severity | Mitigation/Notes | |---------------------------|-------------|----------|-------------------------| | Multiple Spaces—unexpected behavior in non-default Kibana Space. | Low | High | Integration tests will verify that all features are still supported in non-default Kibana Space and when user switches between spaces. | | Multiple nodes—Elasticsearch polling might have race conditions when multiple Kibana nodes are polling for the same tasks. | High | Low | Tasks are idempotent, so executing them multiple times will not result in logical error, but will degrade performance. To test for this case we add plenty of unit tests around this logic and document manual testing procedure. | | Code should gracefully handle cases when feature X or plugin Y are disabled. | Medium | High | Unit tests will verify that any feature flag or plugin combination still results in our service operational. | | [See more potential risk examples](https://github.com/elastic/kibana/blob/master/RISK_MATRIX.mdx) | ### For maintainers - [ ] This was checked for breaking API changes and was [labeled appropriately](https://www.elastic.co/guide/en/kibana/master/contributing.html#kibana-release-notes-process)
- Loading branch information
Showing
23 changed files
with
652 additions
and
173 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -18,6 +18,7 @@ | |
| "data", | ||
| "features", | ||
| "ruleRegistry", | ||
| "timelines", | ||
| "triggersActionsUi" | ||
| ], | ||
| "ui": true, | ||
|
|
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
197 changes: 197 additions & 0 deletions
197
x-pack/plugins/observability/public/pages/alerts/alerts_table_t_grid.tsx
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,197 @@ | ||
| /* | ||
| * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one | ||
| * or more contributor license agreements. Licensed under the Elastic License | ||
| * 2.0; you may not use this file except in compliance with the Elastic License | ||
| * 2.0. | ||
| */ | ||
|
|
||
| import { EuiButtonIcon, EuiDataGridColumn } from '@elastic/eui'; | ||
| import { i18n } from '@kbn/i18n'; | ||
| import React, { Suspense, useState } from 'react'; | ||
| import { | ||
| ALERT_DURATION, | ||
| ALERT_SEVERITY_LEVEL, | ||
| ALERT_STATUS, | ||
| ALERT_START, | ||
| RULE_NAME, | ||
| } from '@kbn/rule-data-utils/target/technical_field_names'; | ||
|
|
||
| import type { TimelinesUIStart } from '../../../../timelines/public'; | ||
| import type { TopAlert } from './'; | ||
| import { useKibana } from '../../../../../../src/plugins/kibana_react/public'; | ||
| import type { ActionProps, ColumnHeaderOptions, RowRenderer } from '../../../../timelines/common'; | ||
| import { getRenderCellValue } from './render_cell_value'; | ||
| import { usePluginContext } from '../../hooks/use_plugin_context'; | ||
| import { decorateResponse } from './decorate_response'; | ||
| import { LazyAlertsFlyout } from '../..'; | ||
|
|
||
| interface AlertsTableTGridProps { | ||
| indexName: string; | ||
| rangeFrom: string; | ||
| rangeTo: string; | ||
| kuery: string; | ||
| status: string; | ||
| setRefetch: (ref: () => void) => void; | ||
| } | ||
|
|
||
| /** | ||
| * columns implements a subset of `EuiDataGrid`'s `EuiDataGridColumn` interface, | ||
| * plus additional TGrid column properties | ||
| */ | ||
| export const columns: Array< | ||
| Pick<EuiDataGridColumn, 'display' | 'displayAsText' | 'id' | 'initialWidth'> & ColumnHeaderOptions | ||
| > = [ | ||
| { | ||
| columnHeaderType: 'not-filtered', | ||
| displayAsText: i18n.translate('xpack.observability.alertsTGrid.statusColumnDescription', { | ||
| defaultMessage: 'Status', | ||
| }), | ||
| id: ALERT_STATUS, | ||
| initialWidth: 79, | ||
| }, | ||
| { | ||
| columnHeaderType: 'not-filtered', | ||
| displayAsText: i18n.translate('xpack.observability.alertsTGrid.triggeredColumnDescription', { | ||
| defaultMessage: 'Triggered', | ||
| }), | ||
| id: ALERT_START, | ||
| initialWidth: 116, | ||
| }, | ||
| { | ||
| columnHeaderType: 'not-filtered', | ||
| displayAsText: i18n.translate('xpack.observability.alertsTGrid.durationColumnDescription', { | ||
| defaultMessage: 'Duration', | ||
| }), | ||
| id: ALERT_DURATION, | ||
| initialWidth: 116, | ||
| }, | ||
| { | ||
| columnHeaderType: 'not-filtered', | ||
| displayAsText: i18n.translate('xpack.observability.alertsTGrid.severityColumnDescription', { | ||
| defaultMessage: 'Severity', | ||
| }), | ||
| id: ALERT_SEVERITY_LEVEL, | ||
| initialWidth: 102, | ||
| }, | ||
| { | ||
| columnHeaderType: 'not-filtered', | ||
| displayAsText: i18n.translate('xpack.observability.alertsTGrid.reasonColumnDescription', { | ||
| defaultMessage: 'Reason', | ||
| }), | ||
| linkField: '*', | ||
| id: RULE_NAME, | ||
| initialWidth: 400, | ||
| }, | ||
| ]; | ||
|
|
||
| const NO_ROW_RENDER: RowRenderer[] = []; | ||
|
|
||
| const trailingControlColumns: never[] = []; | ||
|
|
||
| export function AlertsTableTGrid(props: AlertsTableTGridProps) { | ||
| const { core, observabilityRuleTypeRegistry } = usePluginContext(); | ||
| const { prepend } = core.http.basePath; | ||
| const { indexName, rangeFrom, rangeTo, kuery, status, setRefetch } = props; | ||
| const [flyoutAlert, setFlyoutAlert] = useState<TopAlert | undefined>(undefined); | ||
| const handleFlyoutClose = () => setFlyoutAlert(undefined); | ||
| const { timelines } = useKibana<{ timelines: TimelinesUIStart }>().services; | ||
|
|
||
| const leadingControlColumns = [ | ||
| { | ||
| id: 'expand', | ||
| width: 40, | ||
| headerCellRender: () => null, | ||
| rowCellRender: ({ data }: ActionProps) => { | ||
| const dataFieldEs = data.reduce((acc, d) => ({ ...acc, [d.field]: d.value }), {}); | ||
| const decoratedAlerts = decorateResponse( | ||
| [dataFieldEs] ?? [], | ||
| observabilityRuleTypeRegistry | ||
| ); | ||
| const alert = decoratedAlerts[0]; | ||
| return ( | ||
| <EuiButtonIcon | ||
| size="s" | ||
| iconType="expand" | ||
| color="text" | ||
| onClick={() => setFlyoutAlert(alert)} | ||
| /> | ||
| ); | ||
| }, | ||
| }, | ||
| { | ||
| id: 'view_in_app', | ||
| width: 40, | ||
| headerCellRender: () => null, | ||
| rowCellRender: ({ data }: ActionProps) => { | ||
| const dataFieldEs = data.reduce((acc, d) => ({ ...acc, [d.field]: d.value }), {}); | ||
| const decoratedAlerts = decorateResponse( | ||
| [dataFieldEs] ?? [], | ||
| observabilityRuleTypeRegistry | ||
| ); | ||
| const alert = decoratedAlerts[0]; | ||
| return ( | ||
| <EuiButtonIcon | ||
| size="s" | ||
| target="_blank" | ||
| rel="nofollow noreferrer" | ||
| href={prepend(alert.link ?? '')} | ||
| iconType="inspect" | ||
| color="text" | ||
| /> | ||
| ); | ||
| }, | ||
| }, | ||
| ]; | ||
|
|
||
| return ( | ||
| <> | ||
| {flyoutAlert && ( | ||
| <Suspense fallback={null}> | ||
| <LazyAlertsFlyout | ||
| alert={flyoutAlert} | ||
| observabilityRuleTypeRegistry={observabilityRuleTypeRegistry} | ||
| onClose={handleFlyoutClose} | ||
| /> | ||
| </Suspense> | ||
| )} | ||
| {timelines.getTGrid<'standalone'>({ | ||
| type: 'standalone', | ||
| columns, | ||
| deletedEventIds: [], | ||
| end: rangeTo, | ||
| filters: [], | ||
| indexNames: [indexName], | ||
| itemsPerPage: 10, | ||
| itemsPerPageOptions: [10, 25, 50], | ||
| loadingText: i18n.translate('xpack.observability.alertsTable.loadingTextLabel', { | ||
| defaultMessage: 'loading alerts', | ||
| }), | ||
| footerText: i18n.translate('xpack.observability.alertsTable.footerTextLabel', { | ||
| defaultMessage: 'alerts', | ||
| }), | ||
| query: { | ||
| query: `${ALERT_STATUS}: ${status}${kuery !== '' ? ` and ${kuery}` : ''}`, | ||
| language: 'kuery', | ||
| }, | ||
| renderCellValue: getRenderCellValue({ rangeFrom, rangeTo, setFlyoutAlert }), | ||
| rowRenderers: NO_ROW_RENDER, | ||
| start: rangeFrom, | ||
| setRefetch, | ||
| sort: [ | ||
| { | ||
| columnId: '@timestamp', | ||
| columnType: 'date', | ||
| sortDirection: 'desc', | ||
| }, | ||
| ], | ||
| leadingControlColumns, | ||
| trailingControlColumns, | ||
| unit: (totalAlerts: number) => | ||
| i18n.translate('xpack.observability.alertsTable.showingAlertsTitle', { | ||
| values: { totalAlerts }, | ||
| defaultMessage: '{totalAlerts, plural, =1 {alert} other {alerts}}', | ||
| }), | ||
| })} | ||
| </> | ||
| ); | ||
| } |
Oops, something went wrong.