Add InfluxDB integration

README.md

@@ -1,6 +1,6 @@
 # Speedtest Tracker
 
-[![Docker pulls](https://img.shields.io/docker/pulls/henrywhitaker3/speedtest-tracker?style=flat-square)](https://hub.docker.com/r/henrywhitaker3/speedtest-tracker) [![GitHub Workflow Status](https://img.shields.io/github/workflow/status/henrywhitaker3/Speedtest-Tracker/Stable?label=master&logo=github&style=flat-square)](https://github.com/henrywhitaker3/Speedtest-Tracker/actions) [![GitHub Workflow Status](https://img.shields.io/github/workflow/status/henrywhitaker3/Speedtest-Tracker/Dev?label=dev&logo=github&style=flat-square)](https://github.com/henrywhitaker3/Speedtest-Tracker/actions) [![last_commit](https://img.shields.io/github/last-commit/henrywhitaker3/Speedtest-Tracker?style=flat-square)](https://github.com/henrywhitaker3/Speedtest-Tracker/commits) [![issues](https://img.shields.io/github/issues/henrywhitaker3/Speedtest-Tracker?style=flat-square)](https://github.com/henrywhitaker3/Speedtest-Tracker/issues) [![commit_freq](https://img.shields.io/github/commit-activity/m/henrywhitaker3/Speedtest-Tracker?style=flat-square)](https://github.com/henrywhitaker3/Speedtest-Tracker/commits) ![version](https://img.shields.io/badge/version-v1.11.1-success?style=flat-square) [![license](https://img.shields.io/github/license/henrywhitaker3/Speedtest-Tracker?style=flat-square)](https://github.com/henrywhitaker3/Speedtest-Tracker/blob/master/LICENSE)
+[![Docker pulls](https://img.shields.io/docker/pulls/henrywhitaker3/speedtest-tracker?style=flat-square)](https://hub.docker.com/r/henrywhitaker3/speedtest-tracker) [![GitHub Workflow Status](https://img.shields.io/github/workflow/status/henrywhitaker3/Speedtest-Tracker/Stable?label=master&logo=github&style=flat-square)](https://github.com/henrywhitaker3/Speedtest-Tracker/actions) [![GitHub Workflow Status](https://img.shields.io/github/workflow/status/henrywhitaker3/Speedtest-Tracker/Dev?label=dev&logo=github&style=flat-square)](https://github.com/henrywhitaker3/Speedtest-Tracker/actions) [![last_commit](https://img.shields.io/github/last-commit/henrywhitaker3/Speedtest-Tracker?style=flat-square)](https://github.com/henrywhitaker3/Speedtest-Tracker/commits) [![issues](https://img.shields.io/github/issues/henrywhitaker3/Speedtest-Tracker?style=flat-square)](https://github.com/henrywhitaker3/Speedtest-Tracker/issues) [![commit_freq](https://img.shields.io/github/commit-activity/m/henrywhitaker3/Speedtest-Tracker?style=flat-square)](https://github.com/henrywhitaker3/Speedtest-Tracker/commits) ![version](https://img.shields.io/badge/version-v1.12.0-success?style=flat-square) [![license](https://img.shields.io/github/license/henrywhitaker3/Speedtest-Tracker?style=flat-square)](https://github.com/henrywhitaker3/Speedtest-Tracker/blob/master/LICENSE)
 
 This program runs a speedtest check every hour and graphs the results. The back-end is written in [Laravel](https://laravel.com/) and the front-end uses [React](https://reactjs.org/). It uses the [Ookla's speedtest cli](https://www.speedtest.net/apps/cli) package to get the data and uses [Chart.js](https://www.chartjs.org/) to plot the results.
 
@@ -18,6 +18,7 @@ Disclaimer: You will need to accept Ookla's EULA and privacy agreements in order
 - Slack/Discord/Telegram notifications
 - [healthchecks.io](https://healthchecks.io) integration
 - Organizr integration
+- InfluxDB integration (currently v1 only, v2 is a WIP)
 
 ## Installation & Setup
 
@@ -84,6 +85,8 @@ Container images are configured using parameters passed at runtime (such as thos
 |     `-e PUID`             |   Optional. Supply a local user ID for volume permissions   |
 |     `-e PGID`             |   Optional. Supply a local group ID for volume permissions  |
 |     `-e AUTH`             |   Optional. Set to 'true' to enable authentication for the app |
+|     `-e INFLUXDB_RETENTION`|  Optional. Sets the InfluxDB retention period, defaults to `30d` |
+|     `-e INFLUXDB_HOST_TAG |   Optional. Sets the InfluxDB host tag value, defaults to `speedtest` |
 
 ### Authentication
 
@@ -101,3 +104,7 @@ After enabling, you should change the password through the web UI.
 ### Manual Install
 
 For manual installations, please follow the instructions [here](https://github.com/henrywhitaker3/Speedtest-Tracker/wiki/Manual-Installation).
+
+### Kubernetes
+
+There is a 3rd party helm chart available [here](https://github.com/sOblivionsCall/charts).

app/Actions/GetFailedSpeedtestData.php

@@ -2,7 +2,7 @@
 
 namespace App\Actions;
 
-use App\Speedtest;
+use App\Models\Speedtest;
 use Cache;
 use Carbon\Carbon;
 use DB;

app/Actions/GetLatestSpeedtestData.php

@@ -4,7 +4,7 @@
 
 use App\Helpers\SettingsHelper;
 use App\Helpers\SpeedtestHelper;
-use App\Speedtest;
+use App\Models\Speedtest;
 use DB;
 use Henrywhitaker3\LaravelActions\Interfaces\ActionInterface;
 

app/Actions/GetSpeedtestTimeData.php

@@ -3,7 +3,7 @@
 namespace App\Actions;
 
 use App\Helpers\SettingsHelper;
-use App\Speedtest;
+use App\Models\Speedtest;
 use Cache;
 use Carbon\Carbon;
 use Henrywhitaker3\LaravelActions\Interfaces\ActionInterface;

app/Console/Commands/ClearOldSessionsCommand.php

@@ -2,7 +2,7 @@
 
 namespace App\Console\Commands;
 
-use App\Auth\LoginSession;
+use App\Models\Auth\LoginSession;
 use Carbon\Carbon;
 use Illuminate\Console\Command;
 use Log;

app/Exceptions/InfluxDBConnectionErrorException.php

@@ -0,0 +1,10 @@
+<?php
+
+namespace App\Exceptions;
+
+use Exception;
+
+class InfluxDBConnectionErrorException extends Exception
+{
+    //
+}

app/Exceptions/InfluxDBNotEnabledException.php

@@ -0,0 +1,10 @@
+<?php
+
+namespace App\Exceptions;
+
+use Exception;
+
+class InfluxDBNotEnabledException extends Exception
+{
+    //
+}

app/Helpers/BackupHelper.php

@@ -2,7 +2,7 @@
 
 namespace App\Helpers;
 
-use App\Speedtest;
+use App\Models\Speedtest;
 use Cache;
 use DateTime;
 use Exception;

app/Helpers/EmailVerificationHelper.php

@@ -2,8 +2,8 @@
 
 namespace App\Helpers;
 
-use App\Auth\EmailVerification;
-use App\User;
+use App\Models\Auth\EmailVerification;
+use App\Models\User;
 
 class EmailVerificationHelper {
     public static function checkVerificationAttempt($userID, $token)

app/Helpers/SettingsHelper.php

@@ -3,7 +3,7 @@
 namespace App\Helpers;
 
 use App\Events\TestNotificationEvent;
-use App\Setting;
+use App\Models\Setting;
 use Cache;
 use Carbon\Carbon;
 

app/Helpers/SpeedtestHelper.php

@@ -2,7 +2,8 @@
 
 namespace App\Helpers;
 
-use App\Speedtest;
+use App\Interfaces\SpeedtestProvider;
+use App\Models\Speedtest;
 use App\Utils\OoklaTester;
 use Carbon\Carbon;
 use Exception;
@@ -25,7 +26,7 @@ class SpeedtestHelper
      */
     public static function runSpeedtest()
     {
-        $tester = new OoklaTester();
+        $tester = app()->make(SpeedtestProvider::class);
         return $tester->run();
     }
 

app/Http/Controllers/AuthController.php

@@ -2,14 +2,14 @@
 
 namespace App\Http\Controllers;
 
-use App\Auth\EmailVerification;
-use App\Auth\LoginSession as AuthLoginSession;
+use App\Models\Auth\EmailVerification;
+use App\Models\Auth\LoginSession as AuthLoginSession;
 use App\Helpers\EmailVerificationHelper;
 use Illuminate\Support\Facades\Auth;
 use App\Http\Controllers\Controller;
 use App\LoginSession;
 use App\Rules\CurrentPasswordMatches;
-use App\User;
+use App\Models\User;
 use DateTime;
 use Hash;
 use Illuminate\Support\Facades\Request as RequestFacade;

app/Http/Controllers/SettingsController.php

@@ -4,7 +4,7 @@
 
 use App\Helpers\SettingsHelper;
 use App\Rules\Cron;
-use App\Setting;
+use App\Models\Setting;
 use Illuminate\Http\Request;
 use Illuminate\Support\Facades\Log;
 use Illuminate\Support\Facades\Validator;

app/Http/Controllers/SpeedtestController.php

@@ -9,7 +9,7 @@
 use App\Helpers\SettingsHelper;
 use App\Helpers\SpeedtestHelper;
 use App\Jobs\SpeedtestJob;
-use App\Speedtest;
+use App\Models\Speedtest;
 use Carbon\Carbon;
 use Exception;
 use Illuminate\Http\Request;

app/Http/Middleware/CheckActiveSession.php

@@ -2,7 +2,7 @@
 
 namespace App\Http\Middleware;
 
-use App\Auth\LoginSession;
+use App\Models\Auth\LoginSession;
 use Closure;
 use Exception;
 

app/Interfaces/InfluxDBWrapperInterface.php

@@ -0,0 +1,13 @@
+<?php
+
+namespace App\Interfaces;
+
+use App\Models\Speedtest;
+
+interface InfluxDBWrapperInterface
+{
+    public function testConnection(): bool;
+    public function doesDatabaseExist(string $database): bool;
+    public function createDatabase(string $database): bool;
+    public function store(Speedtest $speedtest): bool;
+}

app/Interfaces/SpeedtestProvider.php

@@ -2,7 +2,7 @@
 
 namespace App\Interfaces;
 
-use App\Speedtest;
+use App\Models\Speedtest;
 
 interface SpeedtestProvider
 {

app/Auth/EmailVerification.php → app/Models/Auth/EmailVerification.php

@@ -1,6 +1,6 @@
 <?php
 
-namespace App\Auth;
+namespace App\Models\Auth;
 
 use Illuminate\Database\Eloquent\Model;
 

app/Auth/LoginSession.php → app/Models/Auth/LoginSession.php

@@ -1,6 +1,6 @@
 <?php
 
-namespace App\Auth;
+namespace App\Models\Auth;
 
 use Illuminate\Database\Eloquent\Model;
 

app/Setting.php → app/Models/Setting.php

@@ -1,6 +1,6 @@
 <?php
 
-namespace App;
+namespace App\Models;
 
 use App\Casts\CommaSeparatedArrayCast;
 use App\Helpers\SettingsHelper;

app/Models/Speedtest.php

@@ -0,0 +1,45 @@
+<?php
+
+namespace App\Models;
+
+use Illuminate\Database\Eloquent\Factories\HasFactory;
+use Illuminate\Database\Eloquent\Model;
+
+class Speedtest extends Model
+{
+    use HasFactory;
+
+    /**
+     * The attributes that are mass assignable.
+     *
+     * @var array
+     */
+    protected $fillable = [
+        'ping',
+        'download',
+        'upload',
+        'created_at',
+        'server_id',
+        'server_name',
+        'server_host',
+        'url',
+        'scheduled',
+        'failed',
+    ];
+
+    protected $table = 'speedtests';
+
+    public function formatForInfluxDB()
+    {
+        return [
+            'id' => (int) $this->id,
+            'download' => (float) $this->download,
+            'upload' => (float) $this->upload,
+            'ping' => (float) $this->ping,
+            'server_id' => (int) $this->server_id,
+            'server_host' => $this->server_host,
+            'server_name' => $this->server_name,
+            'scheduled' => (bool) $this->scheduled,
+        ];
+    }
+}

app/User.php → app/Models/User.php

@@ -1,6 +1,6 @@
 <?php
 
-namespace App;
+namespace App\Models;
 
 use Illuminate\Contracts\Auth\MustVerifyEmail;
 use Illuminate\Foundation\Auth\User as Authenticatable;
@@ -107,7 +107,7 @@ public function getJWTCustomClaims()
 
     public function setPasswordAttribute($password)
     {
-        if ( !empty($password) ) {
+        if (!empty($password)) {
             $this->attributes['password'] = Hash::make($password);
         }
     }

app/Observers/SpeedtestObserver.php

@@ -0,0 +1,30 @@
+<?php
+
+namespace App\Observers;
+
+use App\Exceptions\InfluxDBNotEnabledException;
+use App\Models\Speedtest;
+use App\Utils\InfluxDB\InfluxDB;
+use Exception;
+use Log;
+
+class SpeedtestObserver
+{
+    /**
+     * Handle the Speedtest "created" event.
+     *
+     * @param  \App\Speedtest  $speedtest
+     * @return void
+     */
+    public function created(Speedtest $speedtest)
+    {
+        try {
+            InfluxDB::connect()
+                ->store($speedtest);
+        } catch (InfluxDBNotEnabledException $e) {
+            // /
+        } catch (Exception $e) {
+            Log::error($e);
+        }
+    }
+}

app/Providers/EventServiceProvider.php

@@ -10,6 +10,8 @@
 use App\Listeners\SpeedtestFailedListener;
 use App\Listeners\SpeedtestOverviewListener;
 use App\Listeners\TestNotificationListener;
+use App\Observers\SpeedtestObserver;
+use App\Models\Speedtest;
 use Illuminate\Auth\Events\Registered;
 use Illuminate\Auth\Listeners\SendEmailVerificationNotification;
 use Illuminate\Foundation\Support\Providers\EventServiceProvider as ServiceProvider;
@@ -49,6 +51,6 @@ public function boot()
     {
         parent::boot();
 
-        //
+        Speedtest::observe(SpeedtestObserver::class);
     }
 }