Surveillance

Ce document décrit les techniques de surveillance des composants compatibles avec un déploiement sur site d'Apigee Edge pour le cloud privé.

Présentation

Edge propose plusieurs méthodes pour obtenir des informations sur les services et vérifier leur état. Le tableau suivant répertorie les types de vérifications que vous pouvez effectuer sur chaque service éligible:

API Mgmt
Composant Utilisation de la mémoire [JMX*] Service Check État de l'utilisateur/de l'organisation/ du déploiement axstatus Vérification de la base de données apigee-service : état apigee-monit**
Serveur de gestion
Processeur de messages
Routeur
Qpid
Postgres
En savoir plus En savoir plus En savoir plus En savoir plus En savoir plus En savoir plus En savoir plus

* Avant de pouvoir utiliser JMX, vous devez l'activer, comme décrit dans la section Activer JMX.

** Le service apigee-monit vérifie si un composant est actif et tente de le redémarrer s'il ne l'est pas. Pour en savoir plus, consultez la section Auto-réparation avec apigee-monit.

Surveiller les ports et les fichiers de configuration

Chaque composant est compatible avec les extensions de gestion Java (JMX) et les appels de surveillance de l'API de gestion sur différents ports. Le tableau suivant répertorie les ports JMX et les API de gestion pour chaque type de serveur, ainsi que les emplacements des fichiers de configuration:

Composant Port JMX Port de l'API de gestion Emplacement du fichier de configuration
Serveur de gestion 1099 8080 $APIGEE_ROOT/customer/application/management-server.properties
Processeur de messages 1101 8082 $APIGEE_ROOT/customer/application/message-processor.properties
Routeur 1100 8081 $APIGEE_ROOT/customer/application/router.properties
Qpid 1102 8083 $APIGEE_ROOT/customer/application/qpid-server.properties
Postgres 1103 8084 $APIGEE_ROOT/customer/application/postgres-server.properties

Utiliser JMX pour surveiller les composants

Les sections suivantes expliquent comment utiliser JMX pour surveiller les composants Edge.

Activer JMX

Pour activer JMX sans authentification ni communication basée sur SSL, procédez comme suit : Remarque:Dans les systèmes de production, l'authentification chiffrée et SSL doivent être activées pour des raisons de sécurité.

  1. Modifiez le fichier de configuration approprié (voir la Documentation de référence sur les fichiers de configuration). Créez le fichier de configuration s'il n'existe pas. 
    conf_system_jmxremote_enable=true
  2. Enregistrez le fichier de configuration et assurez-vous qu'il appartient à apigee:apigee.
  3. Redémarrez le composant Edge approprié. 
    apigee-service edge-management-server restart

Pour désactiver JMX, supprimez la propriété conf_system_jmxremote_enable ou remplacez sa valeur par false. Redémarrez ensuite le composant Edge approprié.

Authentification dans JMX

Edge pour Private Cloud prend en charge l'authentification par mot de passe à l'aide d'informations stockées dans des fichiers. Pour plus de sécurité, vous pouvez stocker les mots de passe sous forme de hachage.

  1. Pour activer l'authentification JMX dans un composant edge-*, modifiez le fichier de configuration approprié (voir la documentation de référence sur les fichiers de configuration). Créez le fichier de configuration s'il n'existe pas : 
    conf_system_jmxremote_enable=true
conf_system_jmxremote_authenticate=true
conf_system_jmxremote_encrypted_auth=true
conf_system_jmxremote_access_file=/opt/apigee/customer/application/management-server/jmxremote.access
conf_system_jmxremote_password_file=/opt/apigee/customer/application/management-server/jmxremote.password
    Enregistrez le fichier de configuration et assurez-vous qu'il appartient à apigee:apigee.
  2. Créez un hachage SHA256 du mot de passe : 
    echo -n '' | openssl dgst -sha256
  3. Créez un fichier jmxremote.password avec les identifiants utilisateur JMX :
    1. Copiez les fichiers suivants de votre répertoire $JAVA_HOME dans le répertoire /opt/apigee/customer/application/<component>/ : 
      cp ${JAVA_HOME}/lib/management/jmxremote.password.template $APIGEE_ROOT/customer/application/management-server/jmxremote.password
    2. Modifiez le fichier et ajoutez votre nom d'utilisateur et votre mot de passe JMX à l'aide de la syntaxe suivante : 
      USERNAME <HASH-PASSWORD>
    3. Assurez-vous que le fichier appartient à apigee et que son mode est 400 : 
      chown apigee:apigee $APIGEE_ROOT/customer/application/management-server/jmxremote.password
chmod 400 $APIGEE_ROOT/customer/application/management-server/jmxremote.password
  4. Créez un fichier jmxremote.access avec les autorisations utilisateur JMX :
    1. Copiez les fichiers suivants à partir de votre répertoire $JAVA_HOME dans le répertoire /opt/apigee/customer/application/<component>/. 
      
cp ${JAVA_HOME}/lib/management/jmxremote.access$APIGEE_ROOT/customer/application/management-server/jmxremote.password/jmxremote.access
    2. Modifiez le fichier et ajoutez votre nom d'utilisateur JMX suivi d'une autorisation (READONLY/READWRITE) 
      USERNAME READONLY
    3. Assurez-vous que le fichier appartient à apigee et que le mode de fichier est 400 : 
      chown apigee:apigee $APIGEE_ROOT/customer/application/management-server/jmxremote.password

chmod 400 $APIGEE_ROOT/customer/application/management-server/jmxremote.access
  5. Redémarrez le composant Edge approprié : 
    apigee-service edge-management-server restart

Pour désactiver l'authentification JMX, supprimez la propriété conf_system_jmxremote_authenticate ou remplacez sa valeur par false, puis redémarrez le composant Edge approprié.

SSL dans JMX

Pour activer JMX basé sur SSL dans un composant edge-* :

  1. Modifiez le fichier de configuration approprié (voir la documentation de référence sur les fichiers de configuration). Créez le fichier de configuration s'il n'existe pas : 
    conf_system_jmxremote_enable=true
