Skip to main content

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

Project description

log-analyzer

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.

Install (editable / development)

From the project root:

pip install -e .

Run

Show help:

logan -h

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

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.2.3.tar.gz (8.2 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.2.3-py3-none-any.whl (8.1 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: log_analyzer_sattarab-0.2.3.tar.gz
  • Upload date:
  • Size: 8.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.13.12

File hashes

Hashes for log_analyzer_sattarab-0.2.3.tar.gz
Algorithm Hash digest
SHA256 7bb16b27b5d70f56a89d1120fee62fbc297f697b7b1e9b2bf5c3954c0dc63cdb
MD5 a9336e41f81634cd771c4b7f7cf1b924
BLAKE2b-256 b7fcba5cd64f27355c3734cb0af5c15810d1e5dc0e7aa224fc6f8efec2610f6c

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for log_analyzer_sattarab-0.2.3-py3-none-any.whl
Algorithm Hash digest
SHA256 0562b2be795ef12fba78ead97bd9f339abaff1e7971ff9cf6e412e1340316080
MD5 b797013e833a4e8e9e30d2668dfd67bf
BLAKE2b-256 97feb72a12aac167b5174883771fd1672ea9beaf7cfc58849b03182769ac1b9c

See more details on using hashes here.

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