logfire implementation optional with env variable and measuaring logger and traces of handle messages (#10)

Author: jpizquierdo

.env.example

@@ -1 +1,3 @@
-TELEGRAM_TOKEN="fancyTOKENfromGODFATHER"
+TELEGRAM_TOKEN="fancyTOKENfromGODFATHER"
+LOGFIRE_ENABLED=true
+LOGFIRE_TOKEN="somepydanticToken"

README.md

@@ -75,6 +75,23 @@ If you prefer to use docker run sentence and build the image yourself follow the
     ```
 3. Open Telegram and send a message to your bot clicking in any button like a URL. The bot will respond with a QR code image.
 
+## Observability (Optional)
+
+This project includes optional observability features powered by [Pydantic Logfire](https://logfire.pydantic.dev/docs/). You can enable logging and tracing by configuring the following environment variables in your `.env` file:
+
+```env
+LOGFIRE_ENABLED=true
+LOGFIRE_TOKEN="your_logfire_token"
+```
+
+### How to Enable Observability
+1. Set `LOGFIRE_ENABLED` to `true` in your `.env` file.
+2. Provide your Logfire token in the `LOGFIRE_TOKEN` variable.
+
+When enabled, the bot will log events and traces to Logfire, providing insights into its runtime behavior and performance.
+
+> **Note:** Observability is disabled by default. If `LOGFIRE_ENABLED` is set to `false` or the `LOGFIRE_TOKEN` is not provided, the bot will use a no-op logger as a fallback.
+
 ## Contributing
 
 Contributions are welcome! Please open an issue or submit a pull request.

app/app.py

@@ -13,7 +13,7 @@
     ContextTypes,
     CallbackQueryHandler,
 )
-from app.core.config import settings, logger
+from app.core.config import settings, logger, logfire
 from app.core.models import (
     UserState,
 )
@@ -64,7 +64,8 @@ async def handle_message(update: Update, context: ContextTypes.DEFAULT_TYPE) ->
 
     # Call the appropriate handler or fallback
     handler = state_handlers.get(user_state, handle_invalid_state)
-    await handler(update, context)
+    with logfire.span(str(handler.__name__)):
+        await handler(update, context)
 
 
 # Handle Button Callbacks

app/core/config.py

@@ -4,11 +4,39 @@
 
 class AppSettings(BaseSettings):
     TELEGRAM_TOKEN: str = ""
+    LOGFIRE_ENABLED: bool = False
+    LOGFIRE_TOKEN: str = ""
 
 
 logging.basicConfig(
     format="%(asctime)s - %(levelname)s - %(message)s", level=logging.INFO
 )
 
+
+def logfire_init():  # pragma: no cover
+    # Check if Logfire is enabled in settings
+    if settings.LOGFIRE_ENABLED:
+        import logfire
+
+        logfire.configure(token=settings.LOGFIRE_TOKEN)
+        logger.addHandler(logfire.LogfireLoggingHandler())
+        logger.info("🪵🔥 Logging to Logfire enabled")
+    else:
+        logger.info("🪵🔥 Logging to Logfire disabled")
+        # Define a no-op context manager as fallback
+        from contextlib import contextmanager
+
+        @contextmanager
+        def noop_span(*args, **kwargs):
+            yield
+
+        class DummyLogfire:
+            span = noop_span
+
+        logfire = DummyLogfire()
+    return logfire
+
+
 logger = logging.getLogger(__name__)
 settings = AppSettings()
+logfire = logfire_init()

app/functions/text_qr.py

@@ -1,13 +1,15 @@
 from telegram import Update
 from telegram.ext import ContextTypes
-from pydantic import ValidationError
 from app.functions.shared import command_options
 from app.qrcodegen import generate_text_qr
 
-async def text_qr_handle_text_state(update: Update, context: ContextTypes.DEFAULT_TYPE) -> None:
+
+async def text_qr_handle_text_state(
+    update: Update, context: ContextTypes.DEFAULT_TYPE
+) -> None:
     qr_code = await generate_text_qr(text=update.message.text)
     # Send QR code image
     await update.message.reply_photo(photo=qr_code, caption="Here is your QR code!")
     # Clear user data to prevent unwanted behavior
     context.user_data.clear()
-    await command_options(update, context)
+    await command_options(update, context)

app/functions/url_qr.py

@@ -5,7 +5,10 @@
 from app.functions.shared import command_options
 from app.qrcodegen import generate_url_qr
 
-async def url_qr_handle_url_state(update: Update, context: ContextTypes.DEFAULT_TYPE) -> None:
+
+async def url_qr_handle_url_state(
+    update: Update, context: ContextTypes.DEFAULT_TYPE
+) -> None:
     try:
         qr_code = await generate_url_qr(URLQR(url=update.message.text.strip()))
         # Send QR code image
@@ -16,4 +19,4 @@ async def url_qr_handle_url_state(update: Update, context: ContextTypes.DEFAULT_
     except ValidationError:
         await update.message.reply_text(
             "❌ Invalid URL. Please send a valid URL starting with 'http://' or 'https://'."
-        )
+        )

app/functions/vcard_qr.py

@@ -11,7 +11,9 @@
 )
 
 
-async def vcard_qr_handle_name_state(update: Update, context: ContextTypes.DEFAULT_TYPE) -> None:
+async def vcard_qr_handle_name_state(
+    update: Update, context: ContextTypes.DEFAULT_TYPE
+) -> None:
     context.user_data["name"] = update.message.text
     context.user_data["state"] = UserState.VCARD_AWAITING_SURNAME
     await update.message.reply_text("Please send the surname:")

app/functions/wifi_qr.py

@@ -1,11 +1,14 @@
 from telegram import Update
 from telegram.ext import ContextTypes
 from pydantic import ValidationError
-from app.core.models import WifiQR,WiFiSSIDModel,UserState
+from app.core.models import WifiQR, WiFiSSIDModel, UserState
 from app.functions.shared import command_options
 from app.qrcodegen import generate_wifi_qr
 
-async def wifi_qr_handle_ssid_state(update: Update, context: ContextTypes.DEFAULT_TYPE) -> None:
+
+async def wifi_qr_handle_ssid_state(
+    update: Update, context: ContextTypes.DEFAULT_TYPE
+) -> None:
     try:
         wifi = WiFiSSIDModel(ssid=update.message.text)  # Validation using Pydantic
         context.user_data["ssid"] = wifi.ssid
@@ -32,4 +35,4 @@ async def wifi_qr_handle_password_state(
     except ValidationError:
         await update.message.reply_text(
             "❌ Invalid SSID or Password. Please send a valid SSID (1-32 characters) and a Valid Password between 8 and 63 characters."
-        )
+        )

requirements.txt

@@ -1,4 +1,5 @@
 python-telegram-bot==22.0
 qrcode[pil]==8.0
 pydantic-settings==2.8.1
-pydantic[email]==2.11.1
+pydantic[email]==2.11.1
+logfire==3.12.0