You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+38-32Lines changed: 38 additions & 32 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -20,9 +20,23 @@
20
20
<ahref="https://www.postman.com/parseable/workspace/parseable/overview"target="_blank">API Workspace on Postman</a>
21
21
</h4>
22
22
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.
24
24
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.
"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/"
60
67
}
61
68
]'
62
69
```
63
70
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
65
72
66
73
<table>
67
74
<tr>
@@ -80,28 +87,27 @@ curl --location --request POST 'https://demo.parseable.io/api/v1/logstream/front
80
87
81
88
For complete Parseable API documentation, refer to [Parseable API workspace on Postman](https://www.postman.com/parseable/workspace/parseable/overview).
82
89
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). |
84
91
|-|:-|
85
92
86
93
|: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. |
87
94
|-|:-|
88
95
89
-
## Why Parseable
96
+
## Getting Started
90
97
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.
97
99
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
+
```
99
109
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.
0 commit comments