All files / src/lib/observability slo-history.ts

0% Statements 0/362
100% Branches 0/0
0% Functions 0/1
0% Lines 0/362

Press n or j to go to the next uncovered block, b, p or k for the previous block.

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     
/**
 * SLO Historical Tracking
 *
 * Provides functions for storing and retrieving SLO historical data,
 * calculating trends, and generating statistics over time.
 */

import { prisma } from '@/lib/prisma';
import { calculateAllSLOs, sloDefinitions, type SLOResult } from './slo';
import { logger } from './logger';

/**
 * Historical snapshot data
 */
export interface SLOSnapshot {
  id: string;
  sloName: string;
  category: string;
  current: number;
  target: number;
  budgetConsumed: number;
  status: string;
  window: string;
  periodStart: Date;
  periodEnd: Date;
  sampleSize: number;
  createdAt: Date;
}

/**
 * Trend data point for charting
 */
export interface SLOTrendPoint {
  timestamp: string;
  value: number;
  status: string;
}

/**
 * Summary statistics for a time period
 */
export interface SLOHistorySummary {
  avgValue: number;
  minValue: number;
  maxValue: number;
  breachCount: number;
  uptimePercentage: number;
  dataPointCount: number;
}

/**
 * History query result
 */
export interface SLOHistoryResult {
  sloName: string;
  target: number;
  category: string;
  snapshots: SLOTrendPoint[];
  summary: SLOHistorySummary;
}

/**
 * Create snapshots for all defined SLOs
 *
 * Called by cron job to persist current SLO state
 */
export async function createSLOSnapshots(): Promise<number> {
  const now = new Date();
  const results = await calculateAllSLOs();
  let created = 0;

  for (const result of results) {
    const slo = sloDefinitions.find((s) => s.name === result.name);
    if (!slo) continue;

    // Calculate period based on window
    const periodEnd = now;
    const periodStart = new Date(now.getTime() - getWindowMs(slo.window));

    // Get sample size (count of metrics in window)
    const sampleSize = await getSampleSize(slo.category, periodStart);

    try {
      await prisma.sloSnapshot.create({
        data: {
          sloName: result.name,
          category: result.category,
          current: result.current,
          target: result.target,
          budgetConsumed: result.budgetConsumed,
          status: result.status,
          window: result.window,
          periodStart,
          periodEnd,
          sampleSize,
        },
      });
      created++;
    } catch (error) {
      logger.error('Failed to create SLO snapshot', error as Error, {
        sloName: result.name,
      });
    }
  }

  logger.info('SLO snapshots created', { count: created });
  return created;
}

/**
 * Get historical data for a specific SLO
 */
export async function getSLOHistory(
  sloName: string,
  startDate: Date,
  endDate: Date,
  granularity: 'hourly' | 'daily' = 'hourly'
): Promise<SLOHistoryResult | null> {
  const slo = sloDefinitions.find((s) => s.name === sloName);
  if (!slo) return null;

  const snapshots = await prisma.sloSnapshot.findMany({
    where: {
      sloName,
      periodEnd: {
        gte: startDate,
        lte: endDate,
      },
    },
    orderBy: { periodEnd: 'asc' },
  });

  if (snapshots.length === 0) {
    return {
      sloName,
      target: slo.target,
      category: slo.category,
      snapshots: [],
      summary: {
        avgValue: 0,
        minValue: 0,
        maxValue: 0,
        breachCount: 0,
        uptimePercentage: 0,
        dataPointCount: 0,
      },
    };
  }

  // If daily granularity, aggregate hourly snapshots
  const trendPoints: SLOTrendPoint[] =
    granularity === 'daily'
      ? aggregateToDailyPoints(snapshots)
      : snapshots.map((s) => ({
          timestamp: s.periodEnd.toISOString(),
          value: s.current,
          status: s.status,
        }));

  // Calculate summary statistics
  const values = snapshots.map((s) => s.current);
  const breachCount = snapshots.filter((s) => s.current < slo.target).length;

  return {
    sloName,
    target: slo.target,
    category: slo.category,
    snapshots: trendPoints,
    summary: {
      avgValue: Math.round((values.reduce((a, b) => a + b, 0) / values.length) * 100) / 100,
      minValue: Math.min(...values),
      maxValue: Math.max(...values),
      breachCount,
      uptimePercentage:
        Math.round(((snapshots.length - breachCount) / snapshots.length) * 10000) / 100,
      dataPointCount: snapshots.length,
    },
  };
}

/**
 * Get all SLO histories for a category
 */
export async function getSLOHistoryByCategory(
  category: string,
  startDate: Date,
  endDate: Date
): Promise<SLOHistoryResult[]> {
  const slos = sloDefinitions.filter((s) => s.category === category);
  const results = await Promise.all(
    slos.map((slo) => getSLOHistory(slo.name, startDate, endDate))
  );
  return results.filter((r): r is SLOHistoryResult => r !== null);
}

