diff --git a/content/en/docs/usage/quick-start.md b/content/en/docs/usage/quick-start-external-datasource.md similarity index 96% rename from content/en/docs/usage/quick-start.md rename to content/en/docs/usage/quick-start-external-datasource.md index 120f077..0256d5d 100644 --- a/content/en/docs/usage/quick-start.md +++ b/content/en/docs/usage/quick-start-external-datasource.md @@ -1,5 +1,5 @@ --- -title: "Quick Start" +title: "Quick Start(External Datasource)" date: 2020-10-06T08:48:57+00:00 lastmod: 2020-10-06T08:48:57+00:00 draft: false diff --git a/content/en/docs/usage/quick-start-from-agent.md b/content/en/docs/usage/quick-start-from-agent.md new file mode 100644 index 0000000..1272560 --- /dev/null +++ b/content/en/docs/usage/quick-start-from-agent.md @@ -0,0 +1,56 @@ +--- +title: "Quick Start(Starting from agent)" +date: 2020-10-06T08:48:57+00:00 +lastmod: 2020-10-06T08:48:57+00:00 +draft: false +images: [] +menu: + docs: + parent: "usage" +weight: 200 +toc: true +--- + +## Configure Pushgw.Writers + +Configure Pushgw.Writers in [config.toml](https://github.com/ccfos/nightingale/blob/main/etc/config.toml#L150). The default configuration is as follows: + +```toml +[[Pushgw.Writers]] +# Url = "http://127.0.0.1:8480/insert/0/prometheus/api/v1/write" +Url = "http://127.0.0.1:9090/api/v1/write" +... +``` + +Make sure that the Url is `prometheus remote write` api address. + + +## Install agent + +We recommand you to use [Categraf](/docs/agent/categraf/) as agent collector. Categraf can receive monitoring data as well as heartbeat requests. + +Then start Categraf and you're done. + +## Check Host List + +Menu location: `Infrastructure` -> `Host`. You'll see the host list under `All hosts`. + +![20230810104717](https://download.flashcat.cloud/ulric/20230810104717.png) + +## Check Host Metrics + +Menu location: `Metrics` -> `Explorer`. You can use `cpu_usage_active` as promql query to check host metrics. + +## Import dashboards + +Menu location: `Dashboard` -> `Built-in`. You can clone `Linux Host by Categraf` under Linux Category to `Default busi group` then view the data through the dashboard. + +## Import alerting rules + +Menu location: `Monitors` -> `Built-in`. You can clone all the rules under Linux Category to `Default busi group` then alarm will be triggered if any rule is violated. + +![20230810105514](https://download.flashcat.cloud/ulric/20230810105514.png) + +Screenshot of the Active alarms page: + +![20230810105802](https://download.flashcat.cloud/ulric/20230810105802.png)