From 16f51750356c11fd0a648c4171c1504c810e08cc Mon Sep 17 00:00:00 2001 From: Nitish Tiwari Date: Thu, 25 Aug 2022 20:04:16 +0530 Subject: [PATCH] Update readme --- README.md | 33 +++++++++++++++++++++++---------- 1 file changed, 23 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index bf0bcecf6..ac9bb34b1 100644 --- a/README.md +++ b/README.md @@ -19,7 +19,7 @@ Parseable is an open source, cloud native, log storage and management platform. -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. +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.

Parseable Overview @@ -42,10 +42,17 @@ curl --location --request POST 'https://demo.parseable.io/api/v1/logstream/front --header 'Content-Type: application/json' \ --data-raw '[ { - "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\"}", + "id": 2, + "time": "2022-06-24T14:12:17.411829648Z", + "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\"}", + "http_status": 500, "meta_Host": "10.116.0.3", "meta_Source": "10.244.0.147", - "meta_ContainerName": "log-generator" + "meta_ContainerName": "log-generator", + "meta_ContainerImage": "mingrammer/flog", + "meta_PodName": "go-app-6c87bc9cc9-vqv66", + "meta_Namespace": "go-apasdp", + "meta_PodLabels": "app=go-app,pod-template-hash=6c87bc9cc9" } ]' ``` @@ -69,18 +76,24 @@ curl --location --request POST 'https://demo.parseable.io/api/v1/logstream/front For complete Parseable API documentation, refer to [Parseable API workspace on Postman](https://www.postman.com/parseable/workspace/parseable/overview). -**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. +**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. ## Why Parseable -* Indexing free design. -* 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. -* Stateless design allowing seamless scale and flexibility. +* Log data compressed and stored in [Parquet](https://parquet.apache.org) - columnar, open data format, designed for analytics. +* Query logs via Parseable or bring your own analytics platform. +* Stateless design with object storage (S3, MinIO) as primary storage. Allowing cost effective scale and flexibility. * Own your log data on your object storage buckets. * SDK less, simple REST API calls for log ingestion. +* Indexing free design. ## Features -* Kubernetes native design, allowing to get started with pod logs in minutes. -* Filter log data on tags. -* Query for specific keywords and fields. +* Cloud native design, get started with Pod logs in minutes. +* Filter log data on labels. +* SQL compatible API for querying log data. * Intuitive dashboard to parse and query the log data. +* Bring your own analytics platform for deeper analysis of log data. + +## Contributing + +Refer to the contributing guide [here](https://www.parseable.io/docs/contributing).