[One Discover] Display stacktrace in the logs overview tab #204521

gbamparop · 2024-12-17T08:38:58Z

📓 Summary

Adds a new section to the overview tab in the log details flyout in Discover to display stacktrace information for logs and exceptions.

In a follow-up, the stacktrace could be moved to a new tab in the log details flyout and actions can be added to the stacktrace (and quality) icons in the document table to open the relevant sections in the flyout.

Closes #190460

APM - Log stacktrace (library frames)

APM - Exception (with cause)

APM - Exception (simple stacktrace)

Apache Tomcat Integration (Catalina) - Stacktrace

📝 Notes for reviewers

The @kbn/apm-types package was marked as platform / shared as it's being used by the unified_doc_viewer
The code used to render stacktraces in APM was moved into a new @kbn/event-stacktrace package as it is reused in the unified_doc_viewer
The code used to render metadata table in APM was moved into a new @kbn/key-value-metadata-table package

🧪 Testing instructions

The deployed environments have sample logs that can be used (time range: Jan 1, 2025 - now). For a local setup, please follow the instructions below:

Ingest sample logs with stacktraces (gist). Please note that these are test data and some fields that are not used by stacktraces might not be consistent
View relevant logs in Discover (Query: service.name: "synth-node-0" OR apache_tomcat :*, Time range: Jan 1, 2025 - now)

gbamparop · 2024-12-17T08:39:19Z

/ci

gbamparop · 2024-12-17T09:11:48Z

/ci

…trace

gbamparop · 2024-12-17T11:20:45Z

/ci

…ocs'

gbamparop · 2024-12-17T13:05:21Z

/ci

gbamparop · 2024-12-17T13:35:15Z

/ci

gbamparop · 2024-12-17T13:35:29Z

/oblt-deploy

gbamparop · 2024-12-17T18:21:55Z

/ci

…vant data available

gbamparop · 2024-12-18T11:23:27Z

/ci

…trace

gbamparop · 2025-01-06T10:53:13Z

/ci

…-fix'

gbamparop · 2025-01-06T11:21:21Z

/ci

gbamparop · 2025-01-06T11:22:58Z

/ci

…trace

gbamparop · 2025-01-16T18:01:08Z

/ci

gbamparop · 2025-01-16T18:17:42Z

...ared/kbn-event-stacktrace/src/components/stacktrace/exception/exception_stacktrace_title.tsx

