Skip to content

Commit

Permalink
Improve telemetry documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
hectorespert committed Jul 9, 2024
1 parent e46a2de commit 3164b57
Show file tree
Hide file tree
Showing 3 changed files with 14 additions and 2 deletions.
4 changes: 3 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
.DS_Store
themes/
public
.idea
.idea
# Temporary lock file while building
/.hugo_build.lock
10 changes: 10 additions & 0 deletions content/additional-documentation/telemetry.md
Original file line number Diff line number Diff line change
Expand Up @@ -74,4 +74,14 @@ Temperature controller equipment usage chart:
5. **Controller health**: This chart shows past seven days CPU and Memory usage of the controller. We recommend to run reef-pi under 1/3rd of the CPU/Memory usage. i.e. For Raspberry Pi 3 based controller normal CPU usage should not go above 0.3 and normal Memory usage should not go above 300 MB. This gives enough room for scenarios when the controller has to work harder, even with double workload, it will have 1/3rd of spare cpu/memory. Usually CPU and memory is usage increases with individual subsystem being enabled, higher number of equipment being controlled or higher frequency of sensor checks.
![health chart](/img/telemetry/health-chart.png)

### Self hosted telemetry server

Other option to visualize data from reef-pi is a self hosted telemetry server based in the Grafana stack.

[Telemetry Server Guide](https://www.reef2reef.com/threads/guide-telemetry-server.950238/)

### Grafana Cloud

[Grafana Cloud](https://grafana.com/products/cloud) as a [free plan](https://grafana.com/pricing/) that supports 14-day retention of metrics.


2 changes: 1 addition & 1 deletion layouts/_default/baseof.html
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@
<script src="https://oss.maxcdn.com/libs/respond.js/1.4.2/respond.min.js"></script>
<![endif]-->` | safeHTML }}

{{- template "_internal/google_analytics_async.html" . }}
{{- template "_internal/google_analytics.html" . }}
{{ if .IsTranslated }}
{{ range .Translations }}
<link rel="alternate" hreflang="{{ .Language.Lang }}" href="{{ .Permalink }}" title="{{ .Language.LanguageName }}">
Expand Down

0 comments on commit 3164b57

Please sign in to comment.