Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Adding terminal log tab to data apps #720

Merged
merged 7 commits into from
Jan 28, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions _data/navigation.yml
Original file line number Diff line number Diff line change
Expand Up @@ -472,6 +472,8 @@ items:
title: Microsoft Entra ID
- url: /components/data-apps/oidc/okta/
title: Okta
- url: /components/data-apps/terminal-log-tab/
title: Terminal Log Tab

- url: /components/branches/
title: Development Branches
Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
41 changes: 41 additions & 0 deletions components/data-apps/terminal-log-tab/terminal-log-tab.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
---
title: Terminal Log Tab
permalink: /components/data-apps/terminal-log-tab/
---

* TOC
{:toc}

The Terminal Log Tab in Keboola provides users with an **almost real-time** view of the application’s terminal logs.
While there is a slight delay of a few seconds, this feature is designed to offer valuable insights into the application’s runtime environment,
helping with monitoring and troubleshooting.

{: .image-popup}
![Screenshot - Hello World Data App](/components/data-apps/terminal-log-tab/hello-world.png)

## Key Features
The Terminal Log Tab includes the following features:

- **Near Real-Time Log Display:**
- Displays terminal output from the running application with a slight delay of a few seconds.
- Enables users to monitor logs as they are generated, providing visibility into the application’s current state.
- **Full Log Download:**
- Allows users to download a complete log of the application from its start by selecting the **Download Logs** button located on the right side of the tab.

- **Log Availability:**
- Logs are accessible only while the application is running.
- To maintain system efficiency, logs are automatically deleted when the application is stopped or paused.

## Key Benefits
The Terminal Log Tab offers several benefits:

- **Near Real-Time Monitoring:**
- Provides users with a clear view of the application’s performance during runtime.
- Enables prompt detection of anomalies or bottlenecks.
- **Troubleshooting:**
- Helps developers and operators identify issues by observing log outputs, such as error messages or warnings.
- Simplifies debugging by offering direct insights from the runtime environment.
- **Transparency:**
- Offers a detailed view of the application's internal operations, ensuring visibility and understanding.
- **Full Log Access for Analysis:**
- Supports in-depth analysis by allowing users to download the full log file, which contains all outputs from the start of the application’s execution.
Loading