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).

Prerequisites

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

Remarque : Si vous utilisez une version de l'agent Ops antérieure à la version 2.10.0, vous devez ajouter le champ server_status_url au récepteur de métriques, comme suit :

metrics:
  receivers:
    apache:
      type: apache
      server_status_url: http://localhost:80/server-status?auto

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 produits 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`. Donné en fonction de la durée d'analyse par `time.ParseDuration`, 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`. Donné en fonction de la durée d'analyse par `time.ParseDuration`, 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.

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`

Exemple de tableau de bord

Pour afficher vos métriques de serveur Web Apache, vous devez configurer un graphique ou un tableau de bord. Cloud Monitoring fournit une bibliothèque d'exemples de tableaux de bord pour les intégrations, contenant des graphiques préconfigurés. Pour en savoir plus sur l'installation de ces tableaux de bord, consultez la page Installer des exemples de tableaux de bord.

Vérifier la configuration

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

Pour vérifier que les journaux sont ingérés, accédez à l'explorateur de journaux et exécutez la requête suivante pour afficher les journaux du serveur Web Apache :

resource.type="gce_instance"
(log_id("apache_access") OR log_id("apache_error"))

Pour vérifier que les métriques sont ingérées, accédez à l'explorateur de métriques et exécutez la requête suivante dans l'onglet MQL :

fetch gce_instance
| metric 'workload.googleapis.com/apache.current_connections'
| every 1m

Étapes suivantes

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).