Store client-side pipeline run logs in the artifact store #3498

stefannica · 2025-04-04T16:34:46Z

Describe changes

Reuse the existing step logger context and the pipeline run logs reference to collect the client-side stdout and stderr output of a pipeline run and store it in the active artifact store, so it can be fetched and displayed in the pipeline run logs tab in the dashboard.

Pre-requisites

Please ensure you have done the following:

I have read the CONTRIBUTING.md document.
I have added tests to cover my changes.
I have based my new branch on develop and the open PR is targeting develop. If your branch wasn't based on develop read Contribution guide on rebasing branch to develop.
IMPORTANT: I made sure that my changes are reflected properly in the following resources:
- ZenML Docs
- Dashboard: Needs to be communicated to the frontend team.
- Templates: Might need adjustments (that are not reflected in the template tests) in case of non-breaking changes and deprecations.
- Projects: Depending on the version dependencies, different projects might get affected.

Types of changes

Bug fix (non-breaking change which fixes an issue)
New feature (non-breaking change which adds functionality)
Breaking change (fix or feature that would cause existing functionality to change)
Other (add details above)

coderabbitai · 2025-04-04T16:34:52Z

Important

Review skipped

Auto reviews are disabled on this repository.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

Review comments: Directly reply to a review comment made by CodeRabbit. Example:
- I pushed a fix in commit <commit_id>, please review it.
- Generate unit testing code for this file.
- Open a follow-up GitHub issue for this discussion.
Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
- @coderabbitai generate unit testing code for this file.
- @coderabbitai modularize this function.
PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
- @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
- @coderabbitai read src/utils.ts and generate unit testing code.
- @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
- @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

@coderabbitai pause to pause the reviews on a PR.
@coderabbitai resume to resume the paused reviews.
@coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
@coderabbitai full review to do a full review from scratch and review all the files again.
@coderabbitai summary to regenerate the summary of the PR.
@coderabbitai generate docstrings to generate docstrings for this PR.
@coderabbitai resolve resolve all the CodeRabbit review comments.
@coderabbitai plan to trigger planning for file edits and PR creation.
@coderabbitai configuration to show the current CodeRabbit configuration for the repository.
@coderabbitai help to get help.

Other keywords and placeholders

Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
Add @coderabbitai anywhere in the PR title to generate the title automatically.

Documentation and Community

Visit our Documentation for detailed information on how to use CodeRabbit.
Join our Discord Community to get help, request features, and share feedback.
Follow us on X/Twitter for updates and announcements.

src/zenml/logging/step_logging.py

src/zenml/zen_server/routers/pipeline_deployments_endpoints.py

…un-logs

github-actions · 2025-04-14T14:30:04Z

ZenML CLI Performance Comparison (Threshold: 1.0s, Timeout: 60s, Slow: 5s)

❌ Failed Commands on Current Branch (feature/pipeline-run-logs)

zenml stack list: Command failed on run 1 (exit code: 1)
zenml pipeline list: Command failed on run 1 (exit code: 1)
zenml model list: Command failed on run 1 (exit code: 1)

🚨 New Failures Introduced

The following commands fail on your branch but worked on the target branch:

zenml stack list
zenml pipeline list
zenml model list

Performance Comparison

Command	develop Time (s)	feature/pipeline-run-logs Time (s)	Difference	Status
`zenml --help`	1.560274 ± 0.011045	1.558087 ± 0.007874	-0.002s	✓ No significant change
`zenml model list`	Not tested	Failed	N/A	❌ Broken in current branch
`zenml pipeline list`	Not tested	Failed	N/A	❌ Broken in current branch
`zenml stack --help`	1.566137 ± 0.009055	1.568054 ± 0.011000	+0.002s	✓ No significant change
`zenml stack list`	Not tested	Failed	N/A	❌ Broken in current branch

Summary

Total commands analyzed: 5
Commands compared for timing: 2
Commands improved: 0 (0.0% of compared)
Commands degraded: 0 (0.0% of compared)
Commands unchanged: 2 (100.0% of compared)
Failed commands: 3 (NEW FAILURES INTRODUCED)
Timed out commands: 0
Slow commands: 0

Environment Info

Target branch: Linux 6.8.0-1021-azure
Current branch: Linux 6.8.0-1021-azure
Test timestamp: 2025-04-14T15:33:43Z
Timeout: 60 seconds
Slow threshold: 5 seconds

