Cloud Logging für PHP einrichten

Sie können Logs aus PHP-Anwendungen in Cloud Logging schreiben, wenn Sie die Cloud Logging-Bibliothek für PHP direkt verwenden.

Vorbereitung

  1. Sign in to your Google Cloud account. If you're new to Google Cloud, create an account to evaluate how our products perform in real-world scenarios. New customers also get $300 in free credits to run, test, and deploy workloads.

  2. In the Google Cloud console, on the project selector page, select or create a Google Cloud project.

    Go to project selector

  3. Make sure that billing is enabled for your Google Cloud project.

  4. Enable the Cloud Logging API.

    Enable the API

    5.

  5. In the Google Cloud console, on the project selector page, select or create a Google Cloud project.

    Go to project selector

  6. Make sure that billing is enabled for your Google Cloud project.

  7. Enable the Cloud Logging API.

    Enable the API

    8.

Cloud Logging-Bibliothek für PHP installieren

Mit der Cloud Logging-Bibliothek für PHP lässt sich der Logger PSR-3 für PHP-Web-Frameworks einfach implementieren.

Sie können Logs aus Ihrer Anwendung heraus verfassen, wenn Sie die Cloud Logging-Bibliothek für PHP zu Ihrer composer.json hinzufügen:

composer require google/cloud-logging

PSR-3-Logger erstellen

Mit diesem Code können Sie einen PSR-3-Logger erstellen:

use Google\Cloud\Logging\LoggingClient;
 
$logging = new LoggingClient([
    'projectId' => $projectId
]);
$logger = $logging->psrLogger('app');

Stapelverarbeitungsoption aktivieren

Der PSR-3 Logger sendet die Logs synchron. Das bedeutet, dass jedes Mal, wenn Sie ein Log ausgeben, die RPC-Latenz der Nutzeranfrage erhöht wird. Besonders wenn Sie mehrere Logs in einer einzelnen Anfrage ausgeben, erhöht sich die Latenz erheblich. Das wollen Sie wahrscheinlich vermeiden.

Mit diesem Code erstellen Sie einen PSR-3-Logger, der mehrere Logs zu einem einzigen RPC-Aufruf zusammenfasst:

$logger = LoggingClient::psrBatchLogger('app');

Standardmäßig fasst dieser Logger die Logs in einem einzigen Vorgang zusammen. In der flexiblen App Engine-Umgebung können Sie die Cloud Logging-Bibliothek für PHP so konfigurieren, dass der Durchsatz weiter erhöht und die Latenz minimiert wird. Weitere Informationen finden Sie unter Log-Daemon konfigurieren.

Cloud Logging-Bibliothek für PHP konfigurieren

Sie können das Verhalten der Cloud Logging-Bibliothek für PHP anpassen. Eine Liste der möglichen Konfigurationsoptionen finden Sie im Konfigurationsdokument.

PSR-3-Logger verwenden

Sobald der Logger erstellt wurde, können Sie ihn in Ihrer Anwendung verwenden:

$logger->info('Hello World');
$logger->error('Oh no');

Weitere Informationen zur Installation finden Sie in der Dokumentation zur Cloud Logging-Bibliothek für PHP. Probleme können Sie über die Problemverfolgung melden.

Protokolle mit der Cloud Logging-Clientbibliothek schreiben

Informationen zur direkten Verwendung der Cloud Logging-Clientbibliothek für PHP finden Sie unter Cloud Logging-Clientbibliotheken.

In Google Cloud ausführen

Damit eine Anwendung Protokolle mit der Cloud Logging-Bibliothek für PHP schreiben kann, muss das Dienstkonto für die zugrunde liegende Ressource die IAM Log-Autor (roles/logging.logWriter) haben. In den meisten Google Cloud-Umgebungen wird das Standarddienstkonto automatisch mit dieser Rolle konfiguriert.

App Engine

Cloud Logging ist für App Engine automatisch aktiviert und das Standarddienstkonto Ihrer Anwendung hat standardmäßig die IAM-Berechtigungen zum Schreiben von Logeinträgen.

Weitere Informationen finden Sie unter Logs schreiben und ansehen.

Es empfiehlt sich jedoch, den PSR-3-Logger zu verwenden. Dieser ergänzt Ihre Logs automatisch um Metadaten, sodass Ihre Anwendungslogs den Anfragelogs zugeordnet werden können.

Daemon für die flexible App Engine-Umgebung konfigurieren

In der flexiblen App Engine-Umgebung können Sie die Cloud Logging-Bibliothek für PHP zur Verwendung eines externen Daemon-Programms konfigurieren, um den Logdurchsatz zu maximieren und die Latenz der Anwendung zu minimieren. Fügen Sie die folgende Zeile in den Abschnitt runtime_config in app.yaml ein, um diese Funktion zu aktivieren:

enable_stackdriver_integration: true

Google Kubernetes Engine (GKE)