conf_system_jmxremote_ssl=true
conf_system_javax_net_ssl_keystore=/opt/apigee/customer/application/management-server/jmxremote.keystore
conf_system_javax_net_ssl_keystorepassword=<keystore-password>
    Enregistrez le fichier de configuration et assurez-vous qu'il appartient à apigee:apigee.
  2. Préparez un keystore contenant la clé du serveur et placez-le dans le chemin d'accès fourni dans la configuration conf_system_javax_net_ssl_keystore ci-dessus. Assurez-vous que le fichier Keystore est lisible par apigee:apigee.
  3. Redémarrez le composant Edge approprié : 
    apigee-service edge-management-server restart

Pour désactiver JMX basé sur SSL, supprimez la propriété conf_system_jmxremote_ssl ou remplacez sa valeur par false. Redémarrez le composant Edge approprié.

Surveillance via Jconsole

Les instructions de surveillance via jconsole restent les mêmes que celles décrites sur la page https://docs.apigee.com/private-cloud/v4.52.01/how-monitor#jconsole.

Vous pouvez ajouter une ligne indiquant que "jconsole doit être démarré avec le truststore et le mot de passe du truststore si SSL est activé pour JMX". Référence: https://docs.oracle.com/javase/8/docs/technotes/guides/management/jconsole.html

Surveiller avec JConsole

Utilisez JConsole (un outil compatible avec JMX) pour gérer et surveiller la vérification de l'état et les statistiques de traitement. Avec JConsole, vous pouvez consommer les statistiques JMX exposées par vos serveurs et les afficher dans une interface graphique. Pour en savoir plus, consultez la section Utiliser JConsole.

Vous devez démarrer JConsole avec le truststore et le mot de passe du truststore si SSL est activé pour JMX. Consultez Utiliser JConsole.

JConsole utilise l'URL de service suivante pour surveiller les attributs JMX (MBeans) proposés via JMX:

service:jmx:rmi:///jndi/rmi://IP_address:port_number/jmxrmi

Où :

  • IP_address est l'adresse IP du serveur que vous souhaitez surveiller.
  • port_number correspond au numéro de port JMX du serveur que vous souhaitez surveiller.

