Skip to content

Commit 314cab7

Browse files
authored
Update readme with get started section (#95)
1 parent a44b530 commit 314cab7

File tree

1 file changed

+38
-32
lines changed

1 file changed

+38
-32
lines changed

README.md

Lines changed: 38 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -20,9 +20,23 @@
2020
<a href="https://www.postman.com/parseable/workspace/parseable/overview" target="_blank">API Workspace on Postman</a>
2121
</h4>
2222

23-
Parseable is an open source, cloud native, log storage and management platform.
23+
Parseable is a free and open source, log storage and observability platform.
2424

25-
Parseable helps you ingest high volumes of log data from various sources (Fluent Bit, Logstash etc or directly from applications). Parseable stores log data into highly compressed Parquet file format. With object storage as primary storage for Parseable, you get seamless scale and flexibility for ever growing log data.
25+
Parseable ingests high volumes of log data from various sources (Fluent Bit, Logstash etc or directly from applications). It stores logs into highly compressed Parquet file format. With object storage as primary storage for Parseable, you get seamless scale and flexibility for ever growing log data.
26+
27+
## Why Parseable
28+
29+
* Developer first platform, designed for ease of use and flexibility.
30+
* Log data stored as [Parquet](https://parquet.apache.org) - columnar, open data format, designed for analytics.
31+
* Stateless, index free design with object storage as primary storage.
32+
* SDK less, simple REST API calls for log ingestion.
33+
34+
## Features
35+
36+
* SQL compatible API for querying log data.
37+
* Intuitive dashboard to parse and query the log data.
38+
* Bring your own analytics platform for deeper analysis of log data.
39+
* Auto inferred schema.
2640

2741
<p align="center">
2842
<img src="https://raw.githubusercontent.com/parseablehq/.github/main/images/overview.svg#gh-light-mode-only" alt="Parseable Overview" width="800" height="650" />
@@ -33,35 +47,28 @@ Parseable helps you ingest high volumes of log data from various sources (Fluent
3347

3448
## Live Demo
3549

36-
Try out Parseable server with our demo instance.
37-
38-
1. Post log data to default log stream `frontend`
50+
Try out Parseable server with our demo instance. Send log data to default log stream `frontend`
3951

4052
```sh
4153
curl --location --request POST 'https://demo.parseable.io/api/v1/logstream/frontend' \
4254
--header 'X-P-META-meta1: value1' \
43-
--header 'X-P-META-meta2: value2' \
4455
--header 'X-P-TAGS-tag1: value1' \
45-
--header 'X-P-TAGS-tag2: value2' \
4656
--header 'Authorization: Basic cGFyc2VhYmxlOnBhcnNlYWJsZQ==' \
4757
--header 'Content-Type: application/json' \
4858
--data-raw '[
4959
{
50-
"id": 4,
51-
"host":"153.10.110.81",
52-
"user-identifier":"-",
53-
"datetime":"24/Jun/2022:14:12:15 +0000",
54-
"method": "DELETE",
55-
"request": "/virtual/drive",
56-
"protocol":"HTTP/2.0",
57-
"status":500,
58-
"bytes":21969,
59-
"referer": "http://www.google.com/"
60+
"id": "434a5f5e-2f5f-11ed-a261-0242ac120002",
61+
"datetime": "24/Jun/2022:14:12:15 +0000",
62+
"host": "153.10.110.81",
63+
"user-identifier": "Mozilla/5.0 (Windows NT 6.1; Win64; x64; rv:64.0) Gecko/20100101 Firefox/64.0",
64+
"method": "PUT",
65+
"status": 500,
66+
"referrer": "http://www.google.com/"
6067
}
6168
]'
6269
```
6370

64-
2. Then access the Parseable dashboard to verify the log data is present
71+
Access the Parseable dashboard to verify the log data is present
6572

6673
<table>
6774
<tr>
@@ -80,28 +87,27 @@ curl --location --request POST 'https://demo.parseable.io/api/v1/logstream/front
8087

8188
For complete Parseable API documentation, refer to [Parseable API workspace on Postman](https://www.postman.com/parseable/workspace/parseable/overview).
8289

83-
| :memo: | Parseable is a work in progress. Features will evolve over time and there may be breaking changes between releases. Please give us your feedback in [Slack](https://launchpass.com/parseable), or [Issues](https://github.com/parseablehq/parseable/issues/new). |
90+
| :memo: | Parseable is in alpha stage and will evolve over time. There may be breaking changes between releases. Please give us your feedback in [Slack](https://launchpass.com/parseable), or [Issues](https://github.com/parseablehq/parseable/issues/new). |
8491
|-|:-|
8592

8693
| :exclamation: | Please do not store any sensitive data on this server as the data is openly accessible. We'll delete the data on this server periodically. |
8794
|-|:-|
8895

89-
## Why Parseable
96+
## Getting Started
9097

91-
* Log data compressed and stored in [Parquet](https://parquet.apache.org) - columnar, open data format, designed for analytics.
92-
* Query logs via Parseable or bring your own analytics platform.
93-
* Stateless design with object storage (S3, MinIO) as primary storage. Allowing cost effective scale and flexibility.
94-
* Own your log data on your object storage buckets.
95-
* SDK less, simple REST API calls for log ingestion.
96-
* Indexing free design.
98+
Parseable binary is available on [Github releases](https://github.com/parseablehq/parseable/releases). Please download the latest release for your platform.
9799

98-
## Features
100+
```sh
101+
chmod +x parseable
102+
export P_S3_URL="https://minio.parseable.io:9000"
103+
export P_S3_ACCESS_KEY="minioadmin"
104+
export P_S3_SECRET_KEY="minioadmin"
105+
export P_S3_REGION="us-east-1"
106+
export P_S3_BUCKET="parseable"
107+
./parseable
108+
```
99109

100-
* Cloud native design, get started with Pod logs in minutes.
101-
* Filter log data on labels.
102-
* SQL compatible API for querying log data.
103-
* Intuitive dashboard to parse and query the log data.
104-
* Bring your own analytics platform for deeper analysis of log data.
110+
By default Parseable uses a public bucket to store the data. Please change the object storage credentials to your own bucket, before using Parseable.
105111

106112
## Contributing
107113

0 commit comments

Comments
 (0)