awsim-cloudwatch-logs 0.5.0

AWS CloudWatch Logs emulator for AWSim
Documentation
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
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
//! SQLite-backed log-event storage. The previous in-memory `Vec<LogEvent>`
//! per stream had no retention enforcement and triggered an O(n log n)
//! sort on every `PutLogEvents` — fine for a smoke test, deadly under
//! any sustained logging workload.
//!
//! Layout: a single `log_events` table partitioned by (account, region,
//! log_group, log_stream). All queries use the composite index, so reads
//! stay cheap even at hundreds of thousands of events. Retention is
//! enforced by a single `DELETE WHERE ts < ?` per group.

use std::path::PathBuf;
use std::sync::Arc;

use r2d2::PooledConnection;
use r2d2_sqlite::SqliteConnectionManager;
use rusqlite::{Connection, OptionalExtension, params};

use awsim_core::AwsError;

const POOL_MAX: u32 = 4;
const POOL_MIN_IDLE: u32 = 1;
const CACHE_SIZE_KIB: i64 = -2 * 1024;
const MMAP_SIZE_BYTES: i64 = 16 * 1024 * 1024;
const WAL_AUTOCHECKPOINT_PAGES: i64 = 256;

type Pool = r2d2::Pool<SqliteConnectionManager>;
type Conn = PooledConnection<SqliteConnectionManager>;

/// SQLite-backed store for CloudWatch Logs events. Cheap to clone —
/// internals are an Arc'd r2d2 pool.
#[derive(Clone, Debug)]
pub struct SqliteStore {
    inner: Arc<Inner>,
}

#[derive(Debug)]
struct Inner {
    db_path: PathBuf,
    #[allow(dead_code)] // pool's Debug is what we care about
    pool: Pool,
}

#[derive(Debug, Clone)]
pub struct LogEventRow {
    pub timestamp: u64,
    pub message: String,
    pub ingestion_time: u64,
}

impl SqliteStore {
    pub fn open(path: impl Into<PathBuf>) -> Result<Self, AwsError> {
        let db_path = path.into();
        let manager = SqliteConnectionManager::file(&db_path).with_init(apply_pragmas);
        let pool = r2d2::Pool::builder()
            .max_size(POOL_MAX)
            .min_idle(Some(POOL_MIN_IDLE))
            .build(manager)
            .map_err(|e| AwsError::internal(format!("CWL pool init failed: {e}")))?;
        // Run migrations (just one for now).
        {
            let conn = pool
                .get()
                .map_err(|e| AwsError::internal(format!("CWL pool acquire failed: {e}")))?;
            init_schema(&conn)?;
        }
        Ok(Self {
            inner: Arc::new(Inner { db_path, pool }),
        })
    }

    pub fn db_path(&self) -> &std::path::Path {
        &self.inner.db_path
    }

    fn conn(&self) -> Result<Conn, AwsError> {
        self.inner
            .pool
            .get()
            .map_err(|e| AwsError::internal(format!("CWL pool acquire failed: {e}")))
    }

    /// Bulk-insert log events. Returns the number of events written.
    pub fn put_events(
        &self,
        account: &str,
        region: &str,
        log_group: &str,
        log_stream: &str,
        events: &[LogEventRow],
    ) -> Result<usize, AwsError> {
        if events.is_empty() {
            return Ok(0);
        }
        let mut conn = self.conn()?;
        let tx = conn.transaction().map_err(sqlite_err)?;
        {
            let mut stmt = tx
                .prepare(
                    "INSERT INTO log_events
                     (account, region, log_group, log_stream, ts, ingestion_ts, message)
                     VALUES (?1, ?2, ?3, ?4, ?5, ?6, ?7)",
                )
                .map_err(sqlite_err)?;
            for e in events {
                stmt.execute(params![
                    account,
                    region,
                    log_group,
                    log_stream,
                    e.timestamp as i64,
                    e.ingestion_time as i64,
                    &e.message,
                ])
                .map_err(sqlite_err)?;
            }
        }
        tx.commit().map_err(sqlite_err)?;
        Ok(events.len())
    }

