Skip to content

Latest commit

 

History

History
136 lines (97 loc) · 6.93 KB

README.md

File metadata and controls

136 lines (97 loc) · 6.93 KB

Parseable logo
The versatile log database for search, analysis, and monitoring

Parseable is a cloud native log analytics platform, with a focus on simplicity & resource efficiency. Parseable is useful for use cases where complete data ownership, security and privacy are paramount.

To experience Parseable UI, checkout demo.parseable.com ↗︎. You can also view the demo video ↗︎.

QuickStart ⚡

Docker Image

You can get started with Parseable Docker with a simple Docker run and then send data via cURL to understand how you can ingest data to Parseable. Below is the command to run Parseable in local storage mode with Docker.

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

Once this runs successfully, you'll see dashboard at http://localhost:8000 ↗︎. You can login to the dashboard default credentials admin, admin.

To ingest data, run 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"
    }
]'

Executable Binary

You can 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"

Once this runs successfully, you'll see dashboard at http://localhost:8000 ↗︎. You can login to the dashboard default credentials admin, admin.

To ingest data, run 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"
    }
]'

Features 🚀

How do people use Parseable 💡

  • Log Analytics - Not all logs are created equal. For example application logs are seldom useful after a few days pass, but if same application also logs all the user interactions, that data is very valuable for product managers, and can be stored for a longer period. Several businesses store such high value logs and slice / dice them as needed.

  • Audit & Compliance - Organizations that need to store logs in a secure, compliant manner. Parseable's direct to S3 bucket storage mode ensures that logs are stored in a secure, cost effective manner, and can be accessed only by authorized users, while all the data is queryable in real-time.

  • Observability & Monitoring - A very large chunk of observability data is logs. Organizations that need to monitor their systems, applications, and infrastructure in real-time use Parseable as the primary log storage system so they get timely alerts, and can analyze logs in real-time.

Motivation 🎯

Traditionally, logging has been seen as a text search problem. Log volumes were not high, and data ingestion or storage were not really issues. This led us to today, where all the logging platforms are primarily text search engines.

But with log data growing exponentially, today's log data challenges involve whole lot more – Data ingestion, storage, and observation, all at scale. We are building Parseable to address these challenges.

Verify Image Build Provenance Attestation

All the image builds/pushes 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 ↗︎