alarmer
Alarmer is a tool focus on error reporting for your application.
Installation
pip install alarmer
Usage
It's simple to integrate alarmer in your application, just call Alarmer.init on startup of your application.
import os
from alarmer import Alarmer
from alarmer.provider.feishu import FeiShuProvider
def main():
Alarmer.init(providers=[FeiShuProvider(webhook_url=os.getenv("FEI_SHU_WEBHOOK_URL"))])
raise Exception("test")
if __name__ == "__main__":
main()
Intercept Error Logging
If you want to intercept the logging, you can use LoggingHandler.
import logging
import os
from alarmer import Alarmer
from alarmer.log import LoggingHandler
from alarmer.provider.feishu import FeiShuProvider
def main():
Alarmer.init(providers=[FeiShuProvider(webhook_url=os.getenv("FEI_SHU_WEBHOOK_URL"))])
logging.basicConfig(
level=logging.INFO,
)
logger = logging.getLogger()
logger.addHandler(LoggingHandler(level=logging.ERROR)) # only error and above should be send
logging.error("test logging")
if __name__ == "__main__":
main()
Now when you run the script, you will receive the errors in your provider.
Provider
You can set number of providers for error reporting. All kinds of providers can be found in providers.
Custom Provider
You can write your own custom provider by inheriting the Provider class.
import smtplib
from typing import List
from alarmer.provider import Provider
class CustomProvider(Provider):
def send(self, message: str):
# Send to your custom provider here
pass
In addition to this, you can just write a callable function which takes message argument.
import requests
def my_provider(message: str):
return requests.get('http://xxxx', params={'text': message})
Then add it to Alarmer.init.
Alarmer.init(providers=[CustomProvider(), my_provider])
Throttling
Throttling is used to throttling error messages if there are too many errors.
from alarmer import Alarmer
from alarmer.throttling import Throttling
Alarmer.init(global_throttling=Throttling(), providers=[...])
Custom Throttling
You can write your own throttling by inheriting the Throttling class.
import typing
from alarmer.throttling import Throttling
if typing.TYPE_CHECKING:
from alarmer.provider import Provider
class MyThrottling(Throttling):
def __call__(self, provider: "Provider", message: str) -> bool:
# check whether the error message should be send
return True
License
This project is licensed under the Apache-2.0 License.
32.9k Dec 31, 2022
1 Feb 15, 2022
2 Sep 15, 2022
2k Dec 30, 2022
1k Dec 29, 2022
745 Dec 28, 2022
6 Nov 18, 2022
26 Dec 28, 2022
1.1k Dec 31, 2022
67 Dec 1, 2022
368 Jan 4, 2023
2 Oct 3, 2021
2 Nov 21, 2021
1 Jan 2, 2022
58 Nov 7, 2022
15 Nov 4, 2022
227 Jan 2, 2023
44 Dec 20, 2022
3k Jan 9, 2023
45 Dec 19, 2022
1 Jan 19, 2022
966 Dec 29, 2022
212 Jan 7, 2023
33 Nov 27, 2022
132 Dec 29, 2022
2 Dec 2, 2022
26 Dec 26, 2022
33k Jan 4, 2023