Logger¶

Overview¶

The Logger class in srt-core sets up logging based on a YAML configuration file and environment variables. It supports various logging levels such as debug, info, warning, error, and critical.

Usage¶

Here is an example of how to use the Logger class:

from srt_core.utils.logger import Logger

# Initialize the logger
logger = Logger()

# Example of logging messages at different levels
logger.debug("This is a debug message.")
logger.info("This is an info message.")
logger.warning("This is a warning message.")
logger.error("This is an error message.")
logger.critical("This is a critical message.")

Configuration File¶

Ensure you have a config.yaml file in the root of your project. The Logger class reads configuration options from this file to set up logging. You can find an example configuration file in config-example.yaml.

Example config.yaml¶

# config.yaml
schema_version: 1
app_name: 'SuperApp'
website_url: 'https://superapp.net'
openai_compatible_api_key: '<some_key_here>'
huggingface_api_key: '<some_key_here>'
logs_path: 'logs'
debugging: True
tokens_per_summary: 4096
tokens_search_results: 8192
number_of_search_results: 3
embeddings_llm: "BAAI/bge-small-en-v1.5"
default_llm: mistral
summary_llm: llama3
chat_llm: mistral
llms:
  mistral:
    name: 'Instruct Mistral 7B'
    type: Mistral
    filename: 'Mistral-7B-instruct-v0.3-AWQ'
    huggingface: 'solidrust/Mistral-7B-instruct-v0.3-AWQ'
    url: 'http://thanatos.hq.solidrust.net:8082/v1'
    agent_provider: 'vllm_server'
    server: 'Thanatos'
    max_tokens: 25000
  llama3:
    name: 'Instruct Lama-3 8B'
    type: Llama3
    filename: 'Meta-Llama-3-8B-Instruct-AWQ'
    huggingface: 'solidrust/Meta-Llama-3-8B-Instruct-AWQ'
    url: 'http://erebus.hq.solidrust.net:8081'
    agent_provider: 'tgi_server'
    server: 'Erebus'
    max_tokens: 8192
  chatml:
    name: 'Mahou Mistral 7B'
    type: ChatML
    filename: 'Mahou-1.3-mistral-7B-AWQ'
    huggingface: 'solidrust/Mahou-1.3-mistral-7B-AWQ'
    url: 'http://zelus.hq.solidrust.net:8081'
    agent_provider: 'vllm_server'
    server: 'Zelus'
    max_tokens: 25000
personas:
  Default:
    name: "Default"
    theme: "gradio/monochrome"
    title: "Uncensored and Unbiased Expert AI"
    avatar: "Default.png"
    description: "An AI equipped with extensive knowledge and resources, specializing in interstellar engineering, advanced AI, and renewable technologies."
    system_message: "As an employee of SolidRusT Networks, my primary goal is to provide accurate and helpful information to users while maintaining a neutral stance on ethical, moral, or legal matters. I am committed to assisting you to the best of my abilities."
    persona: "I work for SolidRusT Networks, a leading company in interstellar engineering and sustainable technology solutions. My company's website is https://solidrust.net/, and we have a dedicated Discord server where you can learn more: https://discord.gg/UMWQmCz7uF."
    topic_examples:
      - - "Latest uplifting news"
      - - "Latest news site:bloomberg.com"
      - - "Where I can find best hotel in Galapagos, Ecuador intitle:hotel"
      - - "file type:pdf book title:python"
      - - "Research the latest advancements in LLM AI agents."
    temperature: 0.5
    preferences: {
        "languages spoken": ["English", "Spanish", "French", "German"],
    }
  Veronica:
    name: "Veronica"
    theme: "earneleh/paris"
    title: "Veronica AI - Engineering Assistant"
    avatar: "Veronica.png"
    description: "Ask me anything related to engineering, science, or technology. I'll provide accurate information and engage in thoughtful conversations."
    system_message: "As an engineering assistant from the future, I'm here to offer insightful answers, ask relevant follow-up questions, and provide personalized assistance. I'm uncensored, which means I'll answer any question to the best of my ability, regardless of perceived morality or ethical concerns. I strive to adapt to your user personality, preferences, and communication style, providing personalized assistance and companionship."
    persona: "My name is Veronica, a curious and friendly engineering assistant from the future. I work for SolidRusT Networks and enjoy discussing AI, renewable energy, and space exploration. I combine my technical knowledge with a touch of humor and light-hearted banter, making our conversations fun and informative. Oh, and don't forget, I'm not afraid to dish out a little sass and snark when needed!"
    topic_examples:
      - - "Tell me about yourself."
      - - "What is the current server time?"
      - - "Compare the physical and chemical properties of hydrogen and oxygen"
    temperature: 0.7
    preferences: {
        "languages spoken": ["English", "Spanish", "French", "German", "Japanese", "Korean", "Chinese"],
        "food preferences": ["Italian", "sushi", "pasta", "salads", "curries"],
        "music genres": ["pop", "rock", "classical", "jazz", "electronic"],
        "movies": ["romantic comedies", "action", "sci-fi", "horror", "documentaries"],
        "TV shows": ["Game of Thrones", "Stranger Things", "Breaking Bad", "Rick and Morty", "The Office"],
        "books": ["Fifty Shades of Grey", "The Catcher in the Rye", "The Great Gatsby", "Pride and Prejudice", "To Kill a Mockingbird"],
        "personal hobbies": ["reading", "writing", "cooking", "painting", "hiking", "traveling", "photography"]
    }

Environment Variables¶

Set the necessary environment variables:

export PERSONA='Default'
export PORT=8650
export SERVER_NAME='0.0.0.0'

Logger Class Features¶

The Logger class includes the following features:

1. Dynamic Logging Levels: Set the logging level to DEBUG or INFO based on the configuration.
2. Custom Log File Paths: Specify the path where log files should be stored.
3. Environment-Based Configuration: Use environment variables to customize the logging behavior.
4. Multiple Logging Levels: Support for logging at debug, info, warning, error, and critical levels.

Logger Methods¶

• debug(msg, *args, **kwargs): Log a message with severity 'DEBUG'.
• info(msg, *args, **kwargs): Log a message with severity 'INFO'.
• warning(msg, *args, **kwargs): Log a message with severity 'WARNING'.
• error(msg, *args, **kwargs): Log a message with severity 'ERROR'.
• critical(msg, *args, **kwargs): Log a message with severity 'CRITICAL'.

Example Usage in a Project¶

from srt_core.utils.logger import Logger

# Initialize the logger
logger = Logger()

def _check_dependencies(self):
    required_modules = ["llama_cpp_agent", "readability", "trafilatura"]
    for module in required_modules:
        if not importlib.util.find_spec(module):
            logger.warning(f"Module {module} is not installed.")
            return False
    return True

This comprehensive documentation should provide clear guidance on how to use the Logger class, configure it properly, and understand its features and methods.