Photo by Shahadat Rahman on Unsplash

Logging with Python and Supabase: A Practical Guide

In the world of software development, efficient logging is crucial for monitoring applications, debugging issues, and keeping track of system operations.

Python, with its vast ecosystem, offers various methods for implementing logging.

However, integrating it with a cloud-based database like Supabase opens up new possibilities for real-time logging and monitoring. In this article, we’ll explore a unique approach to script logging using Python and Supabase.

Understanding the Basics:

Before diving into the specifics, it’s essential to understand what logging entails. Logging is the process of recording information about the operations of a program. This information can be used to debug errors, track the flow of the program, or monitor its performance.

Supabase, on the other hand, is an open-source Firebase alternative that provides a suite of tools including a PostgreSQL database, authentication, real-time subscriptions, and more. By leveraging Supabase for logging, we can store log data in a structured format and access it in real-time, which is incredibly beneficial for web applications.

Setting Up the Environment:

Our journey begins with setting up the Python environment. We’ll need a few libraries: logging for creating logs, supabase for interacting with the Supabase database, and python-dotenv for managing environment variables.

pip install python-dotenv supabase

Ensure you have a .env file with your Supabase credentials:

SUPABASE_URL=your_supabase_url
SUPABASE_KEY=your_supabase_key

Creating the Supabase Logging Handler:

The core of our solution is a custom logging handler in Python. This handler, SupabaseLoggingHandler, overrides the emit method to send log data to Supabase:

import logging
from supabase import create_client
from datetime import datetime

class SupabaseLoggingHandler(logging.Handler):
    def emit(self, record):
        log_entry = self.format(record)
        log_data = {
            'level': record.levelname,
            'message': log_entry,
            'timestamp': datetime.utcnow().isoformat()
        }
        response = supabase.table('logs').insert(log_data).execute()
        if response.error:
            print(f"Error logging to Supabase: {response.error}")

Configuring the Logger:

Setting up the logger is straightforward:

logger = logging.getLogger('my_logger')
logger.setLevel(logging.INFO)
formatter = logging.Formatter('%(asctime)s - %(levelname)s - %(message)s')
supabase_handler = SupabaseLoggingHandler()
supabase_handler.setFormatter(formatter)
logger.addHandler(supabase_handler)

Creating the Logs Table in Supabase:

We must ensure our Supabase database has a logs table:

CREATE TABLE logs (
    id SERIAL PRIMARY KEY,
    level VARCHAR(50),
    message TEXT,
    timestamp TIMESTAMP WITH TIME ZONE DEFAULT CURRENT_TIMESTAMP
);

Using the Logger:

Now, logging is as simple as:

logger.info('This is a test log')

This log entry will be inserted into the logs table in Supabase, making it accessible for real-time monitoring.

Conclusion:

Integrating Python’s logging with Supabase offers a modern approach to logging, especially for applications that require real-time data monitoring and analysis. By leveraging the power of Supabase’s real-time database capabilities, developers can achieve more efficient and effective logging strategies.

This method demonstrates the flexibility of Python and the power of cloud-based databases in creating a robust logging mechanism that’s both efficient and scalable.

Where do I Work?

At WOST, we predominantly utilize Python for our automation processes. As one of the leading companies in digital signage in Portugal, we must stay ahead of the curve in technology and innovation. This logging method is just one of the many ways we leverage Python’s versatility and Supabase’s real-time capabilities to maintain our position at the forefront of the industry.

Our commitment to innovation and excellence in digital solutions makes us a trusted partner in the digital signage landscape. We understand the importance of reliable and efficient systems, and our approach to logging is a testament to our dedication to providing top-tier services and solutions.