Skip to content

mihirsn/planck

Repository files navigation

> planck

Observe behavior at the smallest scale.
Meaningful insights from logs with near-zero operational overhead.

CI Latest Release License: MIT Go Version Status: Early Alpha


Planck is in active early development. The log format, CLI flags, and JSON output schema may change between versions without a deprecation period.

Platform testing: Manually tested and verified on macOS arm64 only. Unit tests pass on Linux (ubuntu-latest) via CI. Binaries for Linux and Windows are built via goreleaser but have not yet been manually verified. If you try Planck on Linux or Windows and run into issues, please open a bug report — your feedback helps.

Feedback, bug reports, and ideas are very welcome.


📖 Read the full documentation in the /docs folder

Overview

Planck transforms raw application logs into actionable operational insights — without requiring Prometheus, Grafana, databases, or agents.

Planck is not another Prometheus or Grafana and does not intend to, rather its built for developers running applications on Docker, VPS, and small cloud environments who rely primarily on logs. Most observability tools assume you already have a metrics pipeline. Small teams, self-hosted apps, and early-stage products often don't.

Planck bridges that gap: give it a log file or a Docker container name, and it tells you what's actually happening.

> Planck Analysis
──────────────────────────────────────────────────
Source:          Docker container "my-api"
Total requests:  12,430

🔥 Top endpoints
  /invoice                       ████████░░░░░░░░░░░░  42.1%
  /login                         ████░░░░░░░░░░░░░░░░  18.3%
  /checkout                      ██░░░░░░░░░░░░░░░░░░  11.2%

⏰ Traffic by hour (UTC)
  14:00  ████████████████████  3,200
  15:00  ██████████████████░░  2,900

⚠️  Error rates
  /checkout                      50.0%
  /invoice                       28.6%

🐢 Slow endpoints
  /checkout                      avg: 1103ms  p95: 1980ms

💡 Insights
  ⚠ /checkout has a high error rate of 50.0%
  ⚠ /checkout is slow (avg: 1103ms, p95: 1980ms)

Quick Install

# macOS / Linux
curl -sSL "https://github.com/mihirsn/planck/releases/latest/download/planck_$(uname -s | tr '[:upper:]' '[:lower:]')_$(uname -m | sed 's/x86_64/amd64/;s/aarch64/arm64/').tar.gz" | tar -xz
sudo mv planck /usr/local/bin/

(See the Installation Guide for go install and source build options).

Quick Start

Planck has two primary modes of operation.

1. Analyze Mode (Ad-hoc insights)

Parse a log file or a Docker container's current log stream and generate a summary report.

planck analyze --docker my-api

2. Watch Mode (Continuous monitoring)

Continuously monitor a Docker container's logs and send real-time push notifications via ntfy.sh when things go wrong.

planck watch --docker my-api

(See the Watch Mode Docs for configuration and production deployment details).


Documentation Directory

Dive into the full documentation:


License

MIT

About

Operational insights from application logs, without the overhead.

Topics

Resources

License

Contributing

Stars

Watchers

Forks

Packages

 
 
 

Contributors