    /// Range-query log events for a single stream. `start` / `end` in ms.
    /// Pagination via (timestamp, rowid) tuple → caller passes the
    /// last-seen rowid as `after_rowid` to resume.
    #[allow(clippy::too_many_arguments)]
    pub fn get_events(
        &self,
        account: &str,
        region: &str,
        log_group: &str,
        log_stream: &str,
        start: Option<u64>,
        end: Option<u64>,
        offset: usize,
        limit: usize,
        ascending: bool,
    ) -> Result<Vec<LogEventRow>, AwsError> {
        let conn = self.conn()?;
        let order = if ascending { "ASC" } else { "DESC" };
        let sql = format!(
            "SELECT ts, ingestion_ts, message FROM log_events
             WHERE account = ?1 AND region = ?2 AND log_group = ?3 AND log_stream = ?4
               AND (?5 IS NULL OR ts >= ?5)
               AND (?6 IS NULL OR ts <= ?6)
             ORDER BY ts {order}, rowid {order}
             LIMIT ?7 OFFSET ?8"
        );
        let mut stmt = conn.prepare(&sql).map_err(sqlite_err)?;
        let start_param = start.map(|v| v as i64);
        let end_param = end.map(|v| v as i64);
        let rows = stmt
            .query_map(
                params![
                    account,
                    region,
                    log_group,
                    log_stream,
                    start_param,
                    end_param,
                    limit as i64,
                    offset as i64,
                ],
                |row| {
                    Ok(LogEventRow {
                        timestamp: row.get::<_, i64>(0)? as u64,
                        ingestion_time: row.get::<_, i64>(1)? as u64,
                        message: row.get::<_, String>(2)?,
                    })
                },
            )
            .map_err(sqlite_err)?;
        let out: Result<Vec<_>, _> = rows.collect();
        out.map_err(sqlite_err)
    }

    /// Total event count for a single stream — used to compute
    /// pagination tokens that mirror the legacy index-based ones.
    pub fn count_events(
        &self,
        account: &str,
        region: &str,
        log_group: &str,
        log_stream: &str,
        start: Option<u64>,
        end: Option<u64>,
    ) -> Result<usize, AwsError> {
        let conn = self.conn()?;
        let count: i64 = conn
            .query_row(
                "SELECT COUNT(*) FROM log_events
                 WHERE account = ?1 AND region = ?2 AND log_group = ?3 AND log_stream = ?4
                   AND (?5 IS NULL OR ts >= ?5)
                   AND (?6 IS NULL OR ts <= ?6)",
                params![
                    account,
                    region,
                    log_group,
                    log_stream,
                    start.map(|v| v as i64),
                    end.map(|v| v as i64),
                ],
                |r| r.get(0),
            )
            .map_err(sqlite_err)?;
        Ok(count as usize)
    }

    /// Filter events across one or more streams by substring match
    /// on `message`, returned in `(stream, ts)` order.
    #[allow(clippy::too_many_arguments)]
    pub fn filter_events(
        &self,
        account: &str,
        region: &str,
        log_group: &str,
        stream_filter: Option<&[String]>,
        substring: Option<&str>,
        start: Option<u64>,
        end: Option<u64>,
        limit: usize,
    ) -> Result<Vec<(String, LogEventRow)>, AwsError> {
        let conn = self.conn()?;
        let mut sql = String::from(
            "SELECT log_stream, ts, ingestion_ts, message FROM log_events
             WHERE account = ?1 AND region = ?2 AND log_group = ?3
               AND (?4 IS NULL OR ts >= ?4)
               AND (?5 IS NULL OR ts <= ?5)",
        );
        if let Some(s) = substring
            && !s.is_empty()
        {
            sql.push_str(&format!(
                " AND message LIKE '%' || {} || '%'",
                escape_for_like(s)
            ));
        }
        if let Some(streams) = stream_filter
            && !streams.is_empty()
        {
            sql.push_str(" AND log_stream IN (");
            for (i, s) in streams.iter().enumerate() {
                if i > 0 {
                    sql.push(',');
                }
                sql.push('\'');
                sql.push_str(&s.replace('\'', "''"));
                sql.push('\'');
            }
            sql.push(')');
        }
        sql.push_str(" ORDER BY ts ASC, rowid ASC LIMIT ?6");
        let mut stmt = conn.prepare(&sql).map_err(sqlite_err)?;
        let start_param = start.map(|v| v as i64);
        let end_param = end.map(|v| v as i64);
        let rows = stmt
            .query_map(
                params![
                    account,
                    region,
                    log_group,
                    start_param,
                    end_param,
                    limit as i64,
                ],
                |row| {
                    Ok((
                        row.get::<_, String>(0)?,
                        LogEventRow {
                            timestamp: row.get::<_, i64>(1)? as u64,
                            ingestion_time: row.get::<_, i64>(2)? as u64,
                            message: row.get::<_, String>(3)?,
                        },
                    ))
                },
            )
            .map_err(sqlite_err)?;
        let out: Result<Vec<_>, _> = rows.collect();
        out.map_err(sqlite_err)
    }

