Intégration Elasticsearch

Remarque :

Contactez CAS-PM-Ext@cloud.com pour demander de l’aide concernant l’intégration d’Elasticsearch, l’exportation de données vers Elasticsearch ou pour nous faire part de vos commentaires.

Vous pouvez intégrer Citrix Analytics for Performance à Elasticsearch à l’aide du moteur Logstash. Cette intégration vous permet d’exporter et de corréler les données des utilisateurs de votre environnement informatique Citrix vers Elasticsearch et d’obtenir des informations plus approfondies sur le niveau de sécurité de votre organisation.

Pour plus d’informations sur les avantages de l’intégration et le type de données traitées qui sont envoyées à votre plateforme Observability, consultez la section Exportation de données.

Pré-requis

• Activez le traitement des données pour au moins une source de données. Cela permet à Citrix Analytics for Performance de démarrer le processus d’intégration d’Elasticsearch.

• Assurez-vous que le point de terminaison suivant figure dans la liste d’autorisation de votre réseau.

  Point de terminaison	Région des États-Unis	Région de l’Union européenne	Région Asie-Pacifique Sud
  Brokers Kafka	casnb-0.citrix.com:9094	casnb-eu-0.citrix.com:9094	casnb-aps-0.citrix.com:9094
  	casnb-1.citrix.com:9094	casnb-eu-1.citrix.com:9094	casnb-aps-1.citrix.com:9094
  	casnb-2.citrix.com:9094	casnb-eu-2.citrix.com:9094	casnb-aps-2.citrix.com:9094
  	casnb-3.citrix.com:9094

Intégration à Elasticsearch

1. Accédez à Paramètres > Exportations de données.

2. Dans la section Configuration du compte, créez un compte en spécifiant le nom d’utilisateur et le mot de passe. Ce compte est utilisé pour préparer un fichier de configuration, qui est nécessaire à l’intégration.

   

3. Assurez-vous que le mot de passe répond aux conditions suivantes :

   

4. Cliquez sur Configurer pour générer le fichier de configuration Logstash.

   

5. Sélectionnez l’onglet Elastic Search dans la section Observability Platform pour télécharger les fichiers de configuration :

   • Fichier de configuration Logstash : contient les données de configuration (sections d’entrée, de filtre et de sortie) pour envoyer des événements de Citrix Analytics for Performance à Elasticsearch à l’aide du moteur de collecte de données Logstash. Pour plus d’informations sur la structure du fichier de configuration de Logstash, consultez la documentation Logstash.

   • Fichier JKS : inclut les certificats requis pour la connexion SSL.

     Remarque

     Ces fichiers contiennent des informations sensibles. Conservez-les dans un endroit sûr et sécurisé.

     

6. Configurez Logstash :

   1. Sur votre machine hôte Linux ou Windows, installez Logstash. Vous pouvez également utiliser votre instance Logstash existante.

   2. Sur la machine hôte sur laquelle vous avez installé Logstash, placez les fichiers suivants dans le répertoire spécifié :

      Type de machine hôte	Nom du fichier	Chemin du répertoire
      Linux	CAS_Elasticsearch_LogStash_Config.config	Pour les paquets Debian et RPM : /etc/logstash/conf.d/
      		Pour les archives .zip et .tar.gz : {extract.path}/config
      	kafka.client.truststore.jks	Pour les paquets Debian et RPM : /etc/logstash/ssl/
      		Pour les archives .zip et .tar.gz : {extract.path}/ssl
      Windows	CAS_Elasticsearch_LogStash_Config.config	C:\logstash-7.xx.x\config
      	kafka.client.truststore.jks

      Pour plus d’informations sur la structure de répertoire par défaut des packages d’installation de Logstash, consultez la documentation Logstash.

   3. Ouvrez le fichier de configuration Logstash et procédez comme suit :

      1. Dans la section de saisie du fichier, saisissez les informations suivantes :

         • Mot de passe : mot de passe du compte que vous avez créé dans Citrix Analytics for Performance pour préparer le fichier de configuration.

         • Emplacement du truststore SSL : emplacement de votre certificat client SSL. Il s’agit de l’emplacement du fichier kafka.client.truststore.jks sur votre machine hôte.

         

      2. Dans la section de sortie du fichier, saisissez l’adresse de votre machine hôte ou du cluster sur lequel Elasticsearch est exécuté.

         

   4. Redémarrez votre machine hôte pour envoyer les données traitées depuis Citrix Analytics for Performance vers Elasticsearch.