schustmi · 2025-04-14T14:17:29Z

src/zenml/models/v2/core/pipeline_run.py

@@ -243,6 +249,10 @@ class PipelineRunResponseMetadata(ProjectScopedResponseMetadata):
        title="Substitutions used in the step runs of this pipeline run.",
        default_factory=dict,
    )
+    logs: Optional["LogsResponse"] = Field(


Now that we're newly introducing this, I think PipelineRunResponseResources would be the appropriate container for this attribute, as this refers to another response model?

schustmi · 2025-04-14T14:28:53Z

src/zenml/pipelines/pipeline_definition.py

+            compiled_deployment, schedule, build = self._compile(
+                **self._run_args
            )
+            self._run_args["deployment"] = compiled_deployment
+            self._run_args["schedule"] = schedule
+            self._run_args["build"] = build


This is super ugly 😅 I'm guessing this was necessary to figure out the final state of enable_pipeline_logs before calling the rest of the code?

I'm wondering if there's a cleaner way to achieve this? I guess the value is just:

logging_enabled = run_config.enable_pipeline_logs if logging_enabled is None: logging_enabled = self.config.enable_pipeline_logs

Not just super-ugly, but apparently also breaking everything.

Your suggestion looks a lot better. Done.

src/zenml/pipelines/pipeline_definition.py

github-actions · 2025-04-14T15:23:57Z

Images automagically compressed by Calibre's image-actions ✨

Compression reduced images by 24.4%, saving 74.06 KB.

Filename	Before	After	Improvement	Visual comparison
`docs/book/.gitbook/assets/zenml_pipeline_run_logs.png`	303.44 KB	229.38 KB	-24.4%	View diff

497 images did not require optimisation.

Update required: Update image-actions configuration to the latest version before 1/1/21. See README for instructions.

schustmi · 2025-04-14T15:25:29Z

src/zenml/pipelines/pipeline_definition.py

+                logging_enabled = False
+            else:
+                logging_enabled = self._run_args.get(
+                    "enable_pipeline_logs", True


I think it's still missing the check of self.config.enable_pipeline_logs as a last fallback?

You're right, I missed that. Done.

github-actions · 2025-04-14T15:27:48Z

Documentation Link Check Results

✅ Absolute links check passed
✅ Relative links check passed
_{Last checked: 2025-04-14 19:19:25 UTC}

… into feature/pipeline-run-logs

Document the new feature from PR #3498 that stores client-side pipeline logs in the artifact store, making them accessible after client session ends. Update configuration options and add benefits section. 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <[email protected]>

* Add deployment link * Move Custom Output Names section higher in docs to highlight fundamental concept 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <[email protected]> * Fix images in self-hosted page * Reorg IaC section and move best practices to 'Learn' tab * Fix TOC * Clarify OSS vs Pro features in Model Control Plane documentation 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <[email protected]> * Refine wording in Model Control Plane documentation to enhance clarity regarding open-source and Pro features * Fix GIF URL * Clarify Workspace URL meaning for Pro users in Terraform docs Add specific guidance for ZenML Pro users about what the server_url parameter means in their context, making it clear they should use their Workspace URL from the dashboard. 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <[email protected]> * Clarify Workspace URL and API key usage in Terraform IaC docs Add specific information for ZenML Pro users about Workspace URL configuration and improve the API key generation documentation. 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <[email protected]> * Update logging docs to include client-side pipeline logs storage Document the new feature from PR #3498 that stores client-side pipeline logs in the artifact store, making them accessible after client session ends. Update configuration options and add benefits section. 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <[email protected]> * Add schedule types column to orchestrator scheduling support table This commit adds a new column to the orchestrator comparison table in the scheduling documentation that specifies which schedule types (Cron, Interval, One-time) are supported by each orchestrator with scheduling capabilities. 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <[email protected]> * Make the distinction between configure and with_options * Update with a gotcha * Improve the service connectors docs page * add images * Enhance Docker build documentation with details from DockerSettings docstring - Add details about the Docker build process flow - Document requirements installation order - Explain skip_build behavior in detail - Add notes about custom Dockerfile usage - Improve details on environment replication options - Add section on package installer options - Document build reuse prevention options - Add section on target repository configuration - Add section on container user permissions - Add new best practice about container security 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <[email protected]> * Remove the prevent build reuse stuff * Remove unused terraform-stack-management.md file * Fix merge conflict remaining markers * Add redirect for IaC page * Add workspace URL image * Remove bad redirect * Move the image outside the info box * Testing * add a warning hint about logs --------- Co-authored-by: Claude <[email protected]>

stefannica added 2 commits April 4, 2025 18:02

Store client-side pipeline logs in the artifact store

5d1d02e

Update endpoint to return pipeline logs

e7ee8ee

stefannica requested a review from schustmi April 4, 2025 16:34

stefannica requested review from bcdurak and htahir1 April 4, 2025 16:34

github-actions bot added internal To filter out internal PRs and issues enhancement New feature or request labels Apr 4, 2025

Add project scope to pipeline logs endpoint

a223b1b

stefannica added the run-slow-ci label Apr 4, 2025

schustmi requested changes Apr 7, 2025

View reviewed changes

src/zenml/logging/step_logging.py Outdated Show resolved Hide resolved

src/zenml/zen_server/routers/pipeline_deployments_endpoints.py Outdated Show resolved Hide resolved

src/zenml/zen_server/routers/pipeline_deployments_endpoints.py Show resolved Hide resolved

stefannica added 4 commits April 7, 2025 23:11

Add pipeline log settings and pipeline run logs endpoint

9dea5cf

Merge remote-tracking branch 'origin/develop' into feature/pipeline-r…

03d9970

…un-logs

Merge remote-tracking branch 'origin/develop' into feature/pipeline-r…

5861b01

…un-logs

Fix linter errors

0146607

stefannica requested a review from schustmi April 14, 2025 14:13

Use enable_pipeline_logs instead of enable_step_logs

07906cf

schustmi requested changes Apr 14, 2025

View reviewed changes

Apply code review suggestions and add docs

fdf1eb6

stefannica requested a review from schustmi April 14, 2025 15:22

Optimised images with calibre/image-actions

cc8ac24

Fix linter errors

592df2f

schustmi requested changes Apr 14, 2025

View reviewed changes

stefannica added 2 commits April 14, 2025 17:30

Use the enable_pipeline_logs in the pipeline configuration

fc0b667

Merge branch 'feature/pipeline-run-logs' of github.com:zenml-io/zenml…

485bcac

… into feature/pipeline-run-logs

stefannica requested a review from schustmi April 14, 2025 15:34

schustmi approved these changes Apr 14, 2025

View reviewed changes

stefannica added 3 commits April 14, 2025 20:29

Fix deadlock bug and remaining unit tests

0b2ee2e

Merge branch 'develop' into feature/pipeline-run-logs

25d4ec8

Remove redundant Kubernetes orchestrator logs

ac3f09c

stefannica merged commit 0b96daf into develop Apr 15, 2025
132 of 135 checks passed

stefannica deleted the feature/pipeline-run-logs branch April 15, 2025 08:38

Store client-side pipeline run logs in the artifact store #3498

Store client-side pipeline run logs in the artifact store #3498

Uh oh!

Conversation

stefannica commented Apr 4, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Describe changes

Pre-requisites

Types of changes

Uh oh!

coderabbitai bot commented Apr 4, 2025

Review skipped

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

Documentation and Community

Uh oh!

Uh oh!

Uh oh!

Uh oh!

github-actions bot commented Apr 14, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

ZenML CLI Performance Comparison (Threshold: 1.0s, Timeout: 60s, Slow: 5s)

❌ Failed Commands on Current Branch (feature/pipeline-run-logs)

🚨 New Failures Introduced

Performance Comparison

Summary

Environment Info

Uh oh!

schustmi Apr 14, 2025

Choose a reason for hiding this comment

Uh oh!

stefannica Apr 14, 2025

Choose a reason for hiding this comment

Uh oh!

schustmi Apr 14, 2025

Choose a reason for hiding this comment

Uh oh!

stefannica Apr 14, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

github-actions bot commented Apr 14, 2025

Uh oh!

schustmi Apr 14, 2025

Choose a reason for hiding this comment

Uh oh!

stefannica Apr 14, 2025

Choose a reason for hiding this comment

Uh oh!

github-actions bot commented Apr 14, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Documentation Link Check Results

Uh oh!

Uh oh!

Uh oh!

stefannica commented Apr 4, 2025 •

edited

Loading

github-actions bot commented Apr 14, 2025 •

edited

Loading

github-actions bot commented Apr 14, 2025 •

edited

Loading