Skip to content
This repository was archived by the owner on Aug 2, 2023. It is now read-only.

Commit 7644df9

Browse files
authored
Explain project (#15)
1 parent 25130fc commit 7644df9

1 file changed

Lines changed: 29 additions & 21 deletions

File tree

README.md

Lines changed: 29 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -2,35 +2,43 @@
22

33
[![Build Status](https://travis-ci.org/LinMAD/BitAccretion.svg?branch=master)](https://travis-ci.org/LinMAD/BitAccretion)
44

5-
#### Why it's exist?
6-
[Project plot on medium](https://medium.com/@artjomnemiro/how-valuable-can-be-visual-monitoring-923e9e865625)
7-
8-
```text
9-
TODO Add system chart how it works
10-
Expl:
11-
12-
Main -> Loading
13-
Main -> Kernel
14-
Kernel -> Dashboard
15-
Kernel -> Processor
16-
Kernel -> Sound
17-
```
18-
195
#### About
20-
BitAccretion it's simple tool to aggregate metrics and visualize it.
6+
`BitAccretion` - simple tool to visualize system metrics.
7+
Metrics are collected by the provider and it's based on Go plugins to support different ways to aggregate\assemble metrics data.
218

22-
Based on Go plugins and allows you to implement specific graph assemblers to show them in the terminal dashboard.
9+
[More why it was created, post on medium](https://medium.com/@artjomnemiro/how-valuable-can-be-visual-monitoring-923e9e865625)
2310

24-
The repository contains implemented New Relic API as a data provider but could be also based on Nginx logs aggregation or other sources.
11+
##### Structure
2512

26-
#### What it can do?
27-
- Displaying terminal dashboard of graph(Systems and metrics) in charts representation.
28-
- Sound alerts with System name if audio file exist.
13+
[Configuration file](./config.json.tpl)
14+
15+
Folder hierarchy:
16+
```text
17+
BitAccretion
18+
├── build // Stores compiled project (if used make)
19+
├── core // Responsible for communication between dashboard and provider
20+
├── dashboard // Terminal UI with logic handling
21+
├── event // Observer with common interfaces
22+
├── extension // Go plugin folder
23+
│   ├── fake
24+
│   ├── newrelic
25+
│   ├── sound
26+
| ├── provider.go // Provider (metrics assembling) interface for plugin
27+
| └── sound.go // Sound (alerting) interface for plugin
28+
├── logger // Application logs interface
29+
├── model // Data structures
30+
├── resource // External files, images, audio files, etc
31+
│   └── sound
32+
│   ├── alarm
33+
│   └── voice
34+
├── util // Small useful functions
35+
└── vendor // Third party dependencies (managed by go modules)
36+
```
2937

3038
#### Example how it's looks like
3139
![Demo example](./resource/example.gif)
3240

33-
41+
##### TODO List:
3442
```text
3543
TODO GOTTY in docker container to access from browser
3644
TODO Remove clock and add degradation chart from exec time (Show error regression from exec time till now)

0 commit comments

Comments
 (0)