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 2 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
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[][];
Copy link
Member

Choose a reason for hiding this comment

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

We need to verify taking span links from fields works for our use case. My suspicion is that we need to take span links from _source because fields doesn't return an array of span link objects, but arrays for all leaf fields, such as span.links.trace.id. Also, the content for OTel span links and APM span links will look slightly differently.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Yes, it appears both will have to be specified: span.links.trace.id and span.links.span.id. Are there any additional leaf fields? I can experiment with collecting them and dedotting.

Copy link
Contributor Author

@bryce-b bryce-b Sep 4, 2024 •
edited
Loading

Choose a reason for hiding this comment

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

it seems like span.links.trace.id and span.links.trace.id are string types, while the processed structure is an array of SpanLink[] which implies there may be more than one span link per span, but I'm not able to find examples of spans with more than one SpanLink.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I did some tests and it appears that span.links.trace.id and span.links.span.id will be two equal length and the ids at relative indices are associated.
Screenshot 2024-09-05 at 14 31 15

I was able to recreate the SpanLink[] structure by merging these two arrays together. A commit is coming shortly.

}

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[][];
'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
87 changes: 51 additions & 36 deletions ...terfall_with_summary/waterfall_container/waterfall/waterfall_helpers/waterfall_helpers.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,20 @@ import {
WaterfallSpan,
WaterfallTransaction,
} from '../../../../../../../../common/waterfall/typings';

import {
PARENT_ID,
TIMESTAMP,
ERROR_ID,
TRANSACTION_ID,
TRANSACTION_DURATION,
SERVICE_NAME,
SPAN_LINKS,
SPAN_ID,
SPAN_TYPE,
SPAN_SUBTYPE,
PROCESSOR_EVENT,
SPAN_DURATION,
} from '../../../../../../../../common/es_fields/apm';
type TraceAPIResponse = APIReturnType<'GET /internal/apm/traces/{traceId}'>;

const ROOT_ID = 'root';
Expand Down Expand Up @@ -113,11 +126,11 @@ export type IWaterfallNodeFlatten = Omit<IWaterfallNode, 'children'>;

function getLegendValues(transactionOrSpan: WaterfallTransaction | WaterfallSpan) {
return {
[WaterfallLegendType.ServiceName]: transactionOrSpan.service.name,
[WaterfallLegendType.ServiceName]: transactionOrSpan[SERVICE_NAME]?.[0],
[WaterfallLegendType.SpanType]:
transactionOrSpan.processor.event === ProcessorEvent.span
? (transactionOrSpan as WaterfallSpan).span.subtype ||
(transactionOrSpan as WaterfallSpan).span.type
transactionOrSpan[PROCESSOR_EVENT][0] === ProcessorEvent.span
? (transactionOrSpan as WaterfallSpan)[SPAN_SUBTYPE]?.[0] ||
(transactionOrSpan as WaterfallSpan)[SPAN_TYPE]?.[0]
: '',
};
}
Expand All @@ -129,15 +142,15 @@ function getTransactionItem(
return {
docType: 'transaction',
doc: transaction,
id: transaction.transaction.id,
parentId: transaction.parent?.id,
duration: transaction.transaction.duration.us,
id: transaction[TRANSACTION_ID][0],
parentId: transaction[PARENT_ID]?.[0],
duration: transaction[TRANSACTION_DURATION][0],
offset: 0,
skew: 0,
legendValues: getLegendValues(transaction),
color: '',
spanLinksCount: {
linkedParents: transaction.span?.links?.length ?? 0,
linkedParents: transaction[SPAN_LINKS]?.[0].length ?? 0,
linkedChildren: linkedChildrenCount,
},
};
Expand All @@ -147,15 +160,15 @@ function getSpanItem(span: WaterfallSpan, linkedChildrenCount: number = 0): IWat
return {
docType: 'span',
doc: span,
id: span.span.id,
parentId: span.parent?.id,
duration: span.span.duration.us,
id: span[SPAN_ID][0],
parentId: span[PARENT_ID]?.[0],
duration: span[SPAN_DURATION][0],
offset: 0,
skew: 0,
legendValues: getLegendValues(span),
color: '',
spanLinksCount: {
linkedParents: span.span.links?.length ?? 0,
linkedParents: span[SPAN_LINKS]?.[0].length ?? 0,
linkedChildren: linkedChildrenCount,
},
};
Expand All @@ -166,22 +179,21 @@ function getErrorItem(
items: IWaterfallItem[],
entryWaterfallTransaction?: IWaterfallTransaction
): IWaterfallError {
const entryTimestamp = entryWaterfallTransaction?.doc.timestamp.us ?? 0;
const parent = items.find((waterfallItem) => waterfallItem.id === error.parent?.id) as
const entryTimestamp = entryWaterfallTransaction?.doc[TIMESTAMP][0].us ?? 0;
const parent = items.find((waterfallItem) => waterfallItem.id === error[PARENT_ID]?.[0]) as
| IWaterfallSpanOrTransaction
| undefined;

const errorItem: IWaterfallError = {
docType: 'error',
doc: error,
id: error.error.id,
id: error[ERROR_ID][0] as string,
parent,
parentId: parent?.id,
offset: error.timestamp.us - entryTimestamp,
offset: error[TIMESTAMP][0] - entryTimestamp,
skew: 0,
color: '',
};

return {
...errorItem,
skew: getClockSkew(errorItem, parent),
Expand All @@ -202,15 +214,14 @@ export function getClockSkew(
return parentItem.skew;
// transaction is the initial entry in a service. Calculate skew for this, and it will be propagated to all child spans
case 'transaction': {
const parentStart = parentItem.doc.timestamp.us + parentItem.skew;
const parentStart = parentItem.doc[TIMESTAMP][0] + parentItem.skew;

// determine if child starts before the parent
const offsetStart = parentStart - item.doc.timestamp.us;
const offsetStart = parentStart - item.doc[TIMESTAMP][0];
if (offsetStart > 0) {
const latency = Math.max(parentItem.duration - item.duration, 0) / 2;
return offsetStart + latency;
}

// child transaction starts after parent thus no adjustment is needed
return 0;
}
Expand All @@ -224,7 +235,8 @@ export function getOrderedWaterfallItems(
if (!entryWaterfallTransaction) {
return [];
}
const entryTimestamp = entryWaterfallTransaction.doc.timestamp.us;

const entryTimestamp = entryWaterfallTransaction.doc[TIMESTAMP][0];
const visitedWaterfallItemSet = new Set();

function getSortedChildren(
Expand All @@ -240,7 +252,7 @@ export function getOrderedWaterfallItems(

item.parent = parentItem;
// get offset from the beginning of trace
item.offset = item.doc.timestamp.us - entryTimestamp;
item.offset = item.doc[TIMESTAMP][0] - entryTimestamp;
// move the item to the right if it starts before its parent
item.skew = getClockSkew(item, parentItem);

Expand Down Expand Up @@ -297,15 +309,15 @@ const getWaterfallItems = (
spanLinksCountById: TraceAPIResponse['traceItems']['spanLinksCountById']
) =>
items.map((item) => {
const docType = item.processor.event;
const docType = item[PROCESSOR_EVENT][0];
switch (docType) {
case 'span': {
const span = item as WaterfallSpan;
return getSpanItem(span, spanLinksCountById[span.span.id]);
return getSpanItem(span, spanLinksCountById[span[SPAN_ID]?.[0]]);
}
case 'transaction':
const transaction = item as WaterfallTransaction;
return getTransactionItem(transaction, spanLinksCountById[transaction.transaction.id]);
return getTransactionItem(transaction, spanLinksCountById[transaction[TRANSACTION_ID][0]]);
}
});

Expand All @@ -315,7 +327,7 @@ function reparentSpans(waterfallItems: IWaterfallSpanOrTransaction[]) {
flatten(
waterfallItems.map((waterfallItem) => {
if (waterfallItem.docType === 'span') {
const childIds = waterfallItem.doc.child?.id ?? [];
const childIds = waterfallItem.doc['child.id']?.[0] ?? [];
return childIds.map((id) => [id, waterfallItem.id]);
}
return [];
Expand Down Expand Up @@ -374,12 +386,17 @@ function getWaterfallErrors(
if (!entryWaterfallTransaction) {
return errorItems;
}

const parentIdLookup = [...items, ...errorItems].reduce((map, { id, parentId }) => {
map.set(id, parentId ?? ROOT_ID);
return map;
}, new Map<string, string>());
return errorItems.filter((errorItem) =>
isInEntryTransaction(parentIdLookup, entryWaterfallTransaction?.id, errorItem.id)
isInEntryTransaction(
parentIdLookup,
entryWaterfallTransaction?.[TRANSACTION_ID][0],
errorItem.id
)
);
}

Expand All @@ -389,7 +406,7 @@ function getWaterfallErrors(
*/
function getErrorCountByParentId(errorDocs: TraceAPIResponse['traceItems']['errorDocs']) {
return errorDocs.reduce<Record<string, number>>((acc, doc) => {
const parentId = doc.parent?.id;
const parentId = doc['parent.id']?.[0];

if (!parentId) {
return acc;
Expand All @@ -406,15 +423,15 @@ export const getOrphanTraceItemsCount = (
) => {
const waterfallItemsIds = new Set(
traceDocs.map((doc) =>
doc.processor.event === 'span'
? (doc?.span as WaterfallSpan['span']).id
: doc?.transaction?.id
doc[PROCESSOR_EVENT][0] === 'span'
? (doc as WaterfallSpan)[SPAN_ID][0]
: doc?.[TRANSACTION_ID]?.[0]
)
);

let missingTraceItemsCounter = 0;
traceDocs.some((item) => {
if (item.parent?.id && !waterfallItemsIds.has(item.parent.id)) {
if (item['parent.id']?.[0] && !waterfallItemsIds.has(item['parent.id']?.[0])) {
missingTraceItemsCounter++;
}
});
Expand All @@ -438,14 +455,12 @@ export function getWaterfall(apiResponse: TraceAPIResponse): IWaterfall {
orphanTraceItemsCount: 0,
};
}

const errorCountByParentId = getErrorCountByParentId(traceItems.errorDocs);

const waterfallItems: IWaterfallSpanOrTransaction[] = getWaterfallItems(
traceItems.traceDocs,
traceItems.spanLinksCountById
);

const childrenByParentId = getChildrenGroupedByParentId(reparentSpans(waterfallItems));

const entryWaterfallTransaction = getEntryWaterfallTransaction(
Expand All @@ -462,7 +477,7 @@ export function getWaterfall(apiResponse: TraceAPIResponse): IWaterfall {
const legends = getLegends(items);

const orphanTraceItemsCount = getOrphanTraceItemsCount(traceItems.traceDocs);

q
return {
entryWaterfallTransaction,
rootWaterfallTransaction,
Expand Down
Loading
Loading