Add Sentry support and logging controls. Bump version to 0.3.0.

.env.example

@@ -1,6 +1,11 @@
+RFTB_ENVIRONMENT="development"
 RFTB_PRAW_CLIENT_ID=""
 RFTB_PRAW_CLIENT_SECRET=""
 RFTB_PRAW_USERNAME=""
 RFTB_PRAW_PASSWORD=""
 RFTB_SUBREDDIT=""
 RFTB_DB_CONNECTION_STRING="sqlite+aiosqlite:///:memory:"
+RFTB_LOG_LEVEL="debug"
+RFTB_SENTRY_DSN=""
+RFTB_SENTRY_TRACE_RATE="0.00001"
+RFTB_SENTRY_PROFILE_RATE="0.00001"

README.md

@@ -27,6 +27,12 @@ $ export RFTB_PRAW_CLIENT_SECRET="your_client_secret_here"
 $ export RFTB_PRAW_USERNAME="your_reddit_username_here"
 $ export RFTB_PRAW_PASSWORD="your_reddit_password_here"
 $ export RFTB_SUBREDDIT="the_name_of_a_subreddit_here"
+$ export RFTB_DB_CONNECTION_STRING="sqlite+aiosqlite:///:memory:" # Optional.  It keeps track of what actions have been done so they don't accidently get repeated.
+$ export RFTB_LOG_LEVEL="info" # Optional.  Can be debug, info, warning, error, or critical.
+$ export RFTB_SENTRY_DSN="your_sentry_dsn" # Optional.  Enables Sentry logging
+$ export RFTB_SENTRY_TRACE_RATE="0.1" # Optional.
+$ export RFTB_SENTRY_PROFILE_RATE="0.1" # Optional.
+$ export RFTB_ENVIRONMENT="development" # Optional.  This is for Sentry, mostly, currently
 ```
 
 or, put the secrets in a file called .env (see .env.example)

pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "rflying_tower_bot"
-version = "0.2.1"
+version = "0.3.0"
 description = ""
 authors = ["Kris Knigga <[email protected]>"]
 
@@ -12,6 +12,7 @@ aiohttp = "^3.9.5"
 pydantic = "^2.8.2"
 python-dotenv = "^1.0.1"
 sqlalchemy = {extras = ["asyncio"], version = "^2.0.31"}
+sentry-sdk = "^2.10.0"
 
 [tool.poetry.group.dev.dependencies]
 pre-commit = "^3.7.1"

requirements.txt

@@ -20,6 +20,7 @@ python-dotenv==1.0.1 ; python_version >= "3.12" and python_version < "4.0"
 requests==2.32.3 ; python_version >= "3.12" and python_version < "4.0"
 ruamel-yaml-clib==0.2.8 ; platform_python_implementation == "CPython" and python_version < "3.13" and python_version >= "3.12"
 ruamel-yaml==0.18.6 ; python_version >= "3.12" and python_version < "4.0"
+sentry-sdk==2.10.0 ; python_version >= "3.12" and python_version < "4.0"
 sqlalchemy[asyncio]==2.0.31 ; python_version >= "3.12" and python_version < "4.0"
 typing-extensions==4.12.2 ; python_version >= "3.12" and python_version < "4.0"
 update-checker==0.18.0 ; python_version >= "3.12" and python_version < "4.0"

rflying_tower_bot/__init__.py

@@ -1,3 +1,3 @@
 """rflying_tower_bot package."""
 
-__version__ = "0.2.1"
+__version__ = "0.3.0"

rflying_tower_bot/__main__.py

@@ -9,10 +9,6 @@
 from rflying_tower_bot.modlog import ModLog
 from rflying_tower_bot.post_stream import PostStream
 
-logging.basicConfig(
-    format="%(asctime)s - %(name)s - %(levelname)s - %(message)s", level=logging.INFO
-)
-
 log: logging.Logger = logging.getLogger(f"{__name__}")
 
 praw_config = PRAWConfig()

rflying_tower_bot/config.py

@@ -3,6 +3,7 @@
 import logging
 import os
 
+import sentry_sdk
 from asyncpraw import Reddit
 from asyncpraw.models import Subreddit
 from asyncpraw.models.reddit.removal_reasons import RemovalReason
@@ -22,6 +23,32 @@
 
 load_dotenv()
 
+log_level_map: dict[str, int] = {
+    "debug": logging.DEBUG,
+    "info": logging.INFO,
+    "warning": logging.WARNING,
+    "error": logging.ERROR,
+    "critical": logging.CRITICAL,
+}
+
+log_level = os.getenv("RFTB_LOG_LEVEL", "info")
+logging.basicConfig(
+    format="%(asctime)s - %(name)s - %(levelname)s - %(message)s",
+    level=log_level_map.get(log_level, logging.INFO),
+)
+
+sentry_dsn = os.getenv("RFTB_SENTRY_DSN")
+if sentry_dsn is not None:
+    sentry_sdk.init(
+        dsn=sentry_dsn,
+        release=bot_version,
+        environment=os.getenv("RFTB_ENVIRONMENT", "development"),
+        debug=log_level == "debug",
+        enable_tracing=True,
+        traces_sample_rate=float(os.getenv("RFTB_SENTRY_TRACE_RATE", 0.00001)),
+        profiles_sample_rate=float(os.getenv("RFTB_SENTRY_PROFILE_RATE", 0.00001)),
+    )
+
 
 class BotConfig:
     """General configuration for the bot, as well as a shared asyncpraw.Reddit instance."""

tests/test_rflying_tower_bot.py

@@ -5,4 +5,4 @@
 
 def test_version():
     """Test the version of the rflying_tower_bot package."""
-    assert __version__ == "0.2.0"
+    assert __version__ == "0.3.0"