Adds support for influxdb version 1

app/Console/Commands/TestInfluxConnection.php

@@ -0,0 +1,62 @@
+<?php
+
+namespace App\Console\Commands;
+
+use App\Exceptions\InfluxDBConnectionErrorException;
+use App\Helpers\SettingsHelper;
+use App\Utils\InfluxDB\InfluxDB;
+use Illuminate\Console\Command;
+
+class TestInfluxConnection extends Command
+{
+    /**
+     * The name and signature of the console command.
+     *
+     * @var string
+     */
+    protected $signature = 'speedtest:influx';
+
+    /**
+     * The console command description.
+     *
+     * @var string
+     */
+    protected $description = 'Test connection settings for InfluxDB';
+
+    private bool $enabled;
+
+    /**
+     * Create a new command instance.
+     *
+     * @return void
+     */
+    public function __construct()
+    {
+        parent::__construct();
+
+        $this->enabled = (bool) SettingsHelper::get('influx_db_enabled')->value;
+    }
+
+    /**
+     * Execute the console command.
+     *
+     * @return int
+     */
+    public function handle()
+    {
+        if (!$this->enabled) {
+            $this->warn('InfluxDB is not enabled');
+            exit;
+        }
+
+        try {
+            InfluxDB::connect();
+            $this->info('Connected successfully');
+        } catch (InfluxDBConnectionErrorException $e) {
+            $this->error('Couldn\'t connect');
+            return 1;
+        }
+
+        return 0;
+    }
+}

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/Observers/SpeedtestObserver.php

@@ -0,0 +1,31 @@
+<?php
+
+namespace App\Observers;
+
+use App\Exceptions\InfluxDBNotEnabledException;
+use App\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)
+    {
+        info('trying influx');
+        try {
+            InfluxDB::connect()
+                ->store($speedtest);
+        } catch (InfluxDBNotEnabledException $e) {
+            info('not enabled');
+        } catch (Exception $e) {
+            Log::error($e);
+        }
+    }
+}

app/Providers/EventServiceProvider.php

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

app/Speedtest.php

@@ -25,4 +25,18 @@ class Speedtest extends Model
     ];
 
     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/Utils/InfluxDB/InfluxDB.php

@@ -0,0 +1,104 @@
+<?php
+
+namespace App\Utils\InfluxDB;
+
+use App\Exceptions\InfluxDBConnectionErrorException;
+use App\Exceptions\InfluxDBNotEnabledException;
+use App\Helpers\SettingsHelper;
+use App\Speedtest;
+use InfluxDB\Client as Version1;
+use InfluxDB2\Client as Version2;
+use App\Utils\InfluxDB\InfluxDBWrapperInterface as Client;
+
+class InfluxDB
+{
+    private Client $client;
+
+    private string $database;
+
+    public function __construct(Client $client)
+    {
+        $this->client = $client;
+    }
+
+    /**
+     * Connect to influx db
+     *
+     * @param string $host
+     * @param integer $port
+     * @param string $database
+     * @return InfluxDB
+     */
+    public static function connect()
+    {
+        if (!(bool) SettingsHelper::get('influx_db_enabled')->value) {
+            throw new InfluxDBNotEnabledException();
+        }
+
+        $host = SettingsHelper::get('influx_db_host')->value;
+        $port = SettingsHelper::get('influx_db_port')->value;
+        $token = '';
+        $database = SettingsHelper::get('influx_db_database')->value;
+        $version = (int) SettingsHelper::get('influx_db_version')->value;
+
+        $wrapper = $version === 1
+            ? new InfluxDBVersion1Wrapper(
+                new Version1(str_replace(['http://', 'https://'], '', $host), $port)
+            )
+            : new InfluxDBVersion2Wrapper(
+                new Version2([])
+            );
+
+        return (new self($wrapper))->setDatabase($database)
+            ->testConnection();
+    }
+
+    /**
+     * Set the database field
+     *
+     * @param string $database
+     * @return InfluxDB
+     */
+    public function setDatabase(string $database): InfluxDB
+    {
+        $this->database = $database;
+
+        return $this;
+    }
+
+    /**
+     * Test the connection
+     *
+     * @throws InfluxDBConnectionErrorException
+     * @return InfluxDB
+     */
+    public function testConnection(): InfluxDB
+    {
+        if (!$this->client->testConnection()) {
+            throw new InfluxDBConnectionErrorException();
+        }
+
+        if (!$this->doesDatabaseExist()) {
+            $this->createDatabase();
+        }
+
+        return $this;
+    }
+
+    public function doesDatabaseExist(): bool
+    {
+        return $this->client->doesDatabaseExist($this->database);
+    }
+
+    public function createDatabase(): bool
+    {
+        return $this->client->createDatabase($this->database);
+    }
+
+    public function store(Speedtest $speedtest): InfluxDB
+    {
+        $this->client->store($speedtest);
+
+        return $this;
+    }
+}

