feat: add comprehensive per-service statistics tracking

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.
This commit is contained in:
David Snelling 2025-08-06 10:17:28 -07:00
parent e838327a22
commit d2ddb9199e
7 changed files with 1232 additions and 4 deletions

View file

@ -4177,6 +4177,154 @@ export class BrainyData<T = any> implements BrainyDataInterface<T> {
}
}
/**
* List all services that have written data to the database
* @returns Array of service statistics
*/
public async listServices(): Promise<import('./coreTypes.js').ServiceStatistics[]> {
await this.ensureInitialized()
try {
const stats = await this.storage!.getStatistics()
if (!stats) {
return []
}
// Get unique service names from all counters
const services = new Set<string>()
Object.keys(stats.nounCount).forEach(s => services.add(s))
Object.keys(stats.verbCount).forEach(s => services.add(s))
Object.keys(stats.metadataCount).forEach(s => services.add(s))
// Build service statistics for each service
const result: import('./coreTypes.js').ServiceStatistics[] = []
for (const service of services) {
const serviceStats: import('./coreTypes.js').ServiceStatistics = {
name: service,
totalNouns: stats.nounCount[service] || 0,
totalVerbs: stats.verbCount[service] || 0,
totalMetadata: stats.metadataCount[service] || 0
}
// Add activity timestamps if available
if (stats.serviceActivity && stats.serviceActivity[service]) {
const activity = stats.serviceActivity[service]
serviceStats.firstActivity = activity.firstActivity
serviceStats.lastActivity = activity.lastActivity
serviceStats.operations = {
adds: activity.totalOperations,
updates: 0,
deletes: 0
}
}
// Determine status based on recent activity
if (serviceStats.lastActivity) {
const lastActivityTime = new Date(serviceStats.lastActivity).getTime()
const now = Date.now()
const hourAgo = now - 3600000
if (lastActivityTime > hourAgo) {
serviceStats.status = 'active'
} else {
serviceStats.status = 'inactive'
}
} else {
serviceStats.status = 'inactive'
}
// Check if service is read-only (has no write operations)
if (serviceStats.totalNouns === 0 && serviceStats.totalVerbs === 0) {
serviceStats.status = 'read-only'
}
result.push(serviceStats)
}
// Sort by last activity (most recent first)
result.sort((a, b) => {
if (!a.lastActivity && !b.lastActivity) return 0
if (!a.lastActivity) return 1
if (!b.lastActivity) return -1
return new Date(b.lastActivity).getTime() - new Date(a.lastActivity).getTime()
})
return result
} catch (error) {
console.error('Failed to list services:', error)
throw new Error(`Failed to list services: ${error}`)
}
}
/**
* Get statistics for a specific service
* @param service The service name to get statistics for
* @returns Service statistics or null if service not found
*/
public async getServiceStatistics(
service: string
): Promise<import('./coreTypes.js').ServiceStatistics | null> {
await this.ensureInitialized()
try {
const stats = await this.storage!.getStatistics()
if (!stats) {
return null
}
// Check if service exists in any counter
const hasData =
(stats.nounCount[service] || 0) > 0 ||
(stats.verbCount[service] || 0) > 0 ||
(stats.metadataCount[service] || 0) > 0
if (!hasData && !stats.serviceActivity?.[service]) {
return null
}
const serviceStats: import('./coreTypes.js').ServiceStatistics = {
name: service,
totalNouns: stats.nounCount[service] || 0,
totalVerbs: stats.verbCount[service] || 0,
totalMetadata: stats.metadataCount[service] || 0
}
// Add activity timestamps if available
if (stats.serviceActivity && stats.serviceActivity[service]) {
const activity = stats.serviceActivity[service]
serviceStats.firstActivity = activity.firstActivity
serviceStats.lastActivity = activity.lastActivity
serviceStats.operations = {
adds: activity.totalOperations,
updates: 0,
deletes: 0
}
}
// Determine status
if (serviceStats.lastActivity) {
const lastActivityTime = new Date(serviceStats.lastActivity).getTime()
const now = Date.now()
const hourAgo = now - 3600000
serviceStats.status = lastActivityTime > hourAgo ? 'active' : 'inactive'
} else {
serviceStats.status = 'inactive'
}
// Check if service is read-only
if (serviceStats.totalNouns === 0 && serviceStats.totalVerbs === 0) {
serviceStats.status = 'read-only'
}
return serviceStats
} catch (error) {
console.error(`Failed to get statistics for service ${service}:`, error)
throw new Error(`Failed to get statistics for service ${service}: ${error}`)
}
}
/**
* Check if the database is in read-only mode
* @returns True if the database is in read-only mode, false otherwise