[8.x] [APM] Fix query for transaction marks (#215819) (#216677)

# Backport This will backport the following commits from `main` to `8.x`: - [[APM] Fix query for transaction marks (#215819)](https://github.com/elastic/kibana/pull/215819)  ### Questions ? Please refer to the [Backport tool documentation](https://github.com/sorenlouv/backport)  Co-authored-by: Sunghyun Kim <cqbqdd11519@gmail.com>
2025-04-23 17:28:26 -04:00 · 2025-04-01 14:34:48 -03:00 · 2025-04-01 14:34:48 -03:00 · 93dafef6ae
commit 93dafef6ae
parent ecfc47e88b
6 changed files with 431 additions and 10 deletions
--- a/api_docs/kbn_apm_types.devdocs.json
+++ b/api_docs/kbn_apm_types.devdocs.json
@ -4782,6 +4782,21 @@
        "trackAdoption": false,
        "initialIsOpen": false
      },
+      {
+        "parentPluginId": "@kbn/apm-types",
+        "id": "def-common.TRANSACTION_MARKS_AGENT",
+        "type": "string",
+        "tags": [],
+        "label": "TRANSACTION_MARKS_AGENT",
+        "description": [],
+        "signature": [
+          "\"transaction.marks.agent\""
+        ],
+        "path": "packages/kbn-apm-types/src/es_fields/apm.ts",
+        "deprecated": false,
+        "trackAdoption": false,
+        "initialIsOpen": false
+      },
      {
        "parentPluginId": "@kbn/apm-types",
        "id": "def-common.TRANSACTION_DURATION",
--- a/x-pack/platform/packages/shared/kbn-apm-types/src/es_fields/apm.ts
+++ b/x-pack/platform/packages/shared/kbn-apm-types/src/es_fields/apm.ts
@ -57,7 +57,7 @@ export const OBSERVER_LISTENING = 'observer.listening';
 export const PROCESSOR_EVENT = 'processor.event';
 export const PROCESSOR_NAME = 'processor.name';

-export const TRANSACTION_AGENT_MARKS = 'transaction.agent.marks';
+export const TRANSACTION_MARKS_AGENT = 'transaction.marks.agent';
 export const TRANSACTION_DURATION = 'transaction.duration.us';
 export const TRANSACTION_DURATION_HISTOGRAM = 'transaction.duration.histogram';
 export const TRANSACTION_DURATION_SUMMARY = 'transaction.duration.summary';
--- a/x-pack/plugins/observability_solution/apm/server/routes/transactions/snapshots/queries.test.ts.snap
+++ b/x-pack/plugins/observability_solution/apm/server/routes/transactions/snapshots/queries.test.ts.snap
@ -0,0 +1,406 @@
+// Jest Snapshot v1, https://goo.gl/fbAQLP
+
+exports[`transaction queries fetches a transaction 1`] = `
+Object {
+  "apm": Object {
+    "sources": Array [
+      Object {
+        "documentType": "transactionEvent",
+        "rollupInterval": "none",
+      },
+    ],
+  },
+  "body": Object {
+    "_source": Array [
+      "span.links",
+      "transaction.marks.agent",
+    ],
+    "fields": Array [
+      "trace.id",
+      "agent.name",
+      "processor.event",
+      "@timestamp",
+      "timestamp.us",
+      "service.name",
+      "transaction.id",
+      "transaction.duration.us",
+      "transaction.name",
+      "transaction.sampled",
+      "transaction.type",
+      "processor.name",
+      "service.language.name",
+      "url.full",
+      "transaction.page.url",
+      "http.response.status_code",
+      "http.request.method",
+      "user_agent.name",
+    ],
+    "query": Object {
+      "bool": Object {
+        "filter": Array [
+          Object {
+            "term": Object {
+              "transaction.id": "foo",
+            },
+          },
+          Object {
+            "term": Object {
+              "trace.id": "bar",
+            },
+          },
+          Object {
+            "range": Object {
+              "@timestamp": Object {
+                "format": "epoch_millis",
+                "gte": 0,
+                "lte": 50000,
+              },
+            },
+          },
+        ],
+      },
+    },
+    "size": 1,
+    "terminate_after": 1,
+    "track_total_hits": false,
+  },
+}
+`;
+
+exports[`transaction queries fetches breakdown data for transactions 1`] = `
+Object {
+  "apm": Object {
+    "events": Array [
+      "metric",
+    ],
+  },
+  "body": Object {
+    "aggs": Object {
+      "by_date": Object {
+        "aggs": Object {
+          "sum_all_self_times": Object {
+            "sum": Object {
+              "field": "span.self_time.sum.us",
+            },
+          },
+          "types": Object {
+            "aggs": Object {
+              "subtypes": Object {
+                "aggs": Object {
+                  "total_self_time_per_subtype": Object {
+                    "sum": Object {
+                      "field": "span.self_time.sum.us",
+                    },
+                  },
+                },
+                "terms": Object {
+                  "field": "span.subtype",
+                  "missing": "",
+                  "order": Object {
+                    "_count": "desc",
+                  },
+                  "size": 20,
+                },
+              },
+            },
+            "terms": Object {
+              "field": "span.type",
+              "order": Object {
+                "_count": "desc",
+              },
+              "size": 20,
+            },
+          },
+        },
+        "date_histogram": Object {
+          "extended_bounds": Object {
+            "max": 50000,
+            "min": 0,
+          },
+          "field": "@timestamp",
+          "fixed_interval": "30s",
+          "min_doc_count": 0,
+        },
+      },
+      "sum_all_self_times": Object {
+        "sum": Object {
+          "field": "span.self_time.sum.us",
+        },
+      },
+      "types": Object {
+        "aggs": Object {
+          "subtypes": Object {
+            "aggs": Object {
+              "total_self_time_per_subtype": Object {
+                "sum": Object {
+                  "field": "span.self_time.sum.us",
+                },
+              },
+            },
+            "terms": Object {
+              "field": "span.subtype",
+              "missing": "",
+              "order": Object {
+                "_count": "desc",
+              },
+              "size": 20,
+            },
+          },
+        },
+        "terms": Object {
+          "field": "span.type",
+          "order": Object {
+            "_count": "desc",
+          },
+          "size": 20,
+        },
+      },
+    },
+    "query": Object {
+      "bool": Object {
+        "filter": Array [
+          Object {
+            "term": Object {
+              "service.name": "foo",
+            },
+          },
+          Object {
+            "term": Object {
+              "transaction.type": "bar",
+            },
+          },
+          Object {
+            "range": Object {
+              "@timestamp": Object {
+                "format": "epoch_millis",
+                "gte": 0,
+                "lte": 50000,
+              },
+            },
+          },
+          Object {
+            "exists": Object {
+              "field": "span.self_time.sum.us",
+            },
+          },
+        ],
+      },
+    },
+    "size": 0,
+    "track_total_hits": false,
+  },
+}
+`;
+
+exports[`transaction queries fetches breakdown data for transactions for a transaction name 1`] = `
+Object {
+  "apm": Object {
+    "events": Array [
+      "metric",
+    ],
+  },
+  "body": Object {
+    "aggs": Object {
+      "by_date": Object {
+        "aggs": Object {
+          "sum_all_self_times": Object {
+            "sum": Object {
+              "field": "span.self_time.sum.us",
+            },
+          },
+          "types": Object {
+            "aggs": Object {
+              "subtypes": Object {
+                "aggs": Object {
+                  "total_self_time_per_subtype": Object {
+                    "sum": Object {
+                      "field": "span.self_time.sum.us",
+                    },
+                  },
+                },
+                "terms": Object {
+                  "field": "span.subtype",
+                  "missing": "",
+                  "order": Object {
+                    "_count": "desc",
+                  },
+                  "size": 20,
+                },
+              },
+            },
+            "terms": Object {
+              "field": "span.type",
+              "order": Object {
+                "_count": "desc",
+              },
+              "size": 20,
+            },
+          },
+        },
+        "date_histogram": Object {
+          "extended_bounds": Object {
+            "max": 50000,
+            "min": 0,
+          },
+          "field": "@timestamp",
+          "fixed_interval": "30s",
+          "min_doc_count": 0,
+        },
+      },
+      "sum_all_self_times": Object {
+        "sum": Object {
+          "field": "span.self_time.sum.us",
+        },
+      },
+      "types": Object {
+        "aggs": Object {
+          "subtypes": Object {
+            "aggs": Object {
+              "total_self_time_per_subtype": Object {
+                "sum": Object {
+                  "field": "span.self_time.sum.us",
+                },
+              },
+            },
+            "terms": Object {
+              "field": "span.subtype",
+              "missing": "",
+              "order": Object {
+                "_count": "desc",
+              },
+              "size": 20,
+            },
+          },
+        },
+        "terms": Object {
+          "field": "span.type",
+          "order": Object {
+            "_count": "desc",
+          },
+          "size": 20,
+        },
+      },
+    },
+    "query": Object {
+      "bool": Object {
+        "filter": Array [
+          Object {
+            "term": Object {
+              "service.name": "foo",
+            },
+          },
+          Object {
+            "term": Object {
+              "transaction.type": "bar",
+            },
+          },
+          Object {
+            "range": Object {
+              "@timestamp": Object {
+                "format": "epoch_millis",
+                "gte": 0,
+                "lte": 50000,
+              },
+            },
+          },
+          Object {
+            "exists": Object {
+              "field": "span.self_time.sum.us",
+            },
+          },
+          Object {
+            "term": Object {
+              "transaction.name": "baz",
+            },
+          },
+        ],
+      },
+    },
+    "size": 0,
+    "track_total_hits": false,
+  },
+}
+`;
+
+exports[`transaction queries fetches transaction trace samples 1`] = `
+Object {
+  "_source": Array [
+    "transaction.id",
+    "trace.id",
+    "@timestamp",
+  ],
+  "apm": Object {
+    "events": Array [
+      "transaction",
+    ],
+  },
+  "body": Object {
+    "fields": Array [
+      "transaction.id",
+      "trace.id",
+      "@timestamp",
+    ],
+    "query": Object {
+      "bool": Object {
+        "filter": Array [
+          Object {
+            "term": Object {
+              "service.name": "foo",
+            },
+          },
+          Object {
+            "term": Object {
+              "transaction.type": "baz",
+            },
+          },
+          Object {
+            "term": Object {
+              "transaction.name": "bar",
+            },
+          },
+          Object {
+            "range": Object {
+              "@timestamp": Object {
+                "format": "epoch_millis",
+                "gte": 0,
+                "lte": 50000,
+              },
+            },
+          },
+          Object {
+            "term": Object {
+              "transaction.sampled": true,
+            },
+          },
+        ],
+        "should": Array [
+          Object {
+            "term": Object {
+              "trace.id": "qux",
+            },
+          },
+          Object {
+            "term": Object {
+              "transaction.id": "quz",
+            },
+          },
+        ],
+      },
+    },
+    "size": 500,
+    "sort": Array [
+      Object {
+        "_score": Object {
+          "order": "desc",
+        },
+      },
+      Object {
+        "@timestamp": Object {
+          "order": "desc",
+        },
+      },
+    ],
+    "track_total_hits": false,
+  },
+}
+`;
--- a/x-pack/solutions/observability/plugins/apm/common/es_fields/snapshots/es_fields.test.ts.snap
+++ b/x-pack/solutions/observability/plugins/apm/common/es_fields/snapshots/es_fields.test.ts.snap
@ -344,7 +344,7 @@ exports[`Error TIMESTAMP_US 1`] = `1337`;

 exports[`Error TRACE_ID 1`] = `"trace id"`;

-exports[`Error TRANSACTION_AGENT_MARKS 1`] = `undefined`;
+exports[`Error TRANSACTION_MARKS_AGENT 1`] = `undefined`;

 exports[`Error TRANSACTION_DURATION 1`] = `undefined`;

@ -719,7 +719,7 @@ exports[`Span TIMESTAMP_US 1`] = `1337`;

 exports[`Span TRACE_ID 1`] = `"trace id"`;

-exports[`Span TRANSACTION_AGENT_MARKS 1`] = `undefined`;
+exports[`Span TRANSACTION_MARKS_AGENT 1`] = `undefined`;

 exports[`Span TRANSACTION_DURATION 1`] = `undefined`;

@ -1112,7 +1112,7 @@ exports[`Transaction TIMESTAMP_US 1`] = `1337`;

 exports[`Transaction TRACE_ID 1`] = `"trace id"`;

-exports[`Transaction TRANSACTION_AGENT_MARKS 1`] = `undefined`;
+exports[`Transaction TRANSACTION_MARKS_AGENT 1`] = `undefined`;

 exports[`Transaction TRANSACTION_DURATION 1`] = `1337`;

--- a/x-pack/solutions/observability/plugins/apm/server/routes/transactions/snapshots/queries.test.ts.snap
+++ b/x-pack/solutions/observability/plugins/apm/server/routes/transactions/snapshots/queries.test.ts.snap
@ -13,7 +13,7 @@ Object {
  "body": Object {
    "_source": Array [
      "span.links",
-      "transaction.agent.marks",
+      "transaction.marks.agent",
    ],
    "fields": Array [
      "trace.id",
--- a/x-pack/solutions/observability/plugins/apm/server/routes/transactions/get_transaction/index.ts
+++ b/x-pack/solutions/observability/plugins/apm/server/routes/transactions/get_transaction/index.ts
@ -23,7 +23,7 @@ import {
  AT_TIMESTAMP,
  PROCESSOR_NAME,
  SPAN_LINKS,
-  TRANSACTION_AGENT_MARKS,
+  TRANSACTION_MARKS_AGENT,
  SERVICE_LANGUAGE_NAME,
  URL_FULL,
  HTTP_REQUEST_METHOD,
@ -106,7 +106,7 @@ export async function getTransaction({
        },
      },
      fields: [...requiredFields, ...optionalFields],
-      _source: [SPAN_LINKS, TRANSACTION_AGENT_MARKS],
+      _source: [SPAN_LINKS, TRANSACTION_MARKS_AGENT],
    },
  });

@ -119,9 +119,9 @@ export async function getTransaction({
  const event = unflattenKnownApmEventFields(hit.fields, requiredFields);

  const source =
-    'span' in hit._source && 'transaction' in hit._source
+    'span' in hit._source || 'transaction' in hit._source
      ? (hit._source as {
-          transaction: Pick<Required<Transaction>['transaction'], 'marks'>;
+          transaction?: Pick<Required<Transaction>['transaction'], 'marks'>;
          span?: Pick<Required<Transaction>['span'], 'links'>;
        })
      : undefined;
@ -130,7 +130,7 @@ export async function getTransaction({
    ...event,
    transaction: {
      ...event.transaction,
-      marks: source?.transaction.marks,
+      marks: source?.transaction?.marks,
    },
    processor: {
      name: 'transaction',