From 95ddfe8ee1b155119f312c1e6d019eae13a381cb Mon Sep 17 00:00:00 2001 From: Sven Grossmann Date: Tue, 20 Sep 2022 08:48:32 +0200 Subject: [PATCH] GrafanaUI: mark all Log components deprecated (#55404) --- packages/grafana-ui/src/components/Logs/LogDetails.tsx | 4 ++-- packages/grafana-ui/src/components/Logs/LogDetailsRow.tsx | 4 ++-- packages/grafana-ui/src/components/Logs/LogLabelStats.tsx | 1 + .../grafana-ui/src/components/Logs/LogLabelStatsRow.tsx | 2 ++ packages/grafana-ui/src/components/Logs/LogMessageAnsi.tsx | 1 + packages/grafana-ui/src/components/Logs/LogRow.tsx | 1 + packages/grafana-ui/src/components/Logs/LogRowContext.tsx | 2 ++ .../src/components/Logs/LogRowContextProvider.tsx | 7 +++++++ packages/grafana-ui/src/components/Logs/LogRowMessage.tsx | 4 ++-- .../src/components/Logs/LogRowMessageDetectedFields.tsx | 2 ++ packages/grafana-ui/src/components/Logs/LogRows.tsx | 3 ++- packages/grafana-ui/src/components/Logs/logParser.ts | 2 ++ 12 files changed, 26 insertions(+), 7 deletions(-) diff --git a/packages/grafana-ui/src/components/Logs/LogDetails.tsx b/packages/grafana-ui/src/components/Logs/LogDetails.tsx index 4c9d0262c21..ffc0724151c 100644 --- a/packages/grafana-ui/src/components/Logs/LogDetails.tsx +++ b/packages/grafana-ui/src/components/Logs/LogDetails.tsx @@ -22,8 +22,7 @@ import { LogDetailsRow } from './LogDetailsRow'; import { getLogRowStyles } from './getLogRowStyles'; import { getAllFields } from './logParser'; -//Components - +/** @deprecated will be removed in the next major version */ export interface Props extends Themeable2 { row: LogRowModel; showDuplicates: boolean; @@ -176,5 +175,6 @@ class UnThemedLogDetails extends PureComponent { } } +/** @deprecated will be removed in the next major version */ export const LogDetails = withTheme2(UnThemedLogDetails); LogDetails.displayName = 'LogDetails'; diff --git a/packages/grafana-ui/src/components/Logs/LogDetailsRow.tsx b/packages/grafana-ui/src/components/Logs/LogDetailsRow.tsx index e81c565f233..f74b7a2a793 100644 --- a/packages/grafana-ui/src/components/Logs/LogDetailsRow.tsx +++ b/packages/grafana-ui/src/components/Logs/LogDetailsRow.tsx @@ -12,8 +12,7 @@ import { IconButton } from '../IconButton/IconButton'; import { LogLabelStats } from './LogLabelStats'; import { getLogRowStyles } from './getLogRowStyles'; -//Components - +/** @deprecated will be removed in the next major version */ export interface Props extends Themeable2 { parsedValue: string; parsedKey: string; @@ -220,5 +219,6 @@ class UnThemedLogDetailsRow extends PureComponent { } } +/** @deprecated will be removed in the next major version */ export const LogDetailsRow = withTheme2(UnThemedLogDetailsRow); LogDetailsRow.displayName = 'LogDetailsRow'; diff --git a/packages/grafana-ui/src/components/Logs/LogLabelStats.tsx b/packages/grafana-ui/src/components/Logs/LogLabelStats.tsx index 165f76713af..96bba271e25 100644 --- a/packages/grafana-ui/src/components/Logs/LogLabelStats.tsx +++ b/packages/grafana-ui/src/components/Logs/LogLabelStats.tsx @@ -96,5 +96,6 @@ class UnThemedLogLabelStats extends PureComponent { } } +/** @deprecated will be removed in the next major version */ export const LogLabelStats = withTheme2(UnThemedLogLabelStats); LogLabelStats.displayName = 'LogLabelStats'; diff --git a/packages/grafana-ui/src/components/Logs/LogLabelStatsRow.tsx b/packages/grafana-ui/src/components/Logs/LogLabelStatsRow.tsx index 53344c7979d..f104331f77f 100644 --- a/packages/grafana-ui/src/components/Logs/LogLabelStatsRow.tsx +++ b/packages/grafana-ui/src/components/Logs/LogLabelStatsRow.tsx @@ -51,6 +51,7 @@ const getStyles = (theme: GrafanaTheme2) => ({ `, }); +/** @deprecated will be removed in the next major version */ export interface Props { active?: boolean; count: number; @@ -58,6 +59,7 @@ export interface Props { value?: string; } +/** @deprecated will be removed in the next major version */ export const LogLabelStatsRow: FunctionComponent = ({ active, count, proportion, value }) => { const style = useStyles2(getStyles); const percent = `${Math.round(proportion * 100)}%`; diff --git a/packages/grafana-ui/src/components/Logs/LogMessageAnsi.tsx b/packages/grafana-ui/src/components/Logs/LogMessageAnsi.tsx index dcdc3bd9338..0178098e851 100644 --- a/packages/grafana-ui/src/components/Logs/LogMessageAnsi.tsx +++ b/packages/grafana-ui/src/components/Logs/LogMessageAnsi.tsx @@ -49,6 +49,7 @@ interface State { prevValue: string; } +/** @deprecated will be removed in the next major version */ export class UnThemedLogMessageAnsi extends PureComponent { state: State = { chunks: [], diff --git a/packages/grafana-ui/src/components/Logs/LogRow.tsx b/packages/grafana-ui/src/components/Logs/LogRow.tsx index 7b4891d990f..909b2d495db 100644 --- a/packages/grafana-ui/src/components/Logs/LogRow.tsx +++ b/packages/grafana-ui/src/components/Logs/LogRow.tsx @@ -256,5 +256,6 @@ class UnThemedLogRow extends PureComponent { } } +/** @deprecated will be removed in the next major version */ export const LogRow = withTheme2(UnThemedLogRow); LogRow.displayName = 'LogRow'; diff --git a/packages/grafana-ui/src/components/Logs/LogRowContext.tsx b/packages/grafana-ui/src/components/Logs/LogRowContext.tsx index 94baecbd2d7..73d52fe01d1 100644 --- a/packages/grafana-ui/src/components/Logs/LogRowContext.tsx +++ b/packages/grafana-ui/src/components/Logs/LogRowContext.tsx @@ -123,6 +123,7 @@ const LogRowContextGroupHeader: React.FunctionComponent = ({ row, rows, @@ -184,6 +185,7 @@ export const LogRowContextGroup: React.FunctionComponent = ({ row, context, diff --git a/packages/grafana-ui/src/components/Logs/LogRowContextProvider.tsx b/packages/grafana-ui/src/components/Logs/LogRowContextProvider.tsx index 7fa3bbbaa98..c70216f9db9 100644 --- a/packages/grafana-ui/src/components/Logs/LogRowContextProvider.tsx +++ b/packages/grafana-ui/src/components/Logs/LogRowContextProvider.tsx @@ -11,20 +11,25 @@ import { DataQueryError, } from '@grafana/data'; +/** @deprecated will be removed in the next major version */ export interface RowContextOptions { direction?: 'BACKWARD' | 'FORWARD'; limit?: number; } +/** @deprecated will be removed in the next major version */ export interface LogRowContextRows { before?: string[]; after?: string[]; } + +/** @deprecated will be removed in the next major version */ export interface LogRowContextQueryErrors { before?: string; after?: string; } +/** @deprecated will be removed in the next major version */ export interface HasMoreContextRows { before: boolean; after: boolean; @@ -48,6 +53,7 @@ interface LogRowContextProviderProps { }) => JSX.Element; } +/** @deprecated will be removed in the next major version */ export const getRowContexts = async ( getRowContext: (row: LogRowModel, options?: RowContextOptions) => Promise, row: LogRowModel, @@ -130,6 +136,7 @@ export const getRowContexts = async ( }; }; +/** @deprecated will be removed in the next major version */ export const LogRowContextProvider: React.FunctionComponent = ({ getRowContext, row, diff --git a/packages/grafana-ui/src/components/Logs/LogRowMessage.tsx b/packages/grafana-ui/src/components/Logs/LogRowMessage.tsx index 090fcbd3976..ff6580355d4 100644 --- a/packages/grafana-ui/src/components/Logs/LogRowMessage.tsx +++ b/packages/grafana-ui/src/components/Logs/LogRowMessage.tsx @@ -16,8 +16,7 @@ import { LogRowContext } from './LogRowContext'; import { LogRowContextQueryErrors, HasMoreContextRows, LogRowContextRows } from './LogRowContextProvider'; import { getLogRowStyles } from './getLogRowStyles'; -//Components - +/** @deprecated will be removed in the next major version */ export const MAX_CHARACTERS = 100000; interface Props extends Themeable2 { @@ -187,5 +186,6 @@ class UnThemedLogRowMessage extends PureComponent { } } +/** @deprecated will be removed in the next major version */ export const LogRowMessage = withTheme2(UnThemedLogRowMessage); LogRowMessage.displayName = 'LogRowMessage'; diff --git a/packages/grafana-ui/src/components/Logs/LogRowMessageDetectedFields.tsx b/packages/grafana-ui/src/components/Logs/LogRowMessageDetectedFields.tsx index c4b2363460e..6fae34e6d6e 100644 --- a/packages/grafana-ui/src/components/Logs/LogRowMessageDetectedFields.tsx +++ b/packages/grafana-ui/src/components/Logs/LogRowMessageDetectedFields.tsx @@ -8,6 +8,7 @@ import { Themeable2 } from '../../types/theme'; import { getAllFields } from './logParser'; +/** @deprecated will be removed in the next major version */ export interface Props extends Themeable2 { row: LogRowModel; showDetectedFields: string[]; @@ -45,5 +46,6 @@ class UnThemedLogRowMessageDetectedFields extends PureComponent { } } +/** @deprecated will be removed in the next major version */ export const LogRowMessageDetectedFields = withTheme2(UnThemedLogRowMessageDetectedFields); LogRowMessageDetectedFields.displayName = 'LogRowMessageDetectedFields'; diff --git a/packages/grafana-ui/src/components/Logs/LogRows.tsx b/packages/grafana-ui/src/components/Logs/LogRows.tsx index fe33bf4cc51..1d7896f4189 100644 --- a/packages/grafana-ui/src/components/Logs/LogRows.tsx +++ b/packages/grafana-ui/src/components/Logs/LogRows.tsx @@ -6,13 +6,14 @@ import { TimeZone, LogsDedupStrategy, LogRowModel, Field, LinkModel, LogsSortOrd import { withTheme2 } from '../../themes/index'; import { Themeable2 } from '../../types/theme'; -//Components import { LogRow } from './LogRow'; import { RowContextOptions } from './LogRowContextProvider'; import { getLogRowStyles } from './getLogRowStyles'; +/** @deprecated will be removed in the next major version */ export const PREVIEW_LIMIT = 100; +/** @deprecated will be removed in the next major version */ export interface Props extends Themeable2 { logRows?: LogRowModel[]; deduplicatedRows?: LogRowModel[]; diff --git a/packages/grafana-ui/src/components/Logs/logParser.ts b/packages/grafana-ui/src/components/Logs/logParser.ts index 778c23c43e1..34ad5db7174 100644 --- a/packages/grafana-ui/src/components/Logs/logParser.ts +++ b/packages/grafana-ui/src/components/Logs/logParser.ts @@ -16,6 +16,8 @@ type FieldDef = { /** * Returns all fields for log row which consists of fields we parse from the message itself and additional fields * found in the dataframe (they may contain links). + * + * @deprecated will be removed in the next major version */ export const getAllFields = memoizeOne( (row: LogRowModel, getFieldLinks?: (field: Field, rowIndex: number) => Array>) => {