/**
 * Get recent trend data for sparkline display
 * Returns last 24 data points (hours or as available)
 */
export async function getRecentTrend(sloName: string, points: number = 24): Promise<SLOTrendPoint[]> {
  const snapshots = await prisma.sloSnapshot.findMany({
    where: { sloName },
    orderBy: { periodEnd: 'desc' },
    take: points,
    select: {
      periodEnd: true,
      current: true,
      status: true,
    },
  });

  return snapshots
    .reverse()
    .map((s) => ({
      timestamp: s.periodEnd.toISOString(),
      value: s.current,
      status: s.status,
    }));
}

/**
 * Get trend indicator comparing current value to 24 hours ago
 */
export async function getTrendIndicator(sloName: string): Promise<{
  direction: 'up' | 'down' | 'stable';
  change: number;
} | null> {
  const now = new Date();
  const yesterday = new Date(now.getTime() - 24 * 60 * 60 * 1000);

  const [current, previous] = await Promise.all([
    prisma.sloSnapshot.findFirst({
      where: { sloName },
      orderBy: { periodEnd: 'desc' },
      select: { current: true },
    }),
    prisma.sloSnapshot.findFirst({
      where: {
        sloName,
        periodEnd: { lte: yesterday },
      },
      orderBy: { periodEnd: 'desc' },
      select: { current: true },
    }),
  ]);

  if (!current || !previous) return null;

  const change = Math.round((current.current - previous.current) * 100) / 100;
  const direction = change > 0.1 ? 'up' : change < -0.1 ? 'down' : 'stable';

  return { direction, change };
}

/**
 * Clean up old snapshots based on retention policy
 */
export async function cleanupOldSnapshots(): Promise<{ deleted: number }> {
  const thirtyDaysAgo = new Date();
  thirtyDaysAgo.setDate(thirtyDaysAgo.getDate() - 30);

  // Delete hourly snapshots older than 30 days
  // (Keep daily aggregates indefinitely - would need separate model for that)
  const result = await prisma.sloSnapshot.deleteMany({
    where: {
      periodEnd: { lt: thirtyDaysAgo },
    },
  });

  logger.info('Cleaned up old SLO snapshots', { deleted: result.count });
  return { deleted: result.count };
}

/**
 * Get all SLOs with their recent trend data
 */
export async function getAllSLOsWithTrends(): Promise<
  Array<SLOResult & { trend: SLOTrendPoint[]; trendIndicator: { direction: 'up' | 'down' | 'stable'; change: number } | null }>
> {
  const results = await calculateAllSLOs();

  const withTrends = await Promise.all(
    results.map(async (result) => {
      const [trend, trendIndicator] = await Promise.all([
        getRecentTrend(result.name, 24),
        getTrendIndicator(result.name),
      ]);
      return {
        ...result,
        trend,
        trendIndicator,
      };
    })
  );

  return withTrends;
}

// ============================================================================
// Helper functions
// ============================================================================

function getWindowMs(window: string): number {
  switch (window) {
    case 'hourly':
      return 60 * 60 * 1000;
    case 'daily':
      return 24 * 60 * 60 * 1000;
    case 'weekly':
      return 7 * 24 * 60 * 60 * 1000;
    case 'monthly':
      return 30 * 24 * 60 * 60 * 1000;
    default:
      return 24 * 60 * 60 * 1000;
  }
}

async function getSampleSize(category: string, since: Date): Promise<number> {
  try {
    return await prisma.httpMetric.count({
      where: {
        timestamp: { gte: since },
        ...(category === 'checkout' && { path: { startsWith: '/api/checkout' } }),
        ...(category === 'search' && { path: { startsWith: '/api/products/search' } }),
      },
    });
  } catch {
    return 0;
  }
}

function aggregateToDailyPoints(
  snapshots: Array<{ periodEnd: Date; current: number; status: string }>
): SLOTrendPoint[] {
  const dailyMap = new Map<string, { values: number[]; statuses: string[] }>();

  for (const snapshot of snapshots) {
    const dayKey = snapshot.periodEnd.toISOString().split('T')[0];
    if (!dailyMap.has(dayKey)) {
      dailyMap.set(dayKey, { values: [], statuses: [] });
    }
    dailyMap.get(dayKey)!.values.push(snapshot.current);
    dailyMap.get(dayKey)!.statuses.push(snapshot.status);
  }

  return Array.from(dailyMap.entries())
    .sort((a, b) => a[0].localeCompare(b[0]))
    .map(([date, data]) => {
      const avgValue = data.values.reduce((a, b) => a + b, 0) / data.values.length;
      // Status is critical if any were critical, warning if any were warning
      const status = data.statuses.includes('critical')
        ? 'critical'
        : data.statuses.includes('warning')
          ? 'warning'
          : 'healthy';
      return {
        timestamp: new Date(date).toISOString(),
        value: Math.round(avgValue * 100) / 100,
        status,
      };
    });
}