[APM] Fix anomalies not showing up on transaction charts (#76930)

* [APM] Fix anomalies not showing up on transaction charts * Added API tests to check transaction groups charts for anomaly data * Improve test names and assertions from PR feedback * Updated the transaction groups chart API to make `environment` a required param while making `uiFilters` optional * updates the basic API tests for transaction_groups/charts with the required `environment` param * makes uiFIltersES default to [] on core setup and removes SetupUIFilters type * fixes vertical shade * - replaces uiFiltersES with esFilter & uiFilters and cleans up related code around these - deduplicates the required environment in the transaction_groups/charts API * updates basic apm_api_integration tests * pr feedback * updates api test snapshots with correct anomaly data * removed environment query param from useTransactionCharts and ensures it's included in uiFilters returned from useUrlParams Co-authored-by: Oliver Gupte <[email protected]>
elastic · Oct 2, 2020 · 4ddcd1d · 4ddcd1d
1 parent 1b61cc6
commit 4ddcd1d
Show file tree

Hide file tree

Showing 87 changed files with 528 additions and 548 deletions.
diff --git a/...gins/apm/public/components/app/ServiceMap/__stories__/example_response_opbeans_beats.json b/...gins/apm/public/components/app/ServiceMap/__stories__/example_response_opbeans_beats.json
@@ -83,7 +83,7 @@
         "id": "opbeans-go~>postgresql",
         "sourceData": {
           "id": "opbeans-go",
-          "service.environment": "testing",
+          "service.environment": "test",
           "service.name": "opbeans-go",
           "agent.name": "go"
         },
@@ -103,7 +103,7 @@
         "id": "opbeans-go~opbeans-java",
         "sourceData": {
           "id": "opbeans-go",
-          "service.environment": "testing",
+          "service.environment": "test",
           "service.name": "opbeans-go",
           "agent.name": "go"
         },
@@ -123,13 +123,13 @@
         "id": "opbeans-go~opbeans-node",
         "sourceData": {
           "id": "opbeans-go",
-          "service.environment": "testing",
+          "service.environment": "test",
           "service.name": "opbeans-go",
           "agent.name": "go"
         },
         "targetData": {
           "id": "opbeans-node",
-          "service.environment": "testing",
+          "service.environment": "test",
           "service.name": "opbeans-node",
           "agent.name": "nodejs"
         },
@@ -143,7 +143,7 @@
         "id": "opbeans-go~opbeans-ruby",
         "sourceData": {
           "id": "opbeans-go",
-          "service.environment": "testing",
+          "service.environment": "test",
           "service.name": "opbeans-go",
           "agent.name": "go"
         },
@@ -189,7 +189,7 @@
         },
         "targetData": {
           "id": "opbeans-go",
-          "service.environment": "testing",
+          "service.environment": "test",
           "service.name": "opbeans-go",
           "agent.name": "go"
         },
@@ -209,7 +209,7 @@
         },
         "targetData": {
           "id": "opbeans-node",
-          "service.environment": "testing",
+          "service.environment": "test",
           "service.name": "opbeans-node",
           "agent.name": "nodejs"
         }
@@ -242,7 +242,7 @@
         "id": "opbeans-node~>postgresql",
         "sourceData": {
           "id": "opbeans-node",
-          "service.environment": "testing",
+          "service.environment": "test",
           "service.name": "opbeans-node",
           "agent.name": "nodejs"
         },
@@ -262,7 +262,7 @@
         "id": "opbeans-node~>redis",
         "sourceData": {
           "id": "opbeans-node",
-          "service.environment": "testing",
+          "service.environment": "test",
           "service.name": "opbeans-node",
           "agent.name": "nodejs"
         },
@@ -282,13 +282,13 @@
         "id": "opbeans-node~opbeans-go",
         "sourceData": {
           "id": "opbeans-node",
-          "service.environment": "testing",
+          "service.environment": "test",
           "service.name": "opbeans-node",
           "agent.name": "nodejs"
         },
         "targetData": {
           "id": "opbeans-go",
-          "service.environment": "testing",
+          "service.environment": "test",
           "service.name": "opbeans-go",
           "agent.name": "go"
         },
@@ -302,7 +302,7 @@
         "id": "opbeans-node~opbeans-python",
         "sourceData": {
           "id": "opbeans-node",
-          "service.environment": "testing",
+          "service.environment": "test",
           "service.name": "opbeans-node",
           "agent.name": "nodejs"
         },
@@ -322,7 +322,7 @@
         "id": "opbeans-node~opbeans-ruby",
         "sourceData": {
           "id": "opbeans-node",
-          "service.environment": "testing",
+          "service.environment": "test",
           "service.name": "opbeans-node",
           "agent.name": "nodejs"
         },
@@ -408,7 +408,7 @@
         },
         "targetData": {
           "id": "opbeans-go",
-          "service.environment": "testing",
+          "service.environment": "test",
           "service.name": "opbeans-go",
           "agent.name": "go"
         }
