Apache Web Server (httpd)

L'intégration Apache Web Server collecte des métriques liées au trafic, telles que le nombre de connexions ouvertes ou les requêtes entrantes. L'intégration collecte également les journaux d'accès et d'erreur. Les journaux d'accès sont analysés dans une charge utile JSON axée sur les détails de la requête, et les journaux d'erreur sont analysés pour connaître leur code et leur message d'erreur.

Pour en savoir plus sur le serveur Web Apache, consultez la documentation sur le serveur Web Apache (httpd).

Prérequis

Pour collecter la télémétrie du serveur Web Apache, vous devez installer l'agent Ops :

  • Pour les métriques, installez la version 2.7.0 ou ultérieure.
  • Pour les journaux, installez la version 2.4.0 ou ultérieure.

Cette intégration est compatible avec la version 2.4 du serveur Web Apache.

Configurer votre instance de serveur Web Apache

Pour collecter les données de télémétrie à partir de votre serveur Web Apache, vous devez configurer le fichier httpd.conf du serveur pour activer le plug-in mod_status.

De nombreuses installations Apache activent ce plug-in par défaut. Pour voir si le plug-in est activé sur votre instance de VM, exécutez la commande suivante :

curl localhost:80/server-status?auto

Si c'est le cas, le résultat inclut des lignes semblables aux suivantes :

Total Accesses: 2
Total kBytes: 1
BusyWorkers: 1
IdleWorkers: 4

Si vous obtenez une page 404 Not Found à la place, le plug-in mod_status n'est pas activé.

Configurer l'agent Ops pour le serveur Web Apache

En suivant le guide de configuration de l'agent Ops, ajoutez les éléments requis pour collecter les données télémétriques des instances du serveur Web Apache et redémarrez l'agent.

Exemple de configuration

Les commandes suivantes créent la configuration de collecte et d'ingestion de la télémétrie pour le serveur Web Apache et redémarre l'agent Ops.

# Configures Ops Agent to collect telemetry from the app and restart Ops Agent.

set -e

# Create a back up of the existing file so existing configurations are not lost.
sudo cp /etc/google-cloud-ops-agent/config.yaml /etc/google-cloud-ops-agent/config.yaml.bak

# Configure the Ops Agent.
sudo tee /etc/google-cloud-ops-agent/config.yaml > /dev/null << EOF
metrics:
  receivers:
    apache:
      type: apache
  service:
    pipelines:
      apache:
        receivers:
          - apache
logging:
  receivers:
    apache_access:
      type: apache_access
    apache_error:
      type: apache_error
  service:
    pipelines:
      apache:
        receivers:
          - apache_access
          - apache_error
EOF

sudo service google-cloud-ops-agent restart
sleep 60

Configurer la collecte de journaux

Pour ingérer des journaux à partir du serveur Web Apache, vous devez créer des récepteurs pour les journaux générés par le serveur Web Apache, puis créer un pipeline pour les nouveaux récepteurs.

Pour configurer un récepteur pour vos journaux apache_access, spécifiez les champs suivants :

Champ Par défaut Description
exclude_paths Liste des formats de chemin d'accès au système de fichiers à exclure de l'ensemble correspondant à include_paths.
include_paths [/var/log/apache2/access.log,/var/log/apache2/access_log,/var/log/httpd/access_log] Liste des chemins d'accès du système de fichiers à lire en affichant chaque fichier. Un caractère générique (*) peut être utilisé dans les chemins d'accès. Exemple : /var/log/apache*/*.log.
record_log_file_path false Si cette valeur est définie sur true, le chemin d'accès au fichier spécifique à partir duquel l'enregistrement de journal a été obtenu apparaît dans l'entrée de journal de sortie en tant que valeur du libellé agent.googleapis.com/log_file_path. Lorsque vous utilisez un caractère générique, seul le chemin du fichier à partir duquel l'enregistrement a été obtenu est enregistré.
type Cette valeur doit être apache_access.
wildcard_refresh_interval 60s Intervalle d'actualisation pour les chemins d'accès de fichiers utilisant des caractères génériques dans include_paths. Renseigné sous la forme d'une durée, par exemple, 30s ou 2m. Cette propriété peut s'avérer utile lorsque le débit de journalisation est élevé et que les fichiers journaux sont alternés plus rapidement que l'intervalle par défaut.

Pour configurer un récepteur pour vos journaux apache_error, spécifiez les champs suivants :

Champ Par défaut Description
exclude_paths Liste des formats de chemin d'accès au système de fichiers à exclure de l'ensemble correspondant à include_paths.
include_paths [/var/log/apache2/error.log,/var/log/apache2/error_log,/var/log/httpd/error_log] Liste des chemins d'accès du système de fichiers à lire en affichant chaque fichier. Un caractère générique (*) peut être utilisé dans les chemins d'accès. Exemple : /var/log/apache*/*.log.
record_log_file_path false Si cette valeur est définie sur true, le chemin d'accès au fichier spécifique à partir duquel l'enregistrement de journal a été obtenu apparaît dans l'entrée de journal de sortie en tant que valeur du libellé agent.googleapis.com/log_file_path. Lorsque vous utilisez un caractère générique, seul le chemin du fichier à partir duquel l'enregistrement a été obtenu est enregistré.
type Cette valeur doit être apache_error.
wildcard_refresh_interval 60s Intervalle d'actualisation pour les chemins d'accès de fichiers utilisant des caractères génériques dans include_paths. Renseigné sous la forme d'une durée, par exemple, 30s ou 2m. Cette propriété peut s'avérer utile lorsque le débit de journalisation est élevé et que les fichiers journaux sont alternés plus rapidement que l'intervalle par défaut.

