Influxdb support (alexjustesen#13)

Author: alexjustesen

app/Console/Commands/TestInfluxDB.php

@@ -0,0 +1,53 @@
+<?php
+
+namespace App\Console\Commands;
+
+use App\Models\Result;
+use Illuminate\Console\Command;
+use Illuminate\Support\Facades\File;
+use Illuminate\Support\Facades\Log;
+use InfluxDB2\Client;
+use Symfony\Component\Yaml\Yaml;
+
+class TestInfluxDB extends Command
+{
+    /**
+     * The name and signature of the console command.
+     *
+     * @var string
+     */
+    protected $signature = 'app:test-influxdb';
+
+    /**
+     * The console command description.
+     *
+     * @var string
+     */
+    protected $description = 'Write a test log to InfluxDB to make sure the config works.';
+
+    /**
+     * Execute the console command.
+     *
+     * @return int
+     */
+    public function handle()
+    {
+        if (File::exists(base_path().'/config.yml')) {
+            $config = Yaml::parseFile(
+                base_path().'/config.yml'
+            );
+        }
+
+        if (File::exists('/app/config.yml')) {
+            $config = Yaml::parseFile('/app/config.yml');
+        }
+
+        $influxdb = $config['influxdb'];
+
+        if ($influxdb['enabled'] == true) {
+            $result = Result::factory()->create();
+        }
+
+        return 0;
+    }
+}

app/Models/Result.php

@@ -42,4 +42,21 @@ class Result extends Model
         'scheduled' => 'boolean',
         'created_at' => 'datetime',
     ];
+
+    /**
+     * The attributes to be passed to influxdb
+     */
+    public function formatForInfluxDB2()
+    {
+        return [
+            'id' => (int) $this->id,
+            'ping' => (float) $this->ping,
+            'download' => (int) $this->download,
+            'upload' => (int) $this->upload,
+            'server_id' => (int) $this->server_id,
+            'server_host' => $this->server_host,
+            'server_name' => $this->server_name,
+            'scheduled' => $this->scheduled,
+        ];
+    }
 }

app/Observers/ResultObserver.php

@@ -0,0 +1,111 @@
+<?php
+
+namespace App\Observers;
+
+use App\Models\Result;
+use Illuminate\Support\Facades\File;
+use Illuminate\Support\Facades\Log;
+use InfluxDB2\Client;
+use Symfony\Component\Yaml\Yaml;
+
+class ResultObserver
+{
+    /**
+     * Handle events after all transactions are committed.
+     *
+     * @var bool
+     */
+    public $afterCommit = true;
+
+    /**
+     * Handle the Result "created" event.
+     *
+     * @param  \App\Models\Result  $result
+     * @return void
+     */
+    public function created(Result $result)
+    {
+        if (File::exists(base_path().'/config.yml')) {
+            $config = Yaml::parseFile(
+                base_path().'/config.yml'
+            );
+        }
+
+        if (File::exists('/app/config.yml')) {
+            $config = Yaml::parseFile('/app/config.yml');
+        }
+
+        $influxdb = $config['influxdb'];
+
+        if ($influxdb['enabled'] == true) {
+            $client = new Client([
+                'url' => $influxdb['url'],
+                'token' => $influxdb['token'],
+                'bucket' => $influxdb['bucket'],
+                'org' => $influxdb['org'],
+                'precision' => \InfluxDB2\Model\WritePrecision::S
+            ]);
+
+            $writeApi = $client->createWriteApi();
+
+            $dataArray = [
+                'name' => 'speedtest',
+                'tags' => null,
+                'fields' => $result->formatForInfluxDB2(),
+                'time' => strtotime($result->created_at),
+            ];
+
+            try {
+                $writeApi->write($dataArray);
+            } catch (\Exception $e) {
+                Log::error($e);
+            }
+
+            $writeApi->close();
+        }
+    }
+
+    /**
+     * Handle the Result "updated" event.
+     *
+     * @param  \App\Models\Result  $result
+     * @return void
+     */
+    public function updated(Result $result)
+    {
+        //
+    }
+
+    /**
+     * Handle the Result "deleted" event.
+     *
+     * @param  \App\Models\Result  $result
+     * @return void
+     */
+    public function deleted(Result $result)
+    {
+        //
+    }
+
+    /**
+     * Handle the Result "restored" event.
+     *
+     * @param  \App\Models\Result  $result
+     * @return void
+     */
+    public function restored(Result $result)
+    {
+        //
+    }
+
+    /**
+     * Handle the Result "force deleted" event.
+     *
+     * @param  \App\Models\Result  $result
+     * @return void
+     */
+    public function forceDeleted(Result $result)
+    {
+        //
+    }
+}

app/Providers/EventServiceProvider.php

@@ -2,6 +2,8 @@
 
 namespace App\Providers;
 
+use App\Models\Result;
+use App\Observers\ResultObserver;
 use Illuminate\Auth\Events\Registered;
 use Illuminate\Auth\Listeners\SendEmailVerificationNotification;
 use Illuminate\Foundation\Support\Providers\EventServiceProvider as ServiceProvider;
@@ -27,7 +29,7 @@ class EventServiceProvider extends ServiceProvider
      */
     public function boot()
     {
-        //
+        Result::observe(ResultObserver::class);
     }
 
     /**

composer.json

@@ -8,6 +8,7 @@
         "php": "^8.0.2",
         "dragonmantank/cron-expression": "^3.3",
         "guzzlehttp/guzzle": "^7.2",
+        "influxdata/influxdb-client-php": "^2.9",
         "laravel/framework": "^9.19",
         "laravel/sanctum": "^3.0",
         "laravel/tinker": "^2.7",

composer.lock

@@ -1,9 +1,12 @@
 ---
-authentication: true # Set to false to disable authentication
+authentication: true
 influxdb:
-  enabled: true
-  host_tag: 'speedtest-tracker'
-  retention: '30d'
+  enabled: false
+  version: 2 # Only InfluxDB2 is supported right now
+  url: 'http://your-influxdb-instance' # Full url to your InfluxDB instance, sometimes this includes a port number
+  org: '' # Organization name, usually created when you installed InfluxDB
+  bucket: 'speedtest-tracker' # A name location to store the speedtest data in
+  token: '' # This is your API token
 notifications:
   channels:
     discord: