Skip to content

Commit 3f6ac77

Browse files
authored
update readme (#123)
1 parent 46d01aa commit 3f6ac77

File tree

1 file changed

+18
-11
lines changed

1 file changed

+18
-11
lines changed

README.md

Lines changed: 18 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -19,21 +19,28 @@
1919
<br>
2020
</h4>
2121

22-
Parseable is an efficient and scalable log storage and management platform. Cloud native by design, Parseable ensures ease of deployment and use. It is compatible with standard logging agents like FluentBit, LogStash etc. With object storage as primary storage for Parseable, you get seamless scale and flexibility for ever growing log data. Parseable also offers a builtin, intuitive GUI for log query and analysis.
22+
Parseable is a cloud native, log storage and analysis platform. Parseable is written in Rust and can be deployed on Baremetal, VMs, Containers (Kubernetes).
2323

24-
## Why Parseable
24+
Parseable is designed to ensure index-free ingests log data via HTTP POST calls and exposes a query API to search and analyze logs. It is compatible with logging agents like FluentBit, LogStash, FileBeat among others. So, you can point existing logging agents to Parseable.
2525

26-
* Developer first platform, designed for ease of use and flexibility.
27-
* Log data stored as [Parquet](https://parquet.apache.org) - columnar, open data format, designed for analytics.
28-
* Stateless, index free design with object storage as primary storage.
29-
* SDK less, simple REST API calls for log ingestion.
26+
Parseable ships with a GUI to query and analyze logs.
3027

3128
## Features
3229

33-
* SQL compatible API for querying log data.
34-
* Intuitive dashboard to parse and query the log data.
35-
* Bring your own analytics platform for deeper analysis of log data.
36-
* Auto inferred schema.
30+
[x] Highly compressed log data storage with [Parquet](https://parquet.apache.org).
31+
[x] Use standard SQL for querying log data.
32+
[x] Auto inferred schema for log streams.
33+
[x] Dashboard to query the log data.
34+
[x] Compatible with existing logging agents.
35+
[x] Scale with scaling up the node.
36+
[ ] Configurable alerting.
37+
[ ] Distributed, multi-node cluster.
38+
[ ] Log data visualization via Parseable UI.
39+
[ ] Access control for users and groups.
40+
[ ] Log data retention and export.
41+
[ ] Kafka plugin to ingest log data.
42+
[ ] Grafana plugin to visualize log data.
43+
[ ] Anomaly detection within log data.
3744

3845
## Getting Started
3946

@@ -45,7 +52,7 @@ mkdir -p /tmp/parseable
4552
docker run \
4653
-p 8000:8000 \
4754
-v /tmp/parseable:/data \
48-
parseable/parseable:v0.0.1
55+
parseable/parseable:latest
4956
```
5057

5158
### Kubernetes

0 commit comments

Comments
 (0)