Skip to content

Commit 2dbb852

Browse files
authored
Update readme (#64)
1 parent ae53850 commit 2dbb852

File tree

1 file changed

+23
-10
lines changed

1 file changed

+23
-10
lines changed

README.md

Lines changed: 23 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@
1919

2020
Parseable is an open source, cloud native, log storage and management platform.
2121

22-
Parseable helps you ingest high volumes of log data from various sources (Fluentbit, 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.
22+
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.
2323

2424
<p align="center">
2525
<img src="https://raw.githubusercontent.com/parseablehq/.github/main/images/overview.svg#gh-light-mode-only" alt="Parseable Overview" width="800" height="650" />
@@ -42,10 +42,17 @@ curl --location --request POST 'https://demo.parseable.io/api/v1/logstream/front
4242
--header 'Content-Type: application/json' \
4343
--data-raw '[
4444
{
45-
"log": "{\"id\": 4, \"host\":\"153.10.110.81\", \"user-identifier\":\"-\", \"datetime\":\"24/Jun/2022:14:12:15 +0000\", \"method\": \"GET\", \"request\": \"/virtual/drive\", \"protocol\":\"HTTP/2.0\", \"status\":500, \"bytes\":21969, \"referer\": \"http://www.seniordisintermediate.net/mesh/users\"}",
45+
"id": 2,
46+
"time": "2022-06-24T14:12:17.411829648Z",
47+
"log": "{\"host\":\"153.10.110.81\", \"user-identifier\":\"-\", \"datetime\":\"24/Jun/2022:14:12:15 +0000\", \"method\": \"DELETE\", \"request\": \"/virtual/drive\", \"protocol\":\"HTTP/2.0\", \"status\":500, \"bytes\":21969, \"referer\": \"http://www.seniordisintermediate.net/mesh/users\"}",
48+
"http_status": 500,
4649
"meta_Host": "10.116.0.3",
4750
"meta_Source": "10.244.0.147",
48-
"meta_ContainerName": "log-generator"
51+
"meta_ContainerName": "log-generator",
52+
"meta_ContainerImage": "mingrammer/flog",
53+
"meta_PodName": "go-app-6c87bc9cc9-vqv66",
54+
"meta_Namespace": "go-apasdp",
55+
"meta_PodLabels": "app=go-app,pod-template-hash=6c87bc9cc9"
4956
}
5057
]'
5158
```
@@ -69,18 +76,24 @@ curl --location --request POST 'https://demo.parseable.io/api/v1/logstream/front
6976

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

72-
**Note**: Please do not store any sensitive data on this server as the data is openly available. We'll delete the data on this server periodically.
79+
**Note**: 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.
7380
## Why Parseable
7481

75-
* Indexing free design.
76-
* Highly compressed log data, stored in [Parquet](https://parquet.apache.org) - columnar, open data format. Query logs via Parseable or bring your own analytics platform.
77-
* Stateless design allowing seamless scale and flexibility.
82+
* Log data compressed and stored in [Parquet](https://parquet.apache.org) - columnar, open data format, designed for analytics.
83+
* Query logs via Parseable or bring your own analytics platform.
84+
* Stateless design with object storage (S3, MinIO) as primary storage. Allowing cost effective scale and flexibility.
7885
* Own your log data on your object storage buckets.
7986
* SDK less, simple REST API calls for log ingestion.
87+
* Indexing free design.
8088

8189
## Features
8290

83-
* Kubernetes native design, allowing to get started with pod logs in minutes.
84-
* Filter log data on tags.
85-
* Query for specific keywords and fields.
91+
* Cloud native design, get started with Pod logs in minutes.
92+
* Filter log data on labels.
93+
* SQL compatible API for querying log data.
8694
* Intuitive dashboard to parse and query the log data.
95+
* Bring your own analytics platform for deeper analysis of log data.
96+
97+
## Contributing
98+
99+
Refer to the contributing guide [here](https://www.parseable.io/docs/contributing).

0 commit comments

Comments
 (0)