Skip to content

Code review changes for #1043 #1208

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 7 commits into
base: main
Choose a base branch
from
Open

Code review changes for #1043 #1208

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
1ea8faa
display kind, status, instrumentation library, links, events and stat…
benceszikora Nov 1, 2024
e7f9977
Match OTel Collector Schema
harryjph Feb 3, 2025
c85b8d6
Merge 'upstream/main' into tracing-fields
harryjph Feb 3, 2025
5d9779b
Fix events and links column entry fields
harryjph Feb 3, 2025
c208504
Fix events and links queries when using flatten_nested=0
harryjph Feb 3, 2025
1c0490d
Merge branch 'main' of github.com:grafana/clickhouse-datasource into …
SpencerTorres Mar 26, 2025
3947bcc
code review edits
SpencerTorres Mar 26, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
450 changes: 181 additions & 269 deletions src/components/configEditor/TracesConfig.test.tsx
View file
Open in desktop

Large diffs are not rendered by default.

98 changes: 93 additions & 5 deletions src/components/configEditor/TracesConfig.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,8 +10,9 @@ import { DurationUnitSelect } from 'components/queryBuilder/DurationUnitSelect';
import { CHTracesConfig } from 'types/config';
import allLabels from 'labels';
import { columnLabelToPlaceholder } from 'data/utils';
import { Switch } from 'components/queryBuilder/Switch';

