ObservabilityPython

Overview

Maxim logging is a distributed tracing system that enables real-time log monitoring in production environments.

Generate Maxim API key

Installing SDK

Installing Maxim python SDK

pip install maxim-py

Initializing Maxim logger

from maxim import Maxim, Config
from maxim.logger import Logger, LoggerConfig
 
maxim = Maxim(Config(api_key="maxim-api-key"))
logger = Logger(LoggerConfig(id="log-repository-id"))

Maxim config fields

Field	Type	Description
`apiKey`	`str`	Maxim API key
`baseUrl`	`str`	Maxim API base URL (optional)
`debug`	`bool`	Enable debug mode (optional, default is `False`)
`raiseExceptions`	`bool`	Raise exceptions (optional, default is `False`)
`prompt_management`	`bool`	Enable prompt management (optional, default is `False`)
`cache`	`MaximCache`	Custom cache implementation (optional)

Logger config fields

Field	Type	Description
`id`	`str`	Log repository ID

Concepts

Getting started

Overview

Generate Maxim API key

Installing SDK

Initializing Maxim logger

Maxim config fields

Logger config fields

On this page