Skip to content

Commit

Permalink
Use https and update README
Browse files Browse the repository at this point in the history
  • Loading branch information
Daxin Wang committed Nov 28, 2023
1 parent 4a04b65 commit b10dd5b
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 26 deletions.
4 changes: 2 additions & 2 deletions .github/workflows/deploy-production.yml
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ jobs:
runs-on: ubuntu-latest
environment:
name: kindlingx
url: http://kindlingx.com
url: https://kindlingx.com
steps:
- uses: actions/checkout@v3

Expand All @@ -29,7 +29,7 @@ jobs:
WEBSITE_PATH: ${{ secrets.WEBSITE_PATH }}
run: |
# Set the real domain
sed -i 's|'https://kindlingproject.netlify.app/'|'http://kindlingx.com/'|g' config/production/config.toml
sed -i 's|'https://kindlingproject.netlify.app/'|'https://kindlingx.com/'|g' config/production/config.toml
# Build the website
npm install && npm run build
# Compress and transfer the tarball
Expand Down
27 changes: 3 additions & 24 deletions content/en/docs/overview-and-concepts/overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,9 +36,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.
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 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.

![](/media/202210/architecture_1667204553.png)

Expand Down Expand Up @@ -76,34 +74,15 @@ The next image shows a dependency map in Kubernetes.

![](/media/202210/image-3_1667204628.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

You can deploy Kindling easily, check out the [Installation Guide](/docs/installation) for details.

## Documentation

The Kindling documentation is available on our [Kindling website](http://kindlingx.com).
The Kindling documentation is available on our [Kindling website](https://kindlingx.com).

## Contributing

Expand Down

0 comments on commit b10dd5b

Please sign in to comment.