Rene Nochebuena
14687cfc2f
All checks were successful
Go CI/CD / go-ci (push) Successful in 10m3s
Reviewed-on: #2 Reviewed-by: Cloud Administrator <cloud-admin@noreply.gitstormr.dev> Co-authored-by: Rene Nochebuena <code-raider@noreply.gitstormr.dev> Co-committed-by: Rene Nochebuena <code-raider@noreply.gitstormr.dev>
92 lines
3.2 KiB
Markdown
92 lines
3.2 KiB
Markdown
# π₯ Stonelog - 10 Billion Times Better Logging!
|
|
|
|
The most scientifically badass logging library from the Kingdom of Science!
|
|
|
|
[]()
|
|
[]()
|
|
[]()
|
|
|
|
## π Why Stonelog?
|
|
|
|
- Dr.Stone-themed logging that Senku would approve
|
|
- Dramatic error messages worthy of a lab explosion
|
|
- Character quotes from your favorite scientists
|
|
- 10 billion watts of scientific swagger
|
|
|
|
## π₯ Installation
|
|
|
|
```bash
|
|
go get gitstormr.dev/stone-utils/stonelog@latest
|
|
```
|
|
|
|
## β‘ Initialization
|
|
|
|
```go
|
|
package main
|
|
|
|
import (
|
|
"gitstormr.dev/stone-utils/stonelog"
|
|
)
|
|
|
|
func main() {
|
|
// Basic configuration (INFO level by default)
|
|
stonelog.InitStoneLog(stonelog.INFO, false, false) // false = text mode (true = JSON), false = keep suffixes (true = don't add character quotes)
|
|
|
|
// Example logs
|
|
stonelog.Observation("System initialized successfully!")
|
|
stonelog.Failure("Reactor core temperature critical!")
|
|
}
|
|
```
|
|
|
|
## π Log Levels (Scientific Style!)
|
|
|
|
| Function | Level Equivalent | Example Output |
|
|
|---------------|--------------------|--------------------------------------------------|
|
|
| Trace() | TRACE | π Science traces: Entering function X |
|
|
| Debug() | DEBUG | π€ Hypothesis forming: Variable X = 42 |
|
|
| Observation() | INFO | β
Experiment successful: User logged in |
|
|
| Hypothesis() | WARN | β οΈ Anomaly detected: High memory usage |
|
|
| Failure() | ERROR | π₯ Critical malfunction: DB disconnected |
|
|
| Meltdown() | FATAL | β οΈ FINAL EXPERIMENT FAILED: Server exploded |
|
|
| Panic() | PANIC | π¨ CHAIN REACTION DETECTED: Unrecoverable error |
|
|
|
|
## ποΈ Changing Log Level
|
|
|
|
```go
|
|
// Dynamic change! (e.g., enable DEBUG in production)
|
|
stonelog.SetLogLevel(stonelog.DEBUG)
|
|
```
|
|
|
|
## π¬ JSON Mode (For Production)
|
|
|
|
```go
|
|
stonelog.InitStoneLab(stonelog.STONE_DEBUG, true, false) // true = JSON, false = Keep suffixes
|
|
// Output: {"time":"2023-07-15T12:00:00Z","level":"OBSERVATION","message":"β
Experiment successful: System ready","caller":"main.go:15"}
|
|
```
|
|
|
|
## **π¨ WINDOWS COLOR SUPPORT NOTICE π¨**
|
|
|
|
*"HEY WINDOWS USERS! YOUR TERMINALS NEED SOME SCIENCE!" - Chrome*
|
|
|
|
π¬ **Current Limitations:**
|
|
- Colors don't work in old Windows Command Prompt (CMD)
|
|
- Looks boring in black & white (like stone tablets!)
|
|
- Works perfectly in modern terminals
|
|
|
|
π‘ **Senku-Approved Solutions:**
|
|
1. Install **Windows Terminal** (Microsoft Store)
|
|
2. Use **WSL** (Windows Subsystem for Linux)
|
|
3. Try **VS Code** or **Git Bash**
|
|
|
|
*"This temporary setback represents just 0.0000001% of our scientific progress!"*
|
|
- **Dr. Senku Ishigami**
|
|
|
|
*(Chrome whispers: "Pssst... Linux terminals are SO BADASS!")* π§π₯
|
|
|
|
**Join the Scientific Revolution!**
|
|
|
|
> "This isn't just logging - it's 10 billion percent scientific progress!" - Senku Ishigami
|
|
|
|
Kingdom of Science Approved
|
|
|
|
(Now with 100% more Chrome screaming "SO BADASS!") |