interface TraceConfigProps {
export interface TraceConfigProps {
tracesConfig?: CHTracesConfig;
onDefaultDatabaseChange: (v: string) => void;
onDefaultTableChange: (v: string) => void;
Expand All @@ -27,7 +28,15 @@ interface TraceConfigProps {
onStartTimeColumnChange: (v: string) => void;
onTagsColumnChange: (v: string) => void;
onServiceTagsColumnChange: (v: string) => void;
onKindColumnChange: (v: string) => void;
onStatusCodeColumnChange: (v: string) => void;
onStatusMessageColumnChange: (v: string) => void;
onStateColumnChange: (v: string) => void;
onInstrumentationLibraryNameColumnChange: (v: string) => void;
onInstrumentationLibraryVersionColumnChange: (v: string) => void;
onFlattenNestedChange: (v: boolean) => void;
onEventsColumnPrefixChange: (v: string) => void;
onLinksColumnPrefixChange: (v: string) => void;
}

export const TracesConfig = (props: TraceConfigProps) => {
Expand All @@ -36,13 +45,20 @@ export const TracesConfig = (props: TraceConfigProps) => {
onOtelEnabledChange, onOtelVersionChange,
onTraceIdColumnChange, onSpanIdColumnChange, onOperationNameColumnChange, onParentSpanIdColumnChange,
onServiceNameColumnChange, onDurationColumnChange, onDurationUnitChange, onStartTimeColumnChange,
onTagsColumnChange, onServiceTagsColumnChange, onEventsColumnPrefixChange
onTagsColumnChange, onServiceTagsColumnChange,
onKindColumnChange, onStatusCodeColumnChange, onStatusMessageColumnChange,
onStateColumnChange,
onInstrumentationLibraryNameColumnChange, onInstrumentationLibraryVersionColumnChange,
onFlattenNestedChange, onEventsColumnPrefixChange, onLinksColumnPrefixChange,
} = props;
let {
defaultDatabase, defaultTable,
otelEnabled, otelVersion,
traceIdColumn, spanIdColumn, operationNameColumn, parentSpanIdColumn, serviceNameColumn,
durationColumn, durationUnit, startTimeColumn, tagsColumn, serviceTagsColumn, eventsColumnPrefix
durationColumn, durationUnit, startTimeColumn, tagsColumn, serviceTagsColumn,
kindColumn, statusCodeColumn, statusMessageColumn, stateColumn,
instrumentationLibraryNameColumn, instrumentationLibraryVersionColumn,
flattenNested, traceEventsColumnPrefix, traceLinksColumnPrefix,
} = (props.tracesConfig || {}) as CHTracesConfig;
const labels = allLabels.components.Config.TracesConfig;

Expand All @@ -57,8 +73,16 @@ export const TracesConfig = (props: TraceConfigProps) => {
durationColumn = otelConfig.traceColumnMap.get(ColumnHint.TraceDurationTime);
tagsColumn = otelConfig.traceColumnMap.get(ColumnHint.TraceTags);
serviceTagsColumn = otelConfig.traceColumnMap.get(ColumnHint.TraceServiceTags);
eventsColumnPrefix = otelConfig.traceColumnMap.get(ColumnHint.TraceEventsPrefix);
kindColumn = otelConfig.traceColumnMap.get(ColumnHint.TraceKind);
statusCodeColumn = otelConfig.traceColumnMap.get(ColumnHint.TraceStatusCode);
statusMessageColumn = otelConfig.traceColumnMap.get(ColumnHint.TraceStatusMessage);
stateColumn = otelConfig.traceColumnMap.get(ColumnHint.TraceState);
instrumentationLibraryNameColumn = otelConfig.traceColumnMap.get(ColumnHint.TraceInstrumentationLibraryName);
instrumentationLibraryVersionColumn = otelConfig.traceColumnMap.get(ColumnHint.TraceInstrumentationLibraryVersion);
durationUnit = otelConfig.traceDurationUnit.toString();
flattenNested = otelConfig.flattenNested;
traceEventsColumnPrefix = otelConfig.traceEventsColumnPrefix;
traceLinksColumnPrefix = otelConfig.traceLinksColumnPrefix;
}

return (
Expand Down Expand Up @@ -183,14 +207,78 @@ export const TracesConfig = (props: TraceConfigProps) => {
value={serviceTagsColumn || ''}
onChange={onServiceTagsColumnChange}
/>
<LabeledInput
disabled={otelEnabled}
label={labels.columns.kind.label}
placeholder={columnLabelToPlaceholder(labels.columns.kind.label)}
tooltip={labels.columns.kind.tooltip}
value={kindColumn || ''}
onChange={onKindColumnChange}
/>
<LabeledInput
disabled={otelEnabled}
label={labels.columns.statusCode.label}
placeholder={columnLabelToPlaceholder(labels.columns.statusCode.label)}
tooltip={labels.columns.statusCode.tooltip}
value={statusCodeColumn || ''}
onChange={onStatusCodeColumnChange}
/>
<LabeledInput
disabled={otelEnabled}
label={labels.columns.statusMessage.label}
placeholder={columnLabelToPlaceholder(labels.columns.statusMessage.label)}
tooltip={labels.columns.statusMessage.tooltip}
value={statusMessageColumn || ''}
onChange={onStatusMessageColumnChange}
/>
<LabeledInput
disabled={otelEnabled}
label={labels.columns.state.label}
placeholder={columnLabelToPlaceholder(labels.columns.state.label)}
tooltip={labels.columns.state.tooltip}
value={stateColumn || ''}
onChange={onStateColumnChange}
/>
<LabeledInput
disabled={otelEnabled}
label={labels.columns.instrumentationLibraryName.label}
placeholder={columnLabelToPlaceholder(labels.columns.instrumentationLibraryName.label)}
tooltip={labels.columns.instrumentationLibraryName.tooltip}
value={instrumentationLibraryNameColumn || ''}
onChange={onInstrumentationLibraryNameColumnChange}
/>
<LabeledInput
disabled={otelEnabled}
label={labels.columns.instrumentationLibraryVersion.label}
placeholder={columnLabelToPlaceholder(labels.columns.instrumentationLibraryVersion.label)}
tooltip={labels.columns.instrumentationLibraryVersion.tooltip}
value={instrumentationLibraryVersionColumn || ''}
onChange={onInstrumentationLibraryVersionColumnChange}
/>
<Switch
disabled={otelEnabled}
label={labels.columns.flattenNested.label}
tooltip={labels.columns.flattenNested.tooltip}
value={flattenNested || false}
onChange={onFlattenNestedChange}
wide
/>
<LabeledInput
disabled={otelEnabled}
label={labels.columns.eventsPrefix.label}
placeholder={columnLabelToPlaceholder(labels.columns.eventsPrefix.label)}
tooltip={labels.columns.eventsPrefix.tooltip}
value={eventsColumnPrefix || ''}
value={traceEventsColumnPrefix || ''}
onChange={onEventsColumnPrefixChange}
/>
<LabeledInput
disabled={otelEnabled}
label={labels.columns.linksPrefix.label}
placeholder={columnLabelToPlaceholder(labels.columns.linksPrefix.label)}
tooltip={labels.columns.linksPrefix.tooltip}
value={traceLinksColumnPrefix || ''}
onChange={onLinksColumnPrefixChange}
/>
</ConfigSubSection>
</ConfigSection>
);
Expand Down
4 changes: 3 additions & 1 deletion src/components/queryBuilder/Switch.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,12 +7,13 @@ interface SwitchProps {
onChange: (value: boolean) => void;
label: string;
tooltip: string;
disabled?: boolean;
inline?: boolean;
wide?: boolean;
}

export const Switch = (props: SwitchProps) => {
const { value, onChange, label, tooltip, inline, wide } = props;
const { value, onChange, label, tooltip, disabled, inline, wide } = props;

const theme = useTheme();
const switchContainerStyle: React.CSSProperties = {
Expand All @@ -31,6 +32,7 @@ export const Switch = (props: SwitchProps) => {
</InlineFormLabel>
<div style={switchContainerStyle}>
<GrafanaSwitch
disabled={disabled}
className="gf-form"
value={value}
onChange={e => onChange(e.currentTarget.checked)}
Expand Down
144 changes: 132 additions & 12 deletions src/components/queryBuilder/views/TraceQueryBuilder.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ import { FiltersEditor } from '../FilterEditor';
import allLabels from 'labels';
import { ModeSwitch } from '../ModeSwitch';
import { getColumnByHint } from 'data/sqlGenerator';
import { Alert, Collapse, VerticalGroup } from '@grafana/ui';
import { Alert, Collapse, Stack } from '@grafana/ui';
import { DurationUnitSelect } from 'components/queryBuilder/DurationUnitSelect';
import { Datasource } from 'data/CHDatasource';
import { useBuilderOptionChanges } from 'hooks/useBuilderOptionChanges';
Expand All @@ -18,6 +18,7 @@ import TraceIdInput from '../TraceIdInput';
import { OrderByEditor, getOrderByOptions } from '../OrderByEditor';
import { LimitEditor } from '../LimitEditor';
import { LabeledInput } from 'components/configEditor/LabeledInput';
import { Switch } from '../Switch';

interface TraceQueryBuilderProps {
datasource: Datasource;
Expand All @@ -39,7 +40,15 @@ interface TraceQueryBuilderState {
durationUnit: TimeUnit;
tagsColumn?: SelectedColumn;
serviceTagsColumn?: SelectedColumn;
eventsColumnPrefix?: SelectedColumn;
kindColumn?: SelectedColumn;
statusCodeColumn?: SelectedColumn;
statusMessageColumn?: SelectedColumn;
stateColumn?: SelectedColumn;
instrumentationLibraryNameColumn?: SelectedColumn;
instrumentationLibraryVersionColumn?: SelectedColumn;
flattenNested?: boolean;
traceEventsColumnPrefix?: string;
traceLinksColumnPrefix?: string;
traceId: string;
orderBy: OrderBy[];
limit: number;
Expand All @@ -54,7 +63,7 @@ export const TraceQueryBuilder = (props: TraceQueryBuilderProps) => {
const [isColumnsOpen, setColumnsOpen] = useState<boolean>(showConfigWarning); // Toggle Columns collapse section
const [isFiltersOpen, setFiltersOpen] = useState<boolean>(!(builderOptions.meta?.isTraceIdMode && builderOptions.meta.traceId)); // Toggle Filters collapse section
const labels = allLabels.components.TraceQueryBuilder;
const builderState: TraceQueryBuilderState = useMemo(() => ({
const builderState = useMemo<TraceQueryBuilderState>(() => ({
isTraceIdMode: builderOptions.meta?.isTraceIdMode || false,
otelEnabled: builderOptions.meta?.otelEnabled || false,
otelVersion: builderOptions.meta?.otelVersion || '',
Expand All @@ -68,7 +77,15 @@ export const TraceQueryBuilder = (props: TraceQueryBuilderProps) => {
durationUnit: builderOptions.meta?.traceDurationUnit || TimeUnit.Nanoseconds,
tagsColumn: getColumnByHint(builderOptions, ColumnHint.TraceTags),
serviceTagsColumn: getColumnByHint(builderOptions, ColumnHint.TraceServiceTags),
eventsColumnPrefix: getColumnByHint(builderOptions, ColumnHint.TraceEventsPrefix),
kindColumn: getColumnByHint(builderOptions, ColumnHint.TraceKind),
statusCodeColumn: getColumnByHint(builderOptions, ColumnHint.TraceStatusCode),
statusMessageColumn: getColumnByHint(builderOptions, ColumnHint.TraceStatusMessage),
stateColumn: getColumnByHint(builderOptions, ColumnHint.TraceState),
instrumentationLibraryNameColumn: getColumnByHint(builderOptions, ColumnHint.TraceInstrumentationLibraryName),
instrumentationLibraryVersionColumn: getColumnByHint(builderOptions, ColumnHint.TraceInstrumentationLibraryVersion),
flattenNested: Boolean(builderOptions.meta?.flattenNested),
traceEventsColumnPrefix: builderOptions.meta?.traceEventsColumnPrefix || '',
traceLinksColumnPrefix: builderOptions.meta?.traceLinksColumnPrefix || '',
traceId: builderOptions.meta?.traceId || '',
orderBy: builderOptions.orderBy || [],
limit: builderOptions.limit || 0,
Expand All @@ -86,7 +103,13 @@ export const TraceQueryBuilder = (props: TraceQueryBuilderProps) => {
next.durationTimeColumn,
next.tagsColumn,
next.serviceTagsColumn,
next.eventsColumnPrefix
next.serviceTagsColumn,
next.kindColumn,
next.statusCodeColumn,
next.statusMessageColumn,
next.stateColumn,
next.instrumentationLibraryNameColumn,
next.instrumentationLibraryVersionColumn,
].filter(c => c !== undefined) as SelectedColumn[];

builderOptionsDispatch(setOptions({
Expand All @@ -98,6 +121,9 @@ export const TraceQueryBuilder = (props: TraceQueryBuilderProps) => {
isTraceIdMode: next.isTraceIdMode,
traceDurationUnit: next.durationUnit,
traceId: next.traceId,
flattenNested: next.flattenNested,
traceEventsColumnPrefix: next.traceEventsColumnPrefix,
traceLinksColumnPrefix: next.traceLinksColumnPrefix,
}
}));
}, builderState);
Expand All @@ -108,12 +134,12 @@ export const TraceQueryBuilder = (props: TraceQueryBuilderProps) => {

const configWarning = showConfigWarning && (
<Alert title="" severity="warning" buttonContent="Close" onRemove={() => setConfigWarningOpen(false)}>
<VerticalGroup>
<Stack>
<div>
{'To speed up your query building, enter your default trace configuration in your '}
<a style={{ textDecoration: 'underline' }} href={`/connections/datasources/edit/${encodeURIComponent(datasource.uid)}#traces-config`}>ClickHouse Data Source settings</a>
</div>
</VerticalGroup>
</Stack>
</Alert>
);

Expand Down Expand Up @@ -261,12 +287,106 @@ export const TraceQueryBuilder = (props: TraceQueryBuilderProps) => {
/>
</div>
<div className="gf-form">
<LabeledInput
<ColumnSelect
disabled={builderState.otelEnabled}
allColumns={allColumns}
selectedColumn={builderState.kindColumn}
invalid={!builderState.kindColumn}
onColumnChange={onOptionChange('kindColumn')}
columnHint={ColumnHint.TraceKind}
label={labels.columns.kind.label}
tooltip={labels.columns.kind.tooltip}
wide
/>
<ColumnSelect
disabled={builderState.otelEnabled}
allColumns={allColumns}
selectedColumn={builderState.statusCodeColumn}
invalid={!builderState.statusCodeColumn}
onColumnChange={onOptionChange('statusCodeColumn')}
columnHint={ColumnHint.TraceStatusCode}
label={labels.columns.statusCode.label}
tooltip={labels.columns.statusCode.tooltip}
wide
inline
/>
</div>
<div className="gf-form">
<ColumnSelect
disabled={builderState.otelEnabled}
allColumns={allColumns}
selectedColumn={builderState.statusMessageColumn}
invalid={!builderState.statusMessageColumn}
onColumnChange={onOptionChange('statusMessageColumn')}
columnHint={ColumnHint.TraceStatusMessage}
label={labels.columns.statusMessage.label}
tooltip={labels.columns.statusMessage.tooltip}
wide
/>
<ColumnSelect
disabled={builderState.otelEnabled}
allColumns={allColumns}
selectedColumn={builderState.stateColumn}
invalid={!builderState.stateColumn}
onColumnChange={onOptionChange('stateColumn')}
columnHint={ColumnHint.TraceState}
label={labels.columns.state.label}
tooltip={labels.columns.state.tooltip}
wide
inline
/>
</div>
<div className="gf-form">
<ColumnSelect
disabled={builderState.otelEnabled}
label={labels.columns.eventsPrefix.label}
tooltip={labels.columns.eventsPrefix.tooltip}
value={builderState.eventsColumnPrefix?.name || ''}
onChange={onOptionChange('eventsColumnPrefix')}
allColumns={allColumns}
selectedColumn={builderState.instrumentationLibraryNameColumn}
invalid={!builderState.instrumentationLibraryNameColumn}
onColumnChange={onOptionChange('instrumentationLibraryNameColumn')}
columnHint={ColumnHint.TraceInstrumentationLibraryName}
label={labels.columns.instrumentationLibraryName.label}
tooltip={labels.columns.instrumentationLibraryName.tooltip}
wide
/>
<ColumnSelect
disabled={builderState.otelEnabled}
allColumns={allColumns}
selectedColumn={builderState.instrumentationLibraryVersionColumn}
invalid={!builderState.instrumentationLibraryVersionColumn}
onColumnChange={onOptionChange('instrumentationLibraryVersionColumn')}
columnHint={ColumnHint.TraceInstrumentationLibraryVersion}
label={labels.columns.instrumentationLibraryVersion.label}
tooltip={labels.columns.instrumentationLibraryVersion.tooltip}
wide
inline
/>
</div>
<div className="gf-form">
<Switch
disabled={builderState.otelEnabled}
label={labels.columns.flattenNested.label}
tooltip={labels.columns.flattenNested.tooltip}
value={Boolean(builderState.flattenNested)}
onChange={onOptionChange('flattenNested')}
wide
/>
</div>
<div className="gf-form">
<LabeledInput
disabled={builderState.otelEnabled}
label={labels.columns.eventsPrefix.label}
tooltip={labels.columns.eventsPrefix.tooltip}
value={builderState.traceEventsColumnPrefix || ''}
onChange={onOptionChange('traceEventsColumnPrefix')}
/>
</div>
<div className="gf-form">
<LabeledInput
disabled={builderState.otelEnabled}
label={labels.columns.linksPrefix.label}
tooltip={labels.columns.linksPrefix.tooltip}
value={builderState.traceLinksColumnPrefix || ''}
onChange={onOptionChange('traceLinksColumnPrefix')}
/>
</div>
</Collapse>
Expand Down
Loading