pg-logstats 0.1.0

PostgreSQL log investigation CLI for query-family findings and follow-up SQL
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

# pg-logstats Documentation

This directory contains documentation for the pg-logstats project.

## Documentation Files

### API.md

Complete API documentation for the pg-logstats library, including:
- Module overview
- Data structures
- Method documentation
- Usage examples
- Error handling

## Building Documentation

To build the documentation locally:

```bash
cargo doc --no-deps --open
```

This will generate HTML documentation and open it in your default browser. The generated docs include the latest public API for:
- `parsers` (e.g., `StderrParser`)
- `analytics` (e.g., `QueryAnalyzer`, `TimingAnalyzer`)
- `output` (e.g., `JsonFormatter`, `TextFormatter`)

## Contributing to Documentation

When adding new features to pg-logstats:

1. Update the relevant module documentation in the source code
2. Update this API.md file if new public APIs are added
3. Add fixture-backed usage examples to the root README
4. Update the main README.md if necessary