    /// First / last event timestamps for a stream — used to populate
    /// the `firstEventTimestamp` / `lastEventTimestamp` fields on
    /// DescribeLogStreams. Returns `(None, None)` when the stream is
    /// empty.
    pub fn stream_bounds(
        &self,
        account: &str,
        region: &str,
        log_group: &str,
        log_stream: &str,
    ) -> Result<(Option<u64>, Option<u64>), AwsError> {
        let conn = self.conn()?;
        let row: Option<(Option<i64>, Option<i64>)> = conn
            .query_row(
                "SELECT MIN(ts), MAX(ts) FROM log_events
                 WHERE account = ?1 AND region = ?2 AND log_group = ?3 AND log_stream = ?4",
                params![account, region, log_group, log_stream],
                |r| Ok((r.get::<_, Option<i64>>(0)?, r.get::<_, Option<i64>>(1)?)),
            )
            .optional()
            .map_err(sqlite_err)?;
        Ok(row
            .map(|(a, b)| (a.map(|v| v as u64), b.map(|v| v as u64)))
            .unwrap_or((None, None)))
    }

    /// Delete events older than `cutoff_ts` (ms). Used by the
    /// retention sweeper. Returns the number of rows deleted.
    pub fn trim_older_than(
        &self,
        account: &str,
        region: &str,
        log_group: &str,
        cutoff_ts: u64,
    ) -> Result<usize, AwsError> {
        let conn = self.conn()?;
        let n = conn
            .execute(
                "DELETE FROM log_events
                 WHERE account = ?1 AND region = ?2 AND log_group = ?3 AND ts < ?4",
                params![account, region, log_group, cutoff_ts as i64],
            )
            .map_err(sqlite_err)?;
        Ok(n)
    }

    /// Delete every event for a stream — used when DeleteLogStream
    /// fires. Cheap: indexed lookup + bulk delete.
    pub fn delete_stream(
        &self,
        account: &str,
        region: &str,
        log_group: &str,
        log_stream: &str,
    ) -> Result<usize, AwsError> {
        let conn = self.conn()?;
        let n = conn
            .execute(
                "DELETE FROM log_events
                 WHERE account = ?1 AND region = ?2 AND log_group = ?3 AND log_stream = ?4",
                params![account, region, log_group, log_stream],
            )
            .map_err(sqlite_err)?;
        Ok(n)
    }

    /// Delete every event for a log group — used by DeleteLogGroup.
    pub fn delete_group(
        &self,
        account: &str,
        region: &str,
        log_group: &str,
    ) -> Result<usize, AwsError> {
        let conn = self.conn()?;
        let n = conn
            .execute(
                "DELETE FROM log_events
                 WHERE account = ?1 AND region = ?2 AND log_group = ?3",
                params![account, region, log_group],
            )
            .map_err(sqlite_err)?;
        Ok(n)
    }

    /// Total row count across all groups + streams. Used by the
    /// `/_awsim/storage` endpoint to surface in-memory growth.
    pub fn total_rows(&self) -> Result<u64, AwsError> {
        let conn = self.conn()?;
        let n: i64 = conn
            .query_row("SELECT COUNT(*) FROM log_events", [], |r| r.get(0))
            .map_err(sqlite_err)?;
        Ok(n as u64)
    }
}

fn init_schema(conn: &Connection) -> Result<(), AwsError> {
    conn.execute_batch(
        "CREATE TABLE IF NOT EXISTS log_events (
             account TEXT NOT NULL,
             region TEXT NOT NULL,
             log_group TEXT NOT NULL,
             log_stream TEXT NOT NULL,
             ts INTEGER NOT NULL,
             ingestion_ts INTEGER NOT NULL,
             message TEXT NOT NULL
         );
         CREATE INDEX IF NOT EXISTS log_events_lookup
             ON log_events (account, region, log_group, log_stream, ts);
         CREATE INDEX IF NOT EXISTS log_events_group_ts
             ON log_events (account, region, log_group, ts);",
    )
    .map_err(sqlite_err)?;
    Ok(())
}

