Skip to content

Commit 9dec32a

Browse files
authored
update readme (#524)
1 parent 7fc72e0 commit 9dec32a

File tree

1 file changed

+27
-66
lines changed

1 file changed

+27
-66
lines changed

README.md

Lines changed: 27 additions & 66 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
<picture>
33
<source media="(prefers-color-scheme: dark)" srcset="https://raw.githubusercontent.com/parseablehq/.github/main/images/logo-dark.png">
44
<source media="(prefers-color-scheme: light)" srcset="https://raw.githubusercontent.com/parseablehq/.github/main/images/logo.svg">
5-
<img alt="Parseable Logo" src="https://raw.githubusercontent.com/parseablehq/.github/main/images/logo.svg">
5+
<a href="https://www.parseable.io" target="_blank"><img src="https://raw.githubusercontent.com/parseablehq/.github/main/images/logo.svg" alt="Parseable" width="600" height="150" /></a>
66
</picture>
77
<br>
88
Cloud native log analytics
@@ -15,112 +15,73 @@
1515
[![Docs](https://img.shields.io/badge/stable%20docs-parseable.io%2Fdocs-brightgreen?style=flat&color=%2373DC8C&label=Docs)](https://www.parseable.io/docs)
1616
[![Build](https://img.shields.io/github/checks-status/parseablehq/parseable/main?style=flat&color=%2373DC8C&label=Checks)](https://github.com/parseablehq/parseable/actions)
1717

18-
</div>
19-
20-
Parseable is a lightweight, cloud native log observability and analytics engine. It is written in Rust and uses Apache Arrow and Parquet.
18+
[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)
2119

22-
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.
20+
</div>
2321

24-
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/).
22+
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.
2523

26-
- [Parseable UI Demo (Credentials: admin,admin) ↗︎](https://demo.parseable.io)
27-
- [Grafana Dashboard Demo ↗︎](http://demo.parseable.io:3000/dashboards)
24+
To get started, download the Parseable binary from [releases page ↗︎](https://github.com/parseablehq/parseable/releases/latest) and run it on your machine.
2825

29-
## :rocket: Features
26+
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/).
3027

31-
- Choose your own storage backend - local drive or S3 (or compatible) object store.
32-
- Ingestion API compatible with HTTP + JSON output of log agents.
33-
- Query log data with PostgreSQL compatible SQL.
34-
- [Grafana ↗︎](https://github.com/parseablehq/parseable-datasource) for visualization.
35-
- [Send alerts ↗︎](https://www.parseable.io/docs/api/alerts) to webhook targets including Slack.
36-
- [Stats API ↗︎](https://www.postman.com/parseable/workspace/parseable/request/22353706-b32abe55-f0c4-4ed2-9add-110d265888c3) to track ingestion and compressed data.
37-
- Single binary includes all components - ingestion, store and query. Built-in UI.
28+
For :stethoscope: commercial support and consultation, please reach out to us at [`[email protected]` ↗︎](mailto:[email protected]).
3829

39-
## :white_check_mark: Getting Started
30+
## :zap: Quickstart
4031

41-
Run the below command to deploy Parseable in local storage mode with Docker.
32+
Deploy Parseable in local storage mode with Docker.
4233

4334
```sh
44-
mkdir -p $HOME/parseable/data
45-
mkdir -p $HOME/parseable/staging
46-
4735
docker run -p 8000:8000 \
48-
-v $HOME/parseable/data:/parseable/data \
49-
-v $HOME/parseable/staging:/parseable/staging \
50-
-e P_FS_DIR=/parseable/data \
51-
-e P_STAGING_DIR=/parseable/staging \
5236
parseable/parseable:latest \
5337
parseable local-store
5438
```
5539

56-
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`.
40+
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`.
5741

58-
### Send log events
42+
To ingest data, run the below command. This will send logs to the `demo` stream. You can see the logs in the dashboard.
5943

6044
```sh
6145
curl --location --request POST 'http://localhost:8000/api/v1/ingest' \
62-
--header 'X-P-META-meta1: value1' \
63-
--header 'X-P-TAG-tag1: value1' \
6446
--header 'X-P-Stream: demo' \
6547
--header 'Authorization: Basic YWRtaW46YWRtaW4=' \
6648
--header 'Content-Type: application/json' \
6749
--data-raw '[
6850
{
6951
"id": "434a5f5e-2f5f-11ed-a261-0242ac120002",
7052
"datetime": "24/Jun/2022:14:12:15 +0000",
71-
"host": "153.10.110.81",
72-
"user-identifier": "Mozilla/5.0 Gecko/20100101 Firefox/64.0",
73-
"method": "PUT",
74-
"status": 500,
75-
"referrer": "http://www.google.com/"
53+
"host": "153.10.110.81"
7654
}
7755
]'
7856
```
7957

80-
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.
81-
82-
### Query the stream
83-
84-
You can see the events in Parseable UI, or use the below curl command to see the query response on CLI.
85-
86-
NOTE: Please change the `startTime` and `endTime` to the time range corresponding to the event you sent in the previous step.
87-
88-
```sh
89-
curl --location --request POST 'http://localhost:8000/api/v1/query' \
90-
--header 'Authorization: Basic YWRtaW46YWRtaW4=' \
91-
--header 'Content-Type: application/json' \
92-
--data-raw '{
93-
"query":"select * from demo",
94-
"startTime":"2023-06-09T00:00:00+00:00",
95-
"endTime":"2023-06-09T23:59:00+00:00"
96-
}'
97-
```
98-
99-
## :chart_with_upwards_trend: Benchmarking
58+
## :rocket: Highlights
10059

101-
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/).
60+
- Choose storage backend - local drive or S3 (or compatible) object store.
61+
- Ingestion API compatible with HTTP + JSON output of log agents.
62+
- Query log data with PostgreSQL compatible SQL.
63+
- Single binary includes all components - ingestion, store and query. Built-in UI.
10264

103-
## :books: Documentation
65+
### Enterprise ready
10466

105-
- [Complete documentation ↗︎](https://www.parseable.io/docs/)
106-
- [Roadmap ↗︎](https://github.com/orgs/parseablehq/projects/4)
107-
- [FAQ ↗︎](https://www.parseable.io/docs/faq)
67+
- [Alerts ↗︎](https://www.parseable.io/docs/alerts)
68+
- [RBAC ↗︎](https://www.parseable.io/docs/rbac)
69+
- [OAuth2 ↗︎](https://www.parseable.io/docs/oidc)
70+
- [Grafana ↗︎](https://github.com/parseablehq/parseable-datasource)
71+
- [LLM ↗︎](https://www.parseable.io/docs/llm)
72+
- [Stats ↗︎](https://www.postman.com/parseable/workspace/parseable/request/22353706-b32abe55-f0c4-4ed2-9add-110d265888c3)
10873

10974
## :dart: Motivation
11075

11176
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.
11277

11378
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.
11479

115-
## :stethoscope: Support
116-
117-
- For bugs, please create issue on [GitHub ↗︎](https://github.com/parseablehq/parseable/issues).
118-
- For commercial support and consultation, please reach out to us at [`[email protected]` ↗︎](mailto:[email protected]).
119-
- Please consider supporting us on [GitHub Sponsors ↗︎](https://github.com/sponsors/parseablehq).
120-
12180
## :trophy: Contributing
12281

123-
Refer to the contributing guide [here ↗︎](https://www.parseable.io/docs/contributing).
82+
[Contribution guide ↗︎](https://www.parseable.io/docs/contributing).
83+
84+
![Alt](https://repobeats.axiom.co/api/embed/7c4e0f51cd3b8f78d1da682c396a3b5bd855a6ba.svg "Repobeats analytics image")
12485

12586
### Contributors
12687

0 commit comments

Comments
 (0)