- Multi-word AND search (all words must match) - Project filter (-p, --project) - Date filter (--since today/7d/30d/YYYY-MM-DD) - JSON output (--json) for scripting - Improved preview extraction (skips tool results) - 3s search timeout for safety - Updated documentation in observability.md Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
384 lines
10 KiB
Markdown
384 lines
10 KiB
Markdown
# Session Observability & Monitoring
|
|
|
|
> Track Claude Code usage, estimate costs, and identify patterns across your development sessions.
|
|
|
|
## Table of Contents
|
|
|
|
1. [Why Monitor Sessions](#why-monitor-sessions)
|
|
2. [Session Search & Resume](#session-search--resume)
|
|
3. [Setting Up Session Logging](#setting-up-session-logging)
|
|
4. [Analyzing Session Data](#analyzing-session-data)
|
|
5. [Cost Tracking](#cost-tracking)
|
|
6. [Patterns & Best Practices](#patterns--best-practices)
|
|
7. [Limitations](#limitations)
|
|
|
|
---
|
|
|
|
## Why Monitor Sessions
|
|
|
|
Claude Code usage can accumulate quickly, especially in active development. Monitoring helps you:
|
|
|
|
- **Understand costs**: Estimate API spend before invoices arrive
|
|
- **Identify patterns**: See which tools you use most, which files get edited repeatedly
|
|
- **Optimize workflow**: Find inefficiencies (e.g., repeatedly reading the same large file)
|
|
- **Track projects**: Compare usage across different codebases
|
|
- **Team visibility**: Aggregate usage for team budgeting (when combining logs)
|
|
|
|
---
|
|
|
|
## Session Search & Resume
|
|
|
|
After weeks of using Claude Code, finding past conversations becomes challenging. This section covers native options and community tools.
|
|
|
|
### Native Commands
|
|
|
|
| Command | Use Case |
|
|
|---------|----------|
|
|
| `claude -c` / `claude --continue` | Resume most recent session |
|
|
| `claude -r <id>` / `claude --resume <id>` | Resume specific session by ID |
|
|
| `claude --resume` | Interactive session picker |
|
|
|
|
Sessions are stored locally at `~/.claude/projects/<project>/` as JSONL files.
|
|
|
|
### Community Tools Comparison
|
|
|
|
| Tool | Install | List Speed | Search Speed | Dependencies | Resume Command |
|
|
|------|---------|------------|--------------|--------------|----------------|
|
|
| **session-search.sh** (this repo) | Copy script | **10ms** | **400ms** | None (bash) | ✅ Displayed |
|
|
| claude-conversation-extractor | `pip install` | 230ms | 1.7s | Python | ❌ |
|
|
| claude-code-transcripts | `uvx` | N/A | N/A | Python | ❌ |
|
|
| ran CLI | `npm -g` | N/A | Fast | Node.js | ❌ (commands only) |
|
|
|
|
### Recommended: session-search.sh
|
|
|
|
Zero-dependency bash script optimized for speed with ready-to-use resume commands.
|
|
|
|
**Install:**
|
|
```bash
|
|
cp examples/scripts/session-search.sh ~/.claude/scripts/cs
|
|
chmod +x ~/.claude/scripts/cs
|
|
echo "alias cs='~/.claude/scripts/cs'" >> ~/.zshrc
|
|
source ~/.zshrc
|
|
```
|
|
|
|
**Usage:**
|
|
```bash
|
|
cs # List 10 most recent sessions (~15ms)
|
|
cs "authentication" # Single keyword search (~400ms)
|
|
cs "Prisma migration" # Multi-word AND search (both must match)
|
|
cs -n 20 # Show 20 results
|
|
cs -p myproject "bug" # Filter by project name
|
|
cs --since 7d # Sessions from last 7 days
|
|
cs --since today # Today's sessions only
|
|
cs --json "api" | jq . # JSON output for scripting
|
|
cs --rebuild # Force index rebuild
|
|
```
|
|
|
|
**Output:**
|
|
```
|
|
2026-01-15 08:32 │ my-project │ Implement OAuth flow for...
|
|
claude --resume 84287c0d-8778-4a8d-abf1-eb2807e327a8
|
|
|
|
2026-01-14 21:13 │ other-project │ Fix database migration...
|
|
claude --resume 1340c42e-eac5-4181-8407-cc76e1a76219
|
|
```
|
|
|
|
Copy-paste the `claude --resume` command to continue any session.
|
|
|
|
### How It Works
|
|
|
|
1. **Index mode** (no filters): Uses cached TSV index. Auto-refreshes when sessions change. ~15ms lookup.
|
|
2. **Search mode** (with keyword/filters): Full-text search with 3s timeout. Multi-word queries use AND logic.
|
|
3. **Filters**: `--project` (substring match), `--since` (supports `today`, `yesterday`, `7d`, `YYYY-MM-DD`)
|
|
4. **Output**: Human-readable by default, `--json` for scripting. Excludes agent/subagent sessions.
|
|
|
|
### Alternative: Python Tools
|
|
|
|
If you prefer richer features (HTML export, multiple formats):
|
|
|
|
```bash
|
|
# Install
|
|
pip install claude-conversation-extractor
|
|
|
|
# Interactive UI
|
|
claude-start
|
|
|
|
# Direct search
|
|
claude-search "keyword"
|
|
|
|
# Export to markdown
|
|
claude-extract --format markdown
|
|
```
|
|
|
|
See [session-search.sh](../examples/scripts/session-search.sh) for the complete script.
|
|
|
|
---
|
|
|
|
## Setting Up Session Logging
|
|
|
|
### 1. Install the Logger Hook
|
|
|
|
Copy the session logger to your hooks directory:
|
|
|
|
```bash
|
|
# Create hooks directory if needed
|
|
mkdir -p ~/.claude/hooks
|
|
|
|
# Copy the logger (from this repo's examples)
|
|
cp examples/hooks/bash/session-logger.sh ~/.claude/hooks/
|
|
chmod +x ~/.claude/hooks/session-logger.sh
|
|
```
|
|
|
|
### 2. Register in Settings
|
|
|
|
Add to `~/.claude/settings.json`:
|
|
|
|
```json
|
|
{
|
|
"hooks": {
|
|
"PostToolUse": [
|
|
{
|
|
"type": "command",
|
|
"command": "~/.claude/hooks/session-logger.sh"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
```
|
|
|
|
### 3. Verify Installation
|
|
|
|
Run a few Claude Code commands, then check logs:
|
|
|
|
```bash
|
|
ls ~/.claude/logs/
|
|
# Should see: activity-2026-01-14.jsonl
|
|
|
|
# View recent entries
|
|
tail -5 ~/.claude/logs/activity-$(date +%Y-%m-%d).jsonl | jq .
|
|
```
|
|
|
|
### Configuration Options
|
|
|
|
| Environment Variable | Default | Description |
|
|
|---------------------|---------|-------------|
|
|
| `CLAUDE_LOG_DIR` | `~/.claude/logs` | Where to store logs |
|
|
| `CLAUDE_LOG_TOKENS` | `true` | Enable token estimation |
|
|
| `CLAUDE_SESSION_ID` | auto-generated | Custom session identifier |
|
|
|
|
---
|
|
|
|
## Analyzing Session Data
|
|
|
|
### Using session-stats.sh
|
|
|
|
```bash
|
|
# Copy the script
|
|
cp examples/scripts/session-stats.sh ~/.local/bin/
|
|
chmod +x ~/.local/bin/session-stats.sh
|
|
|
|
# Today's summary
|
|
session-stats.sh
|
|
|
|
# Last 7 days
|
|
session-stats.sh --range week
|
|
|
|
# Specific date
|
|
session-stats.sh --date 2026-01-14
|
|
|
|
# Filter by project
|
|
session-stats.sh --project my-app
|
|
|
|
# Machine-readable output
|
|
session-stats.sh --json
|
|
```
|
|
|
|
### Sample Output
|
|
|
|
```
|
|
═══════════════════════════════════════════════════════════
|
|
Claude Code Session Statistics - today
|
|
═══════════════════════════════════════════════════════════
|
|
|
|
Summary
|
|
Total operations: 127
|
|
Sessions: 3
|
|
|
|
Token Usage
|
|
Input tokens: 45,230
|
|
Output tokens: 12,450
|
|
Total tokens: 57,680
|
|
|
|
Estimated Cost (Sonnet rates)
|
|
Input: $0.1357
|
|
Output: $0.1868
|
|
Total: $0.3225
|
|
|
|
Tools Used
|
|
Edit: 45
|
|
Read: 38
|
|
Bash: 24
|
|
Grep: 12
|
|
Write: 8
|
|
|
|
Projects
|
|
my-app: 89
|
|
other-project: 38
|
|
```
|
|
|
|
### Log Format
|
|
|
|
Each log entry is a JSON object:
|
|
|
|
```json
|
|
{
|
|
"timestamp": "2026-01-14T15:30:00Z",
|
|
"session_id": "1705234567-12345",
|
|
"tool": "Edit",
|
|
"file": "src/components/Button.tsx",
|
|
"project": "my-app",
|
|
"tokens": {
|
|
"input": 350,
|
|
"output": 120,
|
|
"total": 470
|
|
}
|
|
}
|
|
```
|
|
|
|
---
|
|
|
|
## Cost Tracking
|
|
|
|
### Token Estimation Method
|
|
|
|
The logger estimates tokens using a simple heuristic: **~4 characters per token**. This is approximate and tends to slightly overestimate.
|
|
|
|
### Cost Rates
|
|
|
|
Default rates are for Claude Sonnet. Adjust via environment variables:
|
|
|
|
```bash
|
|
# Sonnet rates (default)
|
|
export CLAUDE_RATE_INPUT=0.003 # $3/1M tokens
|
|
export CLAUDE_RATE_OUTPUT=0.015 # $15/1M tokens
|
|
|
|
# Opus rates (if using Opus)
|
|
export CLAUDE_RATE_INPUT=0.015 # $15/1M tokens
|
|
export CLAUDE_RATE_OUTPUT=0.075 # $75/1M tokens
|
|
|
|
# Haiku rates
|
|
export CLAUDE_RATE_INPUT=0.00025 # $0.25/1M tokens
|
|
export CLAUDE_RATE_OUTPUT=0.00125 # $1.25/1M tokens
|
|
```
|
|
|
|
### Budget Alerts (Manual Pattern)
|
|
|
|
Add to your shell profile for daily budget warnings:
|
|
|
|
```bash
|
|
# ~/.zshrc or ~/.bashrc
|
|
claude_budget_check() {
|
|
local cost=$(session-stats.sh --json 2>/dev/null | jq -r '.summary.estimated_cost.total // 0')
|
|
local threshold=5.00 # $5 daily budget
|
|
|
|
if (( $(echo "$cost > $threshold" | bc -l) )); then
|
|
echo "⚠️ Claude Code daily spend: \$$cost (threshold: \$$threshold)"
|
|
fi
|
|
}
|
|
|
|
# Run on shell start
|
|
claude_budget_check
|
|
```
|
|
|
|
---
|
|
|
|
## Patterns & Best Practices
|
|
|
|
### 1. Weekly Review
|
|
|
|
Set a calendar reminder to review weekly stats:
|
|
|
|
```bash
|
|
session-stats.sh --range week
|
|
```
|
|
|
|
Look for:
|
|
- Unusually high token usage days
|
|
- Repeated operations on same files (inefficiency signal)
|
|
- Project distribution (where time is spent)
|
|
|
|
### 2. Per-Project Tracking
|
|
|
|
Use `CLAUDE_SESSION_ID` to tag sessions by project:
|
|
|
|
```bash
|
|
export CLAUDE_SESSION_ID="project-myapp-$(date +%s)"
|
|
claude
|
|
```
|
|
|
|
### 3. Team Aggregation
|
|
|
|
For team-wide tracking, sync logs to shared storage:
|
|
|
|
```bash
|
|
# Example: sync to S3 daily
|
|
aws s3 sync ~/.claude/logs/ s3://company-claude-logs/$(whoami)/
|
|
```
|
|
|
|
Then aggregate with:
|
|
|
|
```bash
|
|
# Download all team logs
|
|
aws s3 sync s3://company-claude-logs/ /tmp/team-logs/
|
|
|
|
# Combine and analyze
|
|
cat /tmp/team-logs/*/activity-$(date +%Y-%m-%d).jsonl | \
|
|
jq -s 'group_by(.project) | map({project: .[0].project, total_tokens: [.[].tokens.total] | add})'
|
|
```
|
|
|
|
### 4. Log Rotation
|
|
|
|
Logs accumulate over time. Add cleanup to cron:
|
|
|
|
```bash
|
|
# Clean logs older than 30 days
|
|
find ~/.claude/logs -name "*.jsonl" -mtime +30 -delete
|
|
```
|
|
|
|
---
|
|
|
|
## Limitations
|
|
|
|
### What This Monitoring CANNOT Do
|
|
|
|
| Limitation | Reason |
|
|
|------------|--------|
|
|
| **Exact token counts** | Claude Code CLI doesn't expose API token metrics |
|
|
| **TTFT (Time to First Token)** | Hook runs after tool completes, not during streaming |
|
|
| **Real-time streaming metrics** | No hook event during response generation |
|
|
| **Actual API costs** | Token estimates are heuristic, not from billing |
|
|
| **Model selection** | Log doesn't capture which model was used per request |
|
|
| **Context window usage** | No visibility into current context percentage |
|
|
|
|
### Accuracy Notes
|
|
|
|
- **Token estimates**: ~15-25% variance from actual billing
|
|
- **Cost estimates**: Use as directional guidance, not accounting
|
|
- **Session boundaries**: Sessions are approximated by ID, not exact API sessions
|
|
|
|
### What You CAN Trust
|
|
|
|
- **Tool usage counts**: Exact count of each tool invocation
|
|
- **File access patterns**: Which files were touched
|
|
- **Relative comparisons**: Day-to-day/project-to-project trends
|
|
- **Operation timing**: When tools were used (timestamp)
|
|
|
|
---
|
|
|
|
## Related Resources
|
|
|
|
- [Session Search Script](../examples/scripts/session-search.sh) - Fast session search & resume
|
|
- [Session Logger Hook](../examples/hooks/bash/session-logger.sh)
|
|
- [Stats Analysis Script](../examples/scripts/session-stats.sh)
|
|
- [Data Privacy Guide](./data-privacy.md) - What data leaves your machine
|
|
- [Cost Optimization](./ultimate-guide.md#cost-optimization) - Tips to reduce spend
|