[APM] Consistent terminology for latency and throughput (#88452)

sorenlouv · formgeist · sorenlouv · commit a75d71f0d66c · 2021-01-15T19:34:31.000+01:00
Co-authored-by: Casper Hübertz &lt;casper@formgeist.com&gt;
diff --git 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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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" />
diff --git 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<ITableColumn<TraceGroup>> = [
   {
     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<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',
           }
         )}
       >
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
@@ -162,7 +162,7 @@ export function TransactionDistribution({
           {i18n.translate(
             'xpack.apm.transactionDetails.transactionsDurationDistributionChartTitle',
             {
-              defaultMessage: 'Transactions duration distribution',
+              defaultMessage: 'Latency distribution',
             }
           )}{' '}
           <EuiIconTip
diff --git a/x-pack/plugins/apm/public/components/app/TransactionDetails/WaterfallWithSummmary/WaterfallContainer/Waterfall/waterfall_helpers/waterfall_helpers.ts b/x-pack/plugins/apm/public/components/app/TransactionDetails/WaterfallWithSummmary/WaterfallContainer/Waterfall/waterfall_helpers/waterfall_helpers.ts
@@ -32,7 +32,7 @@ export interface IWaterfall {
   rootTransaction?: Transaction;
 
   /**
-   * Duration in us
+   * Latency in us
    */
   duration: number;
   items: IWaterfallItem[];
@@ -53,7 +53,7 @@ interface IWaterfallItemBase<T, U> {
   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
@@ -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
@@ -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
@@ -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 };

Original file line number	Diff line number	Diff line change
`@@ -46,7 +46,7 @@ export function registerApmAlerts(`
`46`	`46`	`'xpack.apm.alertTypes.transactionDuration.description',`
`47`	`47`	`{`
`48`	`48`	`defaultMessage:`
`49`		`- 'Alert when the duration of a specific transaction type in a service exceeds a defined threshold.',`
	`49`	`+ 'Alert when the latency of a specific transaction type in a service exceeds a defined threshold.',`
`50`	`50`	`}`
`51`	`51`	`),`
`52`	`52`	`iconClass: 'bell',`
`@@ -68,8 +68,8 @@ export function registerApmAlerts(`
`68`	`68`	`- Service name: \\{\\{context.serviceName\\}\\}`
`69`	`69`	`- Type: \\{\\{context.transactionType\\}\\}`
`70`	`70`	`- Environment: \\{\\{context.environment\\}\\}`
`71`		`-- Threshold: \\{\\{context.threshold\\}\\}ms`
`72`		-- Triggered value: \\{\\{context.triggerValue\\}\\} over the last \\{\\{context.interval\\}\\}`,
	`71`	`+- Latency threshold: \\{\\{context.threshold\\}\\}ms`
	`72`	+- Latency observed: \\{\\{context.triggerValue\\}\\} over the last \\{\\{context.interval\\}\\}`,
`73`	`73`	`}`
`74`	`74`	`),`
`75`	`75`	`});`
`@@ -113,8 +113,7 @@ export function registerApmAlerts(`
`113`	`113`	`description: i18n.translate(`
`114`	`114`	`'xpack.apm.alertTypes.transactionDurationAnomaly.description',`
`115`	`115`	`{`
`116`		`- defaultMessage:`
`117`		`- 'Alert when the overall transaction duration of a service is considered anomalous.',`
	`116`	`+ defaultMessage: 'Alert when the latency of a service is abnormal.',`
`118`	`117`	`}`
`119`	`118`	`),`
`120`	`119`	`iconClass: 'bell',`
Original file line number	Diff line number	Diff line change
`@@ -41,7 +41,7 @@ export function ServiceStatsList({`
`41`	`41`	`title: i18n.translate(`
`42`	`42`	`'xpack.apm.serviceMap.avgTransDurationPopoverStat',`
`43`	`43`	`{`
`44`		`- defaultMessage: 'Trans. duration (avg.)',`
	`44`	`+ defaultMessage: 'Latency (avg.)',`
`45`	`45`	`}`
`46`	`46`	`),`
`47`	`47`	`description: isNumber(transactionStats.avgTransactionDuration)`
`@@ -52,7 +52,7 @@ export function ServiceStatsList({`
`52`	`52`	`title: i18n.translate(`
`53`	`53`	`'xpack.apm.serviceMap.avgReqPerMinutePopoverMetric',`
`54`	`54`	`{`
`55`		`- defaultMessage: 'Req. per minute (avg.)',`
	`55`	`+ defaultMessage: 'Throughput (avg.)',`
`56`	`56`	`}`
`57`	`57`	`),`
`58`	`58`	`description: asTransactionRate(transactionStats.avgRequestsPerMinute),`
Original file line number	Diff line number	Diff line change
`@@ -68,7 +68,7 @@ const traceListColumns: Array<ITableColumn<TraceGroup>> = [`
`68`	`68`	`{`
`69`	`69`	`field: 'averageResponseTime',`
`70`	`70`	`name: i18n.translate('xpack.apm.tracesTable.avgResponseTimeColumnLabel', {`
`71`		`- defaultMessage: 'Avg. response time',`
	`71`	`+ defaultMessage: 'Latency (avg.)',`
`72`	`72`	`}),`
`73`	`73`	`sortable: true,`
`74`	`74`	`dataType: 'number',`
`@@ -91,7 +91,7 @@ const traceListColumns: Array<ITableColumn<TraceGroup>> = [`
`91`	`91`	`'xpack.apm.tracesTable.impactColumnDescription',`
`92`	`92`	`{`
`93`	`93`	`defaultMessage:`
`94`		`- "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.",`
	`94`	`+ 'The most used and slowest endpoints in your service. It is the result of multiplying latency and throughput',`
`95`	`95`	`}`
`96`	`96`	`)}`
`97`	`97`	`>`
Original file line number	Diff line number	Diff line change
`@@ -162,7 +162,7 @@ export function TransactionDistribution({`
`162`	`162`	`{i18n.translate(`
`163`	`163`	`'xpack.apm.transactionDetails.transactionsDurationDistributionChartTitle',`
`164`	`164`	`{`
`165`		`- defaultMessage: 'Transactions duration distribution',`
	`165`	`+ defaultMessage: 'Latency distribution',`
`166`	`166`	`}`
`167`	`167`	`)}{' '}`
`168`	`168`	`<EuiIconTip`
Original file line number	Diff line number	Diff line change
`@@ -126,7 +126,7 @@ export function TransactionList({ items, isLoading }: Props) {`
`126`	`126`	`'xpack.apm.transactionsTable.impactColumnDescription',`
`127`	`127`	`{`
`128`	`128`	`defaultMessage:`
`129`		`- "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.",`
	`129`	`+ 'The most used and slowest endpoints in your service. It is the result of multiplying latency and throughput',`
`130`	`130`	`}`
`131`	`131`	`)}`
`132`	`132`	`/>`