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
+7-8Lines changed: 7 additions & 8 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -16,15 +16,13 @@
16
16
17
17
## Why Parseable?
18
18
19
-
As SREs, DevOps deploy and manage more and more cloud native applications, there is a glaring gap in the ecosystem for a developer friendly, cloud native, event & log observability platform. We faced this issue first hand at our jobs, and we've seen several other large scale Kubernetes users relating to this gap.
19
+
As SREs, DevOps deploy and manage more and more cloud native applications, there is a glaring gap in the ecosystem for a developer friendly, cloud native, event & log observability platform. We saw this issue manifest multiple times in several shapes and forms, across organizations.
20
20
21
-
Parseable started because of this _missing_ case. We intend to enrich the ecosystem with a developer friendly, cloud native, event & log observability platform.
21
+
Our aim with Parseable is to provide a fully open source, developer friendly, kubernetes and cloud native, scalable, logging and observability platform.
22
22
## How it works
23
23
24
24
Parseable exposes REST API to ingest and query log data. Under the hood, it uses Apache Arrow and Parquet to handle and compress high volume log data. All data is stored in S3 (or compatible systems). Parseable also has a bundled web console to visualize and query log data.
25
25
26
-
Parseable can be deployed in cloud and container based environments in minutes and can scale as the requirements grow.
27
-
28
26
#### Key differentiators
29
27
30
28
- Written in Rust. Low CPU & memory footprint, with low latency, high throughput.
@@ -34,7 +32,7 @@ Parseable can be deployed in cloud and container based environments in minutes a
34
32
35
33
## Installing
36
34
37
-
Docker is the quickest way to experience Parseable on your machine. Run the below command to deploy Parseable in demo mode.
35
+
Run the below command to deploy Parseable in demo mode with Docker.
38
36
39
37
```sh
40
38
mkdir -p /tmp/data
@@ -47,7 +45,7 @@ docker run \
47
45
48
46
Once this runs successfully, you'll see dashboard at [http://localhost:8000](http://localhost:8000). You can login to the dashboard with `parseable`, `parseable` as the credentials. Please make sure not to post any important data while in demo mode.
49
47
50
-
For non-demo and other installation options (Kubernetes, bare-metal), please refer to the [documentation](https://www.parseable.io/docs/category/installation).
48
+
Prefer other platforms? Check out installation options (Kubernetes, bare-metal), in the [documentation](https://www.parseable.io/docs/category/installation).
51
49
52
50
#### Live demo
53
51
@@ -56,7 +54,6 @@ Instead of installing locally, you can also try out Parseable on our [Demo insta
56
54
## Usage
57
55
58
56
If you've already deployed Parseable using the above Docker command, use below commands to create stream and post event(s) to the stream. Make sure to replace `<stream-name>` with the name of the stream you want to create and post events (e.g. `my-stream`).
59
-
60
57
#### Create a stream
61
58
62
59
```sh
@@ -85,7 +82,9 @@ curl --location --request POST 'http://localhost:8000/api/v1/logstream/<stream-n
85
82
]'
86
83
```
87
84
88
-
For complete Parseable API documentation, refer to [Parseable API Docs](https://www.parseable.io/docs/category/api).
85
+
- For complete Parseable API documentation, refer to [Parseable API Docs](https://www.parseable.io/docs/category/api).
86
+
- To configure Parseable with popular logging agents, please refer to the [agent documentation](https://www.parseable.io/docs/category/log-agents).
87
+
- To integrate Parseable with your applications directly, please refer to the [integration documentation](https://www.parseable.io/docs/category/application-integration).
0 commit comments