app/Utils/InfluxDB/InfluxDBVersion1Wrapper.php

@@ -0,0 +1,71 @@
+<?php
+
+namespace App\Utils\InfluxDB;
+
+use App\Speedtest;
+use Exception;
+use InfluxDB\Client;
+use InfluxDB\Database;
+use InfluxDB\Database\RetentionPolicy;
+use InfluxDB\Point;
+use Log;
+
+class InfluxDBVersion1Wrapper implements InfluxDBWrapperInterface
+{
+    private Client $client;
+    private Database $database;
+
+    public function __construct(Client $client)
+    {
+        $this->client = $client;
+    }
+
+    public function testConnection(): bool
+    {
+        try {
+            $this->client->listDatabases();
+
+            return true;
+        } catch (Exception $e) {
+            Log::error($e);
+
+            return false;
+        }
+    }
+
+    public function doesDatabaseExist(string $database): bool
+    {
+        $this->database = $this->client->selectDB($database);
+
+        return (bool) $this->database->exists();
+    }
+
+    public function createDatabase(string $database): bool
+    {
+        try {
+            $this->database->create(new RetentionPolicy(
+                'speedtest_retention_policy',
+                config('services.influxdb.retention'),
+                1,
+                true
+            ));
+
+            return true;
+        } catch (Exception $e) {
+            Log::error($e);
+            return false;
+        }
+    }
+
+    public function store(Speedtest $speedtest): bool
+    {
+        return $this->database->writePoints([
+            new Point(
+                'speedtest',
+                null,
+                ['host' => config('services.influxdb.host')],
+                $speedtest->formatForInfluxDB(),
+            )
+        ]);
+    }
+}

app/Utils/InfluxDB/InfluxDBWrapperInterface.php

@@ -0,0 +1,13 @@
+<?php
+
+namespace App\Utils\InfluxDB;
+
+use App\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;
+}

composer.json

@@ -16,6 +16,8 @@
         "guzzlehttp/guzzle": "^7.0.1",
         "henrywhitaker3/healthchecks-io": "^1.0",
         "henrywhitaker3/laravel-actions": "^1.0",
+        "influxdata/influxdb-client-php": "^1.12",
+        "influxdb/influxdb-php": "^1.15",
         "laravel-notification-channels/telegram": "^0.5.0",
         "laravel/framework": "^8.0",
         "laravel/slack-notification-channel": "^2.0",

composer.lock

@@ -4,7 +4,7 @@
         "Read more about it at https://getcomposer.org/doc/01-basic-usage.md#installing-dependencies",
         "This file is @generated automatically"
     ],
-    "content-hash": "2c905613bf401a9978baa23d1a80b710",
+    "content-hash": "46d75195c9e28db55cd2b086a6846e13",
     "packages": [
         {
             "name": "asm89/stack-cors",
@@ -1309,6 +1309,118 @@
             },
             "time": "2021-02-06T09:50:49+00:00"
         },
