Skip to content
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

Removed _Source use from get_trace_items #191647

Closed
wants to merge 10 commits into from
Closed

Removed _Source use from get_trace_items #191647

Show file tree
Hide file tree
Changes from 5 commits
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
111df68
wip
bryce-b Aug 26, 2024
78e1b65
removed _source usage from get_trace_items.ts
bryce-b Aug 28, 2024
a2a0565
removed comment
bryce-b Aug 28, 2024
fddcff4
updated tests and fixes
bryce-b Aug 30, 2024
18954f6
fixed tests to reflect changes from removal of _source usage
bryce-b Sep 3, 2024
3bd5c99
changed span.links to use span.links.span.id and span.links.trace.id
bryce-b Sep 5, 2024
6a4a8e8
Merge branch 'main' into remove-_source-from-queries
bryce-b Sep 5, 2024
d438980
fixed additional fields missed
bryce-b Sep 5, 2024
96ad20e
fixed EventOutcome type
bryce-b Sep 6, 2024
0fe5b64
additional fixes
bryce-b Sep 6, 2024
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
19 changes: 16 additions & 3 deletions x-pack/plugins/observability_solution/apm/common/critical_path/get_critical_path.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,18 +6,29 @@
*/
import { apm, ApmFields, dedot } from '@kbn/apm-synthtrace-client';
import { getWaterfall } from '../../public/components/app/transaction_details/waterfall_with_summary/waterfall_container/waterfall/waterfall_helpers/waterfall_helpers';
import { Span } from '../../typings/es_schemas/ui/span';
import { Transaction } from '../../typings/es_schemas/ui/transaction';
import { getCriticalPath } from './get_critical_path';
import { WaterfallSpan, WaterfallTransaction } from '../waterfall/typings';

