kelora 0.8.0

A command-line log analysis tool with embedded Rhai scripting
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
# Getting Started: Input, Display & Filtering

Master the essential commands for reading logs, controlling display output, and filtering by log level. This tutorial covers the foundation you'll use in every Kelora workflow.

## What You'll Learn

- Specify input formats with `-f` and `-j`
- Control what fields are displayed with `-b`, `-c`, `-k`, and `-K`
- Filter events by log level with `-l` and `-L`
- Export data in different formats with `-F` and `-J`
- Combine options for common workflows

## Prerequisites

- Kelora installed and in your PATH
- Basic command-line familiarity

## Sample Data

Commands below use example files from the repository:

- `examples/simple_json.jsonl` — JSON-formatted application logs with multiple services

If you cloned the project, run commands from the repository root.

---

## Part 1: Input Formats (`-f`, `-j`)

### Explicit Format Selection Required

**Important:** Kelora does **NOT** auto-detect format based on filename. The default is `-f line` (plain text). You must specify the format explicitly.

Let's see what happens without specifying the format:

=== "Command"

    ```bash
    kelora examples/simple_json.jsonl --take 2
    ```

=== "Output"

    ```bash exec="on" source="above" result="ansi"
    kelora examples/simple_json.jsonl --take 2
    ```

Notice it treats the entire JSON line as plain text (`line='...'`). Now with `-j`:

=== "Command"

    ```bash
    kelora -j examples/simple_json.jsonl --take 2
    ```

=== "Output"

    ```bash exec="on" source="above" result="ansi"
    kelora -j examples/simple_json.jsonl --take 2
    ```

**Three ways to read JSON logs:**

```bash
kelora -f json examples/simple_json.jsonl    # Explicit format
kelora -j examples/simple_json.jsonl         # -j is shortcut for -f json
kelora -f auto examples/simple_json.jsonl    # Auto-detect by examining content
```

**Key Points:**

- `-f auto` detects format by **examining the content** (not filename)
- ❌ Kelora does **NOT** look at file extensions (`.jsonl`, `.log`, `.csv`)
- ✅ Default is always `-f line` unless you specify otherwise
- ✅ Best practice: Be explicit with `-j` for JSON

### Common Input Formats

```bash
-f json         # JSON lines (or use -j shortcut)
-f logfmt       # key=value format
-f combined     # Apache/Nginx access logs
-f syslog       # Syslog format (RFC3164/RFC5424)
-f csv          # CSV with header
-f tsv          # Tab-separated values
-f line         # Plain text (default)
-f auto         # Auto-detect by content
```

---

## Part 2: Understanding the Default Display

Let's examine what Kelora shows by default:

=== "Command"

    ```bash
    kelora -j examples/simple_json.jsonl --take 3
    ```

=== "Output"

    ```bash exec="on" source="above" result="ansi"
    kelora -j examples/simple_json.jsonl --take 3
    ```

**The default output format shows:**

- **Field names and values** in `key='value'` format
-**Automatic wrapping** - long events wrap with indentation
-**Colors** (when terminal supports it)
-**Smart ordering** - timestamp, level, message first, then others alphabetically

![Colored key-value output in the default formatter](../screenshots/colored-output.gif)

**Key observations:**

1. Strings are quoted (`'Application started'`)
2. Numbers are not quoted (`max_connections=50`)
3. Fields wrap to next line when too long
4. Each event is separated by a blank line
5. Field names are highlighted in color for better readability

---

## Part 3: Display Modifiers (`-b`, `-c`, `-k`, `-K`)

### Brief Mode (`-b`) - Values Only

Omit field names, show only values for compact output:

=== "Command"

    ```bash
    kelora -j examples/simple_json.jsonl -b --take 3
    ```

=== "Output"

    ```bash exec="on" source="above" result="ansi"
    kelora -j examples/simple_json.jsonl -b --take 3
    ```

**Use `-b` when:** You want compact, grep-friendly output.

### Core Fields (`-c`) - Essentials Only

Show only timestamp, level, and message:

=== "Command"

    ```bash
    kelora -j examples/simple_json.jsonl -c --take 3
    ```

=== "Output"

    ```bash exec="on" source="above" result="ansi"
    kelora -j examples/simple_json.jsonl -c --take 3
    ```

**Use `-c` when:** You want to focus on the essentials, hiding extra metadata.

