Skip to content

Commit 974929a

Browse files
authored
Add dockerfile for using custom console build (#920)
Also update readme and remove unnecessary sections
1 parent c0741f2 commit 974929a

File tree

2 files changed

+50
-31
lines changed

2 files changed

+50
-31
lines changed

Dockerfile.dev

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
# Parseable Server (C) 2022 - 2024 Parseable, Inc.
2+
#
3+
# This program is free software: you can redistribute it and/or modify
4+
# it under the terms of the GNU Affero General Public License as
5+
# published by the Free Software Foundation, either version 3 of the
6+
# License, or (at your option) any later version.
7+
#
8+
# This program is distributed in the hope that it will be useful,
9+
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10+
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11+
# GNU Affero General Public License for more details.
12+
#
13+
# You should have received a copy of the GNU Affero General Public License
14+
# along with this program. If not, see <http://www.gnu.org/licenses/>.
15+
16+
# build stage
17+
FROM rust:1.77.1-bookworm AS builder
18+
19+
LABEL org.opencontainers.image.title="Parseable"
20+
LABEL maintainer="Parseable Team <[email protected]>"
21+
LABEL org.opencontainers.image.vendor="Parseable Inc"
22+
LABEL org.opencontainers.image.licenses="AGPL-3.0"
23+
24+
WORKDIR /parseable
25+
COPY . .
26+
27+
## Ensure that you build the console assests https://github.com/parseablehq/console?tab=readme-ov-file#trophy-development-and-contributing
28+
## Then create a dist folder in the root of the this directory and copy the contents of the console/dist folder into the dist folder
29+
ENV LOCAL_ASSETS_PATH=/parseable/dist
30+
RUN cargo build --release
31+
32+
# final stage
33+
FROM gcr.io/distroless/cc-debian12:latest
34+
35+
WORKDIR /parseable
36+
37+
# Copy the static shell into base image.
38+
COPY --from=builder /parseable/target/release/parseable /usr/bin/parseable
39+
40+
CMD ["/usr/bin/parseable"]

README.md

Lines changed: 10 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
<a href="https://www.parseable.io" target="_blank"><img src="https://raw.githubusercontent.com/parseablehq/.github/main/images/logo.svg" alt="Parseable" width="600" height="150" /></a>
66
</picture>
77
<br>
8-
Log Lake for the cloud-native world
8+
The <i>versatile</i> log database for search, analysis, and monitoring
99
</h2>
1010

1111
<div align="center">
@@ -19,7 +19,7 @@
1919

2020
</div>
2121

22-
Parseable is a **cloud native, log analytics platform, with a focus on performance & resource efficiency**. Parseable is useful for use cases where **complete data ownership, security and privacy are paramount**.
22+
Parseable is a **cloud native log analytics platform, with a focus on simplicity & resource efficiency**. Parseable is useful for use cases where **complete data ownership, security and privacy are paramount**.
2323

2424
To experience Parseable UI, checkout [demo.parseable.com ↗︎](https://demo.parseable.com/login?q=eyJ1c2VybmFtZSI6ImFkbWluIiwicGFzc3dvcmQiOiJhZG1pbiJ9). You can also view the [demo video ↗︎](https://www.parseable.com/video.mp4).
2525

@@ -97,40 +97,24 @@ curl --location --request POST 'http://localhost:8000/api/v1/ingest' \
9797
</p>
9898
</details>
9999

100-
## Why Parseable :question:
100+
## Features :rocket:
101101

102-
### Performance & resource efficiency
103-
104-
Parseable is written in Rust, with a clear focus on performance while ensuring a much lower CPU and memory footprint (compared to Java, Go based systems). When compared with Elastic, Parseable uses ~80% lesser memory and ~50% lesser CPU, while offering a better ingestion rate. This means you can run Parseable on smaller instances, saving costs.
105-
106-
### Easy of use
107-
108-
One of the key challenges users said they face today is the complexity of setting a logging system like Elastic. There are so many moving parts, and it's hard to get started. Parseable is designed to be simple to use, with a single binary that can be run on almost anywhere. The Console is built in the binary itself, so you can start using it without any additional setup.
109-
110-
### Take control of your data
111-
112-
With Apache Arrow and Apache Parquet as the underlying data formats, Parseable stores log data in an optimized, compressed manner as Parquet files. This means you get complete control and access to your data. You can use Parseable query and analysis, but also can plugin tools from wider Parquet ecosystem for further processing, analysis, and visualization.
113-
114-
### Enterprise ready
115-
116-
- High availability & Cluster mode
117-
- Local cache & storage
118-
- [OpenTelemetry support ↗︎](https://opentelemetry.io/)
102+
- [High availability & Cluster mode ↗︎](https://www.parseable.com/docs/concepts/distributed-architecture)
103+
- [Local cache ↗︎](https://www.parseable.com/docs/features/tiering)
119104
- [Alerts ↗︎](https://www.parseable.io/docs/alerts)
120105
- [Role based access control ↗︎](https://www.parseable.io/docs/rbac)
121106
- [OAuth2 support ↗︎](https://www.parseable.io/docs/oidc)
122-
- [Grafana based visualization ↗︎](https://github.com/parseablehq/parseable-datasource)
123-
- [LLM ↗︎](https://www.parseable.io/docs/llm)
124-
- [Stats ↗︎](https://www.postman.com/parseable/workspace/parseable/request/22353706-b32abe55-f0c4-4ed2-9add-110d265888c3)
107+
- [LLM integration ↗︎](https://www.parseable.io/docs/llm)
108+
- [OpenTelemetry support ↗︎](https://www.parseable.com/docs/opentelemetry)
125109

126110
## How do people use Parseable :bulb:
127111

112+
- **Log Analytics** - Not all logs are created equal. For example application logs are seldom useful after a few days pass, but if same application also logs all the user interactions, that data is very valuable for product managers, and can be stored for a longer period. Several businesses store such high value logs and slice / dice them as needed.
113+
128114
- **Audit & Compliance** - Organizations that need to store logs in a secure, compliant manner. Parseable's direct to S3 bucket storage mode ensures that logs are stored in a secure, cost effective manner, and can be accessed only by authorized users, while all the data is queryable in real-time.
129115

130116
- **Observability & Monitoring** - A very large chunk of observability data is logs. Organizations that need to monitor their systems, applications, and infrastructure in real-time use Parseable as the primary log storage system so they get timely alerts, and can analyze logs in real-time.
131117

132-
- **Log Analytics** - Not all logs are created equal. For example application logs are seldom useful after a few days pass, but if same application also logs all the user interactions, that data is very valuable for product managers, and can be stored for a longer period. Several businesses store such high value logs and slice / dice them as needed.
133-
134118
## Motivation :dart:
135119

136120
Traditionally, logging has been seen as a text search problem. Log volumes were not high, and data ingestion or storage were not really issues. This led us to today, where all the logging platforms are primarily text search engines.
@@ -139,11 +123,6 @@ But with log data growing exponentially, today's log data challenges involve who
139123

140124
## Contributing :trophy:
141125

142-
[Contribution guide ↗︎](https://www.parseable.io/docs/contributing).
143-
144126
<a href="https://github.com/parseablehq/parseable/graphs/contributors"><img src="https://contrib.rocks/image?repo=parseablehq/parseable" /></a>
145127

146-
### Supported by
147-
148-
<a href="https://fossunited.org/" target="_blank"><img src="http://fossunited.org/files/fossunited-badge.svg"></a>
149-
<img referrerpolicy="no-referrer-when-downgrade" src="https://static.scarf.sh/a.png?x-pxid=cb5c7633-1c88-4792-be58-6228c476cef5" />
128+
[Contribution guide ↗︎](https://www.parseable.com/docs/contributing)

0 commit comments

Comments
 (0)