Mirador Core — Documentation

Welcome to the Mirador Core documentation. This documentation provides a comprehensive guide for using Mirador Core’s observability platform, with a focus on the four interconnected components: KPIs, Failures, Correlation, and RCA.

User Guide:

• KPI, Failures, Correlation & RCA User Guide
  • Table of Contents
  • Overview
  • Prerequisites & Setup
  • Configuration & Deployment
  • Component 1: KPI Management
  • Component 2: Failure Detection
  • Component 3: Correlation Analysis
  • Component 4: Root Cause Analysis (RCA)
  • Complete Workflows
  • API Reference
  • Troubleshooting
  • Summary

Configuration & Deployment:

• Configuration Guide
  • Configuration Sources
  • Configuration File
  • Core Configuration
  • Authentication Configuration
  • Data Source Configuration
  • Feature Flags
  • Metrics and Monitoring
  • Caching Configuration
  • Rate Limiting
  • KPI Management
  • AI and Analytics
  • Security Configuration
  • Performance Tuning
  • Integration Configuration
  • Development Configuration
  • Environment-Specific Examples
  • Configuration Validation
  • Hot Reloading
  • Secrets Management
  • Monitoring Configuration Changes
• Deployment Guide
  • Prerequisites
  • Quick Start with Helm
  • Configuration
  • Environment-Specific Deployments
  • Docker Compose (Local Development)
  • Database Setup
  • Monitoring and Observability
  • Backup and Recovery
  • Troubleshooting
  • Security Considerations
  • Performance Tuning
  • Upgrading
  • Support
• MariaDB Integration
  • Overview
  • Configuration
  • Database Schema
  • Data Source Discovery
  • KPI Synchronization
  • Health Checks
  • Error Handling
  • Database User Setup
  • Troubleshooting
  • Migration from config.yaml
  • Best Practices

Operations:

• Data Seeding
  • Overview
  • Usage
  • Seeded Data
  • Data Structure
  • Idempotent Operations
  • Integration
  • Development
  • Troubleshooting
• Mirador Core - Monitoring and Observability Guide
  • Table of Contents
  • Overview
  • Metrics Collection
  • Distributed Tracing
  • Alerting Rules
  • Configuration
  • Troubleshooting

Who this is for

• API Consumers: Developers integrating with Mirador Core’s REST APIs

• Platform Engineers: Teams deploying and configuring Mirador Core

• Observability Engineers: Users implementing KPI-driven monitoring and RCA

• Integration Engineers: Building observability solutions with Mirador Core

Quick Links

• Complete User Guide: Comprehensive guide covering KPIs, Failures, Correlation, and RCA

• API Documentation: Complete REST API documentation

• Configuration Guide: All configuration options including MariaDB

• Deployment Guide: Kubernetes, Docker, and production deployment

• MariaDB Integration: Tenant data sources and KPI sync

• Troubleshooting: Common issues and solutions

---