Update README (#600)

KindlingProject · Nov 27, 2023 · 510b6b0 · 510b6b0
1 parent f918a8e
commit 510b6b0
Show file tree

Hide file tree

Showing 2 changed files with 3 additions and 22 deletions.
diff --git a/.github/workflows/metadata-provider-ci.yml b/.github/workflows/metadata-provider-ci.yml
@@ -7,6 +7,7 @@ on:
 
 jobs:
   build-latest-test:
+    if: github.repository == 'KindlingProject/kindling'
     runs-on: ubuntu-latest
     permissions:
       contents: write

diff --git a/README.md b/README.md
@@ -29,8 +29,7 @@ So for trace profiling, how all threads were executed is recorded and can be rep
 ## Architecture
 
 From a high-level view, the agent runs as DeamonSet in Kubernetes. It collects all syscalls and some other tracepoints. We use different exporters for different distributions. 
-- For the lightweight version, we just build a Prometheus exporter to export the data which can be stored in Prometheus and displayed in Grafana Plugin. But for the trace profiling module, the UI is different, it’s a standalone UI module. 
-- For the standard version, which is designed for heavy usage, Kafka is adopted for buffering the events, and data is stored in ElasticSearch with much more detailed information which can be displayed. Currently, the light version has been open-sourced.
+For example, we build a Prometheus exporter to export the data which can be stored in Prometheus and displayed in Grafana Plugin. But for the trace profiling module, the UI is different, that's a standalone module. 
 
 ![image.png](/docs/imgs/architecture.png)
 
@@ -68,26 +67,7 @@ The next image shows a dependency map in Kubernetes.
 
 ![img](https://cdn.nlark.com/yuque/0/2022/png/749988/1642572876088-c26396ac-e7bb-44e7-ae0c-cc96f3344cd8.png)
 
-Kindling provides two versions that have different features but with the same agent. The lightweight is integrated into Prometheus, and it uses PromQL to query the data from Prometheus, so it should be adopted easily. But due to the cardinality constraint of Prometheus, we group the detailed data into buckets which throw away the detailed information.
-
-For the standard version, we provide much more detailed information because we use ElasticSearch as the back-end to store the original information.
-
-The lightweight version was open-sourced in 2022. 
-The standard version will be open-sourced in 2023. 
-
-| Feature                                          | Lightweight | Standard |
-| ------------------------------------------------ | ----------- | -------- |
-| Trace Profiling                                  | √           | √        |
-| Service Map                                      | √           | √        |
-| DNS Monitoring                                   | √           | √        |
-| TCP Status Monitoring                            | √           | √        |
-| HTTP/MySQL/Redis Detailed Information            | √           | √        |
-| Grafana Plugin Display                           | √           | √        |
-| Dump Network Traffic                             |             | √        |
-| Virtual Network Packet Tracing                  |             | √        |
-| Kubernetes Infrastructure Monitoring and Integration |             | √        |
-| Warning and Alert                                |             | √        |
-| Multi-cluster Management                         |             | √        |
+Kindling can be easily integrated with Prometheus, and we uses PromQL to query the data in the frontend, so it should be adopted easily. But due to the cardinality constraint of Prometheus, we group the detailed data into buckets which throw away the detailed information.
 
 ## Get started