mirror of
https://github.com/akvorado/akvorado.git
synced 2025-12-11 22:14:02 +01:00
doc: add a few screenshots
This commit is contained in:
@@ -3,8 +3,13 @@
|
|||||||
This program receives flows (currently Netflow/IPFIX), hydrates them
|
This program receives flows (currently Netflow/IPFIX), hydrates them
|
||||||
with interface names (using SNMP), geo information (using MaxMind),
|
with interface names (using SNMP), geo information (using MaxMind),
|
||||||
and exports them to Kafka, then ClickHouse. It also exposes a web
|
and exports them to Kafka, then ClickHouse. It also exposes a web
|
||||||
interface to browse the result.
|
interface to browse the collected data.
|
||||||
|
|
||||||
|

|
||||||
|
|
||||||
|

|
||||||
|
|
||||||
*Akvorado* is developed by [Free](https://www.free.fr), a French ISP,
|
*Akvorado* is developed by [Free](https://www.free.fr), a French ISP,
|
||||||
and is licensed under the [AGPLv3 license](LICENSE.txt). The
|
and is licensed under the [AGPLv3 license](LICENSE.txt). The
|
||||||
[documentation](/docs/00-intro.md) is in the `docs/` directory.
|
[documentation](docs/00-intro.md) is in the `docs/` directory.
|
||||||
|
|
||||||
|
|||||||
@@ -89,12 +89,25 @@ instances are still running an older version).
|
|||||||
## Console service
|
## Console service
|
||||||
|
|
||||||
`akvorado console` starts the console service. It provides a web
|
`akvorado console` starts the console service. It provides a web
|
||||||
console. The home page is a simple dashboard with a few metrics, some
|
console.
|
||||||
graphs and a recent example of flow. The console also contains this
|
|
||||||
documentation. The most interesting page is the “visualize” tab which
|
### Home page
|
||||||
|
|
||||||
|

|
||||||
|
|
||||||
|
The home page contains a few statistics:
|
||||||
|
|
||||||
|
- number of flows received per second
|
||||||
|
- number of exporters
|
||||||
|
- flow repartition by AS, ports, protocols, countries, and IP families
|
||||||
|
- last flow received
|
||||||
|
|
||||||
|
### Visualize page
|
||||||
|
|
||||||
|
The most interesting page is the “visualize” tab which
|
||||||
allows a user to explore data using graphs.
|
allows a user to explore data using graphs.
|
||||||
|
|
||||||
### Graph options
|

|
||||||
|
|
||||||
The collapsible panel on the left has several options to change the
|
The collapsible panel on the left has several options to change the
|
||||||
aspect of the graph.
|
aspect of the graph.
|
||||||
@@ -134,6 +147,8 @@ The URL contains the encoded parameters and can be used to share with
|
|||||||
others. However, currently, no stability of the options are
|
others. However, currently, no stability of the options are
|
||||||
guaranteed, so an URL may stop working after a few upgrades.
|
guaranteed, so an URL may stop working after a few upgrades.
|
||||||
|
|
||||||
|

|
||||||
|
|
||||||
### Filter language
|
### Filter language
|
||||||
|
|
||||||
The filter language looks like SQL with a few variations. Fields
|
The filter language looks like SQL with a few variations. Fields
|
||||||
|
|||||||
BIN
console/data/docs/home.png
Normal file
BIN
console/data/docs/home.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 47 KiB |
BIN
console/data/docs/sankey.png
Normal file
BIN
console/data/docs/sankey.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 150 KiB |
BIN
console/data/docs/timeseries.png
Normal file
BIN
console/data/docs/timeseries.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 93 KiB |
Reference in New Issue
Block a user