Skip to content

Commit 56157bf

Browse files
committed
Update readme
1 parent a226995 commit 56157bf

File tree

1 file changed

+80
-17
lines changed

1 file changed

+80
-17
lines changed

README.md

Lines changed: 80 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -19,21 +19,19 @@
1919

2020
</div>
2121

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.
22+
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**.
2323

24-
To get started, download the Parseable binary from [releases page ↗︎](https://github.com/parseablehq/parseable/releases/latest) and run it on your machine.
24+
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).
2525

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/).
26+
## :zap: QuickStart
2727

28-
For :stethoscope: commercial support and consultation, please reach out to us at [`[email protected]` ↗︎](mailto:[email protected]).
28+
<details>
29+
<summary><a href="https://www.parseable.com/docs/docker-quick-start">Run Parseable in local disk mode with Docker</a></summary>
30+
<p>
2931

30-
![Parseable Console](https://raw.githubusercontent.com/parseablehq/.github/main/images/console.png)
32+
You can <a href="https://www.parseable.com/docs/docker-quick-start">get started with Parseable Docker</a> 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.
3133

32-
## :zap: Quickstart
33-
34-
Deploy Parseable in local storage mode with Docker.
35-
36-
```sh
34+
```bash
3735
docker run -p 8000:8000 \
3836
parseable/parseable:latest \
3937
parseable local-store
@@ -43,7 +41,65 @@ Once this runs successfully, you'll see dashboard at [http://localhost:8000 ↗
4341

4442
To ingest data, run the below command. This will send logs to the `demo` stream. You can see the logs in the dashboard.
4543

46-
```sh
44+
```bash
45+
curl --location --request POST 'http://localhost:8000/api/v1/ingest' \
46+
--header 'X-P-Stream: demo' \
47+
--header 'Authorization: Basic YWRtaW46YWRtaW4=' \
48+
--header 'Content-Type: application/json' \
49+
--data-raw '[
50+
{
51+
"id": "434a5f5e-2f5f-11ed-a261-0242ac120002",
52+
"datetime": "24/Jun/2022:14:12:15 +0000",
53+
"host": "153.10.110.81"
54+
}
55+
]'
56+
```
57+
58+
</p>
59+
</details>
60+
61+
<details>
62+
<summary><a href="https://www.parseable.com/docs/docker-quick-start">Run Parseable binary</a></summary>
63+
<p>
64+
65+
You can also download and run the Parseable binary on your laptop. To download the binary, run the command specific to your OS.
66+
67+
- Linux
68+
69+
```bash
70+
wget https://github.com/parseablehq/parseable/releases/download/v0.9.0/Parseable_x86_64-unknown-linux-gnu -O parseable
71+
chmod +x parseable
72+
./parseable local-store
73+
```
74+
75+
- MacOS (Apple Silicon)
76+
77+
```bash
78+
wget https://github.com/parseablehq/parseable/releases/download/v0.9.0/Parseable_aarch64-apple-darwin -O parseable
79+
chmod +x parseable
80+
./parseable local-store
81+
```
82+
83+
- MacOS (Intel)
84+
85+
```bash
86+
wget https://github.com/parseablehq/parseable/releases/download/v0.9.0/Parseable_x86_64-apple-darwin -O parseable
87+
chmod +x parseable
88+
./parseable local-store
89+
```
90+
91+
- Windows
92+
93+
```bash
94+
Invoke-WebRequest -Uri "https://github.com/parseablehq/parseable/releases/download/v0.9.0/Parseable_x86_64-pc-windows-msvc.exe" -OutFile "C:\parseable.exe"
95+
C:\parseable.exe local-store
96+
```
97+
98+
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`.
99+
100+
To ingest data, run the below command. This will send logs to the `demo` stream. You can see the logs in the dashboard.
101+
102+
```bash
47103
curl --location --request POST 'http://localhost:8000/api/v1/ingest' \
48104
--header 'X-P-Stream: demo' \
49105
--header 'Authorization: Basic YWRtaW46YWRtaW4=' \
@@ -57,12 +113,19 @@ curl --location --request POST 'http://localhost:8000/api/v1/ingest' \
57113
]'
58114
```
59115

60-
## :rocket: Highlights
116+
</p>
117+
</details>
118+
119+
## :question: Why Parseable
120+
121+
### Take control of your data
122+
123+
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.
124+
125+
### Performance & resource efficiency
126+
127+
### Easy to use for developers and operators
61128

62-
- Choose storage backend - local drive or S3 (or compatible) object store.
63-
- Ingestion API compatible with HTTP + JSON output of log agents.
64-
- Query log data with PostgreSQL compatible SQL.
65-
- Single binary includes all components - ingestion, store and query. Built-in UI.
66129

67130
### Enterprise ready
68131

@@ -75,7 +138,7 @@ curl --location --request POST 'http://localhost:8000/api/v1/ingest' \
75138

76139
## :dart: Motivation
77140

78-
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.
141+
79142

80143
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.
81144

0 commit comments

Comments
 (0)