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
Parseable is a cloud native, log storage and observability platform. Parseable is written in Rust and index free by design. Parseable is available as a single binary / Docker image and can be deployed on a wide range of platforms.
17
+
## Why Parseable?
24
18
25
-
It ingests log data via HTTP POST calls and exposes a query API to search and analyze logs. It is compatible with all the standard logging agents via HTTP output plugins.
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.
Parseable started because of this _missing_ case. We intend to enrich the ecosystem with a developer friendly, cloud native, event & log observability platform.
22
+
## How it works
28
23
29
-
## Features
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.
30
25
31
-
-[x] Highly compressed log data storage with [Parquet](https://parquet.apache.org).
32
-
-[x] Use standard SQL for querying log data.
33
-
-[x] Auto inferred schema for log streams.
34
-
-[x] Dashboard to query the log data.
35
-
-[x] Compatible with existing logging agents.
36
-
-[x] Scale with scaling up the node.
37
-
-[ ] Configurable alerting.
38
-
-[ ] Distributed, multi-node cluster.
39
-
-[ ] Log data visualization via Parseable UI.
40
-
-[ ] Access control for users and groups.
41
-
-[ ] Log data retention and export.
42
-
-[ ] Kafka plugin to ingest log data.
43
-
-[ ] Grafana plugin to visualize log data.
44
-
-[ ] Anomaly detection within log data.
26
+
Parseable can be deployed in cloud and container based environments in minutes and can scale as the requirements grow.
45
27
46
-
##Getting Started
28
+
#### Key differentiators
47
29
48
-
### Docker
49
-
Parseable docker image is available on [Docker hub](https://hub.docker.com/r/parseable/parseable). Please change the environment variables as relevant.
30
+
- Written in Rust. Low CPU & memory footprint, with low latency, high throughput.
31
+
- Open data format (Parquet). Complete ownership of data. Wide range of possibilities for data analysis.
32
+
- Single binary / container based deployment (including UI). Deploy in minutes if not seconds.
33
+
- Indexing free design. Lower CPU and storage overhead. Similar levels of performance as indexing based systems.
50
34
51
-
```sh
52
-
cat <<EOF > parseable-env
53
-
P_S3_URL=https://minio.parseable.io:9000
54
-
P_S3_ACCESS_KEY=minioadmin
55
-
P_S3_SECRET_KEY=minioadmin
56
-
P_S3_REGION=us-east-1
57
-
P_S3_BUCKET=parseable
58
-
P_LOCAL_STORAGE=/data
59
-
P_USERNAME=parseable
60
-
P_PASSWORD=parseable
61
-
EOF
35
+
## Installing
36
+
37
+
Docker is the quickest way to experience Parseable on your machine. Run the below command to deploy Parseable in demo mode.
62
38
39
+
```sh
63
40
mkdir -p /tmp/data
64
41
docker run \
65
42
-p 8000:8000 \
66
-
--env-file parseable-env \
67
43
-v /tmp/data:/data \
68
44
parseable/parseable:latest \
69
-
parseable server
45
+
parseable server --demo
70
46
```
71
47
72
-
### Kubernetes
73
-
Parseable helm chart is available at [Parseable charts repository](https://charts.parseable.io/).
48
+
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.
For non-demo and other installation options (Kubernetes, bare-metal), please refer to the [documentation](https://www.parseable.io/docs/category/installation).
81
51
82
-
### Binary
83
-
Parseable binary is available on [Github releases](https://github.com/parseablehq/parseable/releases). Please download the latest release for your platform, also make sure to change the environment variables as relevant.
52
+
#### Live demo
84
53
85
-
```sh
86
-
export P_S3_URL="https://minio.parseable.io:9000"
87
-
export P_S3_ACCESS_KEY="minioadmin"
88
-
export P_S3_SECRET_KEY="minioadmin"
89
-
export P_S3_REGION="us-east-1"
90
-
export P_S3_BUCKET="parseable"
91
-
export P_LOCAL_STORAGE="./data"
92
-
export P_USERNAME="parseable"
93
-
export P_PASSWORD="parseable"
94
-
chmod +x parseable
95
-
./parseable
96
-
```
54
+
Instead of installing locally, you can also try out Parseable on our [Demo instance](https://demo.parseable.io). Credentials to login to the dashboard are `parseable` / `parseable`.
97
55
98
-
<h1></h1>
56
+
## Usage
99
57
100
-
Parseable dashboard is available at [http://localhost:8000](http://localhost:8000). Credentials to login to the dashboard are the values you set in the environment variables.
58
+
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`).
101
59
102
-
: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).
103
-
104
-
## Using Parseable
105
-
`<stream-name>` is the name of the stream you want to create. `<basic-auth-header>` is the basic auth header value generated from username & password of the user you created in the environment variables. You can generate the basic auth header value using the following command.
106
-
107
-
```sh
108
-
echo -n '<user-name>:<password>'| base64
109
-
```
110
-
111
-
### Create a stream
60
+
#### Create a stream
112
61
113
62
```sh
114
63
curl --location --request PUT 'http://localhost:8000/api/v1/logstream/<stream-name>' \
@@ -136,16 +85,22 @@ curl --location --request POST 'http://localhost:8000/api/v1/logstream/<stream-n
136
85
]'
137
86
```
138
87
139
-
For complete Parseable API documentation, refer to [Parseable API Ref Docs](https://www.parseable.io/docs/api-reference).
88
+
For complete Parseable API documentation, refer to [Parseable API Docs](https://www.parseable.io/docs/category/api).
140
89
141
-
## Live Demo
90
+
## Support
91
+
92
+
For questions and feedback please feel free to reach out to us on [Slack](https://launchpass.com/parseable). For bugs, please create issue on [GitHub](https://github.com/parseablehq/parseable/issues).
You can also try out Parseable on our [https://demo.parseable.io](https://demo.parseable.io). Credentials to login to the dashboard are `parseable` / `parseable`.
144
-
145
96
## Contributing
146
97
147
98
Refer to the contributing guide [here](https://www.parseable.io/docs/contributing).
0 commit comments