error-reporter 0.0.0

A lightweight fastapi library for reporting application errors and exceptions to external application.

Error Reporter for Fast API

A python library for Fast API that sends error reports to messaging platforms like Slack.

When an error other than an HttpException occurs on the server. it is reported according to the configured settings.

Installation

pip install error-reporter

Usage

configuration

from error_reporter import init_error_reporter, SlackOptions

from fastapi import FastAPI

app = FastAPI()

init_error_reporter(
    app=app,
    options=SlackOptions(
        webhook_url='',
        server_name='',
    )
)

slack, discord, google-chat

Option	Type	Required	Default	Description
type	'slack', 'discord', 'google-chat'	✅	-	type of messenger
webhookUrl	string	✅	-	Slack webhook URL to send error logs
serverName	string	❌	unknown server	Identifier for the server

github

Option	Type	Required	Default	Description
type	'github'	✅	-	type of messenger
githubToken	string	✅	-	GitHub personal access token
owner	string	✅	-	Repository owner (user or organization)
repository	string	✅	-	Repository name where issues will be created
serverName	string	❌	unknown server	Identifier for the server

❗Warning

If an invalid or unauthorized token is provided, the application will fail to start.

The server will also fail to start if any of the required GitHub configuration values are missing or incorrect, including:

Example

slack

discord

google-chat

github

Contact

• Email: [e-mail]