Skip to content

Commit

Permalink
docs(readme, observability): add roadmap and fix links (#66)
Browse files Browse the repository at this point in the history
* chore(docs): add observability

* chore(docs): add roadmap to README and fix broken links

* chore(docs): add observability feature
  • Loading branch information
mlycore committed Jun 2, 2022
1 parent 3ae64cb commit 6b1fd6e
Show file tree
Hide file tree
Showing 3 changed files with 28 additions and 3 deletions.
14 changes: 11 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ Pisanix has 3 componenets:

* ***Pisa-Controller***: A Golang control plane designed for sidecar injection and configuration transformation
* ***Pisa-Proxy***: A high performance Rust data plane used as SQL traffic proxy, support various of traffic governance capabilities.
* ***Pisa-Daemon***: A Golang optional data plane works on every node, provide programmable runtime management such as TrafficQoS.
* ***Pisa-Daemon(Coming Soon)***: A Golang optional data plane works on every node, provide programmable runtime management such as TrafficQoS.

# Features
## Database traffic governance
Expand All @@ -38,19 +38,27 @@ For DBAs who could and would like to solve problems with programming. Pisanix su
- [Quick Start](https://www.pisanix.io/docs/quickstart)

# Documentation
Full documentation will be available on the [Pisanix website](https://pisanix.io/).
Full documentation will be available on the [Pisanix website](https://www.pisanix.io/).

# Contribution
Please follows [Contributing Guide](./CONTRIBUTING.md)

# Community & Support
| | |
|:-|:-|
| Mailing List| https://groups.google.com/g/database-mesh |
| Dev Meetings (Starting Feb 27th, 2022), Bi-weekly Wednesday 9:00AM PST|https://meet.google.com/yhv-zrby-pyt |
| Dev Meetings APAC Friendly (Starting April 27th, 2022), Bi-weekly APAC Wednesday 9:00PM GMT+8|https://meeting.tencent.com/dm/6UXDMNsHBVQO |
| Slack |https://databasemesh.slack.com/ |
| Wechat Broker|pisanix|
| Slack |https://join.slack.com/t/databasemesh/shared_invite/zt-19rhvnxkz-USjZ~am~ghd_Q0q~8bAJXA |
| Meetings Notes |https://bit.ly/39Fqt3x |

- Wechat User Group: Broker wechat to add you into the user group.
<img src="static/wechat-user-group-broker.jpeg" width="200" length="200"/>

# Roadmap
The Pisanix project is still at an early stage. In the next work, it will focus on enhancing the governance capabilities of traffic, such as data sharding, application data access auditing , and runtime resource QoS, etc. And it will continuously improve the performance and provide an ease of use experience, support plugin extensions to fit different business scenarios.


## License
[![FOSSA Status](https://app.fossa.com/api/projects/git%2Bgithub.com%2Fdatabase-mesh%2Fpisanix.svg?type=large)](https://app.fossa.com/projects/git%2Bgithub.com%2Fdatabase-mesh%2Fpisanix?ref=badge_large)
17 changes: 17 additions & 0 deletions docs/docs/Features/observability.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
---
sidebar_position: 5
---

# 可观测性

Pisanix 目前在 Pisa-Proxy 处理 SQL 命令的时候采集相关指标,并以 `/metrics` 路径进行暴露。

## 已支持指标
- SQL_PROCESSED_TOTAL: 统计所有执行的 SQL 数量
- SQL_PROCESSED_DURATION: 统计所有 SQL 的执行时间

测试效果如下图:

![grafana](/img/grafana.jpg)

下一步将支持更多标签和指标,如 SQL 语句类型、延迟、错误率、TopK、运行时资源等。
Binary file added docs/static/img/grafana.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 6b1fd6e

Please sign in to comment.