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

Jump to bottom

Usage of a helper for trace name when preparing trace data #544

Merged
merged 3 commits into from
Apr 8, 2020
Merged

Usage of a helper for trace name when preparing trace data #544

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
18df91b
Usage of getTraceName() when preparing trace data
swapster Mar 13, 2020
50bb191
Tests for transform-trace-data helper
swapster Apr 6, 2020
246db52
Removed unnecessary data from tests
swapster Apr 7, 2020
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
190 changes: 189 additions & 1 deletion packages/jaeger-ui/src/model/transform-trace-data.test.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@
// See the License for the specific language governing permissions and
// limitations under the License.

import { orderTags, deduplicateTags } from './transform-trace-data';
import transformTraceData, { orderTags, deduplicateTags } from './transform-trace-data';

describe('orderTags()', () => {
it('correctly orders tags', () => {
Expand Down Expand Up @@ -53,3 +53,191 @@ describe('deduplicateTags()', () => {
expect(tagsInfo.warnings).toEqual(['Duplicate tag "b.ip:8.8.4.4"']);
});
});

describe('transformTraceData()', () => {
const startTime = 1586160015434000;
const duration = 34000;
const traceID = 'f77950feed55c1ce91dd8e87896623a6';
const rootSpanID = 'd4dcb46e95b781f5';
const rootOperationName = 'rootOperation';
const serviceName = 'serviceName';

const spans = [
{
traceID,
spanID: '41f71485ed2593e4',
operationName: 'someOperationName',
references: [
{
refType: 'CHILD_OF',
traceID,
spanID: rootSpanID,
},
],
startTime,
duration,
tags: [
{
key: 'http.url',
type: 'string',
value: 'https://example.com/getSome',
},
{
key: 'http.method',
type: 'string',
value: 'get',
},
{
key: 'http.status_code',
type: 'float64',
value: 200,
},
],
processID: 'p1',
},
{
traceID,
spanID: '4f623fd33c213cba',
operationName: 'anotherOperationName',
references: [
{
refType: 'CHILD_OF',
traceID,
spanID: rootSpanID,
},
],
startTime: startTime + 100,
duration,
tags: [
{
key: 'http.url',
type: 'string',
value: 'https://example.com/getSomeAnother',
},
{
key: 'http.method',
type: 'string',
value: 'get',
},
{
key: 'error',
type: 'bool',
value: true,
},
{
key: 'http.status_code',
type: 'float64',
value: 404,
},
],
processID: 'p1',
},
];

const rootSpanWithMissingRef = {
traceID,
spanID: rootSpanID,
operationName: rootOperationName,
references: [
{
refType: 'CHILD_OF',
traceID,
spanID: 'missingSpanId',
},
],
startTime: startTime + 50,
duration,
tags: [
{
key: 'http.url',
type: 'string',
value: 'https://example.com/getRoot',
},
{
key: 'http.method',
type: 'string',
value: 'get',
},
{
key: 'http.status_code',
type: 'float64',
value: 200,
},
],
processID: 'p1',
};

const rootSpanWithoutRefs = {
traceID,
spanID: rootSpanID,
operationName: rootOperationName,
startTime: startTime + 50,
duration,
tags: [
{
key: 'http.url',
type: 'string',
value: 'https://example.com/getRoot',
},
{
key: 'http.method',
type: 'string',
value: 'get',
},
{
key: 'http.status_code',
type: 'float64',
value: 200,
},
Copy link
Member

Choose a reason for hiding this comment

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

Nit: are these tags relevant to the functionality being tested? They don't look like it. Could you please trim the fixtures to minimally required data?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Sounds reasonable, thanks :)
Removed unnecessary tags.

],
processID: 'p1',
};

const processes = {
p1: {
serviceName,
tags: [
{
key: 'ip',
type: 'string',
value: '0.0.0.0',
},
{
key: 'hostname',
type: 'string',
value: 'localhost',
},
],
},
};

it('should return null for trace without traceID', () => {
const traceData = {
traceID: undefined,
processes,
spans,
};

expect(transformTraceData(traceData)).toEqual(null);
});

it('should return trace data with correct traceName based on root span with missing ref', () => {
const traceData = {
traceID,
processes,
spans: [...spans, rootSpanWithMissingRef],
};

expect(transformTraceData(traceData).traceName).toEqual(`${serviceName}: ${rootOperationName}`);
});

it('should return trace data with correct traceName based on root span without any refs', () => {
const traceData = {
traceID,
processes,
spans: [...spans, rootSpanWithoutRefs],
};

expect(transformTraceData(traceData).traceName).toEqual(`${serviceName}: ${rootOperationName}`);
});
});
6 changes: 2 additions & 4 deletions packages/jaeger-ui/src/model/transform-trace-data.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@ import _isEqual from 'lodash/isEqual';

import { getTraceSpanIdsAsTree } from '../selectors/trace';
import { getConfigValue } from '../utils/config/get-config';
import { getTraceName } from './trace-viewer';
import { KeyValuePair, Span, SpanData, Trace, TraceData } from '../types/trace';
import TreeNode from '../utils/TreeNode';

Expand Down Expand Up @@ -120,7 +121,6 @@ export default function transformTraceData(data: TraceData & { spans: SpanData[]
const tree = getTraceSpanIdsAsTree(data);
const spans: Span[] = [];
const svcCounts: Record<string, number> = {};
let traceName = '';

tree.walk((spanID: string, node: TreeNode, depth: number = 0) => {
if (spanID === '__root__') {
Expand All @@ -132,9 +132,6 @@ export default function transformTraceData(data: TraceData & { spans: SpanData[]
}
const { serviceName } = span.process;
svcCounts[serviceName] = (svcCounts[serviceName] || 0) + 1;
if (!span.references || !span.references.length) {
traceName = `${serviceName}: ${span.operationName}`;
}
span.relativeStartTime = span.startTime - traceStartTime;
span.depth = depth - 1;
span.hasChildren = node.children.length > 0;
Expand Down Expand Up @@ -163,6 +160,7 @@ export default function transformTraceData(data: TraceData & { spans: SpanData[]
});
spans.push(span);
});
const traceName = getTraceName(spans);
const services = Object.keys(svcCounts).map(name => ({ name, numberOfSpans: svcCounts[name] }));
return {
services,
Expand Down