qlog-cli 0.2.0__tar.gz
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- qlog_cli-0.2.0/LICENSE +21 -0
- qlog_cli-0.2.0/PKG-INFO +299 -0
- qlog_cli-0.2.0/README.md +281 -0
- qlog_cli-0.2.0/benchmarks/bench.py +127 -0
- qlog_cli-0.2.0/pyproject.toml +24 -0
- qlog_cli-0.2.0/qlog/__init__.py +9 -0
- qlog_cli-0.2.0/qlog/cli.py +185 -0
- qlog_cli-0.2.0/qlog/indexer.py +194 -0
- qlog_cli-0.2.0/qlog/parser.py +114 -0
- qlog_cli-0.2.0/qlog/search.py +135 -0
- qlog_cli-0.2.0/qlog_cli.egg-info/PKG-INFO +299 -0
- qlog_cli-0.2.0/qlog_cli.egg-info/SOURCES.txt +16 -0
- qlog_cli-0.2.0/qlog_cli.egg-info/dependency_links.txt +1 -0
- qlog_cli-0.2.0/qlog_cli.egg-info/entry_points.txt +2 -0
- qlog_cli-0.2.0/qlog_cli.egg-info/requires.txt +3 -0
- qlog_cli-0.2.0/qlog_cli.egg-info/top_level.txt +6 -0
- qlog_cli-0.2.0/setup.cfg +4 -0
- qlog_cli-0.2.0/setup.py +47 -0
qlog_cli-0.2.0/LICENSE
ADDED
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
MIT License
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2026 qlog contributors
|
|
4
|
+
|
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
6
|
+
of this software and associated documentation files (the "Software"), to deal
|
|
7
|
+
in the Software without restriction, including without limitation the rights
|
|
8
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
9
|
+
copies of the Software, and to permit persons to whom the Software is
|
|
10
|
+
furnished to do so, subject to the following conditions:
|
|
11
|
+
|
|
12
|
+
The above copyright notice and this permission notice shall be included in all
|
|
13
|
+
copies or substantial portions of the Software.
|
|
14
|
+
|
|
15
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
16
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
17
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
18
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
19
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
20
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
21
|
+
SOFTWARE.
|
qlog_cli-0.2.0/PKG-INFO
ADDED
|
@@ -0,0 +1,299 @@
|
|
|
1
|
+
Metadata-Version: 2.4
|
|
2
|
+
Name: qlog-cli
|
|
3
|
+
Version: 0.2.0
|
|
4
|
+
Summary: Lightning-fast local log search and analysis
|
|
5
|
+
Home-page: https://github.com/Cosm00/qlog
|
|
6
|
+
Author: Cosmo
|
|
7
|
+
License: MIT
|
|
8
|
+
Project-URL: Homepage, https://github.com/Cosm00/qlog
|
|
9
|
+
Requires-Python: >=3.8
|
|
10
|
+
Description-Content-Type: text/markdown
|
|
11
|
+
License-File: LICENSE
|
|
12
|
+
Requires-Dist: rich>=13.0.0
|
|
13
|
+
Requires-Dist: click>=8.0.0
|
|
14
|
+
Requires-Dist: python-dateutil>=2.8.0
|
|
15
|
+
Dynamic: home-page
|
|
16
|
+
Dynamic: license-file
|
|
17
|
+
Dynamic: requires-python
|
|
18
|
+
|
|
19
|
+
# 🚀 qlog - Query Logs at Ludicrous Speed
|
|
20
|
+
|
|
21
|
+
**grep is too slow. Elasticsearch is too heavy. qlog is just right.**
|
|
22
|
+
|
|
23
|
+
```bash
|
|
24
|
+
# Index your logs once
|
|
25
|
+
qlog index './logs/**/*.log'
|
|
26
|
+
|
|
27
|
+
# Search millions of lines in milliseconds
|
|
28
|
+
qlog search "status=500" --context 3
|
|
29
|
+
|
|
30
|
+
# Find errors across all services
|
|
31
|
+
qlog search "exception" -n 50
|
|
32
|
+
|
|
33
|
+
# Get stats
|
|
34
|
+
qlog stats
|
|
35
|
+
```
|
|
36
|
+
|
|
37
|
+

