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.

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

[7.x] [APM] Consistent terminology for latency and throughput (#88452) #88502

Merged
merged 1 commit into from
Jan 17, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
4 changes: 2 additions & 2 deletions x-pack/plugins/apm/common/alert_types.ts
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ export const ALERT_TYPES_CONFIG: Record<
},
[AlertType.TransactionDuration]: {
name: i18n.translate('xpack.apm.transactionDurationAlert.name', {
defaultMessage: 'Transaction duration threshold',
defaultMessage: 'Latency threshold',
}),
actionGroups: [THRESHOLD_MET_GROUP],
defaultActionGroupId: THRESHOLD_MET_GROUP_ID,
Expand All @@ -55,7 +55,7 @@ export const ALERT_TYPES_CONFIG: Record<
},
[AlertType.TransactionDurationAnomaly]: {
name: i18n.translate('xpack.apm.transactionDurationAnomalyAlert.name', {
defaultMessage: 'Transaction duration anomaly',
defaultMessage: 'Latency anomaly',
}),
actionGroups: [THRESHOLD_MET_GROUP],
defaultActionGroupId: THRESHOLD_MET_GROUP_ID,
Expand Down
2 changes: 1 addition & 1 deletion x-pack/plugins/apm/e2e/cypress/integration/apm.feature
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
Feature: APM

Scenario: Transaction duration charts
Scenario: Transaction latency charts
Given a user browses the APM UI application
When the user inspects the opbeans-node service
Then should redirect to correct path
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ const alertLabel = i18n.translate('xpack.apm.home.alertsMenu.alerts', {
});
const transactionDurationLabel = i18n.translate(
'xpack.apm.home.alertsMenu.transactionDuration',
{ defaultMessage: 'Transaction duration' }
{ defaultMessage: 'Latency' }
);
const transactionErrorRateLabel = i18n.translate(
'xpack.apm.home.alertsMenu.transactionErrorRate',
Expand Down Expand Up @@ -112,7 +112,7 @@ export function AlertingPopoverAndFlyout({
],
},

// transaction duration panel
// latency panel
{
id: CREATE_TRANSACTION_DURATION_ALERT_PANEL_ID,
title: transactionDurationLabel,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ export function registerApmAlerts(
'xpack.apm.alertTypes.transactionDuration.description',
{
defaultMessage:
'Alert when the duration of a specific transaction type in a service exceeds a defined threshold.',
'Alert when the latency of a specific transaction type in a service exceeds a defined threshold.',
}
),
iconClass: 'bell',
Expand All @@ -68,8 +68,8 @@ export function registerApmAlerts(
- Service name: \\{\\{context.serviceName\\}\\}
- Type: \\{\\{context.transactionType\\}\\}
- Environment: \\{\\{context.environment\\}\\}
- Threshold: \\{\\{context.threshold\\}\\}ms
- Triggered value: \\{\\{context.triggerValue\\}\\} over the last \\{\\{context.interval\\}\\}`,
- Latency threshold: \\{\\{context.threshold\\}\\}ms
- Latency observed: \\{\\{context.triggerValue\\}\\} over the last \\{\\{context.interval\\}\\}`,
}
),
});
Expand Down Expand Up @@ -113,8 +113,7 @@ export function registerApmAlerts(
description: i18n.translate(
'xpack.apm.alertTypes.transactionDurationAnomaly.description',
{
defaultMessage:
'Alert when the overall transaction duration of a service is considered anomalous.',
defaultMessage: 'Alert when the latency of a service is abnormal.',
}
),
iconClass: 'bell',
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ export function ServiceStatsList({
title: i18n.translate(
'xpack.apm.serviceMap.avgTransDurationPopoverStat',
{
defaultMessage: 'Trans. duration (avg.)',
defaultMessage: 'Latency (avg.)',
}
),
description: isNumber(transactionStats.avgTransactionDuration)
Expand All @@ -52,7 +52,7 @@ export function ServiceStatsList({
title: i18n.translate(
'xpack.apm.serviceMap.avgReqPerMinutePopoverMetric',
{
defaultMessage: 'Req. per minute (avg.)',
defaultMessage: 'Throughput (avg.)',
}
),
description: asTransactionRate(transactionStats.avgRequestsPerMinute),
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -75,7 +75,7 @@ export function AnomalyDetection() {
<EuiSpacer size="l" />
<EuiText>
{i18n.translate('xpack.apm.settings.anomalyDetection.descriptionText', {
defaultMessage: `Machine Learning's anomaly detection integration enables application health status indicators for services in each configured environment by identifying transaction duration anomalies.`,
defaultMessage: `Machine Learning's anomaly detection integration enables application health status indicators for services in each configured environment by identifying anomalies in latency.`,
})}
</EuiText>
<EuiSpacer size="l" />
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -68,7 +68,7 @@ const traceListColumns: Array<ITableColumn<TraceGroup>> = [
{
field: 'averageResponseTime',
name: i18n.translate('xpack.apm.tracesTable.avgResponseTimeColumnLabel', {
defaultMessage: 'Avg. response time',
defaultMessage: 'Latency (avg.)',
}),
sortable: true,
dataType: 'number',
Expand All @@ -91,7 +91,7 @@ const traceListColumns: Array<ITableColumn<TraceGroup>> = [
'xpack.apm.tracesTable.impactColumnDescription',
{
defaultMessage:
"The most used and slowest endpoints in your service. It's calculated by taking the relative average duration times the number of transactions per minute.",
'The most used and slowest endpoints in your service. It is the result of multiplying latency and throughput',
}
)}
>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -162,7 +162,7 @@ export function TransactionDistribution({
{i18n.translate(
'xpack.apm.transactionDetails.transactionsDurationDistributionChartTitle',
{
defaultMessage: 'Transactions duration distribution',
defaultMessage: 'Latency distribution',
}
)}{' '}
<EuiIconTip
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ export interface IWaterfall {
rootTransaction?: Transaction;

/**
* Duration in us
* Latency in us
*/
duration: number;
items: IWaterfallItem[];
Expand All @@ -53,7 +53,7 @@ interface IWaterfallItemBase<T, U> {
parentId?: string;

/**
* Duration in us
* Latency in us
*/
duration: number;

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -126,7 +126,7 @@ export function TransactionList({ items, isLoading }: Props) {
'xpack.apm.transactionsTable.impactColumnDescription',
{
defaultMessage:
"The most used and slowest endpoints in your service. It's calculated by taking the relative average duration times the number of transactions per minute.",
'The most used and slowest endpoints in your service. It is the result of multiplying latency and throughput',
}
)}
/>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -62,7 +62,7 @@ export function MLHeader({ hasValidMlLicense, mlJobId }: Props) {
'xpack.apm.metrics.transactionChart.machineLearningTooltip',
{
defaultMessage:
'The stream around the average duration shows the expected bounds. An annotation is shown for anomaly scores ≥ 75.',
'The stream displays the expected bounds of the average latency. A red vertical annotation indicates anomalies with an anomaly score of 75 or above.',
}
)}
/>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ export function getThroughputBuckets({
.map((bucket) => bucket.count.value)
.reduce((a, b) => a + b, 0);

// calculate request/minute
// calculate average throughput
const avg = docCountTotal / durationAsMinutes;

return { key, dataPoints, avg };
Expand Down