### Select Fields (`-k`) - Choose What to Show

Choose exactly which fields to show (and in what order):

=== "Command"

    ```bash
    kelora -j examples/simple_json.jsonl -k level,service,message --take 3
    ```

=== "Output"

    ```bash exec="on" source="above" result="ansi"
    kelora -j examples/simple_json.jsonl -k level,service,message --take 3
    ```

**Pro tip:** Fields appear in the order you specify!

### Exclude Fields (`-K`) - Hide Sensitive Data

Remove specific fields (like passwords, tokens, or verbose metadata):

=== "Command"

    ```bash
    kelora -j examples/simple_json.jsonl -K service,version --take 3
    ```

=== "Output"

    ```bash exec="on" source="above" result="ansi"
    kelora -j examples/simple_json.jsonl -K service,version --take 3
    ```

**Use `-K` when:** Hiding sensitive data (passwords, API keys) or reducing noise.

---

## Part 4: Level Filtering (`-l`, `-L`)

### Include Levels (`-l`) - Show Only Specific Log Levels

Filter to show only errors and warnings:

=== "Command"

    ```bash
    kelora -j examples/simple_json.jsonl -l error,warn
    ```

=== "Output"

    ```bash exec="on" source="above" result="ansi"
    kelora -j examples/simple_json.jsonl -l error,warn
    ```

**Common patterns:**

```bash
kelora -j app.log -l error                    # Errors only
kelora -j app.log -l error,warn,critical      # Problems only (case-insensitive)
kelora -j app.log -l info                     # Application flow (skip debug noise)
```

### Exclude Levels (`-L`) - Hide Debug Noise

Remove verbose log levels:

=== "Command"

    ```bash
    kelora -j examples/simple_json.jsonl -L debug,info --take 5
    ```

=== "Output"

    ```bash exec="on" source="above" result="ansi"
    kelora -j examples/simple_json.jsonl -L debug,info --take 5
    ```

**Use `-L` when:** You want to exclude chatty debug/trace output.

---

## Part 5: Output Formats (`-F`, `-J`)

The default `key='value'` format is great for reading, but sometimes you need machine-readable output.

### JSON Output (`-F json` or `-J`)

=== "Command"

    ```bash
    kelora -j examples/simple_json.jsonl -J --take 2
    ```

=== "Output"

    ```bash exec="on" source="above" result="ansi"
    kelora -j examples/simple_json.jsonl -J --take 2
    ```

**Use JSON when:** Piping to `jq`, saving to file, or integrating with other tools.

### CSV Output (`-F csv`)

Perfect for spreadsheet export:

=== "Command"

    ```bash
    kelora -j examples/simple_json.jsonl -F csv -k timestamp,level,service,message --take 4
    ```

=== "Output"

    ```bash exec="on" source="above" result="ansi"
    kelora -j examples/simple_json.jsonl -F csv -k timestamp,level,service,message --take 4
    ```

**Use CSV when:** Exporting to Excel, Google Sheets, or data analysis tools.

### Logfmt Output (`-F logfmt`)

=== "Command"

    ```bash
    kelora -j examples/simple_json.jsonl -F logfmt --take 2
    ```

=== "Output"

    ```bash exec="on" source="above" result="ansi"
    kelora -j examples/simple_json.jsonl -F logfmt --take 2
    ```

**Use logfmt when:** You want parseable output that's also human-readable.

### Inspect Output (`-F inspect`) - Debug with Types

=== "Command"

    ```bash
    kelora -j examples/simple_json.jsonl -F inspect --take 1
    ```

=== "Output"

    ```bash exec="on" source="above" result="ansi"
    kelora -j examples/simple_json.jsonl -F inspect --take 1
    ```

**Use inspect when:** Debugging type mismatches or understanding field types.

### No Output (`-F none`) - Stats Only

=== "Command"

    ```bash
    kelora -j examples/simple_json.jsonl -F none --stats
    ```

=== "Output"

    ```bash exec="on" source="above" result="ansi"
    kelora -j examples/simple_json.jsonl -F none --stats
    ```

**Use `-F none --stats` when:** You want to analyze log structure without seeing the events.

---

## Part 6: Practical Combinations

### Exercise 1: Find Errors, Show Essentials

Show only errors with just timestamp, service, and message:

