Skip to main content

AI Log Inspector Agent Documentation

Welcome to the complete documentation for the AI Log Inspector Agent - a production-ready PHP package for intelligent log analysis powered by AI.

🚀 Quick Links​

📚 Documentation Sections​

Introduction​

Get familiar with the package and its capabilities.

Getting Started​

Install and configure your first log inspector.

Core Concepts​

Understand the architecture and design principles.

Tools​

Deep dive into available tools and how to use them.

Usage & Features​

Learn how to use the package effectively.

Advanced Topics​

Production deployment and optimization.

API Reference​

Complete API documentation.

Examples​

Real-world code examples and patterns.

🎯 Common Tasks​

How do I...​

...install the package?
→ See Installation

...create my first agent?
→ Follow the Quick Start guide

...search logs semantically?
→ Use LogSearchTool

...trace a request across services?
→ Use RequestContextTool

...use conversations instead of single questions?
→ Check out the Chat Interface

...switch AI providers (OpenAI/Anthropic/Ollama)?
→ Read Multi-Platform Usage

...deploy to production?
→ Follow Best Practices

...create custom tools?
→ See Custom Tools Guide

💡 Key Features​

🧠 Intelligent Analysis​

Ask natural language questions and get AI-powered answers with evidence citations.

$agent->ask('Why did the payment fail for order #12345?');
// → AI explains root cause with supporting log entries

💬 Conversational Debugging​

Multi-turn conversations that remember context.

$chat->ask('What errors occurred?');
$chat->followUp('Were there database issues?');
$chat->ask('What was the root cause?');

🔍 Semantic Search​

Understands meaning, not just keywords.

// Finds "transaction timeout", "payment gateway error", etc.
$agent->ask('payment problems');

🛠️ Extensible Tools​

Build your own tools for custom analysis.

$agent = new LogInspectorAgent($platform, [
    $logSearchTool,
    $requestContextTool,
    $customSecurityTool // Your custom tool
]);

🎯 Multi-Platform​

Works with OpenAI, Anthropic, Ollama, and custom platforms.

// Switch providers without changing your code
$agent = LogInspectorAgentFactory::createWithOpenAI($apiKey);
// OR
$agent = LogInspectorAgentFactory::createWithAnthropic($apiKey);
// OR
$agent = LogInspectorAgentFactory::createWithOllama('llama3.2:1b');

🧪 Production Ready​

✅ 13/13 tests passing with real AI integrations
✅ 104+ assertions across unit, functional, and integration tests
✅ Real log examples from Laravel, Kubernetes, microservices
✅ PHP 8.4+ compatible with modern type system
✅ Symfony AI powered using battle-tested components

📖 Learn by Example​

Simple Query​

require 'vendor/autoload.php';

$agent = LogInspectorAgentFactory::createWithOpenAI($_ENV['OPENAI_API_KEY']);

// Load logs
foreach ($logs as $log) {
    $agent->indexLog(TextDocumentFactory::createFromString($log));
}

// Ask questions
$result = $agent->ask('Show me all payment errors');
echo $result->getContent();

Conversational Investigation​

$chat = LogInspectorChatFactory::createWithOpenAI($_ENV['OPENAI_API_KEY']);
$chat->startInvestigation('Payment incident - Jan 29');

echo $chat->ask('What payment errors occurred?')->getContent();
echo $chat->followUp('What was the root cause?')->getContent();
echo $chat->summarize()->getContent();

Request Tracing​

$agent = new LogInspectorAgent($platform, [
    new LogSearchTool($store, $retriever, $platform),
    new RequestContextTool($store, $retriever, $platform)
]);

// Trace complete request lifecycle
$result = $agent->ask('Debug request req_12345');
// → Shows all logs across all services for that request

🤝 Contributing​

This is an open-source project. Contributions are welcome!

📝 License​

MIT License - see LICENSE file for details.

🆘 Need Help?​

Ready to get started? → Begin with the Quick Start Guide

Want to understand the architecture? → Read the Architecture Overview

Looking for examples? → Browse the Examples section