From 51f59e4fcdb719310037ebbf4b8e9d4be1ab8abc Mon Sep 17 00:00:00 2001 From: Jason Kulatunga Date: Wed, 3 Aug 2022 22:59:19 -0700 Subject: [PATCH] docs, added an explanation for why influxdb is required. --- docs/TROUBLESHOOTING_INFLUXDB.md | 16 ++++++++++++++-- 1 file changed, 14 insertions(+), 2 deletions(-) diff --git a/docs/TROUBLESHOOTING_INFLUXDB.md b/docs/TROUBLESHOOTING_INFLUXDB.md index 22b52c6..faa9d4d 100644 --- a/docs/TROUBLESHOOTING_INFLUXDB.md +++ b/docs/TROUBLESHOOTING_INFLUXDB.md @@ -1,7 +1,19 @@ # InfluxDB Troubleshooting -## Installation -InfluxDB is a required dependency for Scrutiny v0.4.0+. +## Why?? + +Scrutiny has many features, but the relevant one to this conversation is the "S.M.A.R.T metric tracking for historical +trends". Basically Scrutiny not only shows you the current SMART values, but how they've changed over weeks, months (or +even years). + +To efficiently handle that data at scale (and to make my life easier as a developer) I decided to add InfluxDB as a +dependency. It's a dedicated timeseries database, as opposed to the general purpose sqlite DB I used before. I also did +a bunch of testing and analysis before I made the change. With InfluxDB the memory footprint for Scrutiny (at idle) is ~ +100mb, which is still fairly reasonable. + +## Installation + +InfluxDB is a required dependency for Scrutiny v0.4.0+. https://docs.influxdata.com/influxdb/v2.2/install/