David Snelling
d2ddb9199e
Add full support for tracking and analyzing data by service in multi-tenant deployments. ## Features Added - **Service Statistics Tracking**: Track nouns, verbs, and metadata counts per service - **Service Activity Monitoring**: Track first/last activity timestamps and operation counts - **New API Methods**: - `listServices()`: List all services with their statistics and status - `getServiceStatistics(service)`: Get detailed stats for a specific service - Enhanced `getStatistics()` with service filtering and breakdown - **Service Filtering**: Filter search results and queries by service - **Storage Enhancements**: BaseStorageAdapter tracks service activity with timestamps - **Type Definitions**: Added ServiceStatistics interface and extended StatisticsData ## Implementation Details - Services automatically tracked via defaultService config or per-operation override - Service status detection (active/inactive/read-only) based on activity - Memory-efficient tracking at statistics level, not per noun/verb - Backward compatible - existing data tracked under 'default' service ## Documentation - Comprehensive guide in docs/guides/per-service-statistics.md - Examples for multi-tenant apps, health monitoring, and auditing - API reference and migration guide included ## Testing - Full test suite in tests/service-statistics.test.ts - Coverage of all new methods and filtering capabilities This enables better observability, debugging, and management of multi-service Brainy deployments, addressing the need to track individual service performance when multiple services share storage.
122 lines
No EOL
6.9 KiB
Markdown
122 lines
No EOL
6.9 KiB
Markdown
# Brainy Documentation
|
|
|
|
Welcome to the comprehensive documentation for Brainy - the intelligent vector graph database with zero-configuration setup and production-scale performance.
|
|
|
|
## 📚 Documentation Structure
|
|
|
|
### 🚀 [Getting Started](getting-started/)
|
|
Quick setup guides and first steps with Brainy.
|
|
|
|
- **[Quick Start Guide](getting-started/quick-start.md)** - Get up and running in minutes
|
|
- **[Installation Guide](getting-started/installation.md)** - Installation options and requirements
|
|
- **[Environment Setup](getting-started/environment-setup.md)** - Configure your development environment
|
|
- **[First Steps](getting-started/first-steps.md)** - Your first Brainy application
|
|
|
|
### 📖 [User Guides](user-guides/)
|
|
Comprehensive guides for using Brainy features.
|
|
|
|
- **[Search and Metadata Guide](user-guides/SEARCH_AND_METADATA_GUIDE.md)** - Advanced search techniques
|
|
- **[Write-Only Mode](user-guides/WRITEONLY_MODE_IMPLEMENTATION.md)** - Optimized data ingestion
|
|
- **[Read-Only & Frozen Modes](guides/readonly-frozen-modes.md)** - Immutability control for production
|
|
- **[Per-Service Statistics](guides/per-service-statistics.md)** - Multi-service tracking and monitoring
|
|
- **[Cache Configuration](guides/cache-configuration.md)** - Memory and caching optimization
|
|
- **[JSON Document Search](guides/json-document-search.md)** - Searching within JSON documents
|
|
- **[HNSW Field Search](guides/hnsw-field-search.md)** - Field-specific vector search
|
|
- **[Model Management](guides/model-management.md)** - Managing AI models and embeddings
|
|
- **[Production Migration](guides/production-migration-guide.md)** - Moving to production
|
|
|
|
### ⚡ [Optimization Guides](optimization-guides/)
|
|
Performance optimization and scaling strategies.
|
|
|
|
- **[Large-Scale Optimizations](optimization-guides/large-scale-optimizations.md)** - Enterprise-grade performance
|
|
- **[Auto-Configuration System](optimization-guides/auto-configuration.md)** - Zero-config intelligence
|
|
- **[Semantic Partitioning](optimization-guides/semantic-partitioning.md)** - Intelligent data clustering
|
|
- **[Distributed Search](optimization-guides/distributed-search.md)** - Parallel processing
|
|
- **[Memory Optimization](optimization-guides/memory-optimization.md)** - Efficient memory usage
|
|
- **[Storage Optimization](optimization-guides/storage-optimization.md)** - S3 and storage strategies
|
|
- **[S3 Migration Guide](optimization-guides/s3-migration-guide.md)** - Migrating existing data with shared buckets
|
|
|
|
### 🔧 [API Reference](api-reference/)
|
|
Complete API documentation and examples.
|
|
|
|
- **[Core API](api-reference/core-api.md)** - Main BrainyData class methods
|
|
- **[Vector Operations](api-reference/vector-operations.md)** - Vector storage and search
|
|
- **[Graph Operations](api-reference/graph-operations.md)** - Noun and verb relationships
|
|
- **[Configuration API](api-reference/configuration.md)** - System configuration options
|
|
- **[Storage Adapters](api-reference/storage-adapters.md)** - Storage backend interfaces
|
|
- **[Augmentations API](api-reference/augmentations.md)** - Extension system
|
|
|
|
### 🛠️ [Development](development/)
|
|
Development, testing, and contribution guides.
|
|
|
|
- **[Developer Guide](development/DEVELOPERS.md)** - Setting up development environment
|
|
- **[Testing Guide](development/testing.md)** - Running and writing tests
|
|
- **[Documentation Standards](development/DOCUMENTATION_STANDARDS.md)** - Documentation conventions
|
|
- **[Publishing CLI](development/publishing-cli.md)** - CLI package publishing
|
|
- **[Expected Test Messages](development/EXPECTED_TEST_MESSAGES.md)** - Test output reference
|
|
|
|
### 🔬 [Technical Reference](technical/)
|
|
Deep technical documentation and implementation details.
|
|
|
|
- **[Technical Guides Overview](technical/TECHNICAL_GUIDES.md)** - Technical documentation index
|
|
- **[Architecture](technical/architecture.md)** - System architecture overview
|
|
- **[HNSW Implementation](technical/hnsw-implementation.md)** - Vector index details
|
|
- **[Threading](technical/THREADING.md)** - Multi-threading implementation
|
|
- **[Storage Systems](technical/storage-systems.md)** - Storage architecture
|
|
- **[Performance Analysis](technical/performance-analysis.md)** - Performance benchmarks
|
|
- **[Compatibility](technical/COMPATIBILITY.md)** - Platform compatibility matrix
|
|
|
|
### 💡 [Examples](examples/)
|
|
Code examples and tutorials.
|
|
|
|
- **[Basic Usage](examples/basic-usage.md)** - Simple examples to get started
|
|
- **[Advanced Patterns](examples/advanced-patterns.md)** - Complex use cases
|
|
- **[Integration Examples](examples/integrations.md)** - Third-party integrations
|
|
- **[Performance Examples](examples/performance.md)** - Optimization examples
|
|
|
|
### 🔍 [Troubleshooting](troubleshooting/)
|
|
Common issues and solutions.
|
|
|
|
- **[Common Issues](troubleshooting/common-issues.md)** - Frequently encountered problems
|
|
- **[Performance Issues](troubleshooting/performance.md)** - Performance troubleshooting
|
|
- **[Environment Issues](troubleshooting/environment.md)** - Platform-specific problems
|
|
- **[Error Messages](troubleshooting/error-messages.md)** - Error code reference
|
|
|
|
## 🗺️ Quick Navigation
|
|
|
|
### New to Brainy?
|
|
1. **[Installation Guide](getting-started/installation.md)** - Install Brainy
|
|
2. **[Quick Start Guide](getting-started/quick-start.md)** - Your first vector database
|
|
3. **[Basic Usage Examples](examples/basic-usage.md)** - Simple code examples
|
|
|
|
### Need Performance?
|
|
1. **[Large-Scale Optimizations](optimization-guides/large-scale-optimizations.md)** - Enterprise features
|
|
2. **[Auto-Configuration](optimization-guides/auto-configuration.md)** - Zero-config setup
|
|
3. **[Performance Examples](examples/performance.md)** - Optimization patterns
|
|
|
|
### Building Applications?
|
|
1. **[API Reference](api-reference/)** - Complete API documentation
|
|
2. **[User Guides](user-guides/)** - Feature documentation
|
|
3. **[Integration Examples](examples/integrations.md)** - Real-world usage
|
|
|
|
### Contributing?
|
|
1. **[Developer Guide](development/DEVELOPERS.md)** - Development setup
|
|
2. **[Documentation Standards](development/DOCUMENTATION_STANDARDS.md)** - Writing docs
|
|
3. **[Testing Guide](development/testing.md)** - Testing practices
|
|
|
|
## 🔄 Recently Updated
|
|
|
|
- **[S3 Migration Guide](optimization-guides/s3-migration-guide.md)** - NEW: Complete migration guide for shared S3 buckets
|
|
- **[Large-Scale Optimizations](optimization-guides/large-scale-optimizations.md)** - Complete rewrite with auto-configuration
|
|
- **[Quick Start Guide](getting-started/quick-start.md)** - Updated with zero-config setup
|
|
- **[API Reference](api-reference/)** - New auto-configuration APIs
|
|
|
|
## 📞 Getting Help
|
|
|
|
- **[GitHub Issues](https://github.com/soulcraft-research/brainy/issues)** - Bug reports and feature requests
|
|
- **[Discussions](https://github.com/soulcraft-research/brainy/discussions)** - Community support
|
|
- **[Examples](examples/)** - Code examples and tutorials
|
|
|
|
---
|
|
|
|
**📝 Note**: This documentation is automatically organized and regularly updated. All guides include practical examples and are tested with the latest version of Brainy. |