=== "Command"

    ```bash
    kelora -j examples/simple_json.jsonl -l error -k timestamp,service,message
    ```

=== "Output"

    ```bash exec="on" source="above" result="ansi"
    kelora -j examples/simple_json.jsonl -l error -k timestamp,service,message
    ```

### Exercise 2: Export Problems to CSV

Export warnings and errors to CSV for Excel analysis:

=== "Command"

    ```bash
    kelora -j examples/simple_json.jsonl -l error,warn -k timestamp,level,service,message -F csv
    ```

=== "Output"

    ```bash exec="on" source="above" result="ansi"
    kelora -j examples/simple_json.jsonl -l error,warn -k timestamp,level,service,message -F csv
    ```

### Exercise 3: Compact View Without Debug

Brief output excluding debug noise:

=== "Command"

    ```bash
    kelora -j examples/simple_json.jsonl -L debug -b --take 5
    ```

=== "Output"

    ```bash exec="on" source="above" result="ansi"
    kelora -j examples/simple_json.jsonl -L debug -b --take 5
    ```

---

## Quick Reference Cheat Sheet

### Input Formats
```bash
-f json         # JSON lines (or use -j shortcut)
-f logfmt       # key=value format
-f combined     # Apache/Nginx access logs
-f syslog       # Syslog format
-f csv          # CSV with header
-f line         # Plain text (default)
-f auto         # Auto-detect by content
```

### Display Modifiers
```bash
-b              # Brief: values only, no field names
-c              # Core: timestamp + level + message only
-k level,msg    # Keys: show only these fields (in this order)
-K password,ip  # Exclude: hide these fields
```

### Level Filtering
```bash
-l error,warn   # Include: show only these levels
-L debug,trace  # Exclude: hide these levels
```

### Output Formats
```bash
-F default      # Pretty key='value' with colors (default)
-F json         # JSON lines (or use -J shortcut)
-F csv          # CSV with header
-F logfmt       # Logfmt key=value
-F inspect      # Debug with types
-F none         # No output (use with --stats)
```

---

## Understanding the Pipeline Order

Kelora processes your options in this order:

```
1. Read file      (-f json, -j)
2. Filter levels  (-l error, -L debug)
3. Select fields  (-k, -K, -c)
4. Format output  (-F csv, -J, -b)
5. Write output   (stdout or -o file)
```

**This means:**

- `-l` filters happen **before** `-k` (you can filter on fields you won't see in output)
- `-b` affects display, not what gets filtered
- `-F none --stats` still processes everything, just doesn't show events

---

## Common Workflows

### Error Analysis Pipeline
```bash
kelora -j app.log -l error -k timestamp,service,message -F csv -o errors.csv
# Filter → Select fields → Export to CSV → Save to file
```

### Quick Scan (Hide Noise)
```bash
kelora -j app.log -L debug,trace -b --take 20
# Exclude verbose levels → Brief output → First 20 events
```

### Investigation Mode (Full Detail)
```bash
kelora -j app.log -l warn,error,critical -K password,token
# Show problems → Hide sensitive data → Keep all other fields
```

### Stats-Only Analysis
```bash
kelora -j app.log -F none --stats
# No event output → Show processing statistics
```

---

## When to Use What

| Goal | Use | Example |
|------|-----|---------|
| **Find errors fast** | `-l error` | `kelora -j app.log -l error -c` |
| **Hide debug spam** | `-L debug,trace` | `kelora -j app.log -L debug` |
| **Export to Excel** | `-F csv` | `kelora -j app.log -F csv -o report.csv` |
| **Pipe to jq** | `-J` | `kelora -j app.log -J \| jq '.level'` |
| **Quick scan** | `-b --take 20` | `kelora -j app.log -b --take 20` |
| **Hide secrets** | `-K password,token` | `kelora -j app.log -K password,apikey` |
| **See types** | `-F inspect` | `kelora -j app.log -F inspect` |

---

## Next Steps

Once you're comfortable with these basics, continue to:

- **[Working with Time]working-with-time.md** - Time filtering with `--since` and `--until`
- **[Scripting Transforms]scripting-transforms.md** - Custom filters and transformations with Rhai
- **[Metrics and Tracking]metrics-and-tracking.md** - Aggregate data with `track_*()` functions
- **[Parsing Custom Formats]parsing-custom-formats.md** - Handle non-standard log formats