Skip to content

Commit 18eb06b

Browse files
authored
Update readme and gh actions (#389)
1 parent 5057779 commit 18eb06b

File tree

3 files changed

+22
-17
lines changed

3 files changed

+22
-17
lines changed

.github/workflows/integration-test.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ jobs:
1717
- name: Checkout
1818
uses: actions/checkout@v3
1919
- name: Start compose
20-
run: docker-compose up --build --exit-code-from quest quest
20+
run: docker-compose up --build --exit-code-from quest
2121
- name: Stop compose
2222
if: always()
2323
run: docker-compose down

README.md

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
<img alt="Parseable Logo" src="https://raw.githubusercontent.com/parseablehq/.github/main/images/logo.svg">
66
</picture>
77
<br>
8-
Cloud native log observability
8+
Cloud native log analytics
99
</h2>
1010

1111
<div align="center">
@@ -17,11 +17,11 @@
1717

1818
</div>
1919

20-
Parseable is a lightweight, cloud native log observability engine. It can use either a local drive or S3 (and compatible stores) for backend data storage.
20+
Parseable is a lightweight, cloud native log observability and analytics engine. It is written in Rust and uses Apache Arrow and Parquet.
2121

22-
Parseable is written in Rust and uses Apache Arrow and Parquet as underlying data structures. Additionally, it uses a simple, index-free mechanism to organize and query data allowing low latency, and high throughput ingestion and query.
22+
Parseable uses a simple, index-free mechanism to organize and query data allowing low latency, and high throughput ingestion and query. It can use either a local mount point or object storage (S3/compatible stores) for data storage.
2323

24-
Parseable consumes up to **_~80% lower memory_** and **_~50% lower CPU_** than Elastic for similar ingestion throughput.
24+
For comparison, Parseable consumes up to **_~80% lower memory_** and **_~50% lower CPU_** than Elastic for similar ingestion throughput. Read more in the [benchmarks directory](./benchmarks/).
2525

2626
- [Parseable UI Demo (Credentials: admin,admin) ↗︎](https://demo.parseable.io)
2727
- [Grafana Dashboard Demo ↗︎](http://demo.parseable.io:3000/dashboards)
@@ -41,12 +41,12 @@ Parseable consumes up to **_~80% lower memory_** and **_~50% lower CPU_** than E
4141
Run the below command to deploy Parseable in local storage mode with Docker.
4242

4343
```sh
44-
mkdir -p /tmp/parseable/data
45-
mkdir -p /tmp/parseable/staging
44+
mkdir -p $HOME/parseable/data
45+
mkdir -p $HOME/parseable/staging
4646

4747
docker run -p 8000:8000 \
48-
-v /tmp/parseable/data:/parseable/data \
49-
-v /tmp/parseable/staging:/parseable/staging \
48+
-v $HOME/parseable/data:/parseable/data \
49+
-v $HOME/parseable/staging:/parseable/staging \
5050
-e P_FS_DIR=/parseable/data \
5151
-e P_STAGING_DIR=/parseable/staging \
5252
parseable/parseable:latest \
@@ -74,10 +74,10 @@ curl --location --request POST 'http://localhost:8000/api/v1/logstream/demo' \
7474
{
7575
"id": "434a5f5e-2f5f-11ed-a261-0242ac120002",
7676
"datetime": "24/Jun/2022:14:12:15 +0000",
77-
"host": "153.10.110.81",
78-
"user-identifier": "Mozilla/5.0 Gecko/20100101 Firefox/64.0",
79-
"method": "PUT",
80-
"status": 500,
77+
"host": "153.10.110.81",
78+
"user-identifier": "Mozilla/5.0 Gecko/20100101 Firefox/64.0",
79+
"method": "PUT",
80+
"status": 500,
8181
"referrer": "http://www.google.com/"
8282
}
8383
]'
@@ -95,8 +95,8 @@ curl --location --request POST 'http://localhost:8000/api/v1/query' \
9595
--header 'Content-Type: application/json' \
9696
--data-raw '{
9797
"query":"select * from demo",
98-
"startTime":"2023-01-09T00:00:00+00:00",
99-
"endTime":"2023-01-09T23:59:00+00:00"
98+
"startTime":"2023-06-09T00:00:00+00:00",
99+
"endTime":"2023-06-09T23:59:00+00:00"
100100
}'
101101
```
102102

@@ -118,9 +118,9 @@ But with log data growing exponentially, today's log data challenges involve who
118118

119119
## :stethoscope: Support
120120

121-
- For questions and feedback please feel free to reach out to us on [Slack ↗︎](https://launchpass.com/parseable).
122121
- For bugs, please create issue on [GitHub ↗︎](https://github.com/parseablehq/parseable/issues).
123122
- For commercial support and consultation, please reach out to us at [`[email protected]` ↗︎](mailto:[email protected]).
123+
- Please consider supporting us on [GitHub Sponsors ↗︎](https://github.com/parseablehq/sponsors).
124124

125125
## :trophy: Contributing
126126

docker-compose.yaml

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -52,6 +52,11 @@ services:
5252
retries: 5
5353
depends_on:
5454
- minio
55+
deploy:
56+
restart_policy:
57+
condition: on-failure
58+
delay: 20s
59+
max_attempts: 3
5560

5661
quest:
5762
image: ghcr.io/parseablehq/quest:main
@@ -63,5 +68,5 @@ services:
6368
deploy:
6469
restart_policy:
6570
condition: on-failure
66-
delay: 10s
71+
delay: 20s
6772
max_attempts: 3

0 commit comments

Comments
 (0)