apache/airflow

Activate Apprise Persistent Storage for apache-airflow-providers-apprise

Open

#51,102 opened on May 27, 2025

View on GitHub
 (4 comments) (0 reactions) (0 assignees)Python (44,809 stars) (16,781 forks)batch import
area:providersgood first issuekind:featureprovider:apprise

Description

Description

My team is using Apprise to send notifications to Matrix from Airflow DAGs. We are using the apache-airflow-providers-apprise package (source code), which in our case uses Apprise version 1.9.3.

When sending notifications this way we are quickly running into the login rate limit of our Matrix server. When sending these notifications via the Apprise CLI, this is not an issue, apparently thanks to the Persistent Storage feature which caches the login data and avoids frequent re-logins.

Could Apprise's Persistent Storage be activated for the apache-airflow-providers-apprise package? I have requested and obtained hints for implementing this from the Apprise developer:

It looks like this issue is in the AppriseHook() here

apprise_obj = apprise.Apprise()

Adjustment would need to be:

# Prepare a location the persistent storage can write its cached content to.
# By setting this path, this immediately assumes you wish to operate the
# persistent storage in the operational 'auto' mode
asset = apprise.AppriseAsset(storage_path="/path/to/save/data")

# alternatively...
asset = apprise.AppriseAsset(
    # Set our storage path directory (minimum requirement to enable it)
    storage_path="/path/to/save/data",

    # Set the mode... the options are:
    # 1. PersistentStoreMode.MEMORY
    #       - disable persistent storage from writing to disk (default)
    # 2. PersistentStoreMode.AUTO
    #       - write to disk on demand
    # 3. PersistentStoreMode.FLUSH
    #       - write to disk always and often
    storage_mode=apprise.PersistentStoreMode.FLUSH
)

# Now that we've got our asset
apprise_obj = apprise.Apprise(asset=asset)

Use case/motivation

No response

Related issues

No response

Are you willing to submit a PR?

  • Yes I am willing to submit a PR!

Code of Conduct

Contributor guide

Tech stack
python
Domain
backend
Issue type
feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
mostly clear
Prerequisites
PythonAirflow hooks
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70
Research direction
The change needs to be made in the `AppriseHook` class located at `providers/apprise/src/airflow/providers/apprise/hooks/apprise.py`. The hook currently creates an `apprise.Apprise()` object without persistent storage. To enable caching, an `apprise.AppriseAsset` with a `storage path` (e.g., a temporary directory or a configurable path) should be created and passed to the `Apprise` constructor. The issue includes code snippets from the Apprise developer explaining the API. The exact directory path must be chosen (could be a temporary directory or a configurable setting). After making the change, testing with a Matrix server to confirm rate limiting is avoided would be appropriate. No linked PRs exist yet, and the issue is open for contribution.
Activate Apprise Persistent Storage for apache-airflow-providers-apprise · apache/airflow#51102 | Good First Issue