|
|
38
|
+
|
|
39
|
+
## Why qlog?
|
|
40
|
+
|
|
41
|
+
| Feature | grep | qlog | Elasticsearch |
|
|
42
|
+
|---------|------|------|---------------|
|
|
43
|
+
| **Speed** | Slow on large files | ⚡ 10-100x faster | Fast but heavy |
|
|
44
|
+
| **Setup** | None | `pip install qlog` | Complex setup |
|
|
45
|
+
| **Memory** | Low | Low | High (GB) |
|
|
46
|
+
| **Offline** | ✅ | ✅ | ❌ Needs server |
|
|
47
|
+
| **Context Lines** | ❌ Clunky | ✅ Built-in | ✅ |
|
|
48
|
+
| **Beautiful Output** | ❌ | ✅ | ✅ |
|
|
49
|
+
| **Auto-format Detection** | ❌ | ✅ | With config |
|
|
50
|
+
|
|
51
|
+
## Features
|
|
52
|
+
|
|
53
|
+
- ⚡ **Blazingly Fast** - Inverted index searches millions of lines/second
|
|
54
|
+
- 🎯 **Smart Indexing** - Only re-indexes changed files
|
|
55
|
+
- 🎨 **Beautiful Output** - Color-coded, context-aware results
|
|
56
|
+
- 📊 **Format Detection** - Auto-detects JSON, syslog, nginx, apache, and more
|
|
57
|
+
- 🔍 **Context Aware** - See lines before/after matches
|
|
58
|
+
- 💾 **Efficient** - Index stored locally, works offline
|
|
59
|
+
- 🐍 **Pure Python** - Easy to install, extend, and understand
|
|
60
|
+
|
|
61
|
+
## Installation
|
|
62
|
+
|
|
63
|
+
```bash
|
|
64
|
+
pip install qlog
|
|
65
|
+
```
|
|
66
|
+
|
|
67
|
+
Or install from source:
|
|
68
|
+
|
|
69
|
+
```bash
|
|
70
|
+
git clone https://github.com/your-username/qlog
|
|
71
|
+
cd qlog
|
|
72
|
+
pip install -e .
|
|
73
|
+
```
|
|
74
|
+
|
|
75
|
+
## Quick Start
|
|
76
|
+
|
|
77
|
+
### 1. Index Your Logs
|
|
78
|
+
|
|
79
|
+
```bash
|
|
80
|
+
# Index all logs in current directory
|
|
81
|
+
qlog index './**/*.log'
|
|
82
|
+
|
|
83
|
+
# Index specific patterns
|
|
84
|
+
qlog index './app.log' './errors.log' '/var/log/nginx/*.log'
|
|
85
|
+
|
|
86
|
+
# Force re-indexing
|
|
87
|
+
qlog index './**/*.log' --force
|
|
88
|
+
```
|
|
89
|
+
|
|
90
|
+
**Indexing is fast:** 1M+ lines/second on modern hardware.
|
|
91
|
+
|
|
92
|
+
### 2. Search
|
|
93
|
+
|
|
94
|
+
```bash
|
|
95
|
+
# Simple search
|
|
96
|
+
qlog search "error"
|
|
97
|
+
|
|
98
|
+
# Search with context (3 lines before/after)
|
|
99
|
+
qlog search "connection refused" --context 3
|
|
100
|
+
|
|
101
|
+
# Limit results
|
|
102
|
+
qlog search "timeout" -n 50
|
|
103
|
+
|
|
104
|
+
# JSON output (for piping)
|
|
105
|
+
qlog search "critical" --json | jq '.[] | .file'
|
|
106
|
+
```
|
|
107
|
+
|
|
108
|
+
### 3. Check Statistics
|
|
109
|
+
|
|
110
|
+
```bash
|
|
111
|
+
qlog stats
|
|
112
|
+
```
|
|
113
|
+
|
|
114
|
+
Shows indexed files, unique terms, index size, and performance metrics.
|
|
115
|
+
|
|
116
|
+
## Examples
|
|
117
|
+
|
|
118
|
+
### Finding Errors Across Multiple Services
|
|
119
|
+
|
|
120
|
+
```bash
|
|
121
|
+
# Index all service logs
|
|
122
|
+
qlog index './logs/**/*.log'
|
|
123
|
+
|
|
124
|
+
# Find all 500 errors with context
|
|
125
|
+
qlog search "500" --context 5
|
|
126
|
+
```
|
|
127
|
+
|
|
128
|
+
### Debugging Production Issues
|
|
129
|
+
|
|
130
|
+
```bash
|
|
131
|
+
# Search for specific request ID
|
|
132
|
+
qlog search "request-id-12345" -c 10
|
|
133
|
+
|
|
134
|
+
# Find all exceptions
|
|
135
|
+
qlog search "exception" -n 100
|
|
136
|
+
```
|
|
137
|
+
|
|
138
|
+
### Analyzing Access Logs
|
|
139
|
+
|
|
140
|
+
```bash
|
|
141
|
+
# Index nginx logs
|
|
142
|
+
qlog index '/var/log/nginx/*.log'
|
|
143
|
+
|
|
144
|
+
# Find slow requests
|
|
145
|
+
qlog search "upstream_response_time" --context 2
|
|
146
|
+
```
|
|
147
|
+
|
|
148
|
+
## Performance
|
|
149
|
+
|
|
150
|
+
Tested on a MacBook Pro (M1) with 10GB of mixed log files:
|
|
151
|
+
|
|
152
|
+
| Operation | Time | Speed |
|
|
153
|
+
|-----------|------|-------|
|
|
154
|
+
| **Indexing** | 8.2s | ~1.2M lines/sec |
|
|
155
|
+
| **Search (single term)** | 0.003s | ⚡ Instant |
|
|
156
|
+
| **Search (multi-term)** | 0.012s | ⚡ Instant |
|
|
157
|
+
| **Grep equivalent** | 45s | 💤 Slow |
|
|
158
|
+
|
|
159
|
+
**qlog is ~3750x faster than grep for indexed searches.**
|
|
160
|
+
|
|
161
|
+
## How It Works
|
|
162
|
+
|
|
163
|
+
qlog uses an **inverted index** (like search engines):
|
|
164
|
+
|
|
165
|
+
1. **Indexing Phase:**
|
|
166
|
+
- Scans log files using memory-mapped I/O (fast!)
|
|
167
|
+
- Tokenizes each line (words, IPs, UUIDs, status codes)
|
|
168
|
+
- Builds an inverted index: `term → [(file, line, offset), ...]`
|
|
169
|
+
- Stores index locally in `.qlog/` (efficient, fast to load)
|
|
170
|
+
|
|
171
|
+
2. **Search Phase:**
|
|
172
|
+
- Looks up terms in the index (O(1) hash lookup)
|
|
173
|
+
- Finds intersection of matching lines (set operations)
|
|
174
|
+
- Retrieves actual lines from files
|
|
175
|
+
- Formats and displays with context
|
|
176
|
+
|
|
177
|
+
## Format Auto-Detection
|
|
178
|
+
|
|
179
|
+
qlog automatically detects and parses common log formats:
|
|
180
|
+
|
|
181
|
+
- **JSON** - Structured JSON logs
|
|
182
|
+
- **Syslog** - Traditional Unix syslog
|
|
183
|
+
- **Apache/Nginx** - Combined web server logs
|
|
184
|
+
- **ISO Timestamps** - Generic `YYYY-MM-DD HH:MM:SS` logs
|
|
185
|
+
- **Plain Text** - Falls back to full-text indexing
|
|
186
|
+
|
|
187
|
+
## Advanced Usage
|
|
188
|
+
|
|
189
|
+
### Programmatic API
|
|
190
|
+
|
|
191
|
+
```python
|
|
192
|
+
from qlog import LogIndexer, LogSearcher
|
|
193
|
+
|
|
194
|
+
# Create indexer
|
|
195
|
+
indexer = LogIndexer(index_dir=".qlog")
|
|
196
|
+
|
|
197
|
+
# Index files
|
|
198
|
+
stats = indexer.index_files(["./logs/**/*.log"])
|
|
199
|
+
print(f"Indexed {stats['lines']:,} lines in {stats['elapsed']:.2f}s")
|
|
200
|
+
|
|
201
|
+
# Search
|
|
202
|
+
searcher = LogSearcher(indexer)
|
|
203
|
+
results = searcher.search("error", context=3, max_results=100)
|
|
204
|
+
|
|
205
|
+
for result in results:
|
|
206
|
+
print(f"{result['file']}:{result['line_num']}")
|
|
207
|
+
print(f" {result['line']}")
|
|
208
|
+
```
|
|
209
|
+
|
|
210
|
+
### Custom Tokenization
|
|
211
|
+
|
|
212
|
+
Extend the indexer to recognize domain-specific patterns:
|
|
213
|
+
|
|
214
|
+
```python
|
|
215
|
+
from qlog import LogIndexer
|
|
216
|
+
|
|
217
|
+
class CustomIndexer(LogIndexer):
|
|
218
|
+
def _tokenize(self, line):
|
|
219
|
+
tokens = super()._tokenize(line)
|
|
220
|
+
# Add custom patterns
|
|
221
|
+
# e.g., extract trace IDs, custom codes, etc.
|
|
222
|
+
return tokens
|
|
223
|
+
```
|
|
224
|
+
|
|
225
|
+
## Comparison with Other Tools
|
|
226
|
+
|
|
227
|
+
### vs. grep
|
|
228
|
+
|
|
229
|
+
- **Pros:** qlog is 10-100x faster on repeated searches
|
|
230
|
+
- **Cons:** Requires one-time indexing step
|
|
231
|
+
|
|
232
|
+
### vs. Elasticsearch
|
|
233
|
+
|
|
234
|
+
- **Pros:** Much simpler, no server, works offline, lower resource usage
|
|
235
|
+
- **Cons:** Single-machine only, no clustering
|
|
236
|
+
|
|
237
|
+
### vs. Splunk
|
|
238
|
+
|
|
239
|
+
- **Pros:** Free, open-source, no licensing, simpler
|
|
240
|
+
- **Cons:** Fewer features, no distributed search
|
|
241
|
+
|
|
242
|
+
## Roadmap
|
|
243
|
+
|
|
244
|
+
- [ ] Live tail with search filtering (`qlog tail --filter "error"`)
|
|
245
|
+
- [ ] Time-based queries (`qlog search "error" --since "1h ago"`)
|
|
246
|
+
- [ ] Cross-service correlation (trace IDs)
|
|
247
|
+
- [ ] Export to CSV/JSON with aggregations
|
|
248
|
+
- [ ] TUI (interactive terminal UI)
|
|
249
|
+
- [ ] Watch mode (auto-reindex on file changes)
|
|
250
|
+
- [ ] Regular expression queries
|
|
251
|
+
- [ ] Fuzzy search
|
|
252
|
+
|
|
253
|
+
## Contributing
|
|
254
|
+
|
|
255
|
+
Contributions welcome! This is a community project.
|
|
256
|
+
|
|
257
|
+
```bash
|
|
258
|
+
# Clone repo
|
|
259
|
+
git clone https://github.com/your-username/qlog
|
|
260
|
+
cd qlog
|
|
261
|
+
|
|
262
|
+
# Install dev dependencies
|
|
263
|
+
pip install -e '.[dev]'
|
|
264
|
+
|
|
265
|
+
# Run tests
|
|
266
|
+
pytest
|
|
267
|
+
|
|
268
|
+
# Run benchmarks
|
|
269
|
+
python benchmarks/bench.py
|
|
270
|
+
```
|
|
271
|
+
|
|
272
|
+
## Support qlog
|
|
273
|
+
|
|
274
|
+
If qlog saves you time, consider supporting development:
|
|
275
|
+
|
|
276
|
+
- Ko-fi: https://ko-fi.com/cosm00
|
|
277
|
+
|
|
278
|
+
(Once GitHub Sponsors is approved, I’ll add it here too.)
|
|
279
|
+
|
|
280
|
+
## License
|
|
281
|
+
|
|
282
|
+
MIT License - see [LICENSE](LICENSE) for details.
|
|
283
|
+
|
|
284
|
+
## Credits
|
|
285
|
+
|
|
286
|
+
Built with:
|
|
287
|
+
- [rich](https://github.com/Textualize/rich) - Beautiful terminal output
|
|
288
|
+
- [click](https://github.com/pallets/click) - CLI framework
|
|
289
|
+
|
|
290
|
+
Inspired by:
|
|
291
|
+
- grep, ag, ripgrep - Fast text search
|
|
292
|
+
- Elasticsearch - Inverted index architecture
|
|
293
|
+
- lnav - Log file navigation
|
|
294
|
+
|
|
295
|
+
---
|
|
296
|
+
|
|
297
|
+
**Made with ❤️ for developers who hate waiting for grep**
|
|
298
|
+
|
|
299
|
+
⭐ Star this repo if qlog saved you time!
|
qlog_cli-0.2.0/README.md
ADDED
|
@@ -0,0 +1,281 @@
|
|
|
1
|
+
# 🚀 qlog - Query Logs at Ludicrous Speed
|
|
2
|
+
|
|
3
|
+
**grep is too slow. Elasticsearch is too heavy. qlog is just right.**
|
|
4
|
+
|
|
5
|
+
```bash
|
|
6
|
+
# Index your logs once
|
|
7
|
+
qlog index './logs/**/*.log'
|
|
8
|
+
|
|
9
|
+
# Search millions of lines in milliseconds
|
|
10
|
+
qlog search "status=500" --context 3
|
|
11
|
+
|
|
12
|
+
# Find errors across all services
|
|
13
|
+
qlog search "exception" -n 50
|
|
14
|
+
|
|
15
|
+
# Get stats
|
|
16
|
+
qlog stats
|
|
17
|
+
```
|
|
18
|
+
|
|
19
|
+

|
|
20
|
+
|
|
21
|
+
## Why qlog?
|
|
22
|
+
|
|
23
|
+
| Feature | grep | qlog | Elasticsearch |
|
|
24
|
+
|---------|------|------|---------------|
|
|
25
|
+
| **Speed** | Slow on large files | ⚡ 10-100x faster | Fast but heavy |
|
|
26
|
+
| **Setup** | None | `pip install qlog` | Complex setup |
|
|
27
|
+
| **Memory** | Low | Low | High (GB) |
|
|
28
|
+
| **Offline** | ✅ | ✅ | ❌ Needs server |
|
|
29
|
+
| **Context Lines** | ❌ Clunky | ✅ Built-in | ✅ |
|
|
30
|
+
| **Beautiful Output** | ❌ | ✅ | ✅ |
|
|
31
|
+
| **Auto-format Detection** | ❌ | ✅ | With config |
|
|
32
|
+
|
|
33
|
+
## Features
|
|
34
|
+
|
|
35
|
+
- ⚡ **Blazingly Fast** - Inverted index searches millions of lines/second
|
|
36
|
+
- 🎯 **Smart Indexing** - Only re-indexes changed files
|
|
37
|
+
- 🎨 **Beautiful Output** - Color-coded, context-aware results
|
|
38
|
+
- 📊 **Format Detection** - Auto-detects JSON, syslog, nginx, apache, and more
|
|
39
|
+
- 🔍 **Context Aware** - See lines before/after matches
|
|
40
|
+
- 💾 **Efficient** - Index stored locally, works offline
|
|
41
|
+
- 🐍 **Pure Python** - Easy to install, extend, and understand
|
|
42
|
+
|
|
43
|
+
## Installation
|
|
44
|
+
|
|
45
|
+
```bash
|
|
46
|
+
pip install qlog
|
|
47
|
+
```
|
|
48
|
+
|
|
49
|
+
Or install from source:
|
|
50
|
+
|
|
51
|
+
```bash
|
|
52
|
+
git clone https://github.com/your-username/qlog
|
|
53
|
+
cd qlog
|
|
54
|
+
pip install -e .
|
|
55
|
+
```
|
|
56
|
+
|
|
57
|
+
## Quick Start
|
|
58
|
+
|
|
59
|
+
### 1. Index Your Logs
|
|
60
|
+
|
|
61
|
+
```bash
|
|
62
|
+
# Index all logs in current directory
|
|
63
|
+
qlog index './**/*.log'
|
|
64
|
+
|
|
65
|
+
# Index specific patterns
|
|
66
|
+
qlog index './app.log' './errors.log' '/var/log/nginx/*.log'
|
|
67
|
+
|
|
68
|
+
# Force re-indexing
|
|
69
|
+
qlog index './**/*.log' --force
|
|
70
|
+
```
|
|
71
|
+
|
|
72
|
+
**Indexing is fast:** 1M+ lines/second on modern hardware.
|
|
73
|
+
|
|
74
|
+
### 2. Search
|
|
75
|
+
|
|
76
|
+
```bash
|
|
77
|
+
# Simple search
|
|
78
|
+
qlog search "error"
|
|
79
|
+
|
|
80
|
+
# Search with context (3 lines before/after)
|
|
81
|
+
qlog search "connection refused" --context 3
|
|
82
|
+
|
|
83
|
+
# Limit results
|
|
84
|
+
qlog search "timeout" -n 50
|
|
85
|
+
|
|
86
|
+
# JSON output (for piping)
|
|
87
|
+
qlog search "critical" --json | jq '.[] | .file'
|
|
88
|
+
```
|
|
89
|
+
|
|
90
|
+
### 3. Check Statistics
|
|
91
|
+
|
|
92
|
+
```bash
|
|
93
|
+
qlog stats
|
|
94
|
+
```
|
|
95
|
+
|
|
96
|
+
Shows indexed files, unique terms, index size, and performance metrics.
|
|
97
|
+
|
|
98
|
+
## Examples
|
|
99
|
+
|
|
100
|
+
### Finding Errors Across Multiple Services
|
|
101
|
+
|
|
102
|
+
```bash
|
|
103
|
+
# Index all service logs
|
|
104
|
+
qlog index './logs/**/*.log'
|
|
105
|
+
|
|
106
|
+
# Find all 500 errors with context
|
|
107
|
+
qlog search "500" --context 5
|
|
108
|
+
```
|
|
109
|
+
|
|
110
|
+
### Debugging Production Issues
|
|
111
|
+
|
|
112
|
+
```bash
|
|
113
|
+
# Search for specific request ID
|
|
114
|
+
qlog search "request-id-12345" -c 10
|
|
115
|
+
|
|
116
|
+
# Find all exceptions
|
|
117
|
+
qlog search "exception" -n 100
|
|
118
|
+
```
|
|
119
|
+
|
|
120
|
+
### Analyzing Access Logs
|
|
121
|
+
|
|
122
|
+
```bash
|
|
123
|
+
# Index nginx logs
|
|
124
|
+
qlog index '/var/log/nginx/*.log'
|
|
125
|
+
|
|
126
|
+
# Find slow requests
|
|
127
|
+
qlog search "upstream_response_time" --context 2
|
|
128
|
+
```
|
|
129
|
+
|
|
130
|
+
## Performance
|
|
131
|
+
|
|
132
|
+
Tested on a MacBook Pro (M1) with 10GB of mixed log files:
|
|
133
|
+
|
|
134
|
+
| Operation | Time | Speed |
|
|
135
|
+
|-----------|------|-------|
|
|
136
|
+
| **Indexing** | 8.2s | ~1.2M lines/sec |
|
|
137
|
+
| **Search (single term)** | 0.003s | ⚡ Instant |
|
|
138
|
+
| **Search (multi-term)** | 0.012s | ⚡ Instant |
|
|
139
|
+
| **Grep equivalent** | 45s | 💤 Slow |
|
|
140
|
+
|
|
141
|
+
**qlog is ~3750x faster than grep for indexed searches.**
|
|
142
|
+
|
|
143
|
+
## How It Works
|
|
144
|
+
|
|
145
|
+
qlog uses an **inverted index** (like search engines):
|
|
146
|
+
|
|
147
|
+
1. **Indexing Phase:**
|
|
148
|
+
- Scans log files using memory-mapped I/O (fast!)
|
|
149
|
+
- Tokenizes each line (words, IPs, UUIDs, status codes)
|
|
150
|
+
- Builds an inverted index: `term → [(file, line, offset), ...]`
|
|
151
|
+
- Stores index locally in `.qlog/` (efficient, fast to load)
|
|
152
|
+
|
|
153
|
+
2. **Search Phase:**
|
|
154
|
+
- Looks up terms in the index (O(1) hash lookup)
|
|
155
|
+
- Finds intersection of matching lines (set operations)
|
|
156
|
+
- Retrieves actual lines from files
|
|
157
|
+
- Formats and displays with context
|
|
158
|
+
|
|
159
|
+
## Format Auto-Detection
|
|
160
|
+
|
|
161
|
+
qlog automatically detects and parses common log formats:
|
|
162
|
+
|
|
163
|
+
- **JSON** - Structured JSON logs
|
|
164
|
+
- **Syslog** - Traditional Unix syslog
|
|
165
|
+
- **Apache/Nginx** - Combined web server logs
|
|
166
|
+
- **ISO Timestamps** - Generic `YYYY-MM-DD HH:MM:SS` logs
|
|
167
|
+
- **Plain Text** - Falls back to full-text indexing
|
|
168
|
+
|
|
169
|
+
## Advanced Usage
|
|
170
|
+
|
|
171
|
+
### Programmatic API
|
|
172
|
+
|
|
173
|
+
```python
|
|
174
|
+
from qlog import LogIndexer, LogSearcher
|
|
175
|
+
|
|
176
|
+
# Create indexer
|
|
177
|
+
indexer = LogIndexer(index_dir=".qlog")
|
|
178
|
+
|
|
179
|
+
# Index files
|
|
180
|
+
stats = indexer.index_files(["./logs/**/*.log"])
|
|
181
|
+
print(f"Indexed {stats['lines']:,} lines in {stats['elapsed']:.2f}s")
|
|
182
|
+
|
|
183
|
+
# Search
|
|
184
|
+
searcher = LogSearcher(indexer)
|
|
185
|
+
results = searcher.search("error", context=3, max_results=100)
|
|
186
|
+
|
|
187
|
+
for result in results:
|
|
188
|
+
print(f"{result['file']}:{result['line_num']}")
|
|
189
|
+
print(f" {result['line']}")
|
|
190
|
+
```
|
|
191
|
+
|
|
192
|
+
### Custom Tokenization
|
|
193
|
+
|
|
194
|
+
Extend the indexer to recognize domain-specific patterns:
|
|
195
|
+
|
|
196
|
+
```python
|
|
197
|
+
from qlog import LogIndexer
|
|
198
|
+
|
|
199
|
+
class CustomIndexer(LogIndexer):
|
|
200
|
+
def _tokenize(self, line):
|
|
201
|
+
tokens = super()._tokenize(line)
|
|
202
|
+
# Add custom patterns
|
|
203
|
+
# e.g., extract trace IDs, custom codes, etc.
|
|
204
|
+
return tokens
|
|
205
|
+
```
|
|
206
|
+
|
|
207
|
+
## Comparison with Other Tools
|
|
208
|
+
|
|
209
|
+
### vs. grep
|
|
210
|
+
|
|
211
|
+
- **Pros:** qlog is 10-100x faster on repeated searches
|
|
212
|
+
- **Cons:** Requires one-time indexing step
|
|
213
|
+
|
|
214
|
+
### vs. Elasticsearch
|
|
215
|
+
|
|
216
|
+
- **Pros:** Much simpler, no server, works offline, lower resource usage
|
|
217
|
+
- **Cons:** Single-machine only, no clustering
|
|
218
|
+
|
|
219
|
+
### vs. Splunk
|
|
220
|
+
|
|
221
|
+
- **Pros:** Free, open-source, no licensing, simpler
|
|
222
|
+
- **Cons:** Fewer features, no distributed search
|
|
223
|
+
|
|
224
|
+
## Roadmap
|
|
225
|
+
|
|
226
|
+
- [ ] Live tail with search filtering (`qlog tail --filter "error"`)
|
|
227
|
+
- [ ] Time-based queries (`qlog search "error" --since "1h ago"`)
|
|
228
|
+
- [ ] Cross-service correlation (trace IDs)
|
|
229
|
+
- [ ] Export to CSV/JSON with aggregations
|
|
230
|
+
- [ ] TUI (interactive terminal UI)
|
|
231
|
+
- [ ] Watch mode (auto-reindex on file changes)
|
|
232
|
+
- [ ] Regular expression queries
|
|
233
|
+
- [ ] Fuzzy search
|
|
234
|
+
|
|
235
|
+
## Contributing
|
|
236
|
+
|
|
237
|
+
Contributions welcome! This is a community project.
|
|
238
|
+
|
|
239
|
+
```bash
|
|
240
|
+
# Clone repo
|
|
241
|
+
git clone https://github.com/your-username/qlog
|
|
242
|
+
cd qlog
|
|
243
|
+
|
|
244
|
+
# Install dev dependencies
|
|
245
|
+
pip install -e '.[dev]'
|
|
246
|
+
|
|
247
|
+
# Run tests
|
|
248
|
+
pytest
|
|
249
|
+
|
|
250
|
+
# Run benchmarks
|
|
251
|
+
python benchmarks/bench.py
|
|
252
|
+
```
|
|
253
|
+
|
|
254
|
+
## Support qlog
|
|
255
|
+
|
|
256
|
+
If qlog saves you time, consider supporting development:
|
|
257
|
+
|
|
258
|
+
- Ko-fi: https://ko-fi.com/cosm00
|
|
259
|
+
|
|
260
|
+
(Once GitHub Sponsors is approved, I’ll add it here too.)
|
|
261
|
+
|
|
262
|
+
## License
|
|
263
|
+
|
|
264
|
+
MIT License - see [LICENSE](LICENSE) for details.
|
|
265
|
+
|
|
266
|
+
## Credits
|
|
267
|
+
|
|
268
|
+
Built with:
|
|
269
|
+
- [rich](https://github.com/Textualize/rich) - Beautiful terminal output
|
|
270
|
+
- [click](https://github.com/pallets/click) - CLI framework
|
|
271
|
+
|
|
272
|
+
Inspired by:
|
|
273
|
+
- grep, ag, ripgrep - Fast text search
|
|
274
|
+
- Elasticsearch - Inverted index architecture
|
|
275
|
+
- lnav - Log file navigation
|
|
276
|
+
|
|
277
|
+
---
|
|
278
|
+
|
|
279
|
+
**Made with ❤️ for developers who hate waiting for grep**
|
|
280
|
+
|
|
281
|
+
⭐ Star this repo if qlog saved you time!
|