fn apply_pragmas(conn: &mut rusqlite::Connection) -> Result<(), rusqlite::Error> {
    conn.pragma_update(None, "journal_mode", "WAL")?;
    conn.pragma_update(None, "synchronous", "NORMAL")?;
    conn.execute_batch(&format!(
        "PRAGMA temp_store = MEMORY;
         PRAGMA mmap_size  = {MMAP_SIZE_BYTES};
         PRAGMA cache_size = {CACHE_SIZE_KIB};
         PRAGMA wal_autocheckpoint = {WAL_AUTOCHECKPOINT_PAGES};"
    ))?;
    Ok(())
}

/// Naïve quoted literal for substring matching. Wraps the user
/// string in single quotes and escapes embedded quotes. We can't
/// bind the LIKE pattern as a parameter directly because we want
/// to control the wildcards.
fn escape_for_like(s: &str) -> String {
    let mut out = String::with_capacity(s.len() + 2);
    out.push('\'');
    for ch in s.chars() {
        if ch == '\'' {
            out.push_str("''");
        } else {
            out.push(ch);
        }
    }
    out.push('\'');
    out
}

fn sqlite_err(e: rusqlite::Error) -> AwsError {
    AwsError::internal(format!("CloudWatch Logs sqlite error: {e}"))
}

#[cfg(test)]
mod tests {
    use super::*;

    fn store() -> SqliteStore {
        let id = uuid::Uuid::new_v4();
        let path = std::env::temp_dir().join(format!("awsim-cwl-test-{id}.db"));
        SqliteStore::open(path).unwrap()
    }

    fn ev(ts: u64, msg: &str) -> LogEventRow {
        LogEventRow {
            timestamp: ts,
            message: msg.to_string(),
            ingestion_time: ts + 1,
        }
    }

    #[test]
    fn put_then_get_returns_in_ts_order() {
        let s = store();
        s.put_events("a", "r", "g", "stm", &[ev(3, "c"), ev(1, "a"), ev(2, "b")])
            .unwrap();
        let rows = s
            .get_events("a", "r", "g", "stm", None, None, 0, 100, true)
            .unwrap();
        assert_eq!(rows.len(), 3);
        assert_eq!(rows[0].timestamp, 1);
        assert_eq!(rows[2].timestamp, 3);
    }

    #[test]
    fn time_range_filter() {
        let s = store();
        s.put_events("a", "r", "g", "stm", &[ev(1, "a"), ev(5, "b"), ev(10, "c")])
            .unwrap();
        let rows = s
            .get_events("a", "r", "g", "stm", Some(2), Some(7), 0, 100, true)
            .unwrap();
        assert_eq!(rows.len(), 1);
        assert_eq!(rows[0].timestamp, 5);
    }

    #[test]
    fn filter_substring_across_streams() {
        let s = store();
        s.put_events("a", "r", "g", "s1", &[ev(1, "hello world")])
            .unwrap();
        s.put_events(
            "a",
            "r",
            "g",
            "s2",
            &[ev(2, "no match"), ev(3, "world cup")],
        )
        .unwrap();
        let rows = s
            .filter_events("a", "r", "g", None, Some("world"), None, None, 100)
            .unwrap();
        assert_eq!(rows.len(), 2);
        assert_eq!(rows[0].1.timestamp, 1);
        assert_eq!(rows[1].1.timestamp, 3);
    }

    #[test]
    fn trim_older_than_drops_events() {
        let s = store();
        s.put_events("a", "r", "g", "stm", &[ev(1, "a"), ev(5, "b"), ev(10, "c")])
            .unwrap();
        let removed = s.trim_older_than("a", "r", "g", 5).unwrap();
        assert_eq!(removed, 1);
        let remaining = s.count_events("a", "r", "g", "stm", None, None).unwrap();
        assert_eq!(remaining, 2);
    }

    #[test]
    fn stream_bounds_returns_min_max() {
        let s = store();
        s.put_events("a", "r", "g", "stm", &[ev(5, "x"), ev(10, "y"), ev(2, "z")])
            .unwrap();
        let (min, max) = s.stream_bounds("a", "r", "g", "stm").unwrap();
        assert_eq!(min, Some(2));
        assert_eq!(max, Some(10));
    }

    #[test]
    fn delete_stream_removes_only_that_stream() {
        let s = store();
        s.put_events("a", "r", "g", "s1", &[ev(1, "a")]).unwrap();
        s.put_events("a", "r", "g", "s2", &[ev(1, "b")]).unwrap();
        s.delete_stream("a", "r", "g", "s1").unwrap();
        assert_eq!(s.count_events("a", "r", "g", "s1", None, None).unwrap(), 0);
        assert_eq!(s.count_events("a", "r", "g", "s2", None, None).unwrap(), 1);
    }
}