Skip to content

chore: disable workflow logs auto-cleanup by default#28136

Merged
QuantumGhost merged 1 commit intomainfrom
chore/disable-workflow-logs-auto-cleanup-by-default
Nov 12, 2025
Merged

chore: disable workflow logs auto-cleanup by default#28136
QuantumGhost merged 1 commit intomainfrom
chore/disable-workflow-logs-auto-cleanup-by-default

Conversation

@laipz8200
Copy link
Copy Markdown
Member

Summary

This PR changes the default value of WORKFLOW_LOG_CLEANUP_ENABLED from true to false across all configuration files.

Changes

  • api/configs/feature/init.py: Changed WorkflowLogConfig.WORKFLOW_LOG_CLEANUP_ENABLED default from True to False
  • api/.env.example: Changed WORKFLOW_LOG_CLEANUP_ENABLED from true to false

Note: docker/.env.example and docker/docker-compose.yaml already had the correct default value of false.

Motivation

Setting the default to false provides safer default behavior by:

  • Preventing unintended data loss for new installations
  • Giving users explicit control over when to enable log cleanup
  • Following the opt-in principle for data deletion features

Users who need automatic cleanup can enable it by setting WORKFLOW_LOG_CLEANUP_ENABLED=true in their configuration.

Fixes #28135

Set WORKFLOW_LOG_CLEANUP_ENABLED default value to false to provide
safer default behavior and prevent unintended data loss. Users can
still enable automatic cleanup by explicitly setting the configuration.

Fixes #28135
@dosubot dosubot bot added the size:XS This PR changes 0-9 lines, ignoring generated files. label Nov 12, 2025
@gemini-code-assist
Copy link
Copy Markdown
Contributor

Summary of Changes

Hello @laipz8200, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!

This pull request modifies the default behavior of workflow log cleanup, switching it from enabled to disabled. This change is a proactive measure to prevent accidental data loss for new installations and to empower users with explicit control over data retention. By making log cleanup an opt-in feature, the system prioritizes data preservation and user choice.

Highlights

  • Default Workflow Log Cleanup: The default value for WORKFLOW_LOG_CLEANUP_ENABLED has been changed from true to false in api/.env.example and api/configs/feature/__init__.py.
  • Enhanced Data Safety: This change prevents unintended data loss for new installations and gives users explicit control over enabling log cleanup, aligning with an opt-in principle for data deletion features.
Using Gemini Code Assist

The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.

Invoking Gemini

You can request assistance from Gemini at any point by creating a comment using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

Feature Command Description
Code Review /gemini review Performs a code review for the current pull request in its current state.
Pull Request Summary /gemini summary Provides a summary of the current pull request in its current state.
Comment @gemini-code-assist Responds in comments when explicitly tagged, both in pull request comments and review comments.
Help /gemini help Displays a list of available commands.

Customization

To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.

Limitations & Feedback

Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here.

You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.

Footnotes

  1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution.

Copy link
Copy Markdown
Contributor

@gemini-code-assist gemini-code-assist bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Code Review

This pull request changes the default behavior of workflow log cleanup by setting WORKFLOW_LOG_CLEANUP_ENABLED to false. This is a sensible and safe change, as it prevents accidental data loss for new installations and makes log cleanup an opt-in feature. The changes in api/.env.example and api/configs/feature/__init__.py are correct and align with the stated goal.

While reviewing the related code, I noticed that the Celery task clean_workflow_runlogs_precise in api/schedule/clean_workflow_runlogs_precise.py does not check the WORKFLOW_LOG_CLEANUP_ENABLED flag internally. While the check is likely performed by the scheduler, for added safety, you might consider adding a check at the beginning of the task itself in a future PR to prevent accidental execution if the task is triggered manually.

Copy link
Copy Markdown
Contributor

@QuantumGhost QuantumGhost left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM.

Thank you for your contribution!

