Skip to content

Commit f81bc0e

Browse files
authored
cleaned up readme for better readability (#738)
1 parent a226995 commit f81bc0e

File tree

2 files changed

+99
-44
lines changed

2 files changed

+99
-44
lines changed

README.md

Lines changed: 98 additions & 43 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
<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>
8-
Cloud native log analytics
8+
**Log Lake** for the cloud-native world
99
</h2>
1010

1111
<div align="center">
@@ -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, security and privacy 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+
## QuickStart :zap:
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">Docker Image</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,7 @@ 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
4745
curl --location --request POST 'http://localhost:8000/api/v1/ingest' \
4846
--header 'X-P-Stream: demo' \
4947
--header 'Authorization: Basic YWRtaW46YWRtaW4=' \
@@ -57,55 +55,112 @@ curl --location --request POST 'http://localhost:8000/api/v1/ingest' \
5755
]'
5856
```
5957

60-
## :rocket: Highlights
58+
</p>
59+
</details>
6160

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.
61+
<details>
62+
<summary><a href="https://www.parseable.com/docs/docker-quick-start">Executable Binary</a></summary>
63+
<p>
6664

67-
### Enterprise ready
65+
You can download and run the Parseable binary on your laptop.
6866

69-
- [Alerts ↗︎](https://www.parseable.io/docs/alerts)
70-
- [RBAC ↗︎](https://www.parseable.io/docs/rbac)
71-
- [OAuth2 ↗︎](https://www.parseable.io/docs/oidc)
72-
- [Grafana ↗︎](https://github.com/parseablehq/parseable-datasource)
73-
- [LLM ↗︎](https://www.parseable.io/docs/llm)
74-
- [Stats ↗︎](https://www.postman.com/parseable/workspace/parseable/request/22353706-b32abe55-f0c4-4ed2-9add-110d265888c3)
67+
- Linux
7568

76-
## :dart: Motivation
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+
```
7774

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.
75+
- MacOS (Apple Silicon)
7976

80-
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.
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+
```
8182

82-
## :trophy: Contributing
83+
- MacOS (Intel)
8384

84-
[Contribution guide ↗︎](https://www.parseable.io/docs/contributing).
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+
```
8590

86-
![Alt](https://repobeats.axiom.co/api/embed/7c4e0f51cd3b8f78d1da682c396a3b5bd855a6ba.svg "Repobeats analytics image")
91+
- Windows
8792

88-
### Contributors
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+
```
8997

90-
<a href="https://github.com/parseablehq/parseable/graphs/contributors"><img src="https://contrib.rocks/image?repo=parseablehq/parseable" /></a>
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`.
9199

92-
### License report
100+
To ingest data, run the below command. This will send logs to the `demo` stream. You can see the logs in the dashboard.
93101

94-
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.
102+
```bash
103+
curl --location --request POST 'http://localhost:8000/api/v1/ingest' \
104+
--header 'X-P-Stream: demo' \
105+
--header 'Authorization: Basic YWRtaW46YWRtaW4=' \
106+
--header 'Content-Type: application/json' \
107+
--data-raw '[
108+
{
109+
"id": "434a5f5e-2f5f-11ed-a261-0242ac120002",
110+
"datetime": "24/Jun/2022:14:12:15 +0000",
111+
"host": "153.10.110.81"
112+
}
113+
]'
114+
```
95115

96-
If not already installed, install `cargo-about` using the below command.
116+
</p>
117+
</details>
97118

98-
```sh
99-
cargo install --locked cargo-about && cargo about init
100-
```
119+
## Why Parseable :question:
101120

102-
To generate a license report, run the below command.
121+
### Performance & resource efficiency
103122

104-
```sh
105-
cargo about generate about.hbs > parseable-license.html
106-
```
123+
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.
124+
125+
### Easy of use
126+
127+
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.
128+
129+
### Take control of your data
130+
131+
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.
132+
133+
### Enterprise ready
134+
135+
- High availability & Cluster mode
136+
- Local cache & storage
137+
- [OpenTelemetry support ↗︎](https://opentelemetry.io/)
138+
- [Alerts ↗︎](https://www.parseable.io/docs/alerts)
139+
- [Role based access control ↗︎](https://www.parseable.io/docs/rbac)
140+
- [OAuth2 support ↗︎](https://www.parseable.io/docs/oidc)
141+
- [Grafana based visualization ↗︎](https://github.com/parseablehq/parseable-datasource)
142+
- [LLM ↗︎](https://www.parseable.io/docs/llm)
143+
- [Stats ↗︎](https://www.postman.com/parseable/workspace/parseable/request/22353706-b32abe55-f0c4-4ed2-9add-110d265888c3)
107144

108-
You can see the license report in the file parseable-license.html.
145+
## How do people use Parseable :bulb:
146+
147+
- **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.
148+
149+
- **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.
150+
151+
- **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.
152+
153+
## Motivation :dart:
154+
155+
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.
156+
157+
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.
158+
159+
## Contributing :trophy:
160+
161+
[Contribution guide ↗︎](https://www.parseable.io/docs/contributing).
162+
163+
<a href="https://github.com/parseablehq/parseable/graphs/contributors"><img src="https://contrib.rocks/image?repo=parseablehq/parseable" /></a>
109164

110165
### Supported by
111166

USERS.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
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.
44

5-
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.
5+
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.
66

77
---
88

0 commit comments

Comments
 (0)