[APM] APIs refactoring (#85010)

* renaiming /transaction_groups to /transactions/groups * renaiming /transaction_groups to /transactions/groups * renaiming /transaction_groups/charts to /transactions/charts * renaiming /transaction_groups/distribution to transactions/charts/distribution * renaiming /transaction_groups/breakdown to transactions/charts/breakdown * removing /api/apm/transaction_sample. Unused * renaiming /transaction_groups/error_rate to transactions/charts/error_rate * removing transaction_groups * removing /api/apm/transaction_sample. Unused * renaiming /overview_transaction_groups to transactions/groups/overview * refactoring error_groups * addressing pr comments * fixing test
elastic · Dec 5, 2020 · d4370ff · d4370ff
1 parent 2f32754
commit d4370ff
Show file tree

Hide file tree

Showing 33 changed files with 4,073 additions and 260 deletions.
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
@@ -33,11 +33,9 @@ import { unit } from '../../../../style/variables';
 import { ChartContainer } from '../../../shared/charts/chart_container';
 import { EmptyMessage } from '../../../shared/EmptyMessage';
 
-type TransactionDistributionAPIResponse = APIReturnType<'GET /api/apm/services/{serviceName}/transaction_groups/distribution'>;
+type TransactionDistributionAPIResponse = APIReturnType<'GET /api/apm/services/{serviceName}/transactions/charts/distribution'>;
 
-type DistributionApiResponse = APIReturnType<'GET /api/apm/services/{serviceName}/transaction_groups/distribution'>;
-
-type DistributionBucket = DistributionApiResponse['buckets'][0];
+type DistributionBucket = TransactionDistributionAPIResponse['buckets'][0];
 
 interface IChartPoint {
   x0: number;

diff --git a/x-pack/plugins/apm/public/components/app/TransactionDetails/WaterfallWithSummmary/index.tsx b/x-pack/plugins/apm/public/components/app/TransactionDetails/WaterfallWithSummmary/index.tsx
@@ -27,7 +27,7 @@ import { MaybeViewTraceLink } from './MaybeViewTraceLink';
 import { TransactionTabs } from './TransactionTabs';
 import { IWaterfall } from './WaterfallContainer/Waterfall/waterfall_helpers/waterfall_helpers';
 
-type DistributionApiResponse = APIReturnType<'GET /api/apm/services/{serviceName}/transaction_groups/distribution'>;
+type DistributionApiResponse = APIReturnType<'GET /api/apm/services/{serviceName}/transactions/charts/distribution'>;
 
 type DistributionBucket = DistributionApiResponse['buckets'][0];
 

diff --git a/.../apm/public/components/app/service_overview/service_overview_transactions_table/index.tsx b/.../apm/public/components/app/service_overview/service_overview_transactions_table/index.tsx
@@ -36,7 +36,7 @@ import { ImpactBar } from '../../../shared/ImpactBar';
 import { ServiceOverviewTable } from '../service_overview_table';
 
 type ServiceTransactionGroupItem = ValuesType<
-  APIReturnType<'GET /api/apm/services/{serviceName}/overview_transaction_groups'>['transactionGroups']
+  APIReturnType<'GET /api/apm/services/{serviceName}/transactions/groups/overview'>['transactionGroups']
 >;
 
 interface Props {
@@ -100,7 +100,7 @@ export function ServiceOverviewTransactionsTable(props: Props) {
 
     return callApmApi({
       endpoint:
-        'GET /api/apm/services/{serviceName}/overview_transaction_groups',
+        'GET /api/apm/services/{serviceName}/transactions/groups/overview',
       params: {
         path: { serviceName },
         query: {

diff --git a/...pm/public/components/app/transaction_overview/TransactionList/TransactionList.stories.tsx b/...pm/public/components/app/transaction_overview/TransactionList/TransactionList.stories.tsx
@@ -10,7 +10,7 @@ import { APIReturnType } from '../../../../services/rest/createCallApmApi';
 import { MockApmPluginContextWrapper } from '../../../../context/apm_plugin/mock_apm_plugin_context';
 import { TransactionList } from './';
 
-type TransactionGroup = APIReturnType<'GET /api/apm/services/{serviceName}/transaction_groups'>['items'][0];
+type TransactionGroup = APIReturnType<'GET /api/apm/services/{serviceName}/transactions/groups'>['items'][0];
 
 export default {
   title: 'app/TransactionOverview/TransactionList',

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
@@ -20,7 +20,7 @@ import { LoadingStatePrompt } from '../../../shared/LoadingStatePrompt';
 import { EmptyMessage } from '../../../shared/EmptyMessage';
 import { TransactionDetailLink } from '../../../shared/Links/apm/TransactionDetailLink';
 
-type TransactionGroup = APIReturnType<'GET /api/apm/services/{serviceName}/transaction_groups'>['items'][0];
+type TransactionGroup = APIReturnType<'GET /api/apm/services/{serviceName}/transactions/groups'>['items'][0];
 
 // Truncate both the link and the child span (the tooltip anchor.) The link so
 // it doesn't overflow, and the anchor so we get the ellipsis.

diff --git a/x-pack/plugins/apm/public/components/app/transaction_overview/use_transaction_list.ts b/x-pack/plugins/apm/public/components/app/transaction_overview/use_transaction_list.ts
@@ -9,7 +9,7 @@ import { APIReturnType } from '../../../services/rest/createCallApmApi';
 import { useFetcher } from '../../../hooks/use_fetcher';
 import { useUrlParams } from '../../../context/url_params_context/use_url_params';
 
-type TransactionsAPIResponse = APIReturnType<'GET /api/apm/services/{serviceName}/transaction_groups'>;
+type TransactionsAPIResponse = APIReturnType<'GET /api/apm/services/{serviceName}/transactions/groups'>;
 
 const DEFAULT_RESPONSE: Partial<TransactionsAPIResponse> = {
   items: undefined,
@@ -25,7 +25,7 @@ export function useTransactionListFetcher() {
     (callApmApi) => {
       if (serviceName && start && end && transactionType) {
         return callApmApi({
-          endpoint: 'GET /api/apm/services/{serviceName}/transaction_groups',
+          endpoint: 'GET /api/apm/services/{serviceName}/transactions/groups',
           params: {
             path: { serviceName },
             query: {

diff --git a/.../public/components/shared/charts/transaction_breakdown_chart/use_transaction_breakdown.ts b/.../public/components/shared/charts/transaction_breakdown_chart/use_transaction_breakdown.ts
@@ -20,7 +20,7 @@ export function useTransactionBreakdown() {
       if (serviceName && start && end && transactionType) {
         return callApmApi({
           endpoint:
-            'GET /api/apm/services/{serviceName}/transaction_groups/breakdown',
+            'GET /api/apm/services/{serviceName}/transaction/charts/breakdown',
           params: {
             path: { serviceName },
             query: {

diff --git a/x-pack/plugins/apm/public/components/shared/charts/transaction_error_rate_chart/index.tsx b/x-pack/plugins/apm/public/components/shared/charts/transaction_error_rate_chart/index.tsx
@@ -45,7 +45,7 @@ export function TransactionErrorRateChart({
     if (serviceName && start && end) {
       return callApmApi({
         endpoint:
-          'GET /api/apm/services/{serviceName}/transaction_groups/error_rate',
+          'GET /api/apm/services/{serviceName}/transactions/charts/error_rate',
         params: {
           path: {
             serviceName,

diff --git a/x-pack/plugins/apm/public/hooks/use_transaction_charts_fetcher.ts b/x-pack/plugins/apm/public/hooks/use_transaction_charts_fetcher.ts
@@ -21,8 +21,7 @@ export function useTransactionChartsFetcher() {
     (callApmApi) => {
       if (serviceName && start && end) {
         return callApmApi({
-          endpoint:
-            'GET /api/apm/services/{serviceName}/transaction_groups/charts',
+          endpoint: 'GET /api/apm/services/{serviceName}/transactions/charts',
           params: {
             path: { serviceName },
             query: {

diff --git a/x-pack/plugins/apm/public/hooks/use_transaction_distribution_fetcher.ts b/x-pack/plugins/apm/public/hooks/use_transaction_distribution_fetcher.ts
@@ -12,7 +12,7 @@ import { maybe } from '../../common/utils/maybe';
 import { APIReturnType } from '../services/rest/createCallApmApi';
 import { useUrlParams } from '../context/url_params_context/use_url_params';
 
-type APIResponse = APIReturnType<'GET /api/apm/services/{serviceName}/transaction_groups/distribution'>;
+type APIResponse = APIReturnType<'GET /api/apm/services/{serviceName}/transactions/charts/distribution'>;
 
 const INITIAL_DATA = {
   buckets: [] as APIResponse['buckets'],
@@ -38,7 +38,7 @@ export function useTransactionDistributionFetcher() {
       if (serviceName && start && end && transactionType && transactionName) {
         const response = await callApmApi({
           endpoint:
-            'GET /api/apm/services/{serviceName}/transaction_groups/distribution',
+            'GET /api/apm/services/{serviceName}/transactions/charts/distribution',
           params: {
             path: {
               serviceName,

diff --git a/.../apm/server/lib/errors/get_error_group.ts → ...rver/lib/errors/get_error_group_sample.ts b/.../apm/server/lib/errors/get_error_group.ts → ...rver/lib/errors/get_error_group_sample.ts
@@ -14,8 +14,7 @@ import { rangeFilter } from '../../../common/utils/range_filter';
 import { Setup, SetupTimeRange } from '../helpers/setup_request';
 import { getTransaction } from '../transactions/get_transaction';
 
-// TODO: rename from "getErrorGroup"  to "getErrorGroupSample" (since a single error is returned, not an errorGroup)
-export async function getErrorGroup({
+export async function getErrorGroupSample({
   serviceName,
   groupId,
   setup,

diff --git a/x-pack/plugins/apm/server/lib/errors/queries.test.ts b/x-pack/plugins/apm/server/lib/errors/queries.test.ts
@@ -4,7 +4,7 @@
  * you may not use this file except in compliance with the Elastic License.
  */
 
-import { getErrorGroup } from './get_error_group';
+import { getErrorGroupSample } from './get_error_group_sample';
 import { getErrorGroups } from './get_error_groups';
 import {
   SearchParamsMock,
@@ -20,7 +20,7 @@ describe('error queries', () => {
 
   it('fetches a single error group', async () => {
     mock = await inspectSearchParams((setup) =>
-      getErrorGroup({
+      getErrorGroupSample({
         groupId: 'groupId',
         serviceName: 'serviceName',
         setup,

diff --git a/x-pack/plugins/apm/server/lib/transaction_groups/get_transaction_sample_for_group.ts b/x-pack/plugins/apm/server/lib/transaction_groups/get_transaction_sample_for_group.ts
diff --git a/x-pack/plugins/apm/server/routes/create_apm_api.ts b/x-pack/plugins/apm/server/routes/create_apm_api.ts
@@ -23,7 +23,6 @@ import {
   serviceAnnotationsCreateRoute,
   serviceErrorGroupsRoute,
   serviceThroughputRoute,
-  serviceTransactionGroupsRoute,
 } from './services';
 import {
   agentConfigurationRoute,
@@ -52,13 +51,13 @@ import {
   correlationsForFailedTransactionsRoute,
 } from './correlations';
 import {
-  transactionGroupsBreakdownRoute,
-  transactionGroupsChartsRoute,
-  transactionGroupsDistributionRoute,
+  transactionChartsBreakdownRoute,
+  transactionChartsRoute,
+  transactionChartsDistributionRoute,
+  transactionChartsErrorRateRoute,
   transactionGroupsRoute,
-  transactionSampleForGroupRoute,
-  transactionGroupsErrorRateRoute,
-} from './transaction_groups';
+  transactionGroupsOverviewRoute,
+} from './transactions/transactions_routes';
 import {
   errorGroupsLocalFiltersRoute,
   metricsLocalFiltersRoute,
@@ -122,7 +121,6 @@ const createApmApi = () => {
     .add(serviceAnnotationsCreateRoute)
     .add(serviceErrorGroupsRoute)
     .add(serviceThroughputRoute)
-    .add(serviceTransactionGroupsRoute)
 
     // Agent configuration
     .add(getSingleAgentConfigurationRoute)
@@ -152,13 +150,13 @@ const createApmApi = () => {
     .add(tracesByIdRoute)
     .add(rootTransactionByTraceIdRoute)
 
-    // Transaction groups
-    .add(transactionGroupsBreakdownRoute)
-    .add(transactionGroupsChartsRoute)
-    .add(transactionGroupsDistributionRoute)
+    // Transactions
+    .add(transactionChartsBreakdownRoute)
+    .add(transactionChartsRoute)
+    .add(transactionChartsDistributionRoute)
+    .add(transactionChartsErrorRateRoute)
     .add(transactionGroupsRoute)
-    .add(transactionSampleForGroupRoute)
-    .add(transactionGroupsErrorRateRoute)
+    .add(transactionGroupsOverviewRoute)
 
     // UI filters
     .add(errorGroupsLocalFiltersRoute)

diff --git a/x-pack/plugins/apm/server/routes/errors.ts b/x-pack/plugins/apm/server/routes/errors.ts
@@ -7,7 +7,7 @@
 import * as t from 'io-ts';
 import { createRoute } from './create_route';
 import { getErrorDistribution } from '../lib/errors/distribution/get_distribution';
-import { getErrorGroup } from '../lib/errors/get_error_group';
+import { getErrorGroupSample } from '../lib/errors/get_error_group_sample';
 import { getErrorGroups } from '../lib/errors/get_error_groups';
 import { setupRequest } from '../lib/helpers/setup_request';
 import { uiFiltersRt, rangeRt } from './default_api_types';
@@ -56,7 +56,7 @@ export const errorGroupsRoute = createRoute({
   handler: async ({ context, request }) => {
     const setup = await setupRequest(context, request);
     const { serviceName, groupId } = context.params.path;
-    return getErrorGroup({ serviceName, groupId, setup });
+    return getErrorGroupSample({ serviceName, groupId, setup });
   },
 });
 

diff --git a/x-pack/plugins/apm/server/routes/services.ts b/x-pack/plugins/apm/server/routes/services.ts
@@ -19,7 +19,6 @@ import { dateAsStringRt } from '../../common/runtime_types/date_as_string_rt';
 import { getSearchAggregatedTransactions } from '../lib/helpers/aggregated_transactions';
 import { getServiceErrorGroups } from '../lib/services/get_service_error_groups';
 import { toNumberRt } from '../../common/runtime_types/to_number_rt';
-import { getServiceTransactionGroups } from '../lib/services/get_service_transaction_groups';
 import { getThroughput } from '../lib/services/get_throughput';
 
 export const servicesRoute = createRoute({
@@ -276,52 +275,3 @@ export const serviceThroughputRoute = createRoute({
     });
   },
 });
-
-export const serviceTransactionGroupsRoute = createRoute({
-  endpoint: 'GET /api/apm/services/{serviceName}/overview_transaction_groups',
-  params: t.type({
-    path: t.type({ serviceName: t.string }),
-    query: t.intersection([
-      rangeRt,
-      uiFiltersRt,
-      t.type({
-        size: toNumberRt,
-        numBuckets: toNumberRt,
-        pageIndex: toNumberRt,
-        sortDirection: t.union([t.literal('asc'), t.literal('desc')]),
-        sortField: t.union([
-          t.literal('latency'),
-          t.literal('throughput'),
-          t.literal('errorRate'),
-          t.literal('impact'),
-        ]),
-      }),
-    ]),
-  }),
-  options: {
-    tags: ['access:apm'],
-  },
-  handler: async ({ context, request }) => {
-    const setup = await setupRequest(context, request);
-
-    const searchAggregatedTransactions = await getSearchAggregatedTransactions(
-      setup
-    );
-
-    const {
-      path: { serviceName },
-      query: { size, numBuckets, pageIndex, sortDirection, sortField },
-    } = context.params;
-
-    return getServiceTransactionGroups({
-      setup,
-      serviceName,
-      pageIndex,
-      searchAggregatedTransactions,
-      size,
-      sortDirection,
-      sortField,
-      numBuckets,
-    });
-  },
-});