Tideways Installation

Vorwort

Wenn Sie Tideways, einen sehr umfangreichen PHP-Profiler, auf Ihrer Webseite und/oder Online-Shop nutzen möchten, zeigt Ihnen unsere Installationsanleitung, wie Sie den Service auf Ihrem Server installieren und konfigurieren können.

Voraussetzungen

• Managed Server
• aktive Tideways Lizenz

Installation

Um Tideways auf Debian und Ubuntu Servern zu installieren, benötigen Sie eine aktive Root SSH Verbindungen, mit der Sie die Installation beginnen können.

Zu aller erst muss der Tideways PHP Service und der Tideways Daemon installiert werden. Die Installation der beiden Pakete erfolgt über folgende SSH Befehle:

echo 'deb [signed-by=/usr/share/keyrings/tideways.gpg] https://packages.tideways.com/apt-packages-main any-version main' | tee /etc/apt/sources.list.d/tideways.list > /dev/null

wget -qO - 'https://packages.tideways.com/key.gpg' | gpg --dearmor | tee /usr/share/keyrings/tideways.gpg > /dev/null

 apt-get update && apt-get install tideways-php tideways-daemon

Nach der Installation muss Tideways mit Ihrem API-Key und der gewünschten Umgebung (Production, Stage, etc.) konfiguriert werden. Wie Sie Tideways erfolgreich konfigurieren können, zeigen wir Ihnen in den weiteren Schritten für Plesk, PHP-FPM und Mod PHP (Apache2).

Konfiguration unter Plesk

Um Tideways unter Plesk zu konfigurieren, melden Sie sich in Ihrem Plesk Control Panel an und navigieren Sie zu Webseite → PHP-Einstellungen → Zusätzliche Anweisungen

Ihren Tideways API-Key finden Sie unter Tideways → Projekt → Setup → php.ini

Der Aufbau sieht folgendermaßen aus:

Apache

SetEnv TIDEWAYS_APIKEY XXXXXXXXXXXXXXX
SetEnv TIDEWAYS_SAMPLERATE 25

NGINX

location / {
    ...
    fastcgi_param TIDEWAYS_APIKEY 0dhA0nWXp6HI4Tpm;
    fastcgi_param TIDEWAYS_SAMPLERATE 25;
        ...
}

Diesen fügen Sie in die zusätzliche Konfigurationsanweisung in Plesk ein, sodass das Ergebnis wie folgt aussieht:

Nach der Installation können Sie prüfen, ob Tideways bereits Daten sammelt, bitte warten Sie hierfür 60 Sekunden ab, sodass Tideways die Daten sammeln kann.

Konfiguration unter PHP-FPM

Um Tideways unter PHP-FPM zu konfigurieren, benötigen Sie eine aktive SSH Verbindung, mit der Sie sich auf dem gewünschten Server anmelden.

Wenn Sie verbunden sind, öffnen Sie die zz-creoline.ini mit nano oder vim und bearbeiten Sie die Datei wie angegeben.

nano /etc/php/8.2/fpm/conf.d/zz-creoline.ini

Die Datei sollte in etwa wie diese Beispieldatei aussehen:

; Copyright (C) 2023 creoline GmbH
; PHP.ini Configuration for PHP 8.2
; Version: 1.6

max_execution_time=120
memory_limit=1024M
upload_max_filesize=10G
post_max_size=10G

; OpCache Config
; opcache (memory consumption unit: MB)
opcache.memory_consumption=2048
opcache.max_accelerated_files=100000

opcache.jit_buffer_size=100M
opcache.jit=1255

; session
; session.save_handler = redis
; session.save_path = tcp://10.20.2.1:6379

; tideways
; tideways.api_key=
; tideways.sample_rate=25

; Shopware 6
assert.active=0
opcache.enable_file_override=1
opcache.interned_strings_buffer=50
zend.detect_unicode=0
realpath_cache_ttl=3600

\nIn die zz-creoline.ini müssen Sie folgende Zeilen hinzufügen:

tideways.api_key=XXXXXXXXXXXXXXXXXX
tideways.sample_rate=25

Nach der Konfiguration sollten Sie den PHP-FPM Service neu laden, indem Sie die folgenden Befehle ausführen:

# Configtest
php-fpm8.2 --test

# Reload
systemctl reload php8.2-fpm.service

Konfiguration unter Mod PHP (Apache2)

Sollten Sie Tideways unter Apache2 installieren, melden Sie sich als Root Benutzer via SSH auf Ihrem Server an, für den Sie die Daten mit Tideways analysieren möchten.

Zu aller erst müssen Sie den API-Key von Tideways hinterlegen, nutzen Sie dazu die zz-creoline.ini, sollte die Datei noch nicht existieren, können Sie diese gerne mit folgendem Befehl erstellen:

nano /etc/php/8.2/fpm/conf.d/zz-creoline.ini

In die zz-creoline.ini müssen Sie folgende Zeilen hinzufügen:

tideways.api_key=XXXXXXXXXXXXXXXXXX
tideways.sample_rate=25

Nach der Konfiguration sollten Sie den PHP-FPM Service neu laden, in dem Sie die folgenden Befehle ausführen:

# Configtest
php-fpm8.2 --test

# Reload
systemctl reload php8.2-fpm.service

Environment einstellen

In Tideways können Sie mehrere Environments darstellen, die Konfiguration erfolgt über die mitgelieferte tideways-daemon Datei.

Die Datei finden Sie unter /etc/default/tideways-daemon und kann mit nano oder vim bearbeitet werden. Um die Datei zu bearbeiten, kann der folgende Befehl verwendet werden:

nano /etc/default/tideways-daemon

Der Dateiinhalt sollte z. B. wie folgt aussehen:

TIDEWAYS_DAEMON_EXTRA="--env=staging"

Wenn Sie Ihre Staging-Umgebung darstellen möchten, nutzen Sie --env=staging, falls Sie Tideways auf Ihrem Production Enviroment nutzen, müssen Sie hier --env=production eintragen.

Die Daten werden nach einem Restart in der jeweils angegeben Umgebung dargestellt.