From 69e5db227e35ceebb1b5e5ef9903d2caa156753d Mon Sep 17 00:00:00 2001 From: Nitish Tiwari Date: Sun, 1 Oct 2023 10:00:12 +0530 Subject: [PATCH 1/5] update readme --- README.md | 68 +++++++++++++++++-------------------------------------- 1 file changed, 21 insertions(+), 47 deletions(-) diff --git a/README.md b/README.md index 4743e3252..1a5ce8717 100644 --- a/README.md +++ b/README.md @@ -15,28 +15,19 @@ [![Docs](https://img.shields.io/badge/stable%20docs-parseable.io%2Fdocs-brightgreen?style=flat&color=%2373DC8C&label=Docs)](https://www.parseable.io/docs) [![Build](https://img.shields.io/github/checks-status/parseablehq/parseable/main?style=flat&color=%2373DC8C&label=Checks)](https://github.com/parseablehq/parseable/actions) +[Highlights ↗︎](https://github.com/parseablehq/parseable#rocket-highlights) | [Documentation ↗︎](https://www.parseable.io/docs/) | [Demo ↗︎](https://demo.parseable.io/login?q=eyJ1c2VybmFtZSI6ImFkbWluIiwicGFzc3dvcmQiOiJhZG1pbiJ9) | [Integrations ↗︎](https://www.parseable.io/docs/category/integrations) | [FAQ ↗︎](https://www.parseable.io/docs/faq) + -Parseable is a lightweight, cloud native log observability and analytics engine. It is written in Rust and uses Apache Arrow and Parquet. +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 uses a simple, index-free mechanism to organize and query data allowing low latency, and high throughput ingestion and query. It can use either a local mount point or object storage (S3/compatible stores) for data storage. +To get started, download the Parseable binary from [releases page ↗︎](https://github.com/parseablehq/parseable/releases/latest) and run it on your machine. 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/). -- [Parseable UI Demo (Credentials: admin,admin) ↗︎](https://demo.parseable.io) -- [Grafana Dashboard Demo ↗︎](http://demo.parseable.io:3000/dashboards) - -## :rocket: Features +For :stethoscope: commercial support and consultation, please reach out to us at [`sales@parseable.io` ↗︎](mailto:sales@parseable.io). -- Choose your own 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. -- [Grafana ↗︎](https://github.com/parseablehq/parseable-datasource) for visualization. -- [Send alerts ↗︎](https://www.parseable.io/docs/api/alerts) to webhook targets including Slack. -- [Stats API ↗︎](https://www.postman.com/parseable/workspace/parseable/request/22353706-b32abe55-f0c4-4ed2-9add-110d265888c3) to track ingestion and compressed data. -- Single binary includes all components - ingestion, store and query. Built-in UI. - -## :white_check_mark: Getting Started +## :zap: Quickstart Run the below command to deploy Parseable in local storage mode with Docker. @@ -55,7 +46,7 @@ docker run -p 8000:8000 \ 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`. -### Send log events +To ingest data, run the below command. This will send logs to the `demo` stream. You can see the logs in the dashboard. ```sh curl --location --request POST 'http://localhost:8000/api/v1/ingest' \ @@ -77,34 +68,21 @@ curl --location --request POST 'http://localhost:8000/api/v1/ingest' \ ]' ``` -Note: The `X-P-Stream` header is used to specify the log stream where data is sent. Parseable will create the stream automatically if it doesn't exist already. - -### Query the stream - -You can see the events in Parseable UI, or use the below curl command to see the query response on CLI. +## :rocket: Highlights -NOTE: Please change the `startTime` and `endTime` to the time range corresponding to the event you sent in the previous step. - -```sh -curl --location --request POST 'http://localhost:8000/api/v1/query' \ ---header 'Authorization: Basic YWRtaW46YWRtaW4=' \ ---header 'Content-Type: application/json' \ ---data-raw '{ - "query":"select * from demo", - "startTime":"2023-06-09T00:00:00+00:00", - "endTime":"2023-06-09T23:59:00+00:00" -}' -``` - -## :chart_with_upwards_trend: Benchmarking - -Parseable is benchmarked with [K6](https://k6.io). Please find the results and details on how to run the benchmark in your environment in the [benchmarks directory](./benchmarks/). +- 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. -## :books: Documentation +### Enterprise ready -- [Complete documentation ↗︎](https://www.parseable.io/docs/) -- [Roadmap ↗︎](https://github.com/orgs/parseablehq/projects/4) -- [FAQ ↗︎](https://www.parseable.io/docs/faq) +- [Alerts ↗︎](https://www.parseable.io/docs/alerts). +- [RBAC ↗︎](https://www.parseable.io/docs/rbac). +- [OAuth2 ↗︎](https://www.parseable.io/docs/oidc) for authentication. +- [Grafana ↗︎](https://github.com/parseablehq/parseable-datasource) for visualization. +- [LLM ↗︎](https://www.parseable.io/docs/llm). +- [Stats API ↗︎](https://www.postman.com/parseable/workspace/parseable/request/22353706-b32abe55-f0c4-4ed2-9add-110d265888c3) to track ingestion and compressed data. ## :dart: Motivation @@ -112,18 +90,14 @@ Traditionally, logging has been seen as a text search problem. Log volumes were 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. -## :stethoscope: Support - -- For bugs, please create issue on [GitHub ↗︎](https://github.com/parseablehq/parseable/issues). -- For commercial support and consultation, please reach out to us at [`hi@parseable.io` ↗︎](mailto:hi@parseable.io). -- Please consider supporting us on [GitHub Sponsors ↗︎](https://github.com/sponsors/parseablehq). - ## :trophy: Contributing Refer to the contributing guide [here ↗︎](https://www.parseable.io/docs/contributing). ### Contributors +![Alt](https://repobeats.axiom.co/api/embed/7c4e0f51cd3b8f78d1da682c396a3b5bd855a6ba.svg "Repobeats analytics image") + ### Supported by From ae0a6f8ff7805e968a3e5020f2794cbfc9b7bd7f Mon Sep 17 00:00:00 2001 From: Nitish Tiwari Date: Sun, 1 Oct 2023 10:03:23 +0530 Subject: [PATCH 2/5] update --- README.md | 23 +++++------------------ 1 file changed, 5 insertions(+), 18 deletions(-) diff --git a/README.md b/README.md index 1a5ce8717..c88eaccde 100644 --- a/README.md +++ b/README.md @@ -29,17 +29,10 @@ For :stethoscope: commercial support and consultation, please reach out to us at ## :zap: Quickstart -Run the below command to deploy Parseable in local storage mode with Docker. +Deploy Parseable in local storage mode with Docker. ```sh -mkdir -p $HOME/parseable/data -mkdir -p $HOME/parseable/staging - docker run -p 8000:8000 \ - -v $HOME/parseable/data:/parseable/data \ - -v $HOME/parseable/staging:/parseable/staging \ - -e P_FS_DIR=/parseable/data \ - -e P_STAGING_DIR=/parseable/staging \ parseable/parseable:latest \ parseable local-store ``` @@ -50,8 +43,6 @@ To ingest data, run the below command. This will send logs to the `demo` stream. ```sh curl --location --request POST 'http://localhost:8000/api/v1/ingest' \ ---header 'X-P-META-meta1: value1' \ ---header 'X-P-TAG-tag1: value1' \ --header 'X-P-Stream: demo' \ --header 'Authorization: Basic YWRtaW46YWRtaW4=' \ --header 'Content-Type: application/json' \ @@ -59,11 +50,7 @@ curl --location --request POST 'http://localhost:8000/api/v1/ingest' \ { "id": "434a5f5e-2f5f-11ed-a261-0242ac120002", "datetime": "24/Jun/2022:14:12:15 +0000", - "host": "153.10.110.81", - "user-identifier": "Mozilla/5.0 Gecko/20100101 Firefox/64.0", - "method": "PUT", - "status": 500, - "referrer": "http://www.google.com/" + "host": "153.10.110.81" } ]' ``` @@ -92,12 +79,12 @@ But with log data growing exponentially, today's log data challenges involve who ## :trophy: Contributing -Refer to the contributing guide [here ↗︎](https://www.parseable.io/docs/contributing). - -### Contributors +[Contribution guide ↗︎](https://www.parseable.io/docs/contributing). ![Alt](https://repobeats.axiom.co/api/embed/7c4e0f51cd3b8f78d1da682c396a3b5bd855a6ba.svg "Repobeats analytics image") +### Contributors + ### Supported by From 47206466d4d687ac70ebfcb9729e703f2e516603 Mon Sep 17 00:00:00 2001 From: Nitish Tiwari Date: Sun, 1 Oct 2023 10:06:12 +0530 Subject: [PATCH 3/5] update --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index c88eaccde..a183b9153 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,7 @@ - Parseable Logo + Parseable
Cloud native log analytics @@ -15,7 +15,7 @@ [![Docs](https://img.shields.io/badge/stable%20docs-parseable.io%2Fdocs-brightgreen?style=flat&color=%2373DC8C&label=Docs)](https://www.parseable.io/docs) [![Build](https://img.shields.io/github/checks-status/parseablehq/parseable/main?style=flat&color=%2373DC8C&label=Checks)](https://github.com/parseablehq/parseable/actions) -[Highlights ↗︎](https://github.com/parseablehq/parseable#rocket-highlights) | [Documentation ↗︎](https://www.parseable.io/docs/) | [Demo ↗︎](https://demo.parseable.io/login?q=eyJ1c2VybmFtZSI6ImFkbWluIiwicGFzc3dvcmQiOiJhZG1pbiJ9) | [Integrations ↗︎](https://www.parseable.io/docs/category/integrations) | [FAQ ↗︎](https://www.parseable.io/docs/faq) +[Highlights](https://github.com/parseablehq/parseable#rocket-highlights) | [Documentation](https://www.parseable.io/docs/) | [Demo](https://demo.parseable.io/login?q=eyJ1c2VybmFtZSI6ImFkbWluIiwicGFzc3dvcmQiOiJhZG1pbiJ9) | [Integrations](https://www.parseable.io/docs/category/integrations) | [FAQ](https://www.parseable.io/docs/faq) From 0386dc4dc79ace9e45f559d629430b181a143332 Mon Sep 17 00:00:00 2001 From: Nitish Tiwari Date: Sun, 1 Oct 2023 10:10:06 +0530 Subject: [PATCH 4/5] update --- README.md | 29 ++++++++++++++--------------- 1 file changed, 14 insertions(+), 15 deletions(-) diff --git a/README.md b/README.md index a183b9153..6f5f4abeb 100644 --- a/README.md +++ b/README.md @@ -2,20 +2,19 @@ - Parseable + Parseable
Cloud native log analytics + [![Docker Pulls](https://img.shields.io/docker/pulls/parseable/parseable?logo=docker&label=Docker%20Pulls)](https://hub.docker.com/r/parseable/parseable) + [![Slack](https://img.shields.io/badge/slack-brightgreen.svg?logo=slack&label=Community&style=flat&color=%2373DC8C&)](https://launchpass.com/parseable) + [![Docs](https://img.shields.io/badge/stable%20docs-parseable.io%2Fdocs-brightgreen?style=flat&color=%2373DC8C&label=Docs)](https://www.parseable.io/docs) + [![Build](https://img.shields.io/github/checks-status/parseablehq/parseable/main?style=flat&color=%2373DC8C&label=Checks)](https://github.com/parseablehq/parseable/actions)
-[![Docker Pulls](https://img.shields.io/docker/pulls/parseable/parseable?logo=docker&label=Docker%20Pulls)](https://hub.docker.com/r/parseable/parseable) -[![Slack](https://img.shields.io/badge/slack-brightgreen.svg?logo=slack&label=Community&style=flat&color=%2373DC8C&)](https://launchpass.com/parseable) -[![Docs](https://img.shields.io/badge/stable%20docs-parseable.io%2Fdocs-brightgreen?style=flat&color=%2373DC8C&label=Docs)](https://www.parseable.io/docs) -[![Build](https://img.shields.io/github/checks-status/parseablehq/parseable/main?style=flat&color=%2373DC8C&label=Checks)](https://github.com/parseablehq/parseable/actions) - -[Highlights](https://github.com/parseablehq/parseable#rocket-highlights) | [Documentation](https://www.parseable.io/docs/) | [Demo](https://demo.parseable.io/login?q=eyJ1c2VybmFtZSI6ImFkbWluIiwicGFzc3dvcmQiOiJhZG1pbiJ9) | [Integrations](https://www.parseable.io/docs/category/integrations) | [FAQ](https://www.parseable.io/docs/faq) +[Highlights](https://github.com/parseablehq/parseable#rocket-highlights) | [Key Concepts](https://www.parseable.io/docs/concepts) | [Documentation](https://www.parseable.io/docs/) | [Demo](https://demo.parseable.io/login?q=eyJ1c2VybmFtZSI6ImFkbWluIiwicGFzc3dvcmQiOiJhZG1pbiJ9) | [Integrations](https://www.parseable.io/docs/category/integrations) | [FAQ](https://www.parseable.io/docs/faq)
@@ -23,7 +22,7 @@ Parseable is a log analytics platform, built for the modern, cloud native era. P To get started, download the Parseable binary from [releases page ↗︎](https://github.com/parseablehq/parseable/releases/latest) and run it on your machine. -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/). +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/). For :stethoscope: commercial support and consultation, please reach out to us at [`sales@parseable.io` ↗︎](mailto:sales@parseable.io). @@ -37,7 +36,7 @@ docker run -p 8000:8000 \ parseable 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`. +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. @@ -64,12 +63,12 @@ curl --location --request POST 'http://localhost:8000/api/v1/ingest' \ ### Enterprise ready -- [Alerts ↗︎](https://www.parseable.io/docs/alerts). -- [RBAC ↗︎](https://www.parseable.io/docs/rbac). -- [OAuth2 ↗︎](https://www.parseable.io/docs/oidc) for authentication. -- [Grafana ↗︎](https://github.com/parseablehq/parseable-datasource) for visualization. -- [LLM ↗︎](https://www.parseable.io/docs/llm). -- [Stats API ↗︎](https://www.postman.com/parseable/workspace/parseable/request/22353706-b32abe55-f0c4-4ed2-9add-110d265888c3) to track ingestion and compressed data. +- [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) +- [LLM ↗︎](https://www.parseable.io/docs/llm) +- [Stats ↗︎](https://www.postman.com/parseable/workspace/parseable/request/22353706-b32abe55-f0c4-4ed2-9add-110d265888c3) ## :dart: Motivation From 4ed60c59e5aefcbaa56d6667ee07f1608ddcca10 Mon Sep 17 00:00:00 2001 From: Nitish Tiwari Date: Sun, 1 Oct 2023 10:11:36 +0530 Subject: [PATCH 5/5] update --- README.md | 11 ++++++----- 1 file changed, 6 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 6f5f4abeb..1bfa4524f 100644 --- a/README.md +++ b/README.md @@ -6,15 +6,16 @@
Cloud native log analytics - [![Docker Pulls](https://img.shields.io/docker/pulls/parseable/parseable?logo=docker&label=Docker%20Pulls)](https://hub.docker.com/r/parseable/parseable) - [![Slack](https://img.shields.io/badge/slack-brightgreen.svg?logo=slack&label=Community&style=flat&color=%2373DC8C&)](https://launchpass.com/parseable) - [![Docs](https://img.shields.io/badge/stable%20docs-parseable.io%2Fdocs-brightgreen?style=flat&color=%2373DC8C&label=Docs)](https://www.parseable.io/docs) - [![Build](https://img.shields.io/github/checks-status/parseablehq/parseable/main?style=flat&color=%2373DC8C&label=Checks)](https://github.com/parseablehq/parseable/actions)
-[Highlights](https://github.com/parseablehq/parseable#rocket-highlights) | [Key Concepts](https://www.parseable.io/docs/concepts) | [Documentation](https://www.parseable.io/docs/) | [Demo](https://demo.parseable.io/login?q=eyJ1c2VybmFtZSI6ImFkbWluIiwicGFzc3dvcmQiOiJhZG1pbiJ9) | [Integrations](https://www.parseable.io/docs/category/integrations) | [FAQ](https://www.parseable.io/docs/faq) +[![Docker Pulls](https://img.shields.io/docker/pulls/parseable/parseable?logo=docker&label=Docker%20Pulls)](https://hub.docker.com/r/parseable/parseable) +[![Slack](https://img.shields.io/badge/slack-brightgreen.svg?logo=slack&label=Community&style=flat&color=%2373DC8C&)](https://launchpass.com/parseable) +[![Docs](https://img.shields.io/badge/stable%20docs-parseable.io%2Fdocs-brightgreen?style=flat&color=%2373DC8C&label=Docs)](https://www.parseable.io/docs) +[![Build](https://img.shields.io/github/checks-status/parseablehq/parseable/main?style=flat&color=%2373DC8C&label=Checks)](https://github.com/parseablehq/parseable/actions) + +[Key Concepts](https://www.parseable.io/docs/concepts) | [Features](https://github.com/parseablehq/parseable#rocket-highlights) | [Documentation](https://www.parseable.io/docs/) | [Demo](https://demo.parseable.io/login?q=eyJ1c2VybmFtZSI6ImFkbWluIiwicGFzc3dvcmQiOiJhZG1pbiJ9) | [Integrations](https://www.parseable.io/docs/category/integrations) | [FAQ](https://www.parseable.io/docs/faq)