HTTP Check

Supported OS Linux Mac OS Windows

Présentation

Surveillez le statut de disponibilité d’endpoints HTTP locaux ou à distance. Le check HTTP peut détecter des codes d’erreur (p. ex., 404), identifier les certificats SSL sur le point d’expirer, rechercher des réponses pour un texte spécifique, et plus encore. Le check peut également transmettre des délais de réponse HTTP sous la forme d’une métrique.

Configuration

Installation

Le check HTTP est inclus avec le package de l’Agent Datadog : vous n’avez donc rien à installer sur les serveurs à partir desquels vous souhaitez sonder vos sites HTTP. Bien qu’il soit généralement préférable d’exécuter les checks axés sur des métriques sur le même host que celui du service surveillé, ce check axé sur des statuts peut être lancé sur des hosts qui n’exécutent pas les sites surveillés.

Configuration

Modifiez le fichier http_check.d/conf.yaml dans le dossier conf.d/ à la racine du répertoire de configuration de votre Agent. Consultez le fichier d’exemple http_check.d/conf.yaml pour découvrir toutes les options de configuration disponibles :

init_config:

instances:
  - name: Exemple de site
    url: https://example.com/

  - name: Exemple de site (staging)
    url: http://staging.example.com/

Le check HTTP dispose de davantage d’options de configuration que bon nombre de checks. Seules quelques-unes d’entre elles sont indiquées ci-dessus. La plupart des options fonctionnent selon un système d’activation : par exemple, l’Agent n’exécutera pas la validation SSL sauf si vous configurez les options requises. L’Agent vérifiera notamment les certificats SSL sur le point d’expirer par défaut.

Ce check se lance à chaque exécution du collecteur de l’Agent, soit par défaut toutes les 15 secondes. Pour définir une fréquence d’exécution personnalisée pour ce check, consultez la section Intervalle de collecte de la documentation portant sur les checks custom.

Consultez le fichier d’exemple http_check.d/conf.yaml pour obtenir la liste complète des options disponibles ainsi que leur description. Voici la liste des différentes options :

ParamètreDescription
nameLe nom de votre instance de check HTTP. Ce paramètre correspond à un tag pour les checks de service.
urlL’URL à tester.
timeoutLa durée en secondes autorisée pour recevoir une réponse.
methodLa méthode HTTP à utiliser pour le check.
dataUtilisez ce paramètre pour spécifier le corps d’une requête avec une méthode POST, PUT, DELETE ou PATCH. Les requêtes SOAP sont prises en charge si vous utilisez la méthode POST et que vous spécifiez une chaîne XML en tant que paramètre data.
headersCe paramètre vous permet d’envoyer des en-têtes supplémentaires avec la requête. Consultez le fichier d’exemple YAML pour obtenir des informations et des avertissements supplémentaires.
content_matchUne chaîne de caractères ou une expression régulière Python. Le check HTTP recherche cette valeur dans la réponse et renvoie DOWN si la chaîne de caractères ou l’expression est introuvable.
reverse_content_matchSi ce paramètre a pour valeur true, inverse le comportement de l’option content_match. Ainsi, le check HTTP renverra DOWN si la chaîne ou l’expression dans content_match a été trouvée. Valeur par défaut : false.
username et passwordSi votre service demande une authentification basique, vous pouvez fournir avec ces paramètres le nom d’utilisateur et le mot de passe.
http_response_status_codeUne chaîne de caractères ou une expression régulière Python d’un code de statut HTTP. Ce check renvoie DOWN pour tout code de statut ne correspondant pas. Par défaut, ce check couvre les codes de statut HTTP 1xx, 2xx et 3xx. Par exemple, 401 ou 4\d\d.
include_contentLorsque ce paramètre est défini sur true, le check inclut les 500 premiers caractères du corps de la réponse HTTP dans les notifications. Valeur par défaut : false.
collect_response_timePar défaut, le check recueille le délai de réponse (en secondes) par l’intermédiaire de la métrique network.http.response_time. Pour désactiver cette option, définissez cette valeur sur false.
tls_verifyOblige le check à valider le certificat TLS des services lors de la connexion à url.
tls_ignore_warningLorsque tls_verify est défini sur true, les avertissements de sécurité issus de la connexion SSL sont désactivés.
tls_ca_certCe paramètre vous permet de remplacer le chemin de certificat par défaut indiqué dans init_config
check_certificate_expirationLorsque check_certificate_expiration est activé, le check de service vérifie la date d’expiration du certificat SSL. Remarque : cela entraîne la validation du certificat SSL, peu importe la valeur du paramètre tls_verify.
days_warning et days_criticalLorsque check_certificate_expiration est activé, ces paramètres génèrent une alerte « warning » ou « critical » quand la durée avant l’expiration du certificat SSL correspond à la plage spécifiée.
ssl_server_nameLorsque check_certificate_expiration est activé, ce paramètre spécifie le hostname du service auquel se connecter. Si check_hostname est activé, il remplace également le host à faire correspondre.
check_hostnameLorsque ce paramètre est défini sur true, le check envoie un avertissement si le hostname de l’url vérifiée est différent du hostname du certificat SSL.
skip_proxySi ce paramètre est défini, le check ignore les paramètres de proxy et tente d’accéder directement à l’URL de check. Valeur par défaut : false. Si ce paramètre n’est pas défini, les paramètres de proxy de cette intégration correspondront, par défaut, aux paramètres de proxy définis dans le fichier de configuration datadog.yaml.
allow_redirectsCe paramètre permet au check de service de suivre les redirections HTTP. Valeur par défaut : true.
tagsLa liste des tags arbitraires qui seront associés au check. Pour en savoir plus sur les tags, consultez notre Guide d’utilisation des tags et notre article de blog, La puissance des métriques taguées (en anglais).