Une fois la configuration terminée, vérifiez que vous pouvez afficher les données Citrix Analytics dans votre Elasticsearch.

Configuration de Logstash

Un exemple de configuration Logstash peut être téléchargé depuis la page Citrix Analytics for Performance.

Voici une petite variante de la définition du pipeline Logstash qui peut prendre en charge les exemples de tableaux de bord Kibana fournis :

filter {
  json {
    source => "message"
    remove_field => ["message"]
  }
  date {
    match => [ "timestamp", "ISO8601", "yyyy-MM-dd HH:mm:ss" ]
    target => "@timestamp"
  }
}

filter {
  mutate {
    copy => ["eventType", "[@metadata][eventTypeIndex]"]
  }
}

filter {
  mutate {
    lowercase => ["[@metadata][eventTypeIndex]"]
  }
}

output {
  elasticsearch {
    hosts => ["<your logstash host : port>"]
    index => "citrixanalytics-%{[@metadata][eventTypeIndex]}-%{+YYYY.MM.dd}"
  }
}
<!--NeedCopy-->

Sur la base de la configuration précédente, Logstash utilise le champ eventType pour séparer les événements de session et les événements de machine afin de séparer les index.

Vous pouvez remplacer les sections « filtre » et « sortie » du fichier de configuration par défaut téléchargé depuis la page Citrix Analytics par le contenu précédent et redémarrer le service Logstash.

Exemples de tableaux de bord Kibana

Vous pouvez importer l’exemple de tableau de bord Kibana fourni par Citrix, qui inclut :

• Métriques
• Graphiques temporels
• Autres visualisations utiles de la télémétrie des sessions et de l’infrastructure.

Vous pouvez télécharger les définitions du tableau de bord (fichiers JSON) depuis la page de téléchargement de Citrix Analytics.

Vous pouvez importer les fichiers du tableau de bord dans votre instance Kibana, soit vers un compte cloud Elasticsearch, soit vers un compte d’entreprise.

Avant d’importer le tableau de bord, assurez-vous d’avoir correctement configuré vos instances Logstash, Elasticsearch et Kibana et que vous êtes en mesure de consulter les index citrixanalytics sur la page de gestion des index de Kibana.

Pour importer les tableaux de bord et les vues de données référencées, effectuez les opérations suivantes :

1. Accédez à Gestion > Objet enregistré.
2. Cliquez sur Importer et sélectionnez le fichier ndjson fourni inclus dans le fichier compressé donné.
3. Vous pouvez éventuellement sélectionner Créer de nouveaux objets avec des identifiants aléatoires.
4. Cliquez sur Importer.

Après avoir effectué les étapes précédentes, vous pouvez visualiser les quatre nouveaux objets enregistrés comme indiqué dans l’image suivante :

Les vues de données sont référencées par les visualisations du tableau de bord et font référence aux index définis dans la configuration Logstash précédente. Vous devez être en mesure d’ouvrir les tableaux de bord. Voici des exemples de tableaux de bord :

Activer ou désactiver la transmission des données

Une fois que Citrix Analytics for Performance a préparé le fichier de configuration, la transmission des données est activée pour Elasticsearch.

Pour arrêter de transmettre des données depuis Citrix Analytics for Performance, procédez comme suit :

1. Accédez à Paramètres > Exportations de données.

2. Désactivez le bouton pour désactiver la transmission de données. Par défaut, la transmission de données est toujours activée.

   

3. Une fenêtre d’avertissement apparaît pour votre confirmation. Cliquez sur Désactiver la transmission des données pour arrêter l’activité de transmission.

   

Pour réactiver la transmission de données, activez le bouton.