Contenu consigné

Le champ logName est dérivé des ID de récepteur spécifiés dans la configuration. Les champs détaillés dans l'entrée de journal (LogEntry) sont les suivants.

Les journaux apache_access contiennent les champs suivants dans LogEntry :

Champ Type Description
httpRequest objet Consultez HttpRequest
jsonPayload.host chaîne Contenu de l'en-tête d'hôte
jsonPayload.user chaîne Nom d'utilisateur authentifié pour la requête
severity chaîne (LogSeverity) Niveau d'entrée de journal (traduit).

Les journaux apache_error contiennent les champs suivants dans LogEntry :

Champ Type Description
jsonPayload.client chaîne Adresse IP du client (facultatif)
jsonPayload.errorCode chaîne Code d'erreur Apache
jsonPayload.level chaîne Niveau de l'entrée de journal
jsonPayload.message chaîne Message du journal
jsonPayload.module chaîne Module Apache d'où provient le journal
jsonPayload.pid chaîne ID du processus
jsonPayload.tid chaîne ID de Thread
severity chaîne (LogSeverity) Niveau d'entrée de journal (traduit).

Configurer la collecte de métriques

Pour ingérer des métriques à partir du serveur Web Apache, vous devez créer des récepteurs pour les métriques générées par le serveur Web Apache, puis créer un pipeline pour les nouveaux récepteurs.

Ce récepteur ne permet pas d'utiliser plusieurs instances dans la configuration, par exemple pour surveiller plusieurs points de terminaison. Toutes ces instances écrivent dans la même série temporelle, et Cloud Monitoring n'a aucun moyen de les distinguer.

Pour configurer un récepteur pour vos métriques apache, spécifiez les champs suivants :

Champ Par défaut Description
collection_interval 60s Une valeur time duration, telle que 30s ou 5m.
server_status_url http://localhost:80/server-status?auto URL exposée par le module mod_status.
type Cette valeur doit être apache.

Métriques surveillées

Le tableau suivant fournit la liste des métriques que l'agent Ops collecte à partir de l'instance du serveur Web Apache.

Type de métrique
Genre, type
Ressources surveillées		 Étiquettes
workload.googleapis.com/apache.current_connections
GAUGE, INT64
gce_instance 		server_name
workload.googleapis.com/apache.requests
CUMULATIVE, INT64
gce_instance 		server_name
workload.googleapis.com/apache.scoreboard
GAUGE, INT64
gce_instance 		server_name
state
workload.googleapis.com/apache.traffic
CUMULATIVE, INT64
gce_instance 		server_name
workload.googleapis.com/apache.workers
GAUGE, INT64
gce_instance 		server_name
state

Vérifier la configuration

Cette section explique comment vérifier que vous avez bien configuré le récepteur du serveur Web Apache. La collecte de la télémétrie par l'agent Ops peut prendre une ou deux minutes.

Pour vérifier que les journaux du serveur Web Apache sont envoyés à Cloud Logging, procédez comme suit :

  1. Dans la console Google Cloud, accédez à la page Explorateur de journaux.

    Accéder à l'explorateur de journaux

    Si vous utilisez la barre de recherche pour trouver cette page, sélectionnez le résultat dont le sous-titre est Logging.

  2. Saisissez la requête suivante dans l'éditeur, puis cliquez sur Exécuter la requête :
    resource.type="gce_instance"
(log_id("apache_access") OR log_id("apache_error"))

Pour vérifier que les métriques du serveur Web Apache sont envoyées à Cloud Monitoring, procédez comme suit :

  1. Dans la console Google Cloud, accédez à la page Explorateur de métriques :

    Accéder à l'explorateur de métriques

    Si vous utilisez la barre de recherche pour trouver cette page, sélectionnez le résultat dont le sous-titre est Monitoring.

  2. Dans la barre d'outils du volet de création de requêtes, sélectionnez le bouton nommé  MQL ou  PromQL.
  3. Vérifiez que MQL est sélectionné dans le bouton d'activation Langage. Le bouton de langage se trouve dans la barre d'outils qui vous permet de mettre en forme votre requête.
  4. Saisissez la requête suivante dans l'éditeur, puis cliquez sur Exécuter la requête :
    fetch gce_instance
