Skip to main content

Command-line tool to analyze log files and summarize counts by level.

Project description

Quick Start

log-analyzer -f sample.log
log-analyzer -f sample.log --format csv
log-analyzer -f dated.log --date-summary

A small CLI tool that reads a log file, counts log levels, and outputs the counts in a chosen format.
CLI tool to count log levels (INFO/WARNING/ERROR/DEBUG) in a log file.

## Date Summary

Group logs by date and count levels per day:

```bash
log-analyzer -f dated.log --date-summary

Sort by date

log-analyzer -f dated.log --date-summary --sort date

Sort by total count

log-analyzer -f dated.log --date-summary --sort total

Reverse order

log-analyzer -f dated.log --date-summary --sort date --reverse

Mininmum total filter

``bash Show only dates with total logs >= N: log-analyzer -f dated.log --date-summary --min-total 2


#### Limit number of rows

```bash
log-analyzer -f dated.log --date-summary --limit 2

CSV output

log-analyzer -f dated.log --date-summary --format csv

JSON output

log-analyzer -f dated.log --date-summary --format json --indent 2

Example output

2026-03-01 ERROR: 1 (50.0%) WARNING: 0 (0.0%) INFO: 1 (50.0%) DEBUG: 0 (0.0%) TOTAL: 2
2026-04-01 ERROR: 0 (0.0%) WARNING: 0 (0.0%) INFO: 2 (66.7%) DEBUG: 1 (33.3%) TOTAL: 3

Date Filtering

Filter logs by date before counting or summarizing.

Since date

log-analyzer -f dated.log --since 2026-03-10

Until date

log-analyzer -f dated.log --until 2026-04-01

Since and until together

log-analyzer -f dated.log --since 2026-03-10 --until 2026-04-01

Today only

log-analyzer -f dated.log --today

Last N days

log-analyzer -f dated.log --last-days 7

Date filtering with date summary

log-analyzer -f dated.log --since 2026-03-10 --date-summary

Combined Usage Examples

Use multiple options together for more control.

Date range + summary + sort

log-analyzer -f dated.log --since 2026-03-01 --until 2026-04-01 --date-summary --sort total

Date summary + minimum total + limit

log-analyzer -f dated.log --date-summary --min-total 2 --limit 3

Date summary + reverse order

log-analyzer -f dated.log --date-summary --sort date --reverse

Date filtering + CSV output

log-analyzer -f dated.log --since 2026-03-01 --format csv

Date filtering + JSON output

log-analyzer -f dated.log --last-days 7 --format json --indent 2

Summary shortcut

log-analyzer -f dated.log --summary

Equivalent to:

log-analyzer -f dated.log --date-summary --sort total

Combine multiple options for more control.

log-analyzer -f dated.log --since 2026-03-01 --until 2026-04-01 --date-summary --min-total 2 --sort total --reverse --limit 5 --format json --indent 2

Install (editable / development)

From the project root:

pip install -e .

Show help: bash log-analyzer -h

Run with default settings  
(uses data/sample.log, table format, sorted by level):

```bash
logan

Specify a log file:

logan -f data/sample.log

Output formats

Table (default):

logan -f data/sample.log --format table

Example output ERROR: 2 WARNING: 1 INFO: 3 DEBUG: 0

CSV:

logan -f data/sample.log --format csv

JSON:

logan -f data/sample.log --format json

Example output:

{
  "ERROR": 2,
  "WARNING": 1,
  "INFO": 3,
  "DEBUG": 0
}


Sorting

Sort by log level order (default):

```bash
logan -f data/sample.log --sort level

Sort by count (largest first):

logan -f data/sample.log --sort count

Reverse final order:

logan -f data/sample.log --sort count --reverse

Write Output to a file Write out put to a file instead of printing to the console:

logan -f data/sample.log format table --output out.txt
---

To overwrite an existing file:

```bash
logan -f data/sample.log --output out.csv --force

if the file is open(for example in Excel),the CLIwill return an error.

Filtering Specific Levels
you can limit output to specific log levels:

```bash
logan -f data/sample.log --level ERROR WARNING

Exit Codes
o - Success
2 - CLI erroe or file wrie failure

## Design notes

`run_logic(...)` is a pure function:
- no argparse
- no printing
- no sys.exit
- returns ordered counts

`main(...)` handles CLI parsing and error handling.

Printers only print data and do not sort.

---

## Tests

Run all tests:

```bash
python -m pytest

Final check

  • CLI runs correctly
  • All tests pass
  • Editable install works (pip install -e .)

Testing GitHub Actions workflow

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

log_analyzer_sattarab-0.38.0.tar.gz (16.5 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

log_analyzer_sattarab-0.38.0-py3-none-any.whl (12.6 kB view details)

Uploaded Python 3

File details

Details for the file log_analyzer_sattarab-0.38.0.tar.gz.

File metadata

  • Download URL: log_analyzer_sattarab-0.38.0.tar.gz
  • Upload date:
  • Size: 16.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for log_analyzer_sattarab-0.38.0.tar.gz
Algorithm Hash digest
SHA256 859080ada0438ddb78363a56f4eb56db44cbe71e2c08659a761825bc3c404c64
MD5 cc0b268d30b8a6d18561451513a9a8a4
BLAKE2b-256 0abaf7aab90c59ac0d0e9fbe815ce550edf359c0b4096883b8e8146a38cbffb3

See more details on using hashes here.

Provenance

The following attestation bundles were made for log_analyzer_sattarab-0.38.0.tar.gz:

Publisher: python-package.yml on sattarab54/log-analyzer

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file log_analyzer_sattarab-0.38.0-py3-none-any.whl.

File metadata

File hashes

Hashes for log_analyzer_sattarab-0.38.0-py3-none-any.whl
Algorithm Hash digest
SHA256 2d3b7c4e45871e4e6b8142e010aa58d6affb643de0fae5e010d6b7d676fcc490
MD5 191acdfa4d91e761c794c9ef46ac2060
BLAKE2b-256 dd6f84b2259c17f3aa727923c18535f2194130945c4b3a60fec22cecc5bfbad2

See more details on using hashes here.

Provenance

The following attestation bundles were made for log_analyzer_sattarab-0.38.0-py3-none-any.whl:

Publisher: python-package.yml on sattarab54/log-analyzer

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page