GKE gewährt dem Standarddienstkonto automatisch die IAM-Rolle Logautor (roles/logging.logWriter). Wenn Sie Workload Identity Federation for GKE mit diesem Standarddienstkonto verwenden, um Arbeitslasten Zugriff auf bestimmte Google Cloud APIs zu gewähren, ist keine zusätzliche Konfiguration erforderlich. Wenn Sie die Workload Identity-Föderation für GKE jedoch mit einem benutzerdefinierten IAM-Dienstkonto verwenden, muss das benutzerdefinierte Dienstkonto die Rolle „Logs Writer“ (roles/logging.logWriter) haben.

Bei Bedarf können Sie auch den folgenden Befehl verwenden, um beim Erstellen des Clusters den Zugriffsbereich logging.write hinzuzufügen:

gcloud container clusters create example-cluster-name \
    --scopes https://www.googleapis.com/auth/logging.write

Compute Engine

Wenn Sie Compute Engine-VM-Instanzen verwenden, fügen Sie der jeweiligen Instanz den Zugriffsbereich für cloud-platform hinzu. In der Google Cloud Console können Sie das beim Erstellen einer neuen Instanz im Bereich Instanz erstellen im Abschnitt Identität und API-Zugriff erledigen. Verwenden Sie das Compute Engine-Standarddienstkonto oder ein anderes Dienstkonto und wählen Sie im Abschnitt Identität und API-Zugriff die Option Uneingeschränkten Zugriff auf alle Cloud APIs zulassen aus. Achten Sie darauf, dass jedem ausgewählten Dienstkonto im Abschnitt IAM & Verwaltung der Google Cloud Console die Rolle „Log-Autor“ zugewiesen ist.

Lokal und extern ausführen

Wenn Sie die Cloud Logging-Bibliothek für PHP außerhalb von Google Cloud verwenden möchten, z. B. auf Ihrer eigenen Workstation, auf den Computern Ihres Rechenzentrums oder auf den VM-Instanzen eines anderen Cloudanbieters, müssen Sie Ihre Google Cloud-Projekt-ID und die entsprechenden Anmeldedaten für das Dienstkonto direkt in die Cloud Logging-Bibliothek für PHP eintragen.

So gehen Sie bei vorhandenen Dienstkonten vor:

  1. Gewähren Sie dem Dienstkonto die IAM-Rolle Logautor (roles/logging.logWriter). Weitere Informationen zu IAM-Rollen finden Sie unter Zugriffssteuerung.

  2. Richten Sie Standardanmeldedaten für Anwendungen ein.

Wenn Sie kein Dienstkonto haben, erstellen Sie eins. Weitere Informationen finden Sie unter Dienstkonten erstellen.

Allgemeine Informationen zu den Authentifizierungsmethoden finden Sie unter Terminologie: Dienstkonten.

Logs ansehen

Rufen Sie in der Google Cloud Console die Seite Log-Explorer auf.

Zum Log-Explorer

Wenn Sie diese Seite über die Suchleiste suchen, wählen Sie das Ergebnis aus, dessen Zwischenüberschrift Logging ist.

Im Log-Explorer müssen Sie eine oder mehrere Ressourcen angeben. Die Auswahl der Ressourcen ist jedoch möglicherweise nicht offensichtlich. Hier sind ein paar Tipps für den Einstieg.

  • Wenn Sie Ihre Anwendung für App Engine bereitstellen oder die App Engine-spezifischen Bibliotheken verwenden, setzen Sie die Ressource auf GAE-Anwendung.

  • Wenn Sie Ihre Anwendung auf der Compute Engine bereitstellen, setzen Sie die Ressource auf GCE-VM-Instanz.

  • Wenn Sie Ihre Anwendung in Google Kubernetes Engine bereitstellen, wird der Ressourcentyp der Logeinträge von der Loggingkonfiguration des Clusters bestimmt. Weitere Informationen zu den Lösungen mit Legacy Google Cloud Observability und Google Cloud Observability Kubernetes Monitoring und den jeweiligen Auswirkungen auf den Ressourcentyp finden Sie unter Zu Google Cloud Observability Kubernetes Monitoring migrieren.

  • Wenn Ihre Anwendung die Cloud Logging API direkt nutzt, ist die Ressource von der API und Ihrer Konfiguration abhängig. Sie können in Ihrer Anwendung zum Beispiel eine Ressource angeben oder eine Standardressource verwenden.

  • Wenn im Log-Explorer keine Logs zu sehen sind, wechseln Sie zum erweiterten Abfragemodus und verwenden Sie eine leere Abfrage, um alle Logeinträge zu sehen.

    1. Klicken Sie oben im Log-Explorer auf das Dreipunkt-Menü (▾) und wählen Sie In erweiterten Filter umwandeln aus, um zum erweiterten Abfragemodus zu wechseln.
    2. Löschen Sie den Inhalt, der im Filterfeld angezeigt wird.
    3. Klicken Sie auf Filter senden.

    Sie können die einzelnen Einträge prüfen, um Ihre Ressourcen zu identifizieren.

Weitere Informationen finden Sie unter Log-Explorer verwenden.