Skip to content

Commit c6d7904

Browse files
committed
Update CHANGELOG to reflect new trace format parsers and CLI enhancements; remove TRACE_FORMATS_CHANGELOG as its content is now integrated. Document new features, usage examples, and workflow guides for real-world trace analysis.
1 parent 453c1d9 commit c6d7904

2 files changed

Lines changed: 41 additions & 242 deletions

File tree

CHANGELOG.md

Lines changed: 41 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,46 @@
11
# Changelog
22

3-
All notable changes to template will be documented in this file.
3+
All notable changes to tracekit will be documented in this file.
44

55
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
66
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
7+
8+
## [Unreleased]
9+
10+
### Added
11+
12+
#### tracekit-formats
13+
- **ARC trace format parser** - Space-separated format from ARC research (`timestamp key [size]`)
14+
- Source: [moka-rs/cache-trace](https://github.com/moka-rs/cache-trace)
15+
- Use case: Academic research traces (IBM, storage systems)
16+
- **LIRS trace format parser** - One block number per line from LIRS paper
17+
- Source: LIRS paper traces, Caffeine simulator resources
18+
- Use case: Storage and database workload traces
19+
- **CSV trace format parser** - Configurable CSV with flexible column mapping
20+
- Supports custom column ordering, headers, and delimiters
21+
- Pre-configured modes: key-only, TSV
22+
- **Cachelib trace format parser** - Facebook/Meta Cachelib CSV format
23+
- Source: [Cachelib Cachebench](https://cachelib.org/docs/Cache_Library_User_Guides/Cachebench_FB_HW_eval/)
24+
- String key support (automatically hashed to u64)
25+
- Production trace patterns (CDN, social media)
26+
27+
#### tracekit-cli
28+
- Extended `simulate` command to support new trace formats: `arc`, `lirs`, `csv`, `cachelib`
29+
- Extended `rewrite` command to convert between all supported formats
30+
31+
#### Documentation
32+
- `tracekit-formats/README.md` - Comprehensive format documentation with usage examples
33+
- `docs/REAL_TRACES.md` - Complete workflow guide for working with real-world traces
34+
- Trace analysis best practices
35+
- Large trace handling techniques
36+
- Troubleshooting guide
37+
- Links to trace repositories
38+
- `tracekit/examples/real_trace.rs` - Example demonstrating trace analysis
39+
40+
#### Features
41+
- Feature flags for trace formats: `arc`, `lirs`, `csv`, `cachelib`
42+
- `full` feature flag to enable all trace format parsers
43+
44+
### Changed
45+
- `tracekit-formats` default features now include `arc`, `lirs`, and `csv`
46+
- Main README updated with trace format examples and links to trace sources

TRACE_FORMATS_CHANGELOG.md

Lines changed: 0 additions & 241 deletions
This file was deleted.

0 commit comments

Comments
 (0)