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

Added view for showing detailed trace statistics #506

Merged
merged 8 commits into from
Jul 28, 2020
Merged

Added view for showing detailed trace statistics #506

Show file tree
Hide file tree
Changes from 4 commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
8124a95
Added view for showing detailed trace statistics
fylip97 Dec 23, 2019
b0f4837
Reworked trace statistics ui
fylip97 Jan 27, 2020
fb08bd7
Merge remote-tracking branch 'refs/remotes/jaeger/master'
Jan 27, 2020
3b2c011
review included
Feb 26, 2020
72aa762
feedback added
Apr 21, 2020
bb39023
Merge branch 'master' into master
everett980 Jul 24, 2020
0841863
Handle merge conflict, clean up AltViewOptions style
everett980 Jul 28, 2020
d6710ac
Merge branch 'master' into master
everett980 Jul 28, 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
2 changes: 1 addition & 1 deletion packages/jaeger-ui/src/components/DeepDependencies/Header/index.test.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ import MdVisibilityOff from 'react-icons/lib/md/visibility-off';

import Header from './index';
import HopsSelector from './HopsSelector';
import NameSelector from './NameSelector';
import NameSelector from '../../common/NameSelector';
import * as track from '../index.track';

describe('<Header>', () => {
Expand Down
2 changes: 1 addition & 1 deletion packages/jaeger-ui/src/components/DeepDependencies/Header/index.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ import MdVisibility from 'react-icons/lib/md/visibility';
import MdVisibilityOff from 'react-icons/lib/md/visibility-off';

import HopsSelector from './HopsSelector';
import NameSelector from './NameSelector';
import NameSelector from '../../common/NameSelector';
import LayoutSettings from './LayoutSettings';
import { trackFilter, trackHeaderSetOperation, trackShowMatches } from '../index.track';
import UiFindInput from '../../common/UiFindInput';
Expand Down
59 changes: 32 additions & 27 deletions packages/jaeger-ui/src/components/TracePage/TracePageHeader/AltViewOptions.test.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,17 +14,18 @@

import * as React from 'react';
import { shallow } from 'enzyme';
import { Button, Dropdown } from 'antd';
import { Dropdown } from 'antd';
import { Link } from 'react-router-dom';

import AltViewOptions from './AltViewOptions';
import * as track from './TracePageHeader.track';
import { ETraceViewType } from '../types';

describe('AltViewOptions', () => {
let trackGanttView;
let trackGraphView;
let trackJsonView;
let trackRawJsonView;
let trackStatisticsView;

let wrapper;
const getLink = text => {
Expand All @@ -34,21 +35,26 @@ describe('AltViewOptions', () => {
const link = links.at(i);
if (link.children().text() === text) return link;
}
const link = menu.find('a');
if (link.children().text() === text) return link;
const links2 = menu.find('a');
for (let i = 0; i < links.length; i++) {
const link = links2.at(i);
if (link.children().text() === text) return link;
}
throw new Error(`Could not find "${text}"`);
};

const props = {
traceGraphView: true,
viewType: ETraceViewType.TraceTimelineViewer,
traceID: 'test trace ID',
onTraceGraphViewClicked: jest.fn(),
onTraceViewChange: jest.fn(),
};

beforeAll(() => {
trackGanttView = jest.spyOn(track, 'trackGanttView');
trackGraphView = jest.spyOn(track, 'trackGraphView');
trackJsonView = jest.spyOn(track, 'trackJsonView');
trackRawJsonView = jest.spyOn(track, 'trackRawJsonView');
trackStatisticsView = jest.spyOn(track, 'trackStatisticsView');
});

beforeEach(() => {
Expand All @@ -74,33 +80,32 @@ describe('AltViewOptions', () => {
expect(trackGraphView).not.toHaveBeenCalled();
});

it('toggles and tracks toggle', () => {
expect(trackGanttView).not.toHaveBeenCalled();
expect(props.onTraceGraphViewClicked).not.toHaveBeenCalled();
getLink('Trace Timeline').simulate('click');
expect(trackGanttView).toHaveBeenCalledTimes(1);
expect(props.onTraceGraphViewClicked).toHaveBeenCalledTimes(1);

wrapper.setProps({ traceGraphView: false });
it('track dropdown menu', () => {
Copy link
Collaborator

Choose a reason for hiding this comment

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

due to the increase in views, this test is getting slightly out of hand. I would rework it as follows:

const viewInteractions = [{
  link: 'Trace Graph',
  trackFn: trackGraphView,
  onTraceViewChangeArg: ETraceViewType.TraceGraph,
}, {
  link: 'Trace Statistics',
  trackFn: trackStatisticsView,
  onTraceViewChangeArg: ETraceViewType.TraceStatisticsView,
  propViewType: ETraceViewType.TraceGraph,
}, {
  link: 'Trace Timeline',
  trackFn: trackGanttView,
  onTraceViewChangeArg: ETraceViewType.TraceTimelineViewer,
  propViewType: ETraceViewType.TraceStatisticsView
}];

viewInteractions.forEach(({ link, trackFn, onTraceViewChangeArg, propViewType }, i) => {
  if (propViewType) {
    wrapper.setProps({ viewType: propViewType });
  }
  expect(props.onTraceViewChange).toHaveBeenCalledTimes(i);
  expect(trackFn).not.toHaveBeenCalled();

  getLink(link).simulate('click');
  expect(props.onTraceViewChange).toHaveBeenCalledTimes(i + 1);
  expect(props.onTraceViewChange).toHaveBeenLastCalledWith(onTraceViewChangeArg);
  viewInteractions.forEach(({ trackFn: fn, j }) => {
    expect(fn).toHaveBeenCalledTimes(j <= i ? 1 : 0);
  });
});

expect(trackGraphView).not.toHaveBeenCalled();
expect(props.onTraceViewChange).not.toHaveBeenCalled();
getLink('Trace Graph').simulate('click');
expect(trackGraphView).toHaveBeenCalledTimes(1);
expect(props.onTraceGraphViewClicked).toHaveBeenCalledTimes(2);
expect(props.onTraceViewChange).toHaveBeenCalledTimes(1);
expect(trackStatisticsView).not.toHaveBeenCalled();
getLink('Trace Statistics').simulate('click');
expect(trackStatisticsView).toHaveBeenCalledTimes(1);
expect(props.onTraceViewChange).toHaveBeenCalledTimes(2);

wrapper.setProps({ traceGraphView: true });
wrapper.setProps({ viewType: ETraceViewType.TraceGraph });
expect(trackGanttView).not.toHaveBeenCalled();
getLink('Trace Timeline').simulate('click');
expect(trackGanttView).toHaveBeenCalledTimes(1);
wrapper.find(Button).simulate('click');
expect(trackGanttView).toHaveBeenCalledTimes(2);
expect(props.onTraceGraphViewClicked).toHaveBeenCalledTimes(3);

wrapper.setProps({ traceGraphView: false });
expect(trackGraphView).toHaveBeenCalledTimes(1);
wrapper.find(Button).simulate('click');
expect(trackGraphView).toHaveBeenCalledTimes(2);
expect(props.onTraceGraphViewClicked).toHaveBeenCalledTimes(4);
expect(props.onTraceViewChange).toHaveBeenCalledTimes(3);
getLink('Trace Statistics').simulate('click');
expect(trackStatisticsView).toHaveBeenCalledTimes(2);
expect(props.onTraceViewChange).toHaveBeenCalledTimes(4);

wrapper.setProps({ viewType: 2 });
getLink('Trace Timeline').simulate('click');
expect(trackGanttView).toHaveBeenCalledTimes(2);
expect(trackJsonView).not.toHaveBeenCalled();
expect(trackRawJsonView).not.toHaveBeenCalled();
expect(props.onTraceViewChange).toHaveBeenCalledTimes(5);
getLink('Trace Graph').simulate('click');
expect(trackGraphView).toHaveBeenCalledTimes(2);
expect(props.onTraceViewChange).toHaveBeenCalledTimes(6);
});
});
67 changes: 52 additions & 15 deletions packages/jaeger-ui/src/components/TracePage/TracePageHeader/AltViewOptions.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,29 +16,62 @@ import * as React from 'react';
import { Button, Dropdown, Icon, Menu } from 'antd';
import { Link } from 'react-router-dom';

import { trackGanttView, trackGraphView, trackJsonView, trackRawJsonView } from './TracePageHeader.track';
import {
trackGanttView,
trackGraphView,
trackStatisticsView,
trackJsonView,
trackRawJsonView,
} from './TracePageHeader.track';
import prefixUrl from '../../../utils/prefix-url';
import { ETraceViewType } from '../types';

type Props = {
onTraceGraphViewClicked: () => void;
traceGraphView: boolean;
onTraceViewChange: (actualViewType: ETraceViewType) => void;
Copy link
Collaborator

Choose a reason for hiding this comment

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

what does "actual" mean here?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Done.

traceID: string;
viewType: ETraceViewType;
};

const menuItems = [
Copy link
Collaborator

Choose a reason for hiding this comment

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

const MENU_ITEMS

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Done.

{
viewType: ETraceViewType.TraceTimelineViewer,
label: 'Trace Timeline',
},
{
viewType: ETraceViewType.TraceGraph,
label: 'Trace Graph',
},
{
viewType: ETraceViewType.TraceStatistics,
label: 'Trace Statistics',
},
];

export default function AltViewOptions(props: Props) {
const { onTraceGraphViewClicked, traceGraphView, traceID } = props;
const handleToggleView = () => {
if (traceGraphView) trackGanttView();
else trackGraphView();
onTraceGraphViewClicked();
const { onTraceViewChange, viewType, traceID } = props;

const handleToggleView = (item: ETraceViewType) => {
Copy link
Collaborator

Choose a reason for hiding this comment

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

toggle should be select

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Done.

if (item === ETraceViewType.TraceTimelineViewer) {
trackGanttView();
} else if (item === ETraceViewType.TraceGraph) {
trackGraphView();
} else if (item === ETraceViewType.TraceStatistics) {
trackStatisticsView();
}
onTraceViewChange(item);
};

const menu = (
<Menu>
<Menu.Item>
<a onClick={handleToggleView} role="button">
{traceGraphView ? 'Trace Timeline' : 'Trace Graph'}
</a>
</Menu.Item>
{menuItems.map(item =>
Copy link
Collaborator

Choose a reason for hiding this comment

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

This would be clearer as:

{menuItems.filter(item => item.viewType !== viewType).map(item => (
  <Menu.Item key={item.viewType}>
    {/* ... */}
  </Menu.Item>
))}

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Done.

item.viewType === viewType ? null : (
<Menu.Item key={item.label}>
<a onClick={() => handleToggleView(item.viewType)} role="button">
{item.label}
</a>
</Menu.Item>
)
)}
<Menu.Item>
<Link
to={prefixUrl(`/api/traces/${traceID}?prettyPrint=true`)}
Expand All @@ -61,10 +94,14 @@ export default function AltViewOptions(props: Props) {
</Menu.Item>
</Menu>
);

return (
<Dropdown overlay={menu}>
<Button className="ub-mr2" htmlType="button" onClick={handleToggleView}>
Alternate Views <Icon type="down" />
<Button className="ub-mr2" htmlType="button">
Copy link
Collaborator

Choose a reason for hiding this comment

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

This shouldn't be an action-less button, instead it should be a span.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Done.

{menuItems.find(test => test.viewType === viewType) !== undefined
Copy link
Collaborator

Choose a reason for hiding this comment

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

I'd calculate the dropdownText outside of the return value. and I think this:

const currentItem = menuItems.find(item => item.viewType === viewType);
const dropdownText = currentItem ? currentItem.label : 'Alternate Views';

is clearer and better handles the (presumably impossible) case of an invalid current viewType.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Done.

? menuItems.find(test => test.viewType === viewType)!.label
: ''}
<Icon type="down" />
</Button>
</Dropdown>
);
Expand Down
2 changes: 2 additions & 0 deletions packages/jaeger-ui/src/components/TracePage/TracePageHeader/TracePageHeader.track.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,12 +24,14 @@ export const ACTION_GANTT = 'gantt';
export const ACTION_GRAPH = 'graph';
export const ACTION_JSON = 'json';
export const ACTION_RAW_JSON = 'rawJson';
export const ACTION_STATISTICS = 'traceStatistics';

// use a closure instead of bind to prevent forwarding any arguments to trackEvent()
export const trackGanttView = () => trackEvent(CATEGORY_ALT_VIEW, ACTION_GANTT);
export const trackGraphView = () => trackEvent(CATEGORY_ALT_VIEW, ACTION_GRAPH);
export const trackJsonView = () => trackEvent(CATEGORY_ALT_VIEW, ACTION_JSON);
export const trackRawJsonView = () => trackEvent(CATEGORY_ALT_VIEW, ACTION_RAW_JSON);
export const trackStatisticsView = () => trackEvent(CATEGORY_ALT_VIEW, ACTION_STATISTICS);

export const trackSlimHeaderToggle = (isOpen: boolean) =>
trackEvent(CATEGORY_SLIM_HEADER, getToggleValue(isOpen));
18 changes: 7 additions & 11 deletions packages/jaeger-ui/src/components/TracePage/TracePageHeader/TracePageHeader.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ import AltViewOptions from './AltViewOptions';
import KeyboardShortcutsHelp from './KeyboardShortcutsHelp';
import SpanGraph from './SpanGraph';
import TracePageSearchBar from './TracePageSearchBar';
import { TUpdateViewRangeTimeFunction, IViewRange, ViewRangeTimeUpdate } from '../types';
import { TUpdateViewRangeTimeFunction, IViewRange, ViewRangeTimeUpdate, ETraceViewType } from '../types';
import LabeledList from '../../common/LabeledList';
import NewWindowIcon from '../../common/NewWindowIcon';
import TraceName from '../../common/TraceName';
Expand All @@ -49,7 +49,7 @@ type TracePageHeaderEmbedProps = {
nextResult: () => void;
onArchiveClicked: () => void;
onSlimViewClicked: () => void;
onTraceGraphViewClicked: () => void;
onTraceViewChange: (actualViewType: ETraceViewType) => void;
Copy link
Collaborator

Choose a reason for hiding this comment

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

again, why actual?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Done.

prevResult: () => void;
resultCount: number;
showArchiveButton: boolean;
Expand All @@ -60,7 +60,7 @@ type TracePageHeaderEmbedProps = {
textFilter: string | TNil;
toSearch: string | null;
trace: Trace;
traceGraphView: boolean;
viewType: ETraceViewType;
updateNextViewRangeTime: (update: ViewRangeTimeUpdate) => void;
updateViewRangeTime: TUpdateViewRangeTimeFunction;
viewRange: IViewRange;
Expand Down Expand Up @@ -117,7 +117,7 @@ export function TracePageHeaderFn(props: TracePageHeaderEmbedProps & { forwarded
nextResult,
onArchiveClicked,
onSlimViewClicked,
onTraceGraphViewClicked,
onTraceViewChange,
prevResult,
resultCount,
showArchiveButton,
Expand All @@ -128,7 +128,7 @@ export function TracePageHeaderFn(props: TracePageHeaderEmbedProps & { forwarded
textFilter,
toSearch,
trace,
traceGraphView,
viewType,
updateNextViewRangeTime,
updateViewRangeTime,
viewRange,
Expand Down Expand Up @@ -187,15 +187,11 @@ export function TracePageHeaderFn(props: TracePageHeaderEmbedProps & { forwarded
ref={forwardedRef}
resultCount={resultCount}
textFilter={textFilter}
navigable={!traceGraphView}
navigable={viewType === ETraceViewType.TraceTimelineViewer}
/>
{showShortcutsHelp && <KeyboardShortcutsHelp className="ub-m2" />}
{showViewOptions && (
<AltViewOptions
onTraceGraphViewClicked={onTraceGraphViewClicked}
traceGraphView={traceGraphView}
traceID={trace.traceID}
/>
<AltViewOptions onTraceViewChange={onTraceViewChange} traceID={trace.traceID} viewType={viewType} />
)}
{showArchiveButton && (
<Button className="ub-mr2 ub-flex ub-items-center" htmlType="button" onClick={onArchiveClicked}>
Expand Down
13 changes: 10 additions & 3 deletions ...ger-ui/src/components/TracePage/TracePageHeader/__snapshots__/AltViewOptions.test.js.snap
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,15 @@ exports[`AltViewOptions renders correctly 1`] = `
onClick={[Function]}
role="button"
>
Trace Timeline
Trace Graph
</a>
</MenuItem>
<MenuItem>
<a
onClick={[Function]}
role="button"
>
Trace Statistics
</a>
</MenuItem>
<MenuItem>
Expand Down Expand Up @@ -52,10 +60,9 @@ exports[`AltViewOptions renders correctly 1`] = `
ghost={false}
htmlType="button"
loading={false}
onClick={[Function]}
prefixCls="ant-btn"
>
Alternate Views
Trace Timeline
<Icon
type="down"
/>
Expand Down
54 changes: 54 additions & 0 deletions packages/jaeger-ui/src/components/TracePage/TraceStatistics/DetailTableData.css
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,54 @@
/*
Copyright (c) 2018 The Jaeger Authors.
Copy link
Collaborator

Choose a reason for hiding this comment

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

please update to 2020

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Done.


Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/

.DetailTableData--tr {
border-top: 1px solid #ececec;
}

.DetailTableData--tr:hover {
background: #fafafa;
color: black;
}

.DetailTableData--child--td {
border-left: 1px solid rgb(204, 204, 204);
border-right: 1px solid rgb(204, 204, 204);
border-top: 1px solid rgb(230, 230, 230);
border-bottom: 1px solid rgb(230, 230, 230);
width: 10%;
padding-left: 2em;

max-width: 25em;
overflow: hidden;
text-overflow: ellipsis;
white-space: nowrap;
}

.DetailTableData--serviceBorder {
border-left: 4px solid transparent;
padding-left: 0.6em;
}

.DetailTableData--td {
Copy link
Collaborator

Choose a reason for hiding this comment

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

DRY this and .DetailTableData--child--td

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Done.

border-left: 1px solid rgb(204, 204, 204);
border-right: 1px solid rgb(204, 204, 204);
border-top: 1px solid rgb(230, 230, 230);
border-bottom: 1px solid rgb(230, 230, 230);
width: 9.09%;
padding-left: 2em;
white-space: nowrap;
overflow: hidden;
text-overflow: ellipsis;
}
Loading