Skip to content

📄 User Guide

This guide provides simple examples to demonstrate how to use HESTIA Logger:

Python during development

Use it in your script:

script_example.py
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
from hestia_logger import get_logger

# Get a logger instance
logger = get_logger("development")

# Log messages with different levels
logger.debug("This is a DEBUG log")
logger.info("Application started successfully")
logger.warning("Low disk space warning")
logger.error("Failed to connect to database")
logger.critical("System is down!")

Run the Script

poetry run python example.py

📌 Expected output in logs/app.log:

{"timestamp": "2025-03-14T13:57:41.Z", "level": "INFO", "service": "development", "environment": "local", "hostname": "ubuntu", "app_version": "1.0.0", "message": "Application started successfully"}
{"timestamp": "2025-03-14T13:57:41.Z", "level": "WARNING", "service": "development", "environment": "local", "hostname": "ubuntu", "app_version": "1.0.0", "message": "Low disk space warning"}
{"timestamp": "2025-03-14T13:57:41.Z", "level": "ERROR", "service": "development", "environment": "local", "hostname": "ubuntu", "app_version": "1.0.0", "message": "Failed to connect to database"}
{"timestamp": "2025-03-14T13:57:41.Z", "level": "CRITICAL", "service": "development", "environment": "local", "hostname": "ubuntu", "app_version": "1.0.0", "message": "System is down!"}
📌 Expected output in logs/development.log: 
2025-03-14 13:57:41,052 - development - INFO - Application started successfully
2025-03-14 13:57:41,052 - development - WARNING - Low disk space warning
2025-03-14 13:57:41,053 - development - ERROR - Failed to connect to database
2025-03-14 13:57:41,053 - development - CRITICAL - System is down!

HESTIA Logger provides a decorator to automatically log function execution.

example_decorator.py
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
from hestia_logger import get_logger
from hestia_logger.decorators import log_execution

# Initialize the logger
logger = get_logger("decorator")

@log_execution
def add_numbers(a, b):
     """Adds two numbers and returns the result."""
     return a + b

@log_execution
def simulate_task():
     """Simulates a task that takes time."""
     import time
     time.sleep(2)
     return "Task completed!"

# Call the functions
if __name__ == "__main__":
     result = add_numbers(5, 10)
     logger.info(f"Result: {result}")

     task_status = simulate_task()
     logger.info(f"Task Status: {task_status}")

📌 Expected log output:

{"timestamp": "2025-03-14T12:35:00.123Z", "level": "INFO", "service": "decorator", "message": "📌 Started: add_numbers()"}
{"timestamp": "2025-03-14T12:35:00.125Z", "level": "INFO", "service": "decorator", "message": "✅ Finished: add_numbers() in 0.0004 sec"}

HESTIA supports custom metadata to extend the default content of the logger instance:

example_metadata.py
1
2
3
4
5
6
from hestia_logger import get_logger

logger = get_logger("my_application", metadata={"user_id": "12345", 
                                                "request_id": "abcd-xyz"})

logger.info("User login successful")

📌 Expected output in logs/app.log:

{
     "timestamp": "2025-03-14T14:04:30.Z", 
     "level": "INFO", 
     "service": "my_application", 
     "environment": "local", 
     "hostname": "ubuntu", 
     "app_version": "1.0.0", 
     "user_id": "12345", 
     "request_id": "abcd-xyz", 
     "message": "User login successful"
}

📌 Expected output in logs/my_application.log:

2025-03-14 14:04:30,840 - my_application - INFO - User login successful

Running inside a container

Step 1. Create a simple script that logs messages inside a container.

app.py
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
from hestia_logger import get_logger
import time

# Get logger instance
logger = get_logger("container_test")

logger.info("🚀 Starting Hestia Logger inside Docker...")

for i in range(5):
    logger.debug(f"Iteration {i+1}: Debugging log message")
    logger.info(f"Iteration {i+1}: Info log message")
    time.sleep(1)  # Simulate work

logger.warning("⚠️ This is a warning log inside Docker.")
logger.error("❌ This is an error log inside Docker.")
logger.critical("🔥 Critical system failure inside Docker!")

logger.info("✅ Hestia Logger test completed inside Docker.")

Step 2. Create a Dockerfile:

Dockerfile
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
# Use official Python image
FROM python:3.10

# Set working directory
WORKDIR /app

# Copy project files
COPY . .

# Install Poetry
RUN pip install poetry

# Install dependencies
RUN poetry install 

# Set environment variables
ENV ENVIRONMENT="container"
ENV LOGS_DIR="/var/logs"
ENV LOG_LEVEL="INFO"
ENV ENABLE_INTERNAL_LOGGER="true"

# Create logs directory with proper permissions
RUN mkdir -p /var/logs && chmod -R 777 /var/logs

# Define entrypoint
CMD ["poetry", "run", "python", "app.py"]

Step 3. Build and run the Docker Container

Build the container:

docker build -t hestia-test .

Run the container:

docker run --rm -v $(pwd)/logs:/var/logs hestia-test

The -v $(pwd)/logs:/var/logs mounts the logs folder from the container to your local machine. This ensures logs persist outside the container.