docs: update README
This commit is contained in:
parent
b8e8681d64
commit
9a922cf263
11
README.md
11
README.md
@ -2,6 +2,17 @@
|
||||
|
||||
Insight into everything
|
||||
|
||||
`Uptime Monitor` + `Website analytics` + `Server Status ` = `Tianji`
|
||||
|
||||
All in one project!
|
||||
|
||||
## Motivation
|
||||
|
||||
During our observations of the website. We often need to use multiple applications together. For example, we need analysis tools such as `GA`/`umami` to check pv/uv and the number of visits to each page, we need an uptime monitor to check the network quality and connectivity of the server, and we need to use prometheus to obtain the status reported by the server to check the quality of the server. In addition, if we develop an application that allows open source deployment, we often need a telemetry system to help us collect the simplest information about other people's deployment situations.
|
||||
|
||||
I think these tools should serve the same purpose, so is there an application that can integrate these common needs in a lightweight way? After all, most of the time we don't need very professional and in-depth functions. But in order to achieve comprehensive monitoring, I need to install so many services.
|
||||
|
||||
It's good to specialize in one thing, if we are experts in related abilities we need such specialized tools. But for most users who only have lightweight needs, an **All-in-One** application will be more convenient and easier to use.
|
||||
|
||||
## Open Source
|
||||
|
||||
|
21
README.zh.md
Normal file
21
README.zh.md
Normal file
@ -0,0 +1,21 @@
|
||||
# Tianji
|
||||
|
||||
洞察一切
|
||||
|
||||
`状态监控器` + `网站分析器` + `服务状态上报` = `Tianji`
|
||||
|
||||
所有一切都在一起!
|
||||
|
||||
## Motivation
|
||||
|
||||
在我们对网站进行观察时。我们往往需要多个应用一起来组合使用。比如我们需要ga/umami等分析工具来查看pvuv以及各个页面的访问量,我们需要uptime监控器来检查服务器的网络质量与连通性,我们需要通关prometheus获取服务端上报的状态来检查服务器的质量。另外如果开发的是一个允许被开源部署的应用,我们往往还需要一个遥测系统来帮助我们对其他人的部署情况做一个最简单的信息收集。
|
||||
|
||||
我认为这些工具应当是为同一个目的而服务的,那么有没有一款应用能够轻量级的将这些常见的需求整合为一体呢?毕竟在大部分时候我们并不需要非常专业与深入的功能。但是我为了实现全面的监控却需要安装如此多的服务。
|
||||
|
||||
专精于一项这很好,如果我们是相关能力的专家我们需要这样的专业工具。但是对于大部分只有轻量级需求的用户而言,一个all in one的应用会更加方便与易于使用
|
||||
|
||||
## Open Source
|
||||
|
||||
`Tianji` is open source with `Apache 2.0` license.
|
||||
|
||||
And its inspired by `umami` license which under `MIT` and `uptime-kuma` which under `MIT` license too
|
Loading…
Reference in New Issue
Block a user