Skip to content

An open-source, self-hostable PaaS alternative to Vercel, Heroku & Netlify that lets you easily deploy static sites, databases, full-stack applications and 360+ one-click services on your own servers.

feat(traffic): add server traffic analytics toggle

Aditya Tripathi045a222164a0
diff --git a/app/Livewire/Server/Sentinel.php b/app/Livewire/Server/Sentinel.php
index cd05002aae..aabcabbcee 100644
--- a/app/Livewire/Server/Sentinel.php
+++ b/app/Livewire/Server/Sentinel.php
@@ -2,6 +2,7 @@
namespace App\Livewire\Server;
+use App\Actions\Server\ConfigureTrafficAnalytics;
use App\Actions\Server\StartSentinel;
use App\Actions\Server\StopSentinel;
use App\Models\Server;
@@ -40,6 +41,11 @@ class Sentinel extends Component
public ?string $sentinelCustomDockerImage = null;
+ public bool $isTrafficAnalyticsEnabled;
+
+ #[Validate(['nullable', 'string', 'max:255'])]
+ public ?string $geoipMaxmindLicenseKey = null;
+
public function getListeners()
{
$teamId = $this->server->team_id ?? auth()->user()->currentTeam()->id;
@@ -67,6 +73,7 @@ class Sentinel extends Component
$this->server->settings->sentinel_custom_url = $this->sentinelCustomUrl;
$this->server->settings->is_sentinel_enabled = $this->isSentinelEnabled;
$this->server->settings->is_sentinel_debug_enabled = $this->isSentinelDebugEnabled;
+ $this->server->settings->geoip_maxmind_license_key = $this->geoipMaxmindLicenseKey;
$this->server->settings->save();
} else {
$this->isMetricsEnabled = $this->server->settings->is_metrics_enabled;
@@ -78,6 +85,8 @@ class Sentinel extends Component
$this->isSentinelEnabled = $this->server->settings->is_sentinel_enabled;
$this->isSentinelDebugEnabled = $this->server->settings->is_sentinel_debug_enabled;
$this->sentinelUpdatedAt = $this->server->sentinel_updated_at;
+ $this->isTrafficAnalyticsEnabled = $this->server->isTrafficAnalyticsEnabled();
+ $this->geoipMaxmindLicenseKey = $this->server->settings->geoip_maxmind_license_key;
}
}
@@ -131,6 +140,22 @@ class Sentinel extends Component
}
}
+ public function toggleTrafficAnalytics(): void
+ {
+ try {
+ $this->authorize('update', $this->server);
+ $enable = ! $this->server->isTrafficAnalyticsEnabled();
+ ConfigureTrafficAnalytics::run($this->server, $enable);
+ $this->server->refresh();
+ $this->isTrafficAnalyticsEnabled = $this->server->isTrafficAnalyticsEnabled();
+ $this->dispatch('success', $enable
+ ? 'Traffic analytics enabled. Restarting proxy and Sentinel.'
+ : 'Traffic analytics disabled. Restarting proxy and Sentinel.');
+ } catch (\Throwable $e) {
+ handleError($e, $this);
+ }
+ }
+
public function regenerateSentinelToken()
{
try {
diff --git a/resources/views/livewire/server/sentinel.blade.php b/resources/views/livewire/server/sentinel.blade.php
index e5041fb4b6..67a47489f6 100644
--- a/resources/views/livewire/server/sentinel.blade.php
+++ b/resources/views/livewire/server/sentinel.blade.php
@@ -6,7 +6,7 @@
`$wire.set('sentinelCustomDockerImage', …)` (and similar) briefly
flashes this bar on every page open. --}}
<x-unsaved-bar action="submit"
- targets="sentinelCustomUrl,sentinelToken,sentinelMetricsRefreshRateSeconds,sentinelMetricsHistoryDays,sentinelPushIntervalSeconds" />
+ targets="sentinelCustomUrl,sentinelToken,sentinelMetricsRefreshRateSeconds,sentinelMetricsHistoryDays,sentinelPushIntervalSeconds,geoipMaxmindLicenseKey" />
@endif
<x-application.settings-section id="server-sentinel-overview-section" title="Sentinel"
@@ -92,6 +92,28 @@
</div>
</x-application.settings-section>
+ <x-application.settings-section id="server-sentinel-traffic-analytics-section" title="Traffic analytics"
+ helper="Collect proxy access logs and geolocate visitor traffic for applications on this server.">
+ <x-slot:actions>
+ <x-forms.button canGate="update" :canResource="$server" wire:click="toggleTrafficAnalytics"
+ wire:confirm="{{ $isTrafficAnalyticsEnabled ? 'Disable' : 'Enable' }} traffic analytics? The proxy and Sentinel will restart, causing a brief connectivity blip for all applications on this server.">
+ {{ $isTrafficAnalyticsEnabled ? 'Disable' : 'Enable' }} traffic analytics
+ </x-forms.button>
+ </x-slot:actions>
+
+ @if ($isTrafficAnalyticsEnabled)
+ <div class="grid gap-4 lg:grid-cols-2">
+ <x-forms.input canGate="update" :canResource="$server" type="password"
+ id="geoipMaxmindLicenseKey" label="MaxMind GeoIP license key" placeholder="Optional"
+ helper="Used to download the GeoLite2 database for visitor geolocation. Leave empty to disable geolocation." />
+ </div>
+ @else
+ <x-empty size="sm" title="Traffic analytics is disabled"
+ description="Enable traffic analytics to collect proxy access logs and geolocate visitor traffic."
+ icon-name="dashboard" />
+ @endif
+ </x-application.settings-section>
+
@if (isDev())
<x-application.settings-section id="server-sentinel-development-section"
title="Development overrides"
diff --git a/tests/Feature/TrafficAnalytics/ToggleTrafficAnalyticsTest.php b/tests/Feature/TrafficAnalytics/ToggleTrafficAnalyticsTest.php
new file mode 100644
index 0000000000..89fbb56bfd
--- /dev/null
+++ b/tests/Feature/TrafficAnalytics/ToggleTrafficAnalyticsTest.php
@@ -0,0 +1,34 @@
+<?php
+
+use App\Actions\Server\ConfigureTrafficAnalytics;
+use App\Livewire\Server\Sentinel;
+use App\Models\Server;
+use App\Models\User;
+use Illuminate\Foundation\Testing\RefreshDatabase;
+use Livewire\Livewire;
+
+uses(RefreshDatabase::class);
+
+beforeEach(function () {
+ $this->user = User::factory()->create();
+ $this->team = $this->user->teams()->first();
+ $this->actingAs($this->user);
+ session(['currentTeam' => $this->team]);
+});
+
+it('toggles traffic analytics via the sentinel settings component', function () {
+ ConfigureTrafficAnalytics::partialMock()->shouldReceive('handle')->once()->andReturnUsing(function ($server, $enable) {
+ $server->settings->is_traffic_analytics_enabled = $enable;
+ $server->settings->save();
+ });
+
+ $server = Server::factory()->create(['team_id' => $this->team->id]);
+
+ expect($server->isTrafficAnalyticsEnabled())->toBeFalse();
+
+ Livewire::test(Sentinel::class, ['server' => $server])
+ ->call('toggleTrafficAnalytics')
+ ->assertHasNoErrors();
+
+ expect($server->fresh()->isTrafficAnalyticsEnabled())->toBeTrue();
+});