Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 7 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,15 +16,13 @@

## Why Parseable?

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.
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.

Parseable started because of this _missing_ case. We intend to enrich the ecosystem with a developer friendly, cloud native, event & log observability platform.
Our aim with Parseable is to provide a fully open source, developer friendly, kubernetes and cloud native, scalable, logging and observability platform.
## How it works

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.

Parseable can be deployed in cloud and container based environments in minutes and can scale as the requirements grow.

#### Key differentiators

- Written in Rust. Low CPU & memory footprint, with low latency, high throughput.
Expand All @@ -34,7 +32,7 @@ Parseable can be deployed in cloud and container based environments in minutes a

## Installing

Docker is the quickest way to experience Parseable on your machine. Run the below command to deploy Parseable in demo mode.
Run the below command to deploy Parseable in demo mode with Docker.

```sh
mkdir -p /tmp/data
Expand All @@ -47,7 +45,7 @@ docker run \

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).
Prefer other platforms? Check out installation options (Kubernetes, bare-metal), in the [documentation](https://www.parseable.io/docs/category/installation).

#### Live demo

Expand All @@ -56,7 +54,6 @@ Instead of installing locally, you can also try out Parseable on our [Demo insta
## Usage

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`).

#### Create a stream

```sh
Expand Down Expand Up @@ -85,7 +82,9 @@ curl --location --request POST 'http://localhost:8000/api/v1/logstream/<stream-n
]'
```

For complete Parseable API documentation, refer to [Parseable API Docs](https://www.parseable.io/docs/category/api).
- For complete Parseable API documentation, refer to [Parseable API Docs](https://www.parseable.io/docs/category/api).
- To configure Parseable with popular logging agents, please refer to the [agent documentation](https://www.parseable.io/docs/category/log-agents).
- To integrate Parseable with your applications directly, please refer to the [integration documentation](https://www.parseable.io/docs/category/application-integration).

## Support

Expand Down
168 changes: 0 additions & 168 deletions docs/syslog_ng_log_forwarding.md

This file was deleted.