Une fois la configuration de http_check.d/conf.yaml terminée, redémarrez l’Agent pour commencer à envoyer les temps de réponse et les checks de service HTTP à Datadog.

Validation

Lancez la sous-commande status de l’Agent et cherchez http_check dans la section Checks.

Données collectées

Métriques

network.http.response_time
(gauge)
The response time of an HTTP request to a given url, tagged by url, e.g. 'url:http://example.com'.
Shown as second
network.http.can_connect
(gauge)
Whether the check can connect, 1 if true, 0 otherwise. Tagged by url, e.g. 'url:http://example.com'.
network.http.cant_connect
(gauge)
Whether the check failed to connect, 1 if true, 0 otherwise. Tagged by url, e.g. 'url:http://example.com'.
http.ssl.days_left
(gauge)
Days until SSL certificate expiration
Shown as day
http.ssl.seconds_left
(gauge)
Seconds until SSL certificate expiration
Shown as second

Événements

Le check HTTP n’inclut aucun événement.

Checks de service

Pour créer des conditions d’alerte sur ces checks de service dans Datadog, sélectionnez « Network » sur la page Create Monitor, et non « Integration ».

http.can_connect :
Renvoie DOWN lorsqu’une des affirmations suivantes se vérifie :

  • La requête vers uri expire.
  • Le code de réponse correspond à 4xx/5xx, ou ne correspond pas à l’expression fournie pour le paramètre http_response_status_code.
  • Le corps de la réponse ne contient pas l’expression de content_match.
  • reverse_content_match est défini sur « true » et le corps de la réponse contient l’expression de content_match.
  • uri contient https et tls_verify est défini sur « true », et la connexion SSL ne peut pas être validée.

Si ce n’est pas le cas, renvoie UP.

http.ssl_cert :
Le check renvoie :

  • DOWN si le certificat de uri a déjà expiré ;
  • CRITICAL si le certificat de uri expire dans moins de days_critical jours ;
  • WARNING si le certificat de uri expire dans moins de days_warning jours.

Si ce n’est pas le cas, renvoie UP.

Pour désactiver ce check, définissez check_certificate_expiration sur false.

Dépannage

Besoin d’aide ? Contactez l’assistance Datadog.

PREVIEWING: safchain/fix-custom-agent