Skip to content

README.md

Latest commit

 

History

History
138 lines (97 loc) · 5.79 KB

README.md

File metadata and controls

138 lines (97 loc) · 5.79 KB

Parseable logo

Parseable is a full stack observability platform built to ingest, analyze and extract insights from all types of telemetry (MELT) data. You can run Parseable on your local machine, in the cloud, or as a managed service. To experience Parseable UI, checkout demo.parseable.com ↗︎.

Quickstart ⚡

Run Parseable

Docker Image

Get started with Parseable Docker image with a single command:

docker run -p 8000:8000 \
  parseable/parseable:latest \
  parseable local-store

Executable Binary

Download and run the Parseable binary on your laptop:

  • Linux or MacOS
curl -fsSL https://logg.ing/install | bash
  • Windows
powershell -c "irm https://logg.ing/install-windows | iex"

Ingestion and query

Once you have Parseable running, ingest data with the below command. This will send logs to the demo stream. You can see the logs in the dashboard.

curl --location --request POST 'http://localhost:8000/api/v1/ingest' \
--header 'X-P-Stream: demo' \
--header 'Authorization: Basic YWRtaW46YWRtaW4=' \
--header 'Content-Type: application/json' \
--data-raw '[
    {
        "id": "434a5f5e-2f5f-11ed-a261-0242ac120002",
        "datetime": "24/Jun/2022:14:12:15 +0000",
        "host": "153.10.110.81"
    }
]'

Access the UI at http://localhost:8000 ↗︎. You can login to the dashboard default credentials admin, admin.

Configure with TOML

We can keep Parseable configuration in a TOML file instead of managing dozens of environment variables. When a file named parseable.toml is present in the working directory, Parseable automatically loads it; you can also point to a different file via parseable --config-file /path/to/config.toml (or by setting P_CONFIG_FILE).

Example:

# parseable.toml
storage = "s3-store"

[env]
P_S3_URL = "https://s3.amazonaws.com"
P_S3_REGION = "us-east-1"
P_S3_BUCKET = "my-observability-bucket"
P_USERNAME = "admin"
P_PASSWORD = "super-secret"

Values from the TOML file are written to the corresponding P_* environment variables unless they are already set in the shell. Command-line flags still take precedence over everything else, so you can override individual fields without editing the file.

Getting started 💡

For quickstart, refer the quickstart section ↗︎.

This section elaborates available options to run Parseable in production or development environments.

Features 🚀

Verify images ✍️

Parseable builds are attested for build provenance and integrity using the attest-build-provenance action. The attestations can be verified by having the latest version of GitHub CLI installed in your system. Then, execute the following command:

gh attestation verify PATH/TO/YOUR/PARSEABLE/ARTIFACT-BINARY -R parseablehq/parseable

Contributing 🏆

Contribution guide ↗︎