Skip to content

Adds UI notification for dropped spans #25017

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

Merged
merged 3 commits into from
Nov 13, 2018
Merged

Adds UI notification for dropped spans #25017

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
4efd265
Adds icon and tooltip for dropped spans
jasonrhodes Nov 1, 2018
ec57494
Adds callout and style in transaction flyout instead of timeline for …
jasonrhodes Nov 7, 2018
e5fff8c
Review tweaks and linting fixes
jasonrhodes Nov 9, 2018
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
65 changes: 63 additions & 2 deletions ...p/TransactionDetails/Transaction/WaterfallContainer/Waterfall/TransactionFlyout/index.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,17 +6,22 @@

import {
EuiButtonEmpty,
EuiCallOut,
EuiFlexGroup,
EuiFlexItem,
EuiFlyout,
EuiFlyoutBody,
EuiFlyoutHeader,
EuiHorizontalRule,
EuiLink,
EuiPortal,
EuiTitle
} from '@elastic/eui';
import { get } from 'lodash';
import React from 'react';
import styled from 'styled-components';
import { IUrlParams } from 'x-pack/plugins/apm/public/store/urlParams';
import { APM_AGENT_DROPPED_SPANS_DOCS } from 'x-pack/plugins/apm/public/utils/documentation/agents';
import { Transaction } from 'x-pack/plugins/apm/typings/Transaction';
import { DiscoverTransactionLink } from '../../../ActionMenu';
import { StickyTransactionProperties } from '../../../StickyTransactionProperties';
Expand All @@ -32,6 +37,61 @@ interface Props {
waterfall: IWaterfall;
}

const ResponsiveFlyout = styled(EuiFlyout)`
Copy link
Member

@sorenlouv sorenlouv Nov 7, 2018

Choose a reason for hiding this comment

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

This feels like something that should be part of EUIFlyout

Copy link
Contributor

@formgeist formgeist Nov 8, 2018

Choose a reason for hiding this comment

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

++

Copy link
Member Author

@jasonrhodes jasonrhodes Nov 9, 2018

Choose a reason for hiding this comment

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

Yeah, I totally agree.

width: 100%;

@media (min-width: 800px) {
width: 90%;
}

@media (min-width: 1000px) {
width: 70%;
}

@media (min-width: 1400px) {
width: 50%;
}

@media (min-width: 2000px) {
width: 35%;
}
`;

function DroppedSpansWarning({
transactionDoc
}: {
transactionDoc: Transaction;
}) {
const dropped: number = get(
transactionDoc,
'transaction.span_count.dropped.total',
Copy link
Member

@sorenlouv sorenlouv Nov 12, 2018

Choose a reason for hiding this comment

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

This should be added to the constants file.

Copy link
Member

@sorenlouv sorenlouv Nov 15, 2018

Choose a reason for hiding this comment

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

@jasonrhodes Minor thing: I noticed this didn't get changed. I can just do it as part of another PR so no biggie - unless it was intentional?

0
);

if (dropped === 0) {
return null;
}

const url =
APM_AGENT_DROPPED_SPANS_DOCS[transactionDoc.context.service.agent.name];

const docsLink = url ? (
<EuiLink href={url} target="_blank">
Learn more.
</EuiLink>
) : null;

return (
<React.Fragment>
<EuiCallOut size="s">
The APM agent that reported this transaction dropped {dropped} spans or
more based on its configuration. {docsLink}
</EuiCallOut>
<EuiHorizontalRule />
</React.Fragment>
);
}

export function TransactionFlyout({
transaction: transactionDoc,
onClose,
Expand All @@ -45,7 +105,7 @@ export function TransactionFlyout({

return (
<EuiPortal>
<EuiFlyout onClose={onClose} size="m" ownFocus={true}>
<ResponsiveFlyout onClose={onClose} ownFocus={true} maxWidth={false}>
<EuiFlyoutHeader hasBorder>
<EuiFlexGroup>
<EuiFlexItem grow={false}>
Expand All @@ -71,13 +131,14 @@ export function TransactionFlyout({
totalDuration={waterfall.traceRootDuration}
/>
<EuiHorizontalRule />
<DroppedSpansWarning transactionDoc={transactionDoc} />
<TransactionPropertiesTableForFlyout
transaction={transactionDoc}
location={location}
urlParams={urlParams}
/>
</EuiFlyoutBody>
</EuiFlyout>
</ResponsiveFlyout>
</EuiPortal>
);
}
11 changes: 6 additions & 5 deletions x-pack/plugins/apm/public/utils/documentation/agents.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,16 +6,17 @@

const AGENT_URL_ROOT = 'https://www.elastic.co/guide/en/apm/agent';

// TODO: currently unused but should be added to timeline view
export const APM_AGENT_DROPPED_SPANS_DOCS = {
interface AgentNamedValues {
[agentName: string]: string;
}

export const APM_AGENT_DROPPED_SPANS_DOCS: AgentNamedValues = {
nodejs: `${AGENT_URL_ROOT}/nodejs/1.x/agent-api.html#transaction-max-spans`,
python: `${AGENT_URL_ROOT}/python/2.x/configuration.html#config-transaction-max-spans`
};

const APM_AGENT_FEATURE_DOCS: {
[featureName: string]: {
[agentName: string]: string;
};
[featureName: string]: AgentNamedValues;
} = {
user: {
java: `${AGENT_URL_ROOT}/java/0.7/public-api.html#api-transaction-set-user`,
Expand Down