From 5ab4a40c7f2e4f2d9c7a93f27d515eaf0a8f74e7 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?S=C3=B8ren=20Louv-Jansen?= Date: Sun, 17 Jan 2021 13:48:45 +0100 Subject: [PATCH] [7.x] [APM] Consistent terminology for latency and throughput (#88452) (#88502) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-authored-by: Casper Hübertz Co-authored-by: Casper Hübertz --- x-pack/plugins/apm/common/alert_types.ts | 4 ++-- x-pack/plugins/apm/e2e/cypress/integration/apm.feature | 2 +- .../application/action_menu/alerting_popover_flyout.tsx | 4 ++-- .../public/components/alerting/register_apm_alerts.ts | 9 ++++----- .../app/ServiceMap/Popover/ServiceStatsList.tsx | 4 ++-- .../components/app/Settings/anomaly_detection/index.tsx | 2 +- .../public/components/app/TraceOverview/TraceList.tsx | 4 ++-- .../app/TransactionDetails/Distribution/index.tsx | 2 +- .../Waterfall/waterfall_helpers/waterfall_helpers.ts | 4 ++-- .../app/transaction_overview/TransactionList/index.tsx | 2 +- .../shared/charts/transaction_charts/ml_header.tsx | 2 +- .../lib/transactions/get_throughput_charts/transform.ts | 2 +- 12 files changed, 20 insertions(+), 21 deletions(-) diff --git a/x-pack/plugins/apm/common/alert_types.ts b/x-pack/plugins/apm/common/alert_types.ts index bb42c8acd167af..57236ea58063ca 100644 --- a/x-pack/plugins/apm/common/alert_types.ts +++ b/x-pack/plugins/apm/common/alert_types.ts @@ -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, @@ -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, diff --git a/x-pack/plugins/apm/e2e/cypress/integration/apm.feature b/x-pack/plugins/apm/e2e/cypress/integration/apm.feature index 72c060c48f7551..0cc8f00d48dfd2 100644 --- a/x-pack/plugins/apm/e2e/cypress/integration/apm.feature +++ b/x-pack/plugins/apm/e2e/cypress/integration/apm.feature @@ -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 diff --git a/x-pack/plugins/apm/public/application/action_menu/alerting_popover_flyout.tsx b/x-pack/plugins/apm/public/application/action_menu/alerting_popover_flyout.tsx index 395233735a9d54..3204f4b183b4f8 100644 --- a/x-pack/plugins/apm/public/application/action_menu/alerting_popover_flyout.tsx +++ b/x-pack/plugins/apm/public/application/action_menu/alerting_popover_flyout.tsx @@ -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', @@ -112,7 +112,7 @@ export function AlertingPopoverAndFlyout({ ], }, - // transaction duration panel + // latency panel { id: CREATE_TRANSACTION_DURATION_ALERT_PANEL_ID, title: transactionDurationLabel, diff --git a/x-pack/plugins/apm/public/components/alerting/register_apm_alerts.ts b/x-pack/plugins/apm/public/components/alerting/register_apm_alerts.ts index 78d771aec13e04..1e35b10d83b7c9 100644 --- a/x-pack/plugins/apm/public/components/alerting/register_apm_alerts.ts +++ b/x-pack/plugins/apm/public/components/alerting/register_apm_alerts.ts @@ -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', @@ -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\\}\\}`, } ), }); @@ -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', diff --git a/x-pack/plugins/apm/public/components/app/ServiceMap/Popover/ServiceStatsList.tsx b/x-pack/plugins/apm/public/components/app/ServiceMap/Popover/ServiceStatsList.tsx index cc41c254ffb507..377496cf2ac9ba 100644 --- a/x-pack/plugins/apm/public/components/app/ServiceMap/Popover/ServiceStatsList.tsx +++ b/x-pack/plugins/apm/public/components/app/ServiceMap/Popover/ServiceStatsList.tsx @@ -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) @@ -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), diff --git a/x-pack/plugins/apm/public/components/app/Settings/anomaly_detection/index.tsx b/x-pack/plugins/apm/public/components/app/Settings/anomaly_detection/index.tsx index addfd64a9ef624..01544901f3849e 100644 --- a/x-pack/plugins/apm/public/components/app/Settings/anomaly_detection/index.tsx +++ b/x-pack/plugins/apm/public/components/app/Settings/anomaly_detection/index.tsx @@ -75,7 +75,7 @@ export function AnomalyDetection() { {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.`, })} diff --git a/x-pack/plugins/apm/public/components/app/TraceOverview/TraceList.tsx b/x-pack/plugins/apm/public/components/app/TraceOverview/TraceList.tsx index b216ab5498cf6d..a2ab8a365c7116 100644 --- a/x-pack/plugins/apm/public/components/app/TraceOverview/TraceList.tsx +++ b/x-pack/plugins/apm/public/components/app/TraceOverview/TraceList.tsx @@ -68,7 +68,7 @@ const traceListColumns: Array> = [ { field: 'averageResponseTime', name: i18n.translate('xpack.apm.tracesTable.avgResponseTimeColumnLabel', { - defaultMessage: 'Avg. response time', + defaultMessage: 'Latency (avg.)', }), sortable: true, dataType: 'number', @@ -91,7 +91,7 @@ const traceListColumns: Array> = [ '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', } )} > diff --git a/x-pack/plugins/apm/public/components/app/TransactionDetails/Distribution/index.tsx b/x-pack/plugins/apm/public/components/app/TransactionDetails/Distribution/index.tsx index 8ab09eccd9bdbc..a94c48f02c1017 100644 --- a/x-pack/plugins/apm/public/components/app/TransactionDetails/Distribution/index.tsx +++ b/x-pack/plugins/apm/public/components/app/TransactionDetails/Distribution/index.tsx @@ -162,7 +162,7 @@ export function TransactionDistribution({ {i18n.translate( 'xpack.apm.transactionDetails.transactionsDurationDistributionChartTitle', { - defaultMessage: 'Transactions duration distribution', + defaultMessage: 'Latency distribution', } )}{' '} { parentId?: string; /** - * Duration in us + * Latency in us */ duration: number; diff --git a/x-pack/plugins/apm/public/components/app/transaction_overview/TransactionList/index.tsx b/x-pack/plugins/apm/public/components/app/transaction_overview/TransactionList/index.tsx index d2a3dc54c2a487..877a4d22aa6281 100644 --- a/x-pack/plugins/apm/public/components/app/transaction_overview/TransactionList/index.tsx +++ b/x-pack/plugins/apm/public/components/app/transaction_overview/TransactionList/index.tsx @@ -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', } )} /> diff --git a/x-pack/plugins/apm/public/components/shared/charts/transaction_charts/ml_header.tsx b/x-pack/plugins/apm/public/components/shared/charts/transaction_charts/ml_header.tsx index 33dcbf02ccda7c..89bf370c90ad64 100644 --- a/x-pack/plugins/apm/public/components/shared/charts/transaction_charts/ml_header.tsx +++ b/x-pack/plugins/apm/public/components/shared/charts/transaction_charts/ml_header.tsx @@ -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.', } )} /> diff --git a/x-pack/plugins/apm/server/lib/transactions/get_throughput_charts/transform.ts b/x-pack/plugins/apm/server/lib/transactions/get_throughput_charts/transform.ts index 0ebf1446265fde..a12e36c0e9de45 100644 --- a/x-pack/plugins/apm/server/lib/transactions/get_throughput_charts/transform.ts +++ b/x-pack/plugins/apm/server/lib/transactions/get_throughput_charts/transform.ts @@ -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 };