@@ -427,7 +427,7 @@
         },
         "targetData": {
           "id": "opbeans-node",
-          "service.environment": "testing",
+          "service.environment": "test",
           "service.name": "opbeans-node",
           "agent.name": "nodejs"
         },
@@ -487,7 +487,7 @@
         },
         "targetData": {
           "id": "opbeans-go",
-          "service.environment": "testing",
+          "service.environment": "test",
           "service.name": "opbeans-go",
           "agent.name": "go"
         },
@@ -527,7 +527,7 @@
         },
         "targetData": {
           "id": "opbeans-node",
-          "service.environment": "testing",
+          "service.environment": "test",
           "service.name": "opbeans-node",
           "agent.name": "nodejs"
         },
@@ -566,7 +566,7 @@
         },
         "targetData": {
           "id": "opbeans-go",
-          "service.environment": "testing",
+          "service.environment": "test",
           "service.name": "opbeans-go",
           "agent.name": "go"
         }
@@ -602,7 +602,7 @@
         },
         "targetData": {
           "id": "opbeans-node",
-          "service.environment": "testing",
+          "service.environment": "test",
           "service.name": "opbeans-node",
           "agent.name": "nodejs"
         }
@@ -673,7 +673,7 @@
     {
       "data": {
         "id": "opbeans-node",
-        "service.environment": "testing",
+        "service.environment": "test",
         "service.name": "opbeans-node",
         "agent.name": "nodejs",
         "anomaly_score": 41.31593099784474,
@@ -733,7 +733,7 @@
     {
       "data": {
         "id": "opbeans-go",
-        "service.environment": "testing",
+        "service.environment": "test",
         "service.name": "opbeans-go",
         "agent.name": "go",
         "anomaly_score": 0.2633884161762746,

diff --git a/x-pack/plugins/apm/public/context/UrlParamsContext/index.tsx b/x-pack/plugins/apm/public/context/UrlParamsContext/index.tsx
@@ -25,6 +25,7 @@ import {
 import { pickKeys } from '../../../common/utils/pick_keys';
 import { useDeepObjectIdentity } from '../../hooks/useDeepObjectIdentity';
 import { LocalUIFilterName } from '../../../common/ui_filter';
+import { ENVIRONMENT_ALL } from '../../../common/environment_filter_values';
 
 interface TimeRange {
   rangeFrom: string;
@@ -38,7 +39,11 @@ function useUiFilters(params: IUrlParams): UIFilters {
     (val) => (val ? val.split(',') : [])
   ) as Partial<Record<LocalUIFilterName, string[]>>;
 
-  return useDeepObjectIdentity({ kuery, environment, ...localUiFilters });
+  return useDeepObjectIdentity({
+    kuery,
+    environment: environment || ENVIRONMENT_ALL.value,
+    ...localUiFilters,
+  });
 }
 
 const defaultRefresh = (_time: TimeRange) => {};

diff --git a/x-pack/plugins/apm/public/utils/testHelpers.tsx b/x-pack/plugins/apm/public/utils/testHelpers.tsx
@@ -25,6 +25,7 @@ import {
 } from '../../typings/elasticsearch';
 import { MockApmPluginContextWrapper } from '../context/ApmPluginContext/MockApmPluginContext';
 import { UrlParamsProvider } from '../context/UrlParamsContext';
+import { UIFilters } from '../../typings/ui_filters';
 
 const originalConsoleWarn = console.warn; // eslint-disable-line no-console
 /**
@@ -118,7 +119,8 @@ interface MockSetup {
   apmEventClient: any;
   internalClient: any;
   config: APMConfig;
-  uiFiltersES: ESFilter[];
+  uiFilters: UIFilters;
+  esFilter: ESFilter[];
   indices: {
     /* eslint-disable @typescript-eslint/naming-convention */
     'apm_oss.sourcemapIndices': string;
@@ -179,7 +181,8 @@ export async function inspectSearchParams(
         },
       }
     ) as APMConfig,
-    uiFiltersES: [{ term: { 'my.custom.ui.filter': 'foo-bar' } }],
+    uiFilters: { environment: 'test' },
+    esFilter: [{ term: { 'service.environment': 'test' } }],
     indices: {
       /* eslint-disable @typescript-eslint/naming-convention */
       'apm_oss.sourcemapIndices': 'myIndex',

diff --git a/x-pack/plugins/apm/server/lib/errors/__snapshots__/queries.test.ts.snap b/x-pack/plugins/apm/server/lib/errors/__snapshots__/queries.test.ts.snap
diff --git a/x-pack/plugins/apm/server/lib/errors/distribution/__snapshots__/queries.test.ts.snap b/x-pack/plugins/apm/server/lib/errors/distribution/__snapshots__/queries.test.ts.snap
diff --git a/x-pack/plugins/apm/server/lib/errors/distribution/__tests__/get_buckets.test.ts b/x-pack/plugins/apm/server/lib/errors/distribution/__tests__/get_buckets.test.ts
@@ -41,7 +41,10 @@ describe('timeseriesFetcher', () => {
             get: () => 'myIndex',
           }
         ) as APMConfig,
-        uiFiltersES: [
+        uiFilters: {
+          environment: 'prod',
+        },
+        esFilter: [
           {
             term: { 'service.environment': 'prod' },
           },

diff --git a/x-pack/plugins/apm/server/lib/errors/distribution/get_buckets.ts b/x-pack/plugins/apm/server/lib/errors/distribution/get_buckets.ts
@@ -11,11 +11,7 @@ import {
   SERVICE_NAME,
 } from '../../../../common/elasticsearch_fieldnames';
 import { rangeFilter } from '../../../../common/utils/range_filter';
-import {
-  Setup,
-  SetupTimeRange,
-  SetupUIFilters,
-} from '../../helpers/setup_request';
+import { Setup, SetupTimeRange } from '../../helpers/setup_request';
 
 export async function getBuckets({
   serviceName,
@@ -26,13 +22,13 @@ export async function getBuckets({
   serviceName: string;
   groupId?: string;
   bucketSize: number;
-  setup: Setup & SetupTimeRange & SetupUIFilters;
+  setup: Setup & SetupTimeRange;
 }) {
-  const { start, end, uiFiltersES, apmEventClient } = setup;
+  const { start, end, esFilter, apmEventClient } = setup;
   const filter: ESFilter[] = [
     { term: { [SERVICE_NAME]: serviceName } },
     { range: rangeFilter(start, end) },
-    ...uiFiltersES,
+    ...esFilter,
   ];
 
   if (groupId) {

diff --git a/x-pack/plugins/apm/server/lib/errors/distribution/get_distribution.ts b/x-pack/plugins/apm/server/lib/errors/distribution/get_distribution.ts
@@ -5,11 +5,7 @@
  */
 
 import { PromiseReturnType } from '../../../../typings/common';
-import {
-  Setup,
-  SetupTimeRange,
-  SetupUIFilters,
-} from '../../helpers/setup_request';
+import { Setup, SetupTimeRange } from '../../helpers/setup_request';
 import { getBuckets } from './get_buckets';
 import { BUCKET_TARGET_COUNT } from '../../transactions/constants';
 
@@ -28,7 +24,7 @@ export async function getErrorDistribution({
 }: {
   serviceName: string;
   groupId?: string;
-  setup: Setup & SetupTimeRange & SetupUIFilters;
+  setup: Setup & SetupTimeRange;
 }) {
   const bucketSize = getBucketSize({ start: setup.start, end: setup.end });
   const { buckets, noHits } = await getBuckets({

diff --git a/x-pack/plugins/apm/server/lib/errors/get_error_group.ts b/x-pack/plugins/apm/server/lib/errors/get_error_group.ts
@@ -12,11 +12,7 @@ import {
 } from '../../../common/elasticsearch_fieldnames';
 import { PromiseReturnType } from '../../../typings/common';
 import { rangeFilter } from '../../../common/utils/range_filter';
-import {
-  Setup,
-  SetupTimeRange,
-  SetupUIFilters,
-} from '../helpers/setup_request';
+import { Setup, SetupTimeRange } from '../helpers/setup_request';
 import { getTransaction } from '../transactions/get_transaction';
 
 export type ErrorGroupAPIResponse = PromiseReturnType<typeof getErrorGroup>;
@@ -29,9 +25,9 @@ export async function getErrorGroup({
 }: {
   serviceName: string;
   groupId: string;
-  setup: Setup & SetupTimeRange & SetupUIFilters;
+  setup: Setup & SetupTimeRange;
 }) {
-  const { start, end, uiFiltersES, apmEventClient } = setup;
+  const { start, end, esFilter, apmEventClient } = setup;
 
   const params = {
     apm: {
@@ -45,7 +41,7 @@ export async function getErrorGroup({
             { term: { [SERVICE_NAME]: serviceName } },
             { term: { [ERROR_GROUP_ID]: groupId } },
             { range: rangeFilter(start, end) },
-            ...uiFiltersES,
+            ...esFilter,
           ],
           should: [{ term: { [TRANSACTION_SAMPLED]: true } }],
         },

diff --git a/x-pack/plugins/apm/server/lib/errors/get_error_groups.ts b/x-pack/plugins/apm/server/lib/errors/get_error_groups.ts
@@ -13,11 +13,7 @@ import {
   ERROR_LOG_MESSAGE,
 } from '../../../common/elasticsearch_fieldnames';
 import { PromiseReturnType } from '../../../typings/common';
-import {
-  Setup,
-  SetupTimeRange,
-  SetupUIFilters,
-} from '../helpers/setup_request';
+import { Setup, SetupTimeRange } from '../helpers/setup_request';
 import { getErrorGroupsProjection } from '../../projections/errors';
 import { mergeProjection } from '../../projections/util/merge_projection';
 import { SortOptions } from '../../../typings/elasticsearch/aggregations';
@@ -35,7 +31,7 @@ export async function getErrorGroups({
   serviceName: string;
   sortField?: string;
   sortDirection?: 'asc' | 'desc';
-  setup: Setup & SetupTimeRange & SetupUIFilters;
+  setup: Setup & SetupTimeRange;
 }) {
   const { apmEventClient } = setup;