From 56157bfb6127bd7f8befd388e21442aebc6f63eb Mon Sep 17 00:00:00 2001 From: Nitish Tiwari Date: Wed, 3 Apr 2024 18:39:51 +0530 Subject: [PATCH 1/2] Update readme --- README.md | 97 +++++++++++++++++++++++++++++++++++++++++++++---------- 1 file changed, 80 insertions(+), 17 deletions(-) diff --git a/README.md b/README.md index a773ca766..fa40fe069 100644 --- a/README.md +++ b/README.md @@ -19,21 +19,19 @@ -Parseable is a log analytics platform, built for the modern, cloud native era. Parseable uses a index-free mechanism to organize and query data allowing low latency, and high throughput ingestion and query. +Parseable is a **cloud native, log analytics platform, with a focus on performance & resource efficiency**. Parseable is useful for use cases where **complete data ownership, privacy, and performance are paramount**. -To get started, download the Parseable binary from [releases page ↗︎](https://github.com/parseablehq/parseable/releases/latest) and run it on your machine. +To experience Parseable UI, checkout [demo.parseable.com ↗︎](https://demo.parseable.com/login?q=eyJ1c2VybmFtZSI6ImFkbWluIiwicGFzc3dvcmQiOiJhZG1pbiJ9). You can also view the [demo video ↗︎](https://www.parseable.com/video.mp4). -For comparison, Parseable consumes up to **_~80% lower memory_** and **_~50% lower CPU_** than Elastic for similar ingestion throughput. Read more in the [benchmarks directory ↗︎](./benchmarks/). +## :zap: QuickStart -For :stethoscope: commercial support and consultation, please reach out to us at [`sales@parseable.io` ↗︎](mailto:sales@parseable.io). +
+Run Parseable in local disk mode with Docker +

-![Parseable Console](https://raw.githubusercontent.com/parseablehq/.github/main/images/console.png) +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. -## :zap: Quickstart - -Deploy Parseable in local storage mode with Docker. - -```sh +```bash docker run -p 8000:8000 \ parseable/parseable:latest \ parseable local-store @@ -43,7 +41,65 @@ Once this runs successfully, you'll see dashboard at [http://localhost:8000 ↗ To ingest data, run the below command. This will send logs to the `demo` stream. You can see the logs in the dashboard. -```sh +```bash +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" + } +]' +``` + +

+
+ +
+Run Parseable binary +

+ +You can also download and run the Parseable binary on your laptop. To download the binary, run the command specific to your OS. + +- Linux + +```bash +wget https://github.com/parseablehq/parseable/releases/download/v0.9.0/Parseable_x86_64-unknown-linux-gnu -O parseable +chmod +x parseable +./parseable local-store +``` + +- MacOS (Apple Silicon) + +```bash +wget https://github.com/parseablehq/parseable/releases/download/v0.9.0/Parseable_aarch64-apple-darwin -O parseable +chmod +x parseable +./parseable local-store +``` + +- MacOS (Intel) + +```bash +wget https://github.com/parseablehq/parseable/releases/download/v0.9.0/Parseable_x86_64-apple-darwin -O parseable +chmod +x parseable +./parseable local-store +``` + +- Windows + +```bash +Invoke-WebRequest -Uri "https://github.com/parseablehq/parseable/releases/download/v0.9.0/Parseable_x86_64-pc-windows-msvc.exe" -OutFile "C:\parseable.exe" +C:\parseable.exe local-store +``` + +Once this runs successfully, you'll see dashboard at [http://localhost:8000 ↗︎](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. + +```bash curl --location --request POST 'http://localhost:8000/api/v1/ingest' \ --header 'X-P-Stream: demo' \ --header 'Authorization: Basic YWRtaW46YWRtaW4=' \ @@ -57,12 +113,19 @@ curl --location --request POST 'http://localhost:8000/api/v1/ingest' \ ]' ``` -## :rocket: Highlights +

+
+ +## :question: Why Parseable + +### Take control of your data + +With Apache Arrow and Apache Parquet as the underlying data format, Parseable ensures that not only you have access to your data, but also that it is stored in a performant and efficient manner. + +### Performance & resource efficiency + +### Easy to use for developers and operators -- Choose storage backend - local drive or S3 (or compatible) object store. -- Ingestion API compatible with HTTP + JSON output of log agents. -- Query log data with PostgreSQL compatible SQL. -- Single binary includes all components - ingestion, store and query. Built-in UI. ### Enterprise ready @@ -75,7 +138,7 @@ curl --location --request POST 'http://localhost:8000/api/v1/ingest' \ ## :dart: 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. From 69e82b7d28ec6f9c51bb2879058a3b7206badc3d Mon Sep 17 00:00:00 2001 From: Nitish Tiwari Date: Wed, 3 Apr 2024 18:44:32 +0530 Subject: [PATCH 2/2] update --- README.md | 68 ++++++++++++++++++++++++------------------------------- USERS.md | 2 +- 2 files changed, 31 insertions(+), 39 deletions(-) diff --git a/README.md b/README.md index fa40fe069..b68ca4759 100644 --- a/README.md +++ b/README.md @@ -5,7 +5,7 @@ Parseable
- Cloud native log analytics + **Log Lake** for the cloud-native world
@@ -19,14 +19,14 @@
-Parseable is a **cloud native, log analytics platform, with a focus on performance & resource efficiency**. Parseable is useful for use cases where **complete data ownership, privacy, and performance are paramount**. +Parseable is a **cloud native, log analytics platform, with a focus on performance & 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 ↗︎](https://demo.parseable.com/login?q=eyJ1c2VybmFtZSI6ImFkbWluIiwicGFzc3dvcmQiOiJhZG1pbiJ9). You can also view the [demo video ↗︎](https://www.parseable.com/video.mp4). -## :zap: QuickStart +## QuickStart :zap:
-Run Parseable in local disk mode with Docker +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. @@ -59,10 +59,10 @@ curl --location --request POST 'http://localhost:8000/api/v1/ingest' \

-Run Parseable binary +Executable Binary

-You can also download and run the Parseable binary on your laptop. To download the binary, run the command specific to your OS. +You can download and run the Parseable binary on your laptop. - Linux @@ -116,59 +116,51 @@ curl --location --request POST 'http://localhost:8000/api/v1/ingest' \

-## :question: Why Parseable +## Why Parseable :question: -### Take control of your data +### Performance & resource efficiency -With Apache Arrow and Apache Parquet as the underlying data format, Parseable ensures that not only you have access to your data, but also that it is stored in a performant and efficient manner. +Parseable is written in Rust, with a clear focus on performance while ensuring a much lower CPU and memory footprint (compared to Java, Go based systems). When compared with Elastic, Parseable uses ~80% lesser memory and ~50% lesser CPU, while offering a better ingestion rate. This means you can run Parseable on smaller instances, saving costs. -### Performance & resource efficiency +### Easy of use -### Easy to use for developers and operators +One of the key challenges users said they face today is the complexity of setting a logging system like Elastic. There are so many moving parts, and it's hard to get started. Parseable is designed to be simple to use, with a single binary that can be run on almost anywhere. The Console is built in the binary itself, so you can start using it without any additional setup. + +### Take control of your data +With Apache Arrow and Apache Parquet as the underlying data formats, Parseable stores log data in an optimized, compressed manner as Parquet files. This means you get complete control and access to your data. You can use Parseable query and analysis, but also can plugin tools from wider Parquet ecosystem for further processing, analysis, and visualization. ### Enterprise ready +- High availability & Cluster mode +- Local cache & storage +- [OpenTelemetry support ↗︎](https://opentelemetry.io/) - [Alerts ↗︎](https://www.parseable.io/docs/alerts) -- [RBAC ↗︎](https://www.parseable.io/docs/rbac) -- [OAuth2 ↗︎](https://www.parseable.io/docs/oidc) -- [Grafana ↗︎](https://github.com/parseablehq/parseable-datasource) +- [Role based access control ↗︎](https://www.parseable.io/docs/rbac) +- [OAuth2 support ↗︎](https://www.parseable.io/docs/oidc) +- [Grafana based visualization ↗︎](https://github.com/parseablehq/parseable-datasource) - [LLM ↗︎](https://www.parseable.io/docs/llm) - [Stats ↗︎](https://www.postman.com/parseable/workspace/parseable/request/22353706-b32abe55-f0c4-4ed2-9add-110d265888c3) -## :dart: Motivation +## How do people use Parseable :bulb: +- **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. -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. - -## :trophy: Contributing +- **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. -[Contribution guide ↗︎](https://www.parseable.io/docs/contributing). +## Motivation :dart: -![Alt](https://repobeats.axiom.co/api/embed/7c4e0f51cd3b8f78d1da682c396a3b5bd855a6ba.svg "Repobeats analytics image") +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. -### Contributors - - - -### License report - -A license report lists all the licenses of all dependencies in a project. You can use [cargo-about ↗︎](https://embarkstudios.github.io/cargo-about/) to generate a license report for the Parseable. - -If not already installed, install `cargo-about` using the below command. - -```sh -cargo install --locked cargo-about && cargo about init -``` +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. -To generate a license report, run the below command. +## Contributing :trophy: -```sh -cargo about generate about.hbs > parseable-license.html -``` +[Contribution guide ↗︎](https://www.parseable.io/docs/contributing). -You can see the license report in the file parseable-license.html. + ### Supported by diff --git a/USERS.md b/USERS.md index c158012da..ec82da99b 100644 --- a/USERS.md +++ b/USERS.md @@ -2,7 +2,7 @@ The following document is a list of users and adopters who use Parseable. The users themselves directly maintain the list. You can add your organization by editing this file directly. -If you're using Parseable in your organization, please add your company name to this list. It really helps the project gain momentum and credibility. It's a small contribution to the project with a big impact. +If you're using Parseable in your organization, please add your company name to this list. It really helps the project gain momentum and credibility. It's a small contribution to the project with a big impact. ---