+        {
+            "name": "influxdata/influxdb-client-php",
+            "version": "1.12.0",
+            "source": {
+                "type": "git",
+                "url": "https://github.com/influxdata/influxdb-client-php.git",
+                "reference": "e04f802a4d9c52b5b497077673269e8463fdb6ea"
+            },
+            "dist": {
+                "type": "zip",
+                "url": "https://api.github.com/repos/influxdata/influxdb-client-php/zipball/e04f802a4d9c52b5b497077673269e8463fdb6ea",
+                "reference": "e04f802a4d9c52b5b497077673269e8463fdb6ea",
+                "shasum": ""
+            },
+            "require": {
+                "ext-curl": "*",
+                "ext-json": "*",
+                "ext-mbstring": "*",
+                "guzzlehttp/guzzle": "^6.2|^7.0.1",
+                "php": ">=7.1"
+            },
+            "require-dev": {
+                "phpunit/phpunit": "^7.4|^9.1",
+                "squizlabs/php_codesniffer": "~2.6"
+            },
+            "type": "library",
+            "autoload": {
+                "psr-4": {
+                    "InfluxDB2\\": "src/InfluxDB2"
+                }
+            },
+            "notification-url": "https://packagist.org/downloads/",
+            "license": [
+                "MIT"
+            ],
+            "description": "InfluxDB (v2+) Client Library for PHP",
+            "homepage": "https://www.github.com/influxdata/influxdb-client-php",
+            "keywords": [
+                "influxdb"
+            ],
+            "support": {
+                "issues": "https://github.com/influxdata/influxdb-client-php/issues",
+                "source": "https://github.com/influxdata/influxdb-client-php/tree/1.12.0"
+            },
+            "time": "2021-04-01T06:28:57+00:00"
+        },
+        {
+            "name": "influxdb/influxdb-php",
+            "version": "1.15.2",
+            "source": {
+                "type": "git",
+                "url": "https://github.com/influxdata/influxdb-php.git",
+                "reference": "d6e59f4f04ab9107574fda69c2cbe36671253d03"
+            },
+            "dist": {
+                "type": "zip",
+                "url": "https://api.github.com/repos/influxdata/influxdb-php/zipball/d6e59f4f04ab9107574fda69c2cbe36671253d03",
+                "reference": "d6e59f4f04ab9107574fda69c2cbe36671253d03",
+                "shasum": ""
+            },
+            "require": {
+                "guzzlehttp/guzzle": "^6.0|^7.0",
+                "php": "^5.5 || ^7.0 || ^8.0"
+            },
+            "require-dev": {
+                "dms/phpunit-arraysubset-asserts": "^0.2.1",
+                "phpunit/phpunit": "^9.5"
+            },
+            "suggest": {
+                "ext-curl": "Curl extension, needed for Curl driver",
+                "stefanotorresi/influxdb-php-async": "An asyncronous client for InfluxDB, implemented via ReactPHP."
+            },
+            "type": "library",
+            "autoload": {
+                "psr-4": {
+                    "InfluxDB\\": "src/InfluxDB"
+                }
+            },
+            "notification-url": "https://packagist.org/downloads/",
+            "license": [
+                "MIT"
+            ],
+            "authors": [
+                {
+                    "name": "Stephen Hoogendijk",
+                    "email": "stephen@tca0.nl"
+                },
+                {
+                    "name": "Daniel Martinez",
+                    "email": "danimartcas@hotmail.com"
+                },
+                {
+                    "name": "Gianluca Arbezzano",
+                    "email": "gianarb92@gmail.com"
+                }
+            ],
+            "description": "InfluxDB client library for PHP",
+            "keywords": [
+                "client",
+                "influxdata",
+                "influxdb",
+                "influxdb class",
+                "influxdb client",
+                "influxdb library",
+                "time series"
+            ],
+            "support": {
+                "issues": "https://github.com/influxdata/influxdb-php/issues",
+                "source": "https://github.com/influxdata/influxdb-php/tree/1.15.2"
+            },
+            "time": "2020-12-26T17:45:17+00:00"
+        },
         {
             "name": "laravel-notification-channels/telegram",
             "version": "0.5.1",

config/services.php

@@ -34,4 +34,9 @@ return [
         'token' => env('TELEGRAM_BOT_TOKEN', 'YOUR BOT TOKEN HERE')
     ],
 
+    'influxdb' => [
+        'retention' => env('INFLUXDB_RETENTION', '30d'),
+        'host' => env('INFLUXDB_HOST_TAG', 'speedtest'),
+    ],
+
 ];

database/migrations/2021_04_10_182503_add_influx_db_settings.php

@@ -0,0 +1,74 @@
+<?php
+
+use App\Helpers\SettingsHelper;
+use App\Setting;
+use Illuminate\Database\Migrations\Migration;
+use Illuminate\Database\Schema\Blueprint;
+use Illuminate\Support\Facades\Schema;
+
+class AddInfluxDbSettings extends Migration
+{
+    /**
+     * Run the migrations.
+     *
+     * @return void
+     */
+    public function up()
+    {
+        if (!SettingsHelper::get('influx_db_enabled')) {
+            Setting::create([
+                'name' => 'influx_db_enabled',
+                'value' => false,
+                'description' => 'Enable the InfluxDB integration for speedtests.'
+            ]);
+        }
+
+        if (!SettingsHelper::get('influx_db_host')) {
+            Setting::create([
+                'name' => 'influx_db_host',
+                'value' => '',
+                'description' => 'InfluxDB hostname, include the protocol (http:// or https://).'
+            ]);
+        }
+
+        if (!SettingsHelper::get('influx_db_port')) {
+            Setting::create([
+                'name' => 'influx_db_port',
+                'value' => '',
+                'description' => 'InfluxDB port'
+            ]);
+        }
+
+        if (!SettingsHelper::get('influx_db_database')) {
+            Setting::create([
+                'name' => 'influx_db_database',
+                'value' => '',
+                'description' => 'InfluxDB database'
+            ]);
+        }
+
+        if (!SettingsHelper::get('influx_db_version')) {
+            Setting::create([
+                'name' => 'influx_db_version',
+                'value' => 1,
+                'description' => 'InfluxDB version'
+            ]);
+        }
+    }
+
+    /**
+     * Reverse the migrations.
+     *
+     * @return void
+     */
+    public function down()
+    {
+        Setting::whereIn('name', [
+            'influx_db_enabled',
+            'influx_db_host',
+            'influx_db_port',
+            'influx_db_database',
+            'influx_db_version',
+        ])->delete();
+    }
+}