Par exemple, pour surveiller le serveur de gestion, exécutez une commande comme celle-ci (en supposant que l'adresse IP du serveur est 216.3.128.12):

service:jmx:rmi:///jndi/rmi://216.3.128.12:1099/jmxrmi

Notez que cet exemple spécifie le port 1099, qui est le port JMX du serveur de gestion. Pour les autres ports, consultez la section Ports de surveillance JMX et API de gestion.

Le tableau suivant présente les statistiques JMX génériques:

MBeans JMX Attributs JMX

Mémoire

HeapMemoryUsage

NonHeapMemoryUsage

Utilisation

Documentation de référence du fichier de configuration

Les sections suivantes décrivent les modifications que vous devrez peut-être apporter aux fichiers de configuration des composants Edge pour les configurations liées à JMX. Pour en savoir plus, consultez la section Surveiller les ports et les fichiers de configuration.

Configuration JMX à ajouter au fichier de configuration du composant approprié

  • Activez l'agent JMX sur le composant edge. "False" par défaut. 
    conf_system_jmxremote_enable=true

Configurations pour l'authentification par mot de passe

  • Activez l'authentification par mot de passe. "False" par défaut. 
    conf_system_jmxremote_authenticate=true
  • Chemin d'accès au fichier. Doit être détenu et lisible par l'utilisateur Apigee uniquement. 
    conf_system_jmxremote_access_file=/opt/apigee/customer/application/management-server/jmxremote.access
  • Chemin d'accès au fichier de mot de passe. Doit être détenu et lisible par l'utilisateur Apigee uniquement. 
    conf_system_jmxremote_password_file=/opt/apigee/customer/application/management-server/jmxremote.password
  • Activez le stockage du mot de passe au format chiffré. "False" par défaut. 
    conf_system_jmxremote_encrypted_auth=true

Configurations pour JMX basé sur SSL

  • Activez SSL pour la communication JMX. "False" par défaut. 
    conf_system_jmxremote_ssl=true
  • Chemin d'accès au keystore. Doit être détenu et lisible par l'utilisateur Apigee uniquement. 
    conf_system_javax_net_ssl_keystore=/opt/apigee/customer/application/management-server/jmxremote.keystore
  • Mot de passe du keystore : 
    conf_system_javax_net_ssl_keystorepassword=changeme

Configurations JMX facultatives

Les valeurs indiquées sont des valeurs par défaut et peuvent être modifiées.

  • Port JMX. Les valeurs par défaut sont indiquées dans le tableau ci-dessous. 
    conf_system_jmxremote_port=
  • Port RMI JMX. Par défaut, le processus Java sélectionne un port aléatoire. 
    conf_system_jmxremote_rmi_port=
  • Nom d'hôte des bouchons distants. Adresse IP par défaut de localhost. 
    conf_system_java_rmi_server_hostname=
  • Protégez le registre JMX avec SSL. Valeur par défaut : "false". Ne s'applique que si SSL est activé. 
    conf_system_jmxremote_registry_ssl=false

Surveiller avec l'API de gestion

Edge inclut plusieurs API que vous pouvez utiliser pour effectuer des vérifications de service sur vos serveurs, ainsi que pour vérifier vos utilisateurs, vos organisations et vos déploiements. Cette section décrit ces API.

Effectuer des vérifications du service

L'API de gestion fournit plusieurs points de terminaison pour surveiller et diagnostiquer les problèmes liés à vos services. Ces points de terminaison incluent les éléments suivants:

Point de terminaison Description
/servers/self/up

Vérifie si un service est en cours d'exécution. Aucune authentification n'est requise pour cet appel d'API.

Si le service est en cours d'exécution, ce point de terminaison renvoie la réponse suivante:

<ServerField>
  <Up>true</Up>
</ServerField>

Si le service n'est pas en cours d'exécution, vous recevrez une réponse semblable à la suivante (selon le service et la méthode de vérification):

curl: Failed connect to localhost:port_number; Connection refused
/servers/self

Renvoie des informations sur le service, y compris:

  • Propriétés de configuration
  • Heure de début et temps de disponibilité
  • Informations sur la compilation, l'RPM et l'UUID
  • Nom d'hôte et adresse IP internes et externes
  • Région et pod
  • Propriété <isUp>, qui indique si le service est en cours d'exécution

Cet appel d'API nécessite que vous vous authentifiiez à l'aide de vos identifiants d'administrateur Apigee.

Pour utiliser ces points de terminaison, appelez un utilitaire tel que curl avec des commandes qui utilisent la syntaxe suivante:

curl http://host:port_number/v1/servers/self/up -H "Accept: [application/json|application/xml]"
curl http://host:port_number/v1/servers/self -u username:password -H "Accept: [application/json|application/xml]"

Où :

  • host correspond à l'adresse IP du serveur que vous souhaitez vérifier. Si vous êtes connecté au serveur, vous pouvez utiliser "localhost". Sinon, spécifiez l'adresse IP du serveur, ainsi que le nom d'utilisateur et le mot de passe.
  • port_number est le port de l'API Management du serveur que vous souhaitez vérifier. Il s'agit d'un port différent pour chaque type de composant. Par exemple, le port de l'API de gestion du serveur de gestion est 8080. Pour obtenir la liste des numéros de port de l'API Management à utiliser, consultez la section Ports de surveillance JMX et de l'API Management.

Pour modifier le format de la réponse, vous pouvez spécifier l'en-tête Accept comme "application/json" ou "application/xml".

L'exemple suivant obtient l'état du routeur sur localhost (port 8081):

curl http://localhost:8081/v1/servers/self/up -H "Accept: application/xml"

L'exemple suivant permet d'obtenir des informations sur le processeur de messages sur l'adresse 216.3.128.12 (port 8082):

curl http://216.3.128.12:8082/v1/servers/self -u sysAdminEmail:password
  -H "Accept: application/xml"

Surveiller l'état des utilisateurs, de l'organisation et du déploiement

Vous pouvez utiliser l'API Management pour surveiller l'état de l'utilisateur, de l'organisation et du déploiement de vos proxys sur les serveurs de gestion et les processeurs de messages en exécutant les commandes suivantes:

curl http://host:port_number/v1/users -u sysAdminEmail:password
curl http://host:port_number/v1/organizations -u sysAdminEmail:password
curl http://host:port_number/v1/organizations/orgname/deployments -u sysAdminEmail:password

où port_number est 8080 pour le serveur de gestion ou 8082 pour le processeur de messages.

Cet appel nécessite votre authentification avec votre nom d'utilisateur et votre mot de passe d'administrateur système.

Le serveur doit renvoyer un état "déployé" pour tous les appels. Si ces étapes ne fonctionnent pas, procédez comme suit:

  1. Recherchez d'éventuelles erreurs dans les journaux du serveur. Les journaux se trouvent à l'emplacement suivant :
    • Serveur de gestion: opt/apigee/var/log/edge-management-server
    • Processeur de messages: opt/apigee/var/log/edge-message-processor
  2. Appelez le serveur pour vérifier qu'il fonctionne correctement.
  3. Supprimez le serveur de l'ELB, puis redémarrez-le : 
    /opt/apigee/apigee-service/bin/apigee-service service_name restart

    Où service_name correspond à :

    • edge-management-server
    • edge-message-processor

Vérifier l'état à l'aide de la commande apigee-service

Vous pouvez résoudre les problèmes de vos services Edge à l'aide de la commande apigee-service lorsque vous êtes connecté au serveur exécutant le service.

Pour vérifier l'état d'un service avec apigee-service:

  1. Connectez-vous au serveur et exécutez la commande suivante : 
    /opt/apigee/apigee-service/bin/apigee-service service_name status

    où service_name est l'un des éléments suivants :

    • Serveur de gestion: edge-management-server
    • Processeur de messages: edge-message-processor
    • Postgres: edge-postgres-server
    • Qpid: edge-qpid-server
    • Routeur : edge-router

    Exemple :

    /opt/apigee/apigee-service/bin/apigee-service edge-message-processor status
  2. Si le service n'est pas en cours d'exécution, démarrez-le : 
    /opt/apigee/apigee-service/bin/apigee-service service_name start
  3. Après avoir redémarré le service, vérifiez qu'il fonctionne, soit à l'aide de la commande apigee-service status que vous avez utilisée précédemment, soit à l'aide de l'API Management décrite dans la section Surveiller avec l'API Management.

    Exemple :

    curl -v http://localhost:port_number/v1/servers/self/up

    où port_number est le port de l'API de gestion du service.

    Cet exemple suppose que vous êtes connecté au serveur et que vous pouvez utiliser "localhost" comme nom d'hôte. Pour vérifier l'état à distance avec l'API de gestion, vous devez spécifier l'adresse IP du serveur et inclure le nom d'utilisateur et le mot de passe de l'administrateur système dans votre appel d'API.

Surveillance de Postgres

Postgres est compatible avec plusieurs utilitaires que vous pouvez utiliser pour vérifier son état. Ces utilitaires sont décrits dans les sections suivantes.

Vérifier les organisations et les environnements sur Postgres

Vous pouvez vérifier les noms d'organisation et d'environnement intégrés au serveur Postgres en exécutant la commande curl suivante:

curl -v http://postgres_IP:8084/v1/servers/self/organizations

Le système doit afficher le nom de l'organisation et de l'environnement.

Vérifier l'état des données analytiques

Vous pouvez vérifier l'état des serveurs d'analyse Postgres et Qpid en exécutant la commande curl suivante:

curl -u userEmail:password http://host:port_number/v1/organizations/orgname/environments/envname/provisioning/axstatus

Le système doit afficher un état de réussite pour tous les serveurs d'analyse, comme illustré dans l'exemple suivant:

{
  "environments" : [ {
    "components" : [ {
      "message" : "success at Thu Feb 28 10:27:38 CET 2013",
      "name" : "pg",
      "status" : "SUCCESS",
      "uuid" : "[c678d16c-7990-4a5a-ae19-a99f925fcb93]"
     }, {
      "message" : "success at Thu Feb 28 10:29:03 CET 2013",
      "name" : "qs",
      "status" : "SUCCESS",
      "uuid" : "[ee9f0db7-a9d3-4d21-96c5-1a15b0bf0adf]"
     } ],
    "message" : "",
    "name" : "prod"
   } ],
  "organization" : "acme",
  "status" : "SUCCESS"
}

Base de données PostgreSQL

Cette section décrit les techniques que vous pouvez utiliser spécifiquement pour surveiller la base de données PostgreSQL.

Utiliser le script check_postgres.pl

Pour surveiller la base de données PostgreSQL, vous pouvez utiliser un script de surveillance standard, check_postgres.pl. Pour en savoir plus, consultez la page http://bucardo.org/wiki/Check_postgres.

Avant d'exécuter le script:

  1. Vous devez installer le script check_postgres.pl sur chaque nœud Postgres.
  2. Assurez-vous d'avoir installé perl-Time-HiRes.x86_64, un module Perl qui implémente des alarmes, des délais de sommeil, des gettimeofday et des minuteurs d'intervalle haute résolution. Par exemple, vous pouvez l'installer à l'aide de la commande suivante:
    yum install perl-Time-HiRes.x86_64
  3. CentOS 7: avant d'utiliser check_postgres.pl sur CentOS 7, installez le RPM perl-Data-Dumper.x86_64.

Sortie de check_postgres.pl

La sortie par défaut des appels d'API à l'aide de check_postgres.pl est compatible avec Nagios. Après avoir installé le script, effectuez les vérifications suivantes:

  1. Vérifiez la taille de la base de données : 
    check_postgres.pl -H 10.176.218.202 -db apigee -u apigee -dbpass postgres -include=apigee -action database_size --warning='800 GB' --critical='900 GB'
  2. Vérifiez le nombre de connexions entrantes à la base de données et comparez-le au nombre maximal de connexions autorisées : 
    check_postgres.pl -H 10.176.218.202 -db apigee -u apigee -dbpass postgres -action backends
  3. Vérifiez si la base de données est en cours d'exécution et disponible : 
    check_postgres.pl -H 10.176.218.202 -db apigee -u apigee -dbpass postgres -action connection
  4. Vérifiez l'espace disque : 
    check_postgres.pl -H 10.176.218.202 -db apigee -u apigee -dbpass postgres -action disk_space --warning='80%' --critical='90%'
  5. Vérifiez le nombre d'organisations et d'environnements intégrés dans un nœud Postgres : 
    check_postgres.pl -H 10.176.218.202 -db apigee -u apigee -dbpass postgres -action=custom_query --query="select count(*) as result from pg_tables where schemaname='analytics' and tablename like '%fact'" --warning='80' --critical='90' --valtype=integer

Exécuter des vérifications de base de données

Vous pouvez vérifier que les tables appropriées sont créées dans la base de données PostgreSQL. Connectez-vous à la base de données PostgreSQL à l'aide de la commande suivante:

psql -h /opt/apigee/var/run/apigee-postgresql/ -U apigee -d apigee

Exécutez ensuite la commande ci-dessous :

\d analytics."org.env.fact"

Vérifier l'état de santé du processus postgres

Vous pouvez effectuer des vérifications de l'API sur la machine Postgres en appelant la commande curl suivante:

curl -v http://postgres_IP:8084/v1/servers/self/health

Cette commande renvoie l'état ACTIVE lorsque le processus postgres est actif. Si le processus Postgres n'est pas opérationnel, il renvoie l'état INACTIVE.

Ressources Postgres

Pour en savoir plus sur la surveillance du service Postgres, consultez les ressources suivantes:

Apache Cassandra

JMX est activé par défaut pour Cassandra, et l'accès JMX à distance à Cassandra ne nécessite pas de mot de passe.

Activer l'authentification JMX pour Cassandra

Vous pouvez activer l'authentification JMX pour Cassandra. Vous devrez ensuite transmettre un nom d'utilisateur et un mot de passe à tous les appels de l'utilitaire nodetool.

Pour activer l'authentification JMX pour Cassandra:

  1. Créez et modifiez le fichier cassandra.properties :
    1. Modifiez le fichier /opt/apigee/customer/application/cassandra.properties. Si le fichier n'existe pas, créez-le.
    2. Ajoutez ce qui suit au fichier : 
      conf_cassandra_env_com.sun.management.jmxremote.authenticate=true
conf_cassandra_env_com.sun.management.jmxremote.password.file=${APIGEE_ROOT}/customer/application/apigee-cassandra/jmxremote.password
conf_cassandra_env_com.sun.management.jmxremote.access.file=${APIGEE_ROOT}/customer/application/apigee-cassandra/jmxremote.access
    3. Enregistrez le fichier cassandra.properties.
    4. Remplacez le propriétaire du fichier par apigee:apigee, comme illustré dans l'exemple suivant : 
      chown apigee:apigee /opt/apigee/customer/application/cassandra.properties

    Pour en savoir plus sur l'utilisation de fichiers de propriétés pour définir des jetons, consultez la section Configurer Edge.

  2. Créer et modifier des jmx_auth.sh :
    1. Si le fichier n'existe pas, créez-le à l'emplacement suivant : 
      /opt/apigee/customer/application/jmx_auth.sh
    2. Ajoutez les propriétés suivantes au fichier : 
      export CASS_JMX_USERNAME=JMX_USERNAME
export CASS_JMX_PASSWORD=JMX_PASSWORD
    3. Enregistrez le fichier jmx_auth.sh.
    4. Sourcez le fichier : 
      source /opt/apigee/customer/application/jmx_auth.sh
  3. Copiez et modifiez le fichier jmxremote.password :
    1. Copiez le fichier suivant de votre répertoire $JAVA_HOME dans /opt/apigee/customer/application/apigee-cassandra/ : 
      cp ${JAVA_HOME}/lib/management/jmxremote.password.template $APIGEE_ROOT/customer/application/apigee-cassandra/jmxremote.password
    2. Modifiez le fichier jmxremote.password et ajoutez votre nom d'utilisateur et votre mot de passe JMX à l'aide de la syntaxe suivante : 
      JMX_USERNAME JMX_PASSWORD

      Où JMX_USERNAME et JMX_PASSWORD sont le nom d'utilisateur et le mot de passe JMX que vous avez définis précédemment.

    3. Assurez-vous que le fichier appartient à "apigee" et que le mode de fichier est 400 : 
      chown apigee:apigee /opt/apigee/customer/application/apigee-cassandra/jmxremote.password
chmod 400 /opt/apigee/customer/application/apigee-cassandra/jmxremote.password
  4. Copiez et modifiez le fichier jmxremote.access :
    1. Copiez le fichier suivant de votre répertoire $JAVA_HOME dans /opt/apigee/customer/application/apigee-cassandra/ : 
      cp ${JAVA_HOME}/lib/management/jmxremote.access
$APIGEE_ROOT/customer/application/apigee-cassandra/jmxremote.access
    2. Modifiez le fichier jmxremote.access et ajoutez le rôle suivant : 
      JMX_USERNAME readwrite
    3. Assurez-vous que le fichier appartient à "apigee" et que le mode de fichier est 400 : 
      chown apigee:apigee /opt/apigee/customer/application/apigee-cassandra/jmxremote.access
chmod 400 /opt/apigee/customer/application/apigee-cassandra/jmxremote.access
  5. Exécutez configure sur Cassandra : 
    /opt/apigee/apigee-service/bin/apigee-service apigee-cassandra configure
  6. Redémarrez Cassandra : 
    /opt/apigee/apigee-service/bin/apigee-service apigee-cassandra restart
  7. Répétez cette procédure sur tous les autres nœuds Cassandra.

Activer le chiffrement des mots de passe JMX

Pour activer le chiffrement des mots de passe JMX, procédez comme suit:

  1. Ouvrez le fichier source/conf/casssandra-env.sh.
  2. Créez et modifiez le fichier cassandra.properties :
    1. Modifiez le fichier /opt/apigee/customer/application/cassandra.properties. Si le fichier n'existe pas, créez-le.
    2. Ajoutez ce qui suit au fichier : 
      conf_cassandra_env_com.sun.management.jmxremote.encrypted.authenticate=true
    3. Enregistrez le fichier cassandra.properties.
    4. Remplacez le propriétaire du fichier par apigee:apigee, comme illustré dans l'exemple suivant : 
      chown apigee:apigee /opt/apigee/customer/application/cassandra.properties
  3. Dans la ligne de commande, générez un ou plusieurs hachages SHA1 du ou des mots de passe souhaités en saisissant : echo -n 'Secret' | openssl dgst -sha1
  4. Définissez le ou les mots de passe pour le nom d'utilisateur dans $APIGEE_ROOT/customer/application/apigee-cassandra/jmxremote.password (créé dans la section précédente).
  5. Exécutez configure sur Cassandra : 
    /opt/apigee/apigee-service/bin/apigee-service apigee-cassandra configure
  6. Redémarrez Cassandra : 
    /opt/apigee/apigee-service/bin/apigee-service apigee-cassandra restart
  7. Répétez cette procédure sur tous les autres nœuds Cassandra.

Activer JMX avec SSL pour Cassandra

L'activation de JMX avec SSL offre une sécurité et un chiffrement supplémentaires pour la communication basée sur JMX avec Cassandra. Pour activer JMX avec SSL, vous devez fournir une clé et un certificat à Cassandra pour qu'il accepte les connexions JMX basées sur SSL. Vous devez également configurer nodetool (et tous les autres outils qui communiquent avec Cassandra via JMX) pour SSL.

JMX compatible avec SSL accepte à la fois les mots de passe JMX en texte brut et chiffrés.

Pour activer JMX avec SSL pour Cassandra, procédez comme suit:

  1. Activez JMX. Activez le chiffrement du mot de passe si nécessaire.
  2. Activez l'authentification JMX pour Cassandra. comme décrit ci-dessus. Assurez-vous que nodetool fonctionne avec le nom d'utilisateur et le mot de passe configurés. 
    /opt/apigee/apigee-cassandra/bin/nodetool -u <JMX_USER> -pw <JMX_PASS> ring

  3. Préparez le keystore et le truststore.

    • Le keystore doit contenir une clé et un certificat, et est utilisé pour configurer le serveur Cassandra. Si le keystore contient plusieurs paires de clés, Cassandra utilise la première paire de clés pour activer SSL.

      Notez que les mots de passe du keystore et de la clé doivent être identiques (par défaut lorsque vous générez la clé à l'aide de keytool).

    • Le truststore ne doit contenir que le certificat et est utilisé par les clients (commandes basées sur le service Apigee ou nodetool) pour se connecter via JMX.

    Une fois que vous avez vérifié les conditions ci-dessus:

    1. Placez le fichier keystore dans /opt/apigee/customer/application/apigee-cassandra/.
    2. Assurez-vous que le fichier Keystore n'est lisible que par l'utilisateur Apigee en saisissant 
      chown apigee:apigee /opt/apigee/customer/application/apigee-cassandra/keystore.node1
chmod 400 /opt/apigee/customer/application/apigee-cassandra/keystore.node1
      .
  4. Pour configurer Cassandra pour JMX avec SSL, procédez comme suit :
    1. Arrêtez le nœud Cassandra en saisissant 
      apigee-service apigee-cassandra stop
      .
    2. Activez SSL dans Cassandra en ouvrant le fichier /opt/apigee/customer/application/cassandra.properties et en ajoutant les lignes suivantes : 
      conf_cassandra_env_com.sun.management.jmxremote.ssl=true
conf_cassandra_env_javax.net.ssl.keyStore=/opt/apigee/customer/application/apigee-cassandra/keystore.node1
conf_cassandra_env_javax.net.ssl.keyStorePassword=keystore-password
    3. Remplacez le propriétaire du fichier par apigee:apigee, comme illustré dans l'exemple suivant : 
      chown apigee:apigee /opt/apigee/customer/application/cassandra.properties
    4. Exécutez configure sur Cassandra : 
      /opt/apigee/apigee-service/bin/apigee-service apigee-cassandra configure
    5. Redémarrez Cassandra : 
      /opt/apigee/apigee-service/bin/apigee-service apigee-cassandra restart
    6. Répétez cette procédure sur tous les autres nœuds Cassandra.
    7. Démarrez le nœud Cassandra en saisissant : 
      apigee-service apigee-cassandra start
  5. Configurez les commandes Cassandra apigee-service. Vous devez définir certaines variables d'environnement lorsque vous exécutez des commandes apigee-service, y compris les suivantes : 
    apigee-service apigee-cassandra stop
apigee-service apigee-cassandra wait_for_ready
apigee-service apigee-cassandra ring
apigee-service apigee-cassandra backup

    Plusieurs options permettent de configurer apigee-service pour l'authentification JMX et SSL. Choisissez une option en fonction de la facilité d'utilisation et de vos pratiques de sécurité.

    Option 1 (arguments SSL stockés dans un fichier)

    Définissez les variables d'environnement suivantes :

    export CASS_JMX_USERNAME=ADMIN
# Provide encrypted password here if you have setup JMX password encryption
export CASS_JMX_PASSWORD=PASSWORD
export CASS_JMX_SSL=Y

    Créez un fichier dans le répertoire d'accueil de l'utilisateur Apigee (/opt/apigee). 

    $HOME/.cassandra/nodetool-ssl.properties

    Modifiez le fichier et ajoutez les lignes suivantes:

    -Djavax.net.ssl.trustStore=<path-to-truststore.node1>
-Djavax.net.ssl.trustStorePassword=<truststore-password>
-Dcom.sun.management.jmxremote.registry.ssl=true

    Assurez-vous que le fichier trustore est lisible par l'utilisateur Apigee.

    Exécutez la commande apigee-service suivante : Si l'application s'exécute sans erreur, vos configurations sont correctes.

    apigee-service apigee-cassandra ring

    Option 2 (arguments SSL stockés dans des variables d'environnement)

    Définissez les variables d'environnement suivantes :

    export CASS_JMX_USERNAME=ADMIN
# Provide encrypted password here if you have setup JMX password encryption
export CASS_JMX_PASSWORD=PASSWORD
export CASS_JMX_SSL=Y
# Ensure the truststore file is accessible by Apigee user.
export CASS_JMX_TRUSTSTORE=<path-to-trustore.node1>
export CASS_JMX_TRUSTSTORE_PASSWORD=<truststore-password>

    Exécutez la commande apigee-service suivante : Si l'application s'exécute sans erreur, vos configurations sont correctes. 

    apigee-service apigee-cassandra ring

    Option 3 (arguments SSL transmis directement à apigee-service)

    Exécutez une commande apigee-service comme celle ci-dessous. Vous n'avez pas besoin de configurer de variables d'environnement.

    CASS_JMX_USERNAME=ADMIN CASS_JMX_PASSWORD=PASSWORD CASS_JMX_SSL=Y CASS_JMX_TRUSTSTORE=<path-to-trustore.node1> CASS_JMX_TRUSTSTORE_PASSWORD=<trustore-password> /opt/apigee/apigee-service/bin/apigee-service apigee-cassandra ring

  6. Configurez nodetool. Nodetool nécessite que des paramètres JMX lui soient transmis. Vous pouvez configurer nodetool pour qu'il s'exécute avec JMX compatible avec SSL de deux manières, comme décrit dans les options de configuration ci-dessous:

    Les options diffèrent dans la manière dont les configurations liées au protocole SSL sont transmises à nodetool. Dans les deux cas, l'utilisateur qui exécute nodetool doit disposer d'autorisations de lecture sur le fichier truststore. Choisissez une option appropriée en fonction de la facilité d'utilisation et de vos pratiques de sécurité.

    Pour en savoir plus sur les paramètres nodetool, consultez la documentation DataStax.

    Option de configuration 1

    Créez un fichier dans le répertoire d'accueil de l'utilisateur qui exécute nodetool.

    $HOME/.cassandra/nodetool-ssl.properties

    Ajoutez les lignes suivantes au fichier :

    -Djavax.net.ssl.trustStore=<path-to-truststore.node1>
-Djavax.net.ssl.trustStorePassword=<truststore-password>
-Dcom.sun.management.jmxremote.registry.ssl=true

    Le chemin d'accès au truststore spécifié ci-dessus doit être accessible à tous les utilisateurs exécutant nodetool.

    Exécutez nodetool avec l'option --ssl.

    /opt/apigee/apigee-cassandra/bin/nodetool --ssl -u <jmx-user-name> -pw <jmx-user-password> -h localhost ring

    Option de configuration 2

    Exécutez nodetool en tant que commande unique avec les paramètres supplémentaires listés ci-dessous.

    /opt/apigee/apigee-cassandra/bin/nodetool -Djavax.net.ssl.trustStore=<path-to-truststore.node1> -Djavax.net.ssl.trustStorePassword=<truststore-password> -Dcom.sun.management.jmxremote.registry.ssl=true -Dssl.enable=true -u <jmx-user-name> -pw <jmx-user-password> -h localhost ring

Annuler les configurations SSL

Si vous devez rétablir les configurations SSL décrites dans la procédure ci-dessus, procédez comme suit:

  1. Arrêter apigee-cassandra en saisissant 
    apigee-service apigee-cassandra stop
  2. Supprimez la ligne conf_cassandra-env_com.sun.management.jmxremote.ssl=true du fichier /opt/apigee/customer/application/cassandra.properties.
  3. Commentez les lignes suivantes dans /opt/apigee/apigee-cassandra/source/conf/cassandra-env.sh 
    # JVM_OPTS="$JVM_OPTS -Djavax.net.ssl.keyStore=/opt/apigee/data/apigee-cassandra/keystore.node0"
# JVM_OPTS="$JVM_OPTS -Djavax.net.ssl.keyStorePassword=keypass"
# JVM_OPTS="$JVM_OPTS -Dcom.sun.management.jmxremote.registry.ssl=true”
  4. Démarrez apigee-cassandra en saisissant
    5. apigee-service apigee-cassandra start
  5. Supprimez la variable d'environnement CASS_JMX_SSL si elle a été définie.

    unset CASS_JMX_SSL
  6. Vérifiez que les commandes basées sur apigee-service, comme ring, stop, backup, etc., fonctionnent.
  7. Arrêter d'utiliser le commutateur --ssl avec nodetool

Désactiver l'authentification JMX pour Cassandra

Pour désactiver l'authentification JMX pour Cassandra:

  1. Modifier /opt/apigee/customer/application/cassandra.properties.
  2. Supprimez la ligne suivante dans le fichier : 
    conf_cassandra-env_com.sun.management.jmxremote.authenticate=true
  3. Exécutez configure sur Cassandra : 
    /opt/apigee/apigee-service/bin/apigee-service apigee-cassandra configure
  4. Redémarrez Cassandra : 
    /opt/apigee/apigee-service/bin/apigee-service apigee-cassandra restart
  5. Répétez cette procédure sur tous les autres nœuds Cassandra.

Utiliser JConsole: surveiller les statistiques des tâches

Utilisez JConsole et l'URL de service suivante pour surveiller les attributs JMX (MBeans) proposés via JMX:

service:jmx:rmi:///jndi/rmi://IP_address:7199/jmxrmi

Où IP_address correspond à l'adresse IP du serveur Cassandra.

Statistiques JMX Cassandra

MBeans JMX Attributs JMX

ColumnFamilies/apprepo/environments

ColumnFamilies/apprepo/organizations

ColumnFamilies/apprepo/apiproxy_revisions

ColumnFamilies/apprepo/apiproxies

ColumnFamilies/audit/audits

ColumnFamilies/audit/audits_ref

PendingTasks

MemtableColumnsCount

MemtableDataSize

ReadCount

RecentReadLatencyMicros

TotalReadLatencyMicros

WriteCount

RecentWriteLatencyMicros

TotalWriteLatencyMicros

TotalDiskSpaceUsed

LiveDiskSpaceUsed

LiveSSTableCount

BloomFilterFalsePositives

RecentBloomFilterFalseRatio

BloomFilterFalseRatio

Utiliser nodetool pour gérer les nœuds de cluster

L'utilitaire nodetool est une interface de ligne de commande pour Cassandra qui gère les nœuds de cluster. L'utilitaire se trouve à l'emplacement /opt/apigee/apigee-cassandra/bin.

Les appels suivants peuvent être effectués sur tous les nœuds du cluster Cassandra:

  1. Informations générales sur l'anneau (également possible pour un seul nœud Cassandra): recherchez les états "Up" (Actif) et "Normal" (Normal) pour tous les nœuds. 
    nodetool [-u username -pw password] -h localhost ring

    Vous n'avez besoin de transmettre votre nom d'utilisateur et votre mot de passe que si vous avez activé l'authentification JMX pour Cassandra.

    Le résultat de la commande ci-dessus se présente comme suit : 

    Datacenter: dc-1
==========
Address            Rack     Status State   Load    Owns    Token
192.168.124.201    ra1      Up     Normal  1.67 MB 33,33%  0
192.168.124.202    ra1      Up     Normal  1.68 MB 33,33%  5671...5242
192.168.124.203    ra1      Up     Normal  1.67 MB 33,33%  1134...0484

  2. Informations générales sur les nœuds (appel par nœud) 
    nodetool [-u username -pw password]  -h localhost info

    Le résultat de la commande ci-dessus se présente comme suit:

    ID                     : e2e42793-4242-4e82-bcf0-oicu812
Gossip active          : true
Thrift active          : true
Native Transport active: true
Load                   : 273.71 KB
Generation No          : 1234567890
Uptime (seconds)       : 687194
Heap Memory (MB)       : 314.62 / 3680.00
Off Heap Memory (MB)   : 0.14
Data Center            : dc-1
Rack                   : ra-1
Exceptions             : 0
Key Cache              : entries 150, size 13.52 KB, capacity 100 MB, 1520781 hits, 1520923 requests, 1.000 recent hit rate, 14400 save period in seconds
Row Cache              : entries 0, size 0 bytes, capacity 0 bytes, 0 hits, 0 requests, NaN recent hit rate, 0 save period in seconds
Counter Cache          : entries 0, size 0 bytes, capacity 50 MB, 0 hits, 0 requests, NaN recent hit rate, 7200 save period in seconds
Token                  : 0
  3. État du serveur Thrift (serveur de l'API cliente) 
    nodetool [-u username -pw password] -h localhost statusthrift

    Le résultat de la commande ci-dessus se présente comme suit:

    running

  4. État des opérations de streaming de données: observez le trafic des nœuds Cassandra : 
    nodetool [-u username -pw password] -h localhost netstats

    Le résultat de la commande ci-dessus se présente comme suit:

    Mode: NORMAL
Not sending any streams.
Read Repair Statistics:
Attempted: 151612
Mismatch (Blocking): 0
Mismatch (Background): 0
Pool Name                    Active   Pending      Completed   Dropped
Commands                        n/a         0              0         0
Responses                       n/a         0              0       n/a

Pour en savoir plus sur nodetool, consultez la section À propos de l'utilitaire nodetool.

Ressource Cassandra

Consultez l'URL suivante: http://www.datastax.com/docs/1.0/operations/monitoring.

Surveiller Apache Qpid Broker-J

Vous pouvez surveiller Qpid Broker-J à partir de la console de gestion Qpid. Cette section explique comment accéder à la console et l'utiliser pour effectuer des fonctions de surveillance de base. Pour en savoir plus sur l'utilisation de la console de gestion, consultez la section Console de gestion Web dans la documentation Apache Qpid.

Accéder à la console de gestion

Le port par défaut de la console de gestion est 8090. Pour accéder à la console sur ce port par défaut, pointez votre navigateur Web vers:

http://QPID_NODE_IP:8090

Pour vous connecter à la console, utilisez les identifiants par défaut définis par Apigee ou ceux définis dans le fichier de configuration Edge. Pour en savoir plus, consultez la documentation de référence sur le fichier de configuration Edge.

Surveiller les files d'attente et les messages

Dans le panneau de navigation de gauche, accédez à Java-Broker > virtualhosts > queues (Java-Broker > virtualhosts > queues). Sélectionnez une file d'attente pour en afficher les détails dans la partie principale de l'interface utilisateur. Dans la vue détaillée, vous pouvez consulter les attributs et les statistiques de la file d'attente, y compris des informations sur les messages distribués, mis en file d'attente, les taux de messages, etc.

Afficher et télécharger des fichiers journaux

Dans le panneau de navigation de gauche, accédez à Java-Broker > brokerloggers > logfile. Dans la vue d'informations principale de l'UI, vous pouvez consulter les détails des fichiers journaux et les télécharger.

Utiliser l'API de gestion Qpid

Vous pouvez utiliser l'API REST Apache Qpid Broker-J pour automatiser les tâches de gestion et surveiller le broker. Pour en savoir plus, consultez la documentation de l'API REST Apache Qpid Broker.

Vous pouvez également utiliser des outils de ligne de commande pour surveiller le courtier. Exemple :

curl "QPID_NODE_IP":"8090"/api/latest/broker -u "USERNAME":"PASSWORD"

Apache ZooKeeper

Vérifier l'état de ZooKeeper

  1. Assurez-vous que le processus ZooKeeper est en cours d'exécution. ZooKeeper écrit un fichier PID dans opt/apigee/var/run/apigee-zookeeper/apigee-zookeeper.pid.
  2. Testez les ports ZooKeeper pour vous assurer que vous pouvez établir une connexion TCP aux ports 2181 et 3888 sur chaque serveur ZooKeeper.
  3. Assurez-vous de pouvoir lire les valeurs de la base de données ZooKeeper. Connectez-vous à l'aide d'une bibliothèque cliente ZooKeeper (ou /opt/apigee/apigee-zookeeper/bin/zkCli.sh) et lisez une valeur dans la base de données.
  4. Vérifiez l'état : 
    /opt/apigee/apigee-service/bin/apigee-service apigee-zookeeper status

Utiliser des mots de quatre lettres ZooKeeper

ZooKeeper peut être surveillé via un petit ensemble de commandes (mots de quatre lettres) envoyées au port 2181 à l'aide de netcat (nc) ou de telnet.

Pour en savoir plus sur les commandes ZooKeeper, consultez la documentation de référence sur les commandes Apache ZooKeeper.

Exemple :

  • srvr: liste les informations complètes sur le serveur.
  • stat: liste des informations succinctes sur le serveur et les clients connectés.

Vous pouvez envoyer les commandes suivantes au port ZooKeeper:

  1. Exécutez la commande ruok à quatre lettres pour vérifier si le serveur s'exécute dans un état sans erreur. Une réponse réussie renvoie "imok". 
    echo ruok | nc host 2181

    Renvoie :

    imok
  2. Exécutez la commande à quatre lettres, stat, pour afficher les performances du serveur et les statistiques sur les clients connectés : 
    echo stat | nc host 2181

    Renvoie :

    Zookeeper version: 3.4.5-1392090, built on 09/30/2012 17:52 GMT
Clients:
/0:0:0:0:0:0:0:1:33467[0](queued=0,recved=1,sent=0)
/192.168.124.201:42388[1](queued=0,recved=8433,sent=8433)
/192.168.124.202:42185[1](queued=0,recved=1339,sent=1347)
/192.168.124.204:39296[1](queued=0,recved=7688,sent=7692)
Latency min/avg/max: 0/0/128
Received: 26144
Sent: 26160
Connections: 4
Outstanding: 0
Zxid: 0x2000002c2
Mode: follower
Node count: 283
  3. Si netcat (nc) n'est pas disponible, vous pouvez utiliser Python à la place. Créez un fichier nommé zookeeper.py contenant les éléments suivants : 
    import time, socket,
sys c = socket.socket(socket.AF_INET, socket.SOCK_STREAM)
c.connect((sys.argv[1], 2181))
c.send(sys.argv[2])
time.sleep(0.1)
print c.recv(512)

    Exécutez maintenant les lignes Python suivantes:

    python zookeeper.py 192.168.124.201 ruok
python zookeeper.py 192.168.124.201 stat

Test au niveau LDAP

Vous pouvez surveiller OpenLDAP pour voir si les requêtes spécifiques sont correctement traitées. En d'autres termes, recherchez une recherche spécifique qui renvoie le résultat approprié.

  1. Utilisez ldapsearch (yum install openldap-clients) pour interroger l'entrée de l'administrateur système. Cette entrée permet d'authentifier tous les appels d'API. 
    ldapsearch -b "uid=admin,ou=users,ou=global,dc=apigee,dc=com" -x -W -D "cn=manager,dc=apigee,dc=com" -H ldap://localhost:10389 -LLL

    Vous êtes alors invité à saisir le mot de passe administrateur LDAP:

    Enter LDAP Password:

    Une fois le mot de passe saisi, une réponse au format suivant s'affiche:

    dn:
uid=admin,ou=users,ou=global,dc=apigee,dc=com
objectClass: organizationalPerson
objectClass: person
objectClass: inetOrgPerson
objectClass: top
uid: admin
cn: admin
sn: admin
userPassword:: e1NTSEF9bS9xbS9RbVNXSFFtUWVsU1F0c3BGL3BQMkhObFp2eDFKUytmZVE9PQ=
 =
mail: opdk@google.com
  2. Vérifiez si le serveur de gestion est toujours connecté à LDAP à l'aide de la commande suivante : 
    curl -u userEMail:password http://localhost:8080/v1/users/ADMIN

    Renvoie :

    {
  "emailId" : ADMIN,
  "firstName" : "admin",
  "lastName" : "admin"
}

Vous pouvez également surveiller les caches OpenLDAP, qui permettent de réduire le nombre d'accès au disque et donc d'améliorer les performances du système. Surveiller, puis ajuster la taille du cache dans le serveur OpenLDAP peut avoir un impact important sur les performances du serveur d'annuaire. Vous pouvez afficher les fichiers journaux (opt/apigee/var/log) pour obtenir des informations sur le cache.