humanlog - GitLite

KO | EN

gitlite — search

#react #typescript #llm #golang #go #machine-learning #deep-learning #docker #windows #vue #awesome-list #security #mcp #open-source

humanlog

(★ 963)

Observability on your laptop

File Explorer

Download Latest Version (.zip)

- - go.yml
  - golangci-lint.yml
  - release-dev.yml
  - release.yml
- launch.json
- - config.go
  - config_test.go
  - log.go
  - main.go
  - main_test.go
  - versions.go
- alert-architecture-summary.md
- dashboard-authoring-proposal.md
- - resolve.go
  - resolve_test.go
- - interceptors.go
  - token_source.go
- - sink.go
- build.sh
- create_version_artifacts.sh
- dev-runclean.sh
- dev-test-fresh-install.sh
- dev-test-noninteractive-install.sh
- dev-test-noninteractive-install_apictl.sh
- dev-test-reinstall-empty-state.sh
- dev-test-reinstall-rejected-query-engine-last-year.sh
- dev-test-reinstall-rejected-query-engine.sh
- dev-test-reinstall-rejected-signup-last-year.sh
- dev-test-reinstall-rejected-signup.sh
- publish.sh
- write_version_info.sh
- modules.txt
.gitignore
.goreleaser-dev.yaml
.goreleaser.yaml
benchmark_test.go
docker_compose_handler.go
e2e_test.go
go.mod
go.sum
handler.go
json_handler.go
json_handler_test.go
LICENSE.md
logfmt_handler.go
optimize.go
README.md
scanner.go
scanner_test.go
time_parse.go
time_parse_test.go
zap_development_handler.go
zap_development_handler_test.go

# Installation Guide

1. Get the code

git clone https://github.com/humanlogio/humanlog

Downloads the entire project code from GitHub to your computer.

cd humanlog

Moves into the project folder you just downloaded.

2. Official Install Script

Easy Recommended

curl -sSL "https://humanlog.io/install.sh" | bash

Downloads and runs the official install script in one line — this handles the full setup automatically.

✅ After installing, open a new terminal and run the program's version command (e.g. --version) to confirm it worked.

Pulled directly from this repo's README.

3. Go

Medium

Prerequisites

Git Needed to download the project code from GitHub.
Go The Go compiler and toolchain.

go build ./...

Compiles the Go program into an executable.

go run .

Runs the Go program directly without a separate build step.

✅ If the build finishes without errors, it worked. If you used go run ., check the terminal output.

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# humanlog

Read logs from `stdin` and prints them back to `stdout`, but prettier. It's also a localhost observability platform, supporting logs and distributed traces.

# Using it

```bash
curl -sSL "https://humanlog.io/install.sh" | bash
```

Read more at 👉 [how to install](https://humanlog.io/docs/get-started/installation) in our docs.

# Getting started

You can use `humanlog` in the CLI to make your logs prettier. You can also use it as a localhost observability platform to be able to explore the logs and traces that you ingested. Logs parsed by humanlog are persisted in a local database. Similarly, traces are ingested and persisted in a local database when sent via OpenTelemetry/OTLP.

Read more at 👉 [how to get started](https://humanlog.io/docs/get-started/basic-usage) in our docs.

## Example - pretty-printing logs

If you emit logs in JSON or in [`logfmt`](https://brandur.org/logfmt), you will enjoy pretty logs when those
entries are encountered by `humanlog`. Unrecognized lines are left unchanged.

```bash
$ humanlog < /var/log/logfile.log
```

![example CLI usage](https://github.com/user-attachments/assets/d313b4df-30d4-423e-8ea4-f7a34e4e2c60)

When the logs are parsed, they are persisted in a local database. You can then query and explore them via the web UI.

## Example - using it as a localhost observability platform

With the query engine turned on (this is the default on new installations), you can query the logs and traces that you ingested. Run a query with:

```bash
$ humanlog query "spans | where duration > 100ms"
```

![querying](https://github.com/user-attachments/assets/74530872-fa9e-4c31-8798-99fdb34c7280)

Learn more at 👉 [how to query](https://humanlog.io/docs/features/query) in our docs.

## Example - ingesting traces

You can ingest traces via OpenTelemetry/OTLP. Using your language of choices' OpenTelemetry client will work out of the box using the default configuration. If not, point your exporter to `http://localhost:4317` or `http://localhost:4318` (these are the default values).

Other valid values for `OTEL_EXPORTER_OTLP_ENDPOINT` are:

| Situation                            | `OTEL_EXPORTER_OTLP_ENDPOINT`      |
| ------------------------------------ | ---------------------------------- |
| Default (same host, OTLP/HTTP)       | `http://localhost:4317`            |
| Default (same host, OTLP/gRPC)       | `http://localhost:4318`            |
| Docker, Orbstack, `kind` (OTLP/HTTP) | `http://host.docker.internal:4317` |
| Docker, Orbstack, `kind` (OTLP/gRPC) | `http://host.docker.internal:4318` |

Learn more at 👉 [ingesting OpenTelemetry/OTLP](https://humanlog.io/docs/integrations/opentelemetry) in our docs.

# Support and help

Open an issue on this repo or contribute a PR if you find a bug or want to add a feature in the CLI.

Need more help or want to give feedback? Join our [community channels](https://humanlog.io/support).

# License

The core CLI is Apache 2 licensed (everything in this repo). Official releases are available at [humanlog.io](https://humanlog.io) and include proprietary code that is inserted at build time (the query engine).