Skip to content

Commit

Permalink
Merge remote-tracking branch 'upstream/main' into clp-core-generic-pa…
Browse files Browse the repository at this point in the history
…rser-changes
  • Loading branch information
gibber9809 committed May 12, 2024
2 parents 8dba752 + ffdf1ca commit 21c5611
Show file tree
Hide file tree
Showing 72 changed files with 1,558 additions and 512 deletions.
27 changes: 15 additions & 12 deletions .github/workflows/clp-lint.yaml
Original file line number Diff line number Diff line change
@@ -1,6 +1,12 @@
name: "clp-lint"

on: ["pull_request", "push", "workflow_dispatch"]
on:
pull_request:
push:
schedule:
# Run at midnight UTC every day with 15 minutes delay added to avoid high load periods
- cron: "0 15 * * *"
workflow_dispatch:

concurrency:
group: "${{github.workflow}}-${{github.ref}}"
Expand All @@ -9,7 +15,10 @@ concurrency:

jobs:
lint-check:
runs-on: "ubuntu-latest"
strategy:
matrix:
os: ["macos-latest", "ubuntu-latest"]
runs-on: "${{matrix.os}}"
steps:
- uses: "actions/checkout@v3"
with:
Expand All @@ -19,20 +28,14 @@ jobs:
with:
python-version: "3.11"

- id: "parse_meteor_version"
run: |-
release_file="./components/webui/.meteor/release"
meteor_version=$(grep --only-matching --perl-regexp "[\d.]+" $release_file)
echo "meteor_version=${meteor_version}" | tee --append $GITHUB_OUTPUT
- uses: "meteorengineer/setup-meteor@v1"
with:
meteor-release: "${{steps.parse_meteor_version.outputs.meteor_version}}"

- name: "Install task"
shell: "bash"
run: "npm install -g @go-task/cli"

- if: "matrix.os == 'macos-latest'"
name: "Install coreutils (for md5sum)"
run: "brew install coreutils"

- name: "Run lint task"
shell: "bash"
run: "task lint:check"
11 changes: 8 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,8 +12,8 @@ about it, you can read our [paper][clp-paper].

# Benchmarks

![CLP Benchmark on JSON Logs](docs/src/_static/clp-json-benchmark.png)
![CLP Benchmark on Unstructured Logs](docs/src/_static/clp-unstructured-benchmark.png)
![CLP Benchmark on JSON Logs](docs/src/clp-json-benchmark.png)
![CLP Benchmark on Unstructured Logs](docs/src/clp-unstructured-benchmark.png)

The figures above show CLP's compression and search performance compared to other tools. We separate
the experiments between JSON and unstructured logs because (1) some tools can only handle one type
Expand All @@ -31,7 +31,7 @@ the [CLP paper][clp-paper].

# System Overview

![CLP systems overview](docs/src/_static/clp-complete-solution.png)
![CLP systems overview](docs/src/clp-complete-solution.png)

CLP provides an end-to-end log management pipeline consisting of compression, search, analytics, and
viewing. The figure above shows the CLP ecosystem architecture. It consists of the following
Expand Down Expand Up @@ -73,6 +73,10 @@ We also have guides for building the [package][build-package] and [CLP core][cor

For some logs you can use to test CLP, check out our open-source [datasets][datasets].

# Docs

You can find our docs [online][clp-docs] or view the source in `docs/src`.

# Providing Feedback

You can use GitHub issues to [report a bug][bug-report] or [request a feature][feature-req].
Expand All @@ -86,6 +90,7 @@ If you would like a feature or want to report a bug, please file an issue and we

[bug-report]: https://github.com/y-scope/clp/issues/new?assignees=&labels=bug&template=bug-report.yml
[build-package]: http://docs.yscope.com/clp/main/dev-guide/building-package
[clp-docs]: https://docs.yscope.com/clp/main
[clp-ffi-go]: https://github.com/y-scope/clp-ffi-go
[clp-ffi-py]: https://github.com/y-scope/clp-ffi-py
[clp-loglib-py]: https://github.com/y-scope/clp-loglib-py
Expand Down
Loading

0 comments on commit 21c5611

Please sign in to comment.