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.29.0.tar.gz (12.7 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.29.0-py3-none-any.whl (10.7 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: log_analyzer_sattarab-0.29.0.tar.gz
  • Upload date:
  • Size: 12.7 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.29.0.tar.gz
Algorithm Hash digest
SHA256 18eceb86a20392506e39ebad69d4170cbffe7ccfa88b0d9398d74039c6d09d86
MD5 49839200bc87aa870832502c7cf9f682
BLAKE2b-256 85b770eb23575ddc5a6e27f5fbea80463a9de2812fe4a76e1ed23848375151bd

See more details on using hashes here.

Provenance

The following attestation bundles were made for log_analyzer_sattarab-0.29.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.29.0-py3-none-any.whl.

File metadata

File hashes

Hashes for log_analyzer_sattarab-0.29.0-py3-none-any.whl
Algorithm Hash digest
SHA256 22f9f8f13dc51be8c5f4d6ef21cc6a9e19958d165aae484ff3b678e175349081
MD5 b062da44badf5cfc6fcfd536ffff19cd
BLAKE2b-256 101e9e71c6cd4a4a6fae26436aeb0c4d107a583bdacea9acb65f82b7def0b81d

See more details on using hashes here.

Provenance

The following attestation bundles were made for log_analyzer_sattarab-0.29.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