| metric 'workload.googleapis.com/apache.requests'
| every 1m

Afficher le tableau de bord

Pour afficher vos métriques de serveur Web Apache, vous devez configurer un graphique ou un tableau de bord. L'intégration du serveur Web Apache inclut un ou plusieurs tableaux de bord. Tous les tableaux de bord sont automatiquement installés après la configuration de l'intégration et que l'agent Ops a commencé à collecter des données de métriques.

Vous pouvez également afficher des aperçus statiques de tableaux de bord sans installer l'intégration.

Pour afficher un tableau de bord installé, procédez comme suit :

  1. Dans la console Google Cloud, accédez à la page Tableaux de bord .

    Accéder à la page Tableaux de bord

    Si vous utilisez la barre de recherche pour trouver cette page, sélectionnez le résultat dont le sous-titre est Monitoring.

  2. Sélectionnez l'onglet Liste des tableaux de bord, puis choisissez la catégorie Intégrations.
  3. Cliquez sur le nom du tableau de bord que vous souhaitez afficher.

Si vous avez configuré une intégration, mais que le tableau de bord n'a pas été installé, vérifiez que l'agent Ops est en cours d'exécution. Lorsqu'un graphique ne contient aucune donnée de métrique, l'installation du tableau de bord échoue. Une fois que l'agent Ops a commencé à collecter des métriques, le tableau de bord est installé.

Pour afficher un aperçu statique du tableau de bord, procédez comme suit :

  1. Dans la console Google Cloud, accédez à la page Intégrations  :

    Accéder à la page Intégrations

    Si vous utilisez la barre de recherche pour trouver cette page, sélectionnez le résultat dont le sous-titre est Monitoring.

  2. Cliquez sur le filtre de plate-forme de déploiement Compute Engine.
  3. Recherchez l'entrée pour le serveur Web Apache et cliquez sur Afficher les détails.
  4. Cliquez sur l'onglet Tableaux de bord pour afficher un aperçu statique. Si le tableau de bord est installé, vous pouvez y accéder en cliquant sur Afficher le tableau de bord.

Pour en savoir plus sur les tableaux de bord dans Cloud Monitoring, consultez la page Tableaux de bord et graphiques.

Pour en savoir plus sur l'utilisation de la page Intégrations, consultez la page Gérer les intégrations.

Installer des règles d'alerte

Les règles d'alerte indiquent à Cloud Monitoring de vous avertir lorsque des conditions spécifiées se produisent. L'intégration du serveur Web Apache inclut une ou plusieurs règles d'alerte. Vous pouvez afficher et installer ces règles d'alerte à partir de la page Intégrations dans Monitoring.

Pour afficher la description des règles d'alerte disponibles et les installer, procédez comme suit :

  1. Dans la console Google Cloud, accédez à la page Intégrations  :

    Accéder à la page Intégrations

    Si vous utilisez la barre de recherche pour trouver cette page, sélectionnez le résultat dont le sous-titre est Monitoring.

  2. Recherchez l'entrée pour le serveur Web Apache et cliquez sur Afficher les détails.
  3. Sélectionnez l'onglet Alertes. Cet onglet fournit une description des règles d'alerte disponibles et fournit une interface pour les installer.
  4. Installez les règles d'alerte. Les règles d'alerte doivent savoir où envoyer des notifications indiquant que l'alerte a été déclenchée. Elles nécessitent donc des informations de votre part pour l'installation. Pour installer des règles d'alerte, procédez comme suit :
    1. Dans la liste des règles d'alerte disponibles, sélectionnez celles que vous souhaitez installer.

    2. Dans la section Configurer les notifications, sélectionnez un ou plusieurs canaux de notification. Vous avez la possibilité de désactiver l'utilisation des canaux de notification. Toutefois, si vous le faites, vos règles d'alerte se déclenchent en mode silencieux. Vous pouvez vérifier leur état dans Monitoring, mais vous ne recevez aucune notification.

      Pour plus d'informations sur les canaux de notification, consultez la section Gérer les canaux de notification.

    3. Cliquez sur Créer des règles.

Pour plus d'informations sur les règles d'alerte dans Cloud Monitoring, consultez la section Présentation des alertes.

Pour en savoir plus sur l'utilisation de la page Intégrations, consultez la page Gérer les intégrations.

Étape suivante

Pour accéder à un tutoriel pas à pas expliquant comment utiliser Ansible pour installer l'agent Ops, configurer une application tierce et installer un exemple de tableau de bord, consultez la vidéo Install the Ops Agent to troubleshoot third-party applications (Installer l'agent Ops pour résoudre les problèmes liés à des applications tierces).