@dosubot dosubot bot added the lgtm This PR has been approved by a maintainer label Nov 12, 2025
@QuantumGhost QuantumGhost merged commit fe6538b into main Nov 12, 2025
14 checks passed
@QuantumGhost QuantumGhost deleted the chore/disable-workflow-logs-auto-cleanup-by-default branch November 12, 2025 14:55
frf12 pushed a commit to oceanbase/dify-on-mysql that referenced this pull request Nov 13, 2025
* fix(api): Trace Hierarchy, Span Status, and Broken Workflow for Arize & Phoenix Integration (langgenius#27937)

Co-authored-by: crazywoola <100913391+crazywoola@users.noreply.github.com>

* chore: add type-check to pre-commit (langgenius#28005)

* fix document enable (langgenius#28081)

* chore: not SaaS version can query long log time range (langgenius#28109)

* When graph_engine worker run exception, keep the node_id for deep res… (langgenius#26205)

Co-authored-by: autofix-ci[bot] <114827586+autofix-ci[bot]@users.noreply.github.com>
Co-authored-by: -LAN- <laipz8200@outlook.com>

* fix document index test (langgenius#28113)

* chore: improve the user experience of not login into apps (langgenius#28120)

* feat(api): Introduce `WorkflowResumptionContext` for pause state management (langgenius#28122)

Certain metadata (including but not limited to `InvokeFrom`, `call_depth`, and `streaming`)  is required when resuming a paused workflow. However, these fields are not part of `GraphRuntimeState` and were not saved in the previous
 implementation of  `PauseStatePersistenceLayer`.

This commit addresses this limitation by introducing a `WorkflowResumptionContext` model that wraps both the `*GenerateEntity` and `GraphRuntimeState`. This approach provides:

- A structured container for all necessary resumption data
- Better separation of concerns between execution state and persistence
- Enhanced extensibility for future metadata additions
- Clearer naming that distinguishes from `GraphRuntimeState`

The `WorkflowResumptionContext` model makes extending the pause state easier while maintaining backward compatibility and proper version management for the entire execution state ecosystem.

Co-authored-by: autofix-ci[bot] <114827586+autofix-ci[bot]@users.noreply.github.com>

* add transform-datasource-credentials command online check (langgenius#28124)

Co-authored-by: autofix-ci[bot] <114827586+autofix-ci[bot]@users.noreply.github.com>
Co-authored-by: Garfield Dai <dai.hai@foxmail.com>

* feat: introduce trigger functionality (langgenius#27644)

Signed-off-by: lyzno1 <yuanyouhuilyz@gmail.com>
Co-authored-by: Stream <Stream_2@qq.com>
Co-authored-by: lyzno1 <92089059+lyzno1@users.noreply.github.com>
Co-authored-by: zhsama <torvalds@linux.do>
Co-authored-by: Harry <xh001x@hotmail.com>
Co-authored-by: lyzno1 <yuanyouhuilyz@gmail.com>
Co-authored-by: yessenia <yessenia.contact@gmail.com>
Co-authored-by: hjlarry <hjlarry@163.com>
Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
Co-authored-by: Copilot Autofix powered by AI <62310815+github-advanced-security[bot]@users.noreply.github.com>
Co-authored-by: autofix-ci[bot] <114827586+autofix-ci[bot]@users.noreply.github.com>
Co-authored-by: WTW0313 <twwu@dify.ai>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

* fix: determine cpu cores determination in baseedpyright-check script on macos  (langgenius#28058)

* fix: variable assigner can't assign float number (langgenius#28068)

* Add file type validation to paste upload (langgenius#28017)

* test: create some hooks and utils test script, modified clipboard test script (langgenius#27928)

* convert to TypeBase (langgenius#27935)

Co-authored-by: autofix-ci[bot] <114827586+autofix-ci[bot]@users.noreply.github.com>
Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

* chore: disable workflow logs auto-cleanup by default (langgenius#28136)

This PR changes the default value of `WORKFLOW_LOG_CLEANUP_ENABLED` from `true` to `false` across all configuration files.

## Motivation

Setting the default to `false` provides safer default behavior by:

- Preventing unintended data loss for new installations
- Giving users explicit control over when to enable log cleanup
- Following the opt-in principle for data deletion features

Users who need automatic cleanup can enable it by setting `WORKFLOW_LOG_CLEANUP_ENABLED=true` in their configuration.

* fix: simplify graph structure validation in WorkflowService (langgenius#28146)

Co-authored-by: autofix-ci[bot] <114827586+autofix-ci[bot]@users.noreply.github.com>
Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>

* fix: app's ai site text to speech api (langgenius#28091)

* refactor(web): reuse the same edit-custom-collection-modal component, and fix the pop up error (langgenius#28003)

* add doc (langgenius#28016)

Co-authored-by: autofix-ci[bot] <114827586+autofix-ci[bot]@users.noreply.github.com>
Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>

* fix: inconsistent behaviour of zoom in button and shortcut (langgenius#27944)

* consolve conficts

* fix

* fix

---------

Signed-off-by: lyzno1 <yuanyouhuilyz@gmail.com>
Co-authored-by: Ali Saleh <saleh.a@turing.com>
Co-authored-by: crazywoola <100913391+crazywoola@users.noreply.github.com>
Co-authored-by: lyzno1 <92089059+lyzno1@users.noreply.github.com>
Co-authored-by: Jyong <76649700+JohnJyong@users.noreply.github.com>
Co-authored-by: Joel <iamjoel007@gmail.com>
Co-authored-by: 湛露先生 <zhanluxianshen@163.com>
Co-authored-by: autofix-ci[bot] <114827586+autofix-ci[bot]@users.noreply.github.com>
Co-authored-by: -LAN- <laipz8200@outlook.com>
Co-authored-by: QuantumGhost <obelisk.reg+git@gmail.com>
Co-authored-by: Garfield Dai <dai.hai@foxmail.com>
Co-authored-by: Yeuoly <45712896+Yeuoly@users.noreply.github.com>
Co-authored-by: Stream <Stream_2@qq.com>
Co-authored-by: zhsama <torvalds@linux.do>
Co-authored-by: Harry <xh001x@hotmail.com>
Co-authored-by: lyzno1 <yuanyouhuilyz@gmail.com>
Co-authored-by: yessenia <yessenia.contact@gmail.com>
Co-authored-by: hjlarry <hjlarry@163.com>
Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
Co-authored-by: Copilot Autofix powered by AI <62310815+github-advanced-security[bot]@users.noreply.github.com>
Co-authored-by: WTW0313 <twwu@dify.ai>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Bowen Liang <liang.bowen.123@qq.com>
Co-authored-by: Gen Sato <52241300+halogen22@users.noreply.github.com>
Co-authored-by: Gritty_dev <101377478+codomposer@users.noreply.github.com>
Co-authored-by: Asuka Minato <i@asukaminato.eu.org>
Co-authored-by: mnasrautinno <m.nasr@dai.autinno.com>
Co-authored-by: yangzheli <43645580+yangzheli@users.noreply.github.com>
Xiu-Lan pushed a commit to AICT-Team/dify that referenced this pull request Nov 13, 2025
This PR changes the default value of `WORKFLOW_LOG_CLEANUP_ENABLED` from `true` to `false` across all configuration files.

## Motivation

Setting the default to `false` provides safer default behavior by:

- Preventing unintended data loss for new installations
- Giving users explicit control over when to enable log cleanup
- Following the opt-in principle for data deletion features

Users who need automatic cleanup can enable it by setting `WORKFLOW_LOG_CLEANUP_ENABLED=true` in their configuration.
CodingOnStar pushed a commit that referenced this pull request Nov 14, 2025
This PR changes the default value of `WORKFLOW_LOG_CLEANUP_ENABLED` from `true` to `false` across all configuration files.

## Motivation

Setting the default to `false` provides safer default behavior by:

- Preventing unintended data loss for new installations
- Giving users explicit control over when to enable log cleanup
- Following the opt-in principle for data deletion features

Users who need automatic cleanup can enable it by setting `WORKFLOW_LOG_CLEANUP_ENABLED=true` in their configuration.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

lgtm This PR has been approved by a maintainer size:XS This PR changes 0-9 lines, ignoring generated files.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[Chore/Refactor] Disable workflow logs auto-cleanup by default

2 participants