Performance-Analyse mit Glowroot

Bei Performance-Problemen kann der Relution Support um eine Analyse mit Glowroot → bitten. Glowroot zeichnet auf, welche Anfragen wie lange dauern, und zeigt das Ergebnis in einer eigenen Weboberfläche an.

Die bis Relution 27.0 eingebaute Aktivierung von Glowroot über Umgebungsvariablen des Containers wurde mit Relution 27.1 entfernt; diese Variablen werden ab Relution 27.1 ignoriert. Die folgende Anleitung funktioniert auf allen unterstützten Versionen — auf Versionen bis 27.0 darf die alte Aktivierung nur nicht gleichzeitig gesetzt sein, sonst wird Glowroot zweimal eingebunden.

Glowroot herunterladen und verifizieren

Das Glowroot-Paket wird von repo.relution.io heruntergeladen. Es passt zur Java-Version des Relution-Images (derzeit Java 25); welche Java-Version das eingesetzte Image enthält, zeigt:

docker run --rm relution/relution:latest java -version

Die Prüfsumme stellt sicher, dass das Paket unverändert angekommen ist:

wget https://repo.relution.io/glowroot/glowroot-java25-dist.zip
echo "3b9db6b0fc0903233c5e17b6cfa7b022ef8ba6d71ae7d39a9fff6f637608f20c  glowroot-java25-dist.zip" | sha256sum -c
unzip glowroot-java25-dist.zip

Die Befehle werden in dem Verzeichnis ausgeführt, in dem die docker-compose.yml liegt. Das Entpacken erzeugt dort das Verzeichnis glowroot. Meldet die Prüfung FAILED statt OK, darf das Paket nicht verwendet werden.


Weboberfläche erreichbar machen

Glowroot bindet seine Weboberfläche standardmäßig nur an localhost innerhalb des Containers. Damit sie den Container verlässt, wird vor dem Start die Datei glowroot/admin.json angelegt:

echo '{"web": {"bindAddress": "0.0.0.0"}}' > glowroot/admin.json

Glowroot schreibt Konfiguration, Aufzeichnungen und Logs neben den Agenten. Das Verzeichnis muss deshalb dem Benutzer des Containers (UID 20001) gehören:

sudo chown -R 20001:20001 glowroot

Container konfigurieren

In der docker-compose.yml wird das Verzeichnis in den Container gemountet und der Agent über JAVA_TOOL_OPTIONS eingebunden:

  relution:
    image: relution/relution:latest
    environment:
      - JAVA_TOOL_OPTIONS=-javaagent:/opt/glowroot/glowroot.jar
    volumes:
      - ./glowroot:/opt/glowroot
    ports:
      - '127.0.0.1:4000:4000'

Ist JAVA_TOOL_OPTIONS bereits gesetzt, wird der -javaagent-Eintrag an den bestehenden Wert angehängt, statt ihn zu ersetzen. Nach dem Neuanlegen des Containers (docker compose up -d) ist die Oberfläche unter Port 4000 erreichbar. Durch das gemountete Verzeichnis bleiben die Aufzeichnungen auch erhalten, wenn der Container neu angelegt wird.

Das Port-Mapping 127.0.0.1:4000:4000 bindet die Oberfläche an die Loopback-Adresse des Servers; sie ist damit nur vom Server selbst unter http://localhost:4000 erreichbar — von einem Arbeitsplatz aus zum Beispiel über einen SSH-Tunnel (ssh -L 4000:localhost:4000 <server>).

Die Oberfläche auf Port 4000 gibt Datenbankabfragen, Antwortzeiten und Stacktraces preis und ist zunächst nicht durch ein Passwort geschützt. Sie darf keinesfalls aus dem Internet erreichbar sein — das Port-Mapping 127.0.0.1:4000:4000 deshalb nicht auf 4000:4000 erweitern.

Oberfläche mit Passwort schützen

Zusätzlich zur Loopback-Bindung kann die Oberfläche mit einem Passwort geschützt werden, etwa gegen andere Benutzer desselben Servers. Dazu wird in der Oberfläche unter Administration → Users ein Benutzer mit der Rolle Administrator und einem Passwort angelegt und anschließend der Benutzer anonymous entfernt. Glowroot legt den Passwort-Hash in glowroot/admin.json ab; durch das gemountete Verzeichnis bleibt er über Neustarts erhalten.

Da die Oberfläche unverschlüsseltes HTTP spricht, ersetzt das Passwort die Loopback-Bindung nicht: Über ein offenes Port-Mapping würde es im Klartext übertragen.


Glowroot deaktivieren

Glowroot bleibt nur so lange eingebunden, wie die Analyse dauert. Zum Deaktivieren werden die Zeile JAVA_TOOL_OPTIONS und das Port-Mapping wieder entfernt und der Container neu angelegt. Das Verzeichnis glowroot kann danach gelöscht werden; bleibt es bestehen, stehen die bisherigen Aufzeichnungen bei einer späteren Analyse wieder zur Verfügung.

Wie hilfreich war dieser Artikel?