describe('getCriticalPath', () => {
function getCriticalPathFromEvents(events: ApmFields[]) {
events = events.filter((event) => event['processor.event'] !== 'metric');

const entryTransaction = dedot(events[0]!, {}) as Transaction;

const traceDocs = events.map((event: any) => {
Object.keys(event).forEach((key) => {
const item = event[key];
if (!Array.isArray(item)) {
event[key] = [item];
}
});
return event as WaterfallSpan | WaterfallTransaction;
});

const waterfall = getWaterfall({
traceItems: {
traceDocs: events.map((event) => dedot(event, {}) as Transaction | Span),
traceDocs,
errorDocs: [],
exceedsMax: false,
spanLinksCountById: {},
Expand Down Expand Up @@ -72,7 +83,9 @@ describe('getCriticalPath', () => {
.serialize()
);

const longerSpan = waterfall.items.find((item) => (item.doc as Span).span?.name === 'bar');
const longerSpan = waterfall.items.find(
(item) => ((item.doc as WaterfallSpan)['span.name']?.[0] as string) === 'bar'
);

expect(segments).toEqual([
{ self: false, duration: 100000, item: waterfall.items[0], offset: 0 },
Expand Down
113 changes: 45 additions & 68 deletions x-pack/plugins/observability_solution/apm/common/waterfall/typings.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,81 +8,58 @@
import { Exception } from '../../typings/es_schemas/raw/error_raw';
import { EventOutcome } from '../../typings/es_schemas/raw/fields/event_outcome';
import { SpanLink } from '../../typings/es_schemas/raw/fields/span_links';
import { TimestampUs } from '../../typings/es_schemas/raw/fields/timestamp_us';
import { AgentName } from '../../typings/es_schemas/ui/fields/agent';

export interface WaterfallTransaction {
timestamp: TimestampUs;
trace: { id: string };
service: {
name: string;
environment?: string;
};
agent: { name: AgentName };
event?: { outcome?: EventOutcome };
parent?: { id?: string };
processor: { event: 'transaction' };
transaction: {
duration: { us: number };
id: string;
name: string;
type: string;
result?: string;
};
faas?: {
coldstart?: boolean;
};
span?: {
links?: SpanLink[];
};
'timestamp.us': number[];
'trace.id': string[];
'service.name': string[];
'service.environment'?: string[];
'agent.name': AgentName[];
'event.outcome'?: EventOutcome[];
'parent.id'?: string[];
'processor.event': ['transaction'];
'transaction.duration.us': number[];
'transaction.id': string[];
'transaction.name': string[];
'transaction.type': string[];
'transaction.result'?: string[];
'faas.coldstart'?: boolean[];
'span.links'?: SpanLink[];
}

export interface WaterfallSpan {
timestamp: TimestampUs;
trace: { id: string };
service: {
name: string;
environment?: string;
};
agent: { name: AgentName };
event?: { outcome?: EventOutcome };
parent?: { id?: string };
processor: { event: 'span' };
span: {
id: string;
type: string;
subtype?: string;
action?: string;
name: string;
composite?: {
count: number;
sum: { us: number };
compression_strategy: string;
};
sync?: boolean;
duration: { us: number };
links?: SpanLink[];
};
transaction?: {
id: string;
};
child?: { id: string[] };
'timestamp.us': number[];
'trace.id': string[];
'service.name': string[];
'service.environment'?: string[];
'agent.name': AgentName[];
'event.outcome'?: EventOutcome[];
'parent.id'?: string[];
'processor.event': ['span'];
'span.id': string[];
'span.type': string[];
'span.subtype'?: string[];
'span.action'?: string[];
'span.name': string[];
'span.composite.count'?: number[];
'span.composite.sum.us'?: number[];
'span.composite.compression_strategy'?: string[];
'span.sync'?: boolean[];
'span.duration.us': number[];
'span.links'?: SpanLink[];
'transaction.id'?: string[];
'child.id'?: string[];
}

export interface WaterfallError {
timestamp: TimestampUs;
trace?: { id: string };
transaction?: { id: string };
parent?: { id: string };
error: {
id: string;
log?: {
message: string;
};
exception?: Exception[];
grouping_key: string;
};
service: {
name: string;
};
'timestamp.us': number[];
'trace.id'?: string[];
'transaction.id'?: string[];
'parent.id'?: string[];
'error.id': string[];
'error.log.message'?: string[];
'error.exception'?: Exception[];
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This needs to get resolved

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It seems like the error.exception.stacktrace... fields are not accessible through the fields query. Should I try injecting them through the _sources response? @felixbarny

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hm, yes, I think the exception stack trace (and possibly span links) need to be fetched from _source. Make sure to only fetch the fields you need from source using source filtering.

Note that the structure will be different for OTel values. So we'll probably want to normalize/convert the data to have a consistent model the UI can work with.

'error.grouping_key': string[];
'service.name': string[];
}
3 changes: 1 addition & 2 deletions ...servability_solution/apm/public/components/app/transaction_details/distribution/index.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -61,9 +61,8 @@ export function TransactionDistribution({
const { waterfallItemId, detailTab } = urlParams;

const { serviceName } = useApmServiceContext();

const markerCurrentEvent =
waterfallFetchResult.waterfall.entryWaterfallTransaction?.doc.transaction.duration.us;
waterfallFetchResult.waterfall.entryWaterfallTransaction?.doc['transaction.duration.us'][0];

const { chartData, hasData, percentileThresholdValue, status, totalDocCount } =
useTransactionDistributionChartData();
Expand Down
2 changes: 1 addition & 1 deletion ...c/components/app/transaction_details/waterfall_with_summary/waterfall_container/index.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -67,7 +67,7 @@ export function WaterfallContainer({

if (!color) {
// fall back to service color if there's no span.type, e.g. for transactions
color = serviceColors[item.doc.service.name];
color = serviceColors[item.doc['service.name']?.[0]];
}

item.color = color;
Expand Down
16 changes: 8 additions & 8 deletions ...nsaction_details/waterfall_with_summary/waterfall_container/marks/get_error_marks.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,14 +21,14 @@ describe('getErrorMarks', () => {
docType: 'error',
offset: 10,
skew: 5,
doc: { error: { id: 1 }, service: { name: 'opbeans-java' } },
doc: { 'error.id': [1], 'service.name': ['opbeans-java'] },
color: 'red',
} as unknown,
{
docType: 'error',
offset: 50,
skew: 0,
doc: { error: { id: 2 }, service: { name: 'opbeans-node' } },
doc: { 'error.id': [2], 'service.name': ['opbeans-node'] },
color: 'blue',
} as unknown,
] as IWaterfallError[];
Expand All @@ -38,15 +38,15 @@ describe('getErrorMarks', () => {
offset: 15,
verticalLine: false,
id: 1,
error: { error: { id: 1 }, service: { name: 'opbeans-java' } },
error: { 'error.id': [1], 'service.name': ['opbeans-java'] },
serviceColor: 'red',
},
{
type: 'errorMark',
offset: 50,
verticalLine: false,
id: 2,
error: { error: { id: 2 }, service: { name: 'opbeans-node' } },
error: { 'error.id': [2], 'service.name': ['opbeans-node'] },
serviceColor: 'blue',
},
]);
Expand All @@ -58,14 +58,14 @@ describe('getErrorMarks', () => {
docType: 'error',
offset: 10,
skew: 5,
doc: { error: { id: 1 }, service: { name: 'opbeans-java' } },
doc: { 'error.id': [1], 'service.name': ['opbeans-java'] },
color: '',
} as unknown,
{
docType: 'error',
offset: 50,
skew: 0,
doc: { error: { id: 2 }, service: { name: 'opbeans-node' } },
doc: { 'error.id': [2], 'service.name': ['opbeans-node'] },
color: '',
} as unknown,
] as IWaterfallError[];
Expand All @@ -75,15 +75,15 @@ describe('getErrorMarks', () => {
offset: 15,
verticalLine: false,
id: 1,
error: { error: { id: 1 }, service: { name: 'opbeans-java' } },
error: { 'error.id': [1], 'service.name': ['opbeans-java'] },
serviceColor: '',
},
{
type: 'errorMark',
offset: 50,
verticalLine: false,
id: 2,
error: { error: { id: 2 }, service: { name: 'opbeans-node' } },
error: { 'error.id': [2], 'service.name': ['opbeans-node'] },
serviceColor: '',
},
]);
Expand Down
2 changes: 1 addition & 1 deletion ...p/transaction_details/waterfall_with_summary/waterfall_container/marks/get_error_marks.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ export const getErrorMarks = (errorItems: IWaterfallError[]): ErrorMark[] => {
type: 'errorMark',
offset: Math.max(error.offset + error.skew, 0),
verticalLine: false,
id: error.doc.error.id,
id: error.doc['error.id']?.[0],
error: error.doc,
serviceColor: error.color,
}));
Expand Down
Loading