diff --git a/packages/v4/src/content/design-guidelines/extensions/log-viewer/img/logviewer.png b/packages/v4/src/content/design-guidelines/extensions/log-viewer/img/logviewer.png new file mode 100644 index 0000000000..37338088fa Binary files /dev/null and b/packages/v4/src/content/design-guidelines/extensions/log-viewer/img/logviewer.png differ diff --git a/packages/v4/src/content/design-guidelines/extensions/log-viewer/img/logviewerclear.png b/packages/v4/src/content/design-guidelines/extensions/log-viewer/img/logviewerclear.png new file mode 100644 index 0000000000..a8a5999033 Binary files /dev/null and b/packages/v4/src/content/design-guidelines/extensions/log-viewer/img/logviewerclear.png differ diff --git a/packages/v4/src/content/design-guidelines/extensions/log-viewer/img/logviewercog.png b/packages/v4/src/content/design-guidelines/extensions/log-viewer/img/logviewercog.png new file mode 100644 index 0000000000..81381dbdb7 Binary files /dev/null and b/packages/v4/src/content/design-guidelines/extensions/log-viewer/img/logviewercog.png differ diff --git a/packages/v4/src/content/design-guidelines/extensions/log-viewer/img/logviewerdark.png b/packages/v4/src/content/design-guidelines/extensions/log-viewer/img/logviewerdark.png new file mode 100644 index 0000000000..280eddd271 Binary files /dev/null and b/packages/v4/src/content/design-guidelines/extensions/log-viewer/img/logviewerdark.png differ diff --git a/packages/v4/src/content/design-guidelines/extensions/log-viewer/img/logviewersearch.png b/packages/v4/src/content/design-guidelines/extensions/log-viewer/img/logviewersearch.png new file mode 100644 index 0000000000..fa528a12d5 Binary files /dev/null and b/packages/v4/src/content/design-guidelines/extensions/log-viewer/img/logviewersearch.png differ diff --git a/packages/v4/src/content/design-guidelines/extensions/log-viewer/log-viewer.md b/packages/v4/src/content/design-guidelines/extensions/log-viewer/log-viewer.md new file mode 100644 index 0000000000..3ca64ab75b --- /dev/null +++ b/packages/v4/src/content/design-guidelines/extensions/log-viewer/log-viewer.md @@ -0,0 +1,49 @@ +--- +id: Log viewer +section: extensions +--- + +A **log viewer** is a preconfigured component that gives you the option to visualize your log content. Log viewer renders log output in real time in a clear and structured way. + +## Light theme log viewer + +Log Viewer + +1. **Type of log dropdown menu:** Allow users to switch between different types of logs. +2. **Search bar:** Use to look up historical logs. The results will be highlighted in the log. +3. **Pause button:** Play and stop your log content viewing, instead of scrolling through. +4. **Clear log:** Clear the displayed log output. +5. **Cog:** House settings such as wrapping lines, showing timestamps, and displaying line numbers. +6. **Export:** Export log content. +7. **Download:** Download the log file. +8. **Fullscreen:** Expand log viewer to full screen. + +## Dark theme log viewer +We recommend using the light theme editor by default, but there is also a dark theme log viewer +available. All log viewer functionality remains the same whether a light or dark theme is used. + +Dark theme log viewer + +## Usability +Use a log viewer when: +* The user can manipulate 1 large log file or multiple log files at the same time. +* You want to create a more readable and accessible environment for the user. +* The user may actively search for specific logs within a large log file. +* The user shares files frequently with other users or teams. + +## Log viewer functionality + +### With popover +The clear log button opens up a popover with further options, to prevent a user from accidentally clearing their log content. + +Clear this log popover open on a Log viewer + +### With dropdown, drilldown, and search expanded +The cog icon in the log viewer toolbar allows you to store content options such as timestamps or line numbers for better orientation within the log viewer. + +Cog options open on a Log viewer + +### With search results +The search bar provides highlighted search results for better findability within a log viewer’s content. + +Log Viewer with highlighted search results