@@ -40,7 +40,7 @@ export function ExceptionStacktraceTitle({
  }

  return (
-    <EuiTitle size="xs">
+    <EuiTitle size="xxs">


This was changed so the font-size of the exception title is smaller than the section title in Discover's flyout:

It will affect APM too, but LGTM.

Before

After

gbamparop · 2025-01-16T18:18:11Z

/oblt-deploy

github-actions · 2025-01-16T18:19:37Z

🤖 GitHub comments

Expand to view the GitHub comments

Just comment with:

/oblt-deploy : Deploy a Kibana instance using the Observability test environments.
run docs-build : Re-trigger the docs validation. (use unformatted text in the comment!)

gbamparop · 2025-01-16T18:23:11Z

/ci

gbamparop · 2025-01-16T18:36:04Z

.../public/components/doc_viewer_logs_overview/sub_components/stacktrace/stacktrace_content.tsx

+    dataStreamTypeField === APM_ERROR_DATASTREAM_FIELDS.dataStreamType &&
+    dataStreamDatasetField === APM_ERROR_DATASTREAM_FIELDS.dataStreamDataset
+  ) {
+    return <ApmStacktrace hit={hit} dataView={dataView} />;


This component is only used for APM data, as it requires the APM data model to be displayed properly.

elasticmachine · 2025-01-16T19:26:48Z

💛 Build succeeded, but was flaky

Buildkite Build
Commit: 1e0567e
Storybooks Preview
Kibana Serverless Image: docker.elastic.co/kibana-ci/kibana-serverless:pr-204521-1e0567e36f9f

Failed CI Steps

Test Failures

[job] [logs] APM Cypress Tests #3 / service map when navigating to service map when there is no data shows empty state shows empty state
[job] [logs] FTR Configs #44 / Stateful Observability - Deployment-agnostic API integration tests SyntheticsAPITests getSyntheticsMonitors get many monitors without params

Metrics [docs]

Module Count

Fewer modules leads to a faster build time

id	before	after	diff
`apm`	1695	1697	+2
`unifiedDocViewer`	236	277	+41
total			+43

Public APIs missing comments

Total count of every public API that lacks a comment. Target amount is 0. Run node scripts/build_api_docs --plugin [yourplugin] --stats comments for more detailed information.

id	before	after	diff
`@kbn/discover-utils`	228	229	+1
`@kbn/event-stacktrace`	-	18	+18
`@kbn/key-value-metadata-table`	-	10	+10
total			+29

Async chunks

Total size of all lazy-loaded chunks that will be downloaded as the user navigates the app

id	before	after	diff
`apm`	3.9MB	3.9MB	+22.0B
`discover`	844.1KB	844.3KB	+258.0B
`logsExplorer`	223.2KB	223.2KB	+36.0B
`unifiedDocViewer`	124.1KB	148.4KB	+24.4KB
total			+24.7KB

Page load bundle

Size of the bundles that are downloaded on every page load. Target size is below 100kb

id	before	after	diff
`logsExplorer`	26.5KB	26.6KB	+111.0B

Unknown metric groups

API count

id	before	after	diff
`@kbn/discover-utils`	278	279	+1
`@kbn/event-stacktrace`	-	18	+18
`@kbn/key-value-metadata-table`	-	10	+10
total			+29

ESLint disabled line counts

id	before	after	diff
`@kbn/event-stacktrace`	-	3	+3
`@kbn/key-value-metadata-table`	-	2	+2
total			+5

Total ESLint disabled count

id	before	after	diff
`@kbn/event-stacktrace`	-	3	+3
`@kbn/key-value-metadata-table`	-	2	+2
total			+5

History

💛 Build #264297 was flaky 997e251
💔 Build #263509 failed ce72d6e
💔 Build #263498 failed c93fa17
💚 Build #263486 succeeded a98458d
💔 Build #263473 failed 4f6bdb9

jbudz

src/dev/storybook/aliases.ts LGTM

elasticmachine · 2025-01-17T14:06:40Z

Pinging @elastic/obs-ux-infra_services-team (Team:obs-ux-infra_services)

tonyghiani

I made a first pass, the functionalities work and the new code LGTM, I left some questions/suggestions but overall looks good!

tonyghiani · 2025-01-17T13:32:47Z

.../shared/unified_doc_viewer/public/components/doc_viewer_logs_overview/logs_overview.test.tsx

@@ -148,14 +149,18 @@ setUnifiedDocViewerServices(
 const renderLogsOverview = (props: Partial<DocViewRenderProps> = {}) => {
  const { rerender: baseRerender, ...tools } = render(
    <EuiProvider>
-      <LogsOverview dataView={dataView} hit={fullHit} {...props} />
+      <IntlProvider locale="en">


question: Can you explain why we need an explicit provider for intl here?

tonyghiani · 2025-01-17T13:38:20Z

x-pack/platform/packages/shared/kbn-key-value-metadata-table/emotion.d.ts

note: With the changes done in #200958, this file shouldn't be necessary anymore. You only need to update the import for the typings in the tsconfig file.

tonyghiani · 2025-01-17T13:48:28Z

...ugins/shared/unified_doc_viewer/public/components/doc_viewer_logs_overview/logs_overview.tsx

@@ -47,6 +51,7 @@ export function LogsOverview({
      <EuiHorizontalRule margin="xs" />
      <LogsOverviewHighlights formattedDoc={parsedDoc} flattenedDoc={hit.flattened} />
      <LogsOverviewDegradedFields rawDoc={hit.raw} />
+      {isStacktraceAvailable && <LogsOverviewStacktraceSection hit={hit} dataView={dataView} />}


nit: we probably need some spacing here to separate from the AI Assistant.

tonyghiani · 2025-01-17T13:56:33Z

x-pack/platform/packages/shared/kbn-event-stacktrace/emotion.d.ts

note: With the changes done in #200958, this file shouldn't be necessary anymore. You only need to update the import for the typings in the tsconfig file.

tonyghiani · 2025-01-17T14:07:07Z

x-pack/platform/packages/shared/kbn-key-value-metadata-table/src/utils/flatten_object.ts

note: I was about to suggest we already have a shared object flattening function, but looking at the implementation it has a different purpose than object flattening.

Probably it was fine to use it in the scope of APM only, but this naming is quite generic for a utility now exported on a shared package, specially since it matches another exported utility.

Could we rename this to something more specific to what it does, maybe getFlattenedKeyValuePairs

Create key-value-metadata-table package for the local variables table

360019f

gbamparop added release_note:skip Skip the PR/issue when compiling release notes backport:skip This commit does not require backporting labels Dec 17, 2024

Create package for event stacktrace

b41227d

gbamparop force-pushed the discover-logs-stacktrace branch from e11d28d to b41227d Compare December 17, 2024 08:57

gbamparop added 2 commits December 17, 2024 09:00

Update license

6d1ad15

Delete metadata table from APM

b86953e

kibanamachine and others added 5 commits December 17, 2024 09:22

[CI] Auto-commit changed files from 'node scripts/generate codeowners'

8939e2a

Mark kbn-apm-types as platform/shared

dc0d679

Mark kbn-key-value-metadata-table as platform/shared

ca3ad1f

Merge remote-tracking branch 'upstream/main' into discover-logs-stack…

ee1df5b

…trace

Add stacktrace to the overview tab

09296d5

kibanamachine and others added 2 commits December 17, 2024 11:29

[CI] Auto-commit changed files from 'node scripts/build_plugin_list_d…

f3a7554

…ocs'

Fix types

4411afa

Fix jest config

fae18f2

gbamparop added 2 commits December 17, 2024 17:51

Fix Jest tests

2883cea

Fix Jest tests

8b0965f

gbamparop added 3 commits December 18, 2024 10:42

Clean up code in logs overview stacktrace

1321d95

Add checks to not display the stacktrace section if there are no rele…

bda64c4

…vant data available

Add stacktrace section only when there is data available

0239a95

gbamparop added 2 commits December 18, 2024 12:20

Handle cases when the data format is not the one expected

82c9f10

Migrate styled components to emotion

2db6a10

gbamparop changed the title ~~Discover logs stacktrace~~ [One Discover] Display stacktrace in the logs overview tab Dec 31, 2024

Merge remote-tracking branch 'upstream/main' into discover-logs-stack…

23fbe85

…trace

[CI] Auto-commit changed files from 'node scripts/eslint --no-cache -…

997e251

…-fix'

gbamparop mentioned this pull request Jan 6, 2025

[Draft] Logs flyout stacktrace #174781

Closed

gbamparop added 3 commits January 16, 2025 19:52

Merge remote-tracking branch 'upstream/main' into discover-logs-stack…

b16b154

…trace

Fix typo

4b3d5cd

Import StackframeWithLineContext as a type

23c45e4

Change font size for exception title

1e0567e

gbamparop commented Jan 16, 2025

View reviewed changes

gbamparop added the ci:project-deploy-observability Create an Observability project label Jan 16, 2025

gbamparop commented Jan 16, 2025

View reviewed changes

gbamparop marked this pull request as ready for review January 17, 2025 06:50

gbamparop requested review from a team as code owners January 17, 2025 06:50

tonyghiani self-requested a review January 17, 2025 11:15

jbudz approved these changes Jan 17, 2025

View reviewed changes

botelastic bot added the Team:obs-ux-infra_services Observability Infrastructure & Services User Experience Team label Jan 17, 2025

tonyghiani reviewed Jan 17, 2025

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[One Discover] Display stacktrace in the logs overview tab #204521

[One Discover] Display stacktrace in the logs overview tab #204521

gbamparop commented Dec 17, 2024 •

edited

Loading

gbamparop commented Dec 17, 2024

gbamparop commented Dec 17, 2024

gbamparop commented Dec 17, 2024

gbamparop commented Dec 17, 2024

gbamparop commented Dec 17, 2024

gbamparop commented Dec 17, 2024

gbamparop commented Dec 17, 2024

gbamparop commented Dec 18, 2024

gbamparop commented Jan 6, 2025

gbamparop commented Jan 6, 2025

gbamparop commented Jan 6, 2025

gbamparop commented Jan 16, 2025

gbamparop Jan 16, 2025

gbamparop commented Jan 16, 2025

github-actions bot commented Jan 16, 2025

gbamparop commented Jan 16, 2025

gbamparop Jan 16, 2025

elasticmachine commented Jan 16, 2025 •

edited

Loading

API count

ESLint disabled line counts

Total ESLint disabled count

jbudz left a comment

elasticmachine commented Jan 17, 2025

tonyghiani left a comment

tonyghiani Jan 17, 2025

tonyghiani Jan 17, 2025

tonyghiani Jan 17, 2025

tonyghiani Jan 17, 2025

tonyghiani Jan 17, 2025

[One Discover] Display stacktrace in the logs overview tab #204521

Are you sure you want to change the base?

[One Discover] Display stacktrace in the logs overview tab #204521

Conversation

gbamparop commented Dec 17, 2024 • edited Loading

📓 Summary

APM - Log stacktrace (library frames)

APM - Exception (with cause)

APM - Exception (simple stacktrace)

Apache Tomcat Integration (Catalina) - Stacktrace

📝 Notes for reviewers

🧪 Testing instructions

gbamparop commented Dec 17, 2024

gbamparop commented Dec 17, 2024

gbamparop commented Dec 17, 2024

gbamparop commented Dec 17, 2024

gbamparop commented Dec 17, 2024

gbamparop commented Dec 17, 2024

gbamparop commented Dec 17, 2024

gbamparop commented Dec 18, 2024

gbamparop commented Jan 6, 2025

gbamparop commented Jan 6, 2025

gbamparop commented Jan 6, 2025

gbamparop commented Jan 16, 2025

gbamparop Jan 16, 2025

Choose a reason for hiding this comment

Before

After

gbamparop commented Jan 16, 2025

github-actions bot commented Jan 16, 2025

🤖 GitHub comments

gbamparop commented Jan 16, 2025

gbamparop Jan 16, 2025

Choose a reason for hiding this comment

elasticmachine commented Jan 16, 2025 • edited Loading

💛 Build succeeded, but was flaky

Failed CI Steps

Test Failures

Metrics [docs]

Module Count

Public APIs missing comments

Async chunks

Page load bundle

API count

ESLint disabled line counts

Total ESLint disabled count

History

jbudz left a comment

Choose a reason for hiding this comment

elasticmachine commented Jan 17, 2025

tonyghiani left a comment

Choose a reason for hiding this comment

tonyghiani Jan 17, 2025

Choose a reason for hiding this comment

tonyghiani Jan 17, 2025

Choose a reason for hiding this comment

tonyghiani Jan 17, 2025

Choose a reason for hiding this comment

tonyghiani Jan 17, 2025

Choose a reason for hiding this comment

tonyghiani Jan 17, 2025

Choose a reason for hiding this comment

gbamparop commented Dec 17, 2024 •

edited

Loading

elasticmachine commented Jan 16, 2025 •

edited

Loading