Accéder au contenu principal Passer au contenu complémentaire

Configuration et résolution des problèmes de Passerelle de données Qlik - Accès direct

Cette rubrique décrit plusieurs actions à entreprendre pour configurer et résoudre les problèmes rencontrés par Direct Access gateway.

Note InformationsToutes les options de configuration décrites dans cette rubrique peuvent également être exécutées via l'API publique Direct Access gateway. Pour plus d'informations, consultez https://qlik.dev/apis/rest/direct-access-agents/.

Configuration de Direct Access gateway à partir de votre client Qlik Cloud

Même si les paramètres par défaut Direct Access gateway conviennent à la plupart des environnements, vous pouvez écraser les valeurs par défaut pour améliorer les performances, résoudre un problème (via les paramètres de journalisation) ou surmonter différents problèmes de connectivité.

Note Informations
  • La configuration de Direct Access gateway à partir de Qlik Cloud est supportée à partir de la version 1.7.2, mais il est recommandé d'effectuer une mise à niveau à la dernière version pour profiter de l'ensemble des options de configuration.

  • Même si la plupart des paramètres de Direct Access gateway peuvent être configurés dans le centre d'activités Qlik Cloud Administration, certains paramètres ne peuvent être changés qu'en modifiant les fichiers de configuration directement sur le poste Direct Access gateway.

Pour pouvoir modifier les paramètres dans Qlik Cloud, vous devez disposer de l'une des autorisations suivantes :

  • Administrateur de clients et propriétaire de l'espace de la passerelle

  • Membre du client titulaire de l'autorisation Peut consommer des données dans l'espace de la passerelle

Pour ouvrir les paramètres de la passerelle :

  1. Dans votre client Qlik Cloud, accédez à Administration > Passerelles de données et localisez votre Direct Access gateway.

  2. Cliquez sur Plus à la fin de la ligne et sélectionnez Paramètres de la passerelle.

    La boîte de dialogue Paramètres de la passerelle pour <nom> s'ouvre.

    Les paramètres sont divisés en paramètres généraux (ci-dessous) et en Paramètres de connecteur. Notez que la modification des paramètres peut également nécessiter le redémarrage du service Direct Access gateway.

Paramètres généraux

Ces paramètres concernent la fonctionnalité générale de Direct Access gateway, quel que soit le connecteur que vous utilisez.

ID de l'agent

ID de l'agent à utiliser avec l'API publique Direct Access gateway.

Port de l'agent du connecteur

Port à utiliser lors de la connexion à l'agent du connecteur. Ce paramètre ne peut pas être modifié.

Seuil d'échec de l'intégrité de l'agent du connecteur

Des contrôles d'intégrité périodiques sont effectués sur les composants Direct Access gateway. Les contrôles d'intégrité peuvent échouer d'abord et se terminer correctement. Si les contrôles d'intégrité continuent à échouer après le seuil spécifié, le service Direct Access gateway redémarre. Vous ne devez modifier ce paramètre qu'à la demande du Support Qlik.

Expiration de la requête de chargement

En cas d'interruptions de réseau, il se peut que les chargements échouent avec les erreurs suivantes :

Connector error: The session does not exist (DirectAccess-1509)

Connector error: The stream session expired for the load data request (DirectAccess-1012)

Si vous rencontrez souvent les erreurs ci-dessus, essayez de définir le délai d'expiration sur 5-10 minutes.

Niveau de log de l'agent du connecteur.

À des fins de dépannage, vous devrez peut-être modifier le niveau de journalisation des composants de l'agent du connecteur. Vous ne devez modifier ce paramètre qu'à la demande du Support Qlik.

Option de log de l'agent du connecteur

Pour résoudre les problèmes liés à un composant spécifique de l'agent du connecteur, vous devrez peut-être sélectionner le fichier journal correspondant. Vous ne devez modifier ce paramètre qu'à la demande du Support Qlik.

Mémoire pour les blocs de données en cache

Pour chaque opération de chargement, Direct Access gateway peut mettre en cache des blocs de données en mémoire et les décharger sur le disque (lorsque la taille allouée à la mise en cache est dépassée). Cela s'avère particulièrement utile si vous n'utilisez pas la récupération automatique et si vous rencontrez régulièrement des erreurs 4025, 4020 et 4021. Lorsque le seuil spécifié est atteint, la passerelle décharge les blocs chiffrés suivants sur le disque du poste Direct Access gateway.

Seuil de la durée de récupération des blocs

Il s'agit du seuil (en minutes) pour la durée de récupération des blocs. Si le chargement n'a pas repris au moment où le seuil de la durée de récupération est atteint, il échoue en affichant un message approprié.

Cette option est utile pour les chargements qui, sinon, pourraient dépasser la limite de trois heures, suite à une longue récupération. Par exemple, supposons qu'il faille 90 minutes pour récupérer les données de la base de données, mais que dès le début du chargement, l'un des blocs soit corrompu. Dans ce cas, tous les blocs seront stockés dans le cache et envoyés du cache. Dans un tel scénario, l'ensemble du processus de chargement (stockage dans le cache + chargement proprement dit) pourrait prendre trois heures.

Port DCaaS

Port utilisé lors de la connexion à DCaaS. Ce paramètre ne peut pas être modifié.

Niveau de log DCaaS

À des fins de dépannage, vous devrez peut-être modifier le niveau de journalisation des journaux DCaaS. Vous ne devez modifier ce paramètre qu'à la demande du Support Qlik.

Paramètres de connecteur

Pour modifier les paramètres de connecteur, sélectionnez le type de connecteur à gauche, puis modifiez les paramètres selon les besoins.

Port

Port à utiliser lors de la connexion à la source de données. Ce paramètre ne peut pas être modifié.

Niveau de log

À des fins de dépannage, vous devrez peut-être modifier le niveau de journalisation des journaux du connecteur. Vous ne devez modifier ce paramètre qu'à la demande du Support Qlik.

Isolement des processus

Note Informations

Nécessite Direct Access gateway 1.6.1 ou une version ultérieure.

L'isolation de processus permet aux administrateurs disposant d'un accès au système d'exploitation du serveur Direct Access gateway de contrôler le nombre de processus disponibles pour les chargements et/ou commandes de métadonnées par type de connecteur. La diffusion des chargements et/ou commandes de métadonnées sur plusieurs processus de connecteur augmente le niveau d'isolement en réduisant le nombre de chargements et/ou commandes de métadonnées exécutés simultanément sur chaque processus de connecteur. Cette opération, à son tour, améliore la stabilité générale de Direct Access gateway en cas de plantage de certains connecteurs.

Dans le cas d'une nouvelle installation, l'isolation de processus est activée par défaut. Le nombre par défaut de chargements et/ou commandes de métadonnées simultanés pour chaque type de connecteur est de 9. Vous pouvez modifier la valeur par défaut comme indiqué à la section Nombre de processus de chargement/commande simultanés ci-dessous.

Les options suivantes sont disponibles :

  • Désactivé : Le Support Qlik peut vous demander de désactiver l'isolation de processus à des fins de dépannage.

  • Métadonnées : Activez l'isolation de processus uniquement pour les commandes de métadonnées. Cela peut être utile, par exemple, pour les clients disposant de pilotes ODBC qui ne prennent pas en charge le multi-threading, mais qui souhaitent exécuter des commandes de métadonnées simultanément (principalement à des fins de prévisualisation).

    Note InformationsSupport à partir de Direct Access gateway 1.7.9.
  • Charger (Par défaut) : Activez l'isolation de processus uniquement pour les commandes de métadonnées.

  • Tout : Activez l'isolation de processus pour les chargements et commandes de métadonnées.

    Note InformationsSupport à partir de Direct Access gateway 1.7.9.

Nombre de processus de chargement/commande simultanés

Nombre de processus de chargement/commande simultanés affectés au connecteur, y compris le processus de commande. Par exemple, une valeur 30 signifie un maximum de 29 chargements/commandes simultanés. Notez que ce paramètre n'est pertinent que lorsque l'isolation de processus est activée.

Note InformationsÀ partir de la version 1.6.7 de Direct Access gateway, cette valeur peut dépasser 10 sans qu'il soit nécessaire de modifier d'autres paramètres. Pour isoler complètement les actualisations avec un type de connecteur spécifique (c'est-à-dire, pas plus d'une actualisation par processus de connecteur), cette valeur doit être définie sur un minimum de 30, mais il peut être nécessaire de la définir sur une valeur aussi élevée que 60 suivant la charge de travail.

Durée de vie d'une session de chargement

Note InformationsConcerne uniquement le connecteur ODBC (via Direct Access gateway).

Si la connexion entre Direct Access gateway et Qlik Cloud est inactive pendant au moins 20 secondes, l'opération de chargement peut parfois échouer en affichant l'erreur suivante :

Invalid object name '#<TempTableName>' (indicating that the Direct Access gateway temp tables are unavailable).

La durée de vie par défaut d'une session est de 20 secondes, mais, si vous rencontrez souvent cette erreur, vous pouvez prolonger la durée de vie de la session selon les besoins.

Nombre maximal de tables à décharger

Note Informations
  • Concerne uniquement le connecteur ODBC (via Direct Access gateway).

  • Nécessite Direct Access gateway 1.7.1 ou une version ultérieure.

Par défaut, 10 000 tables maximum sont extraites de la base de données. Vous pouvez écraser la valeur par défaut lorsque votre base de données contient plus de 10 000 tables.

Limitation des URL auxquelles Direct Access gateway peut accéder via le connecteur REST

Vous pouvez limiter l'accès à des URL spécifiques ou à des chemins d'accès à des URL accessibles via le connecteur REST.

Note InformationsLes modifications apportées (ajout, modification ou suppression d'URL) ne seront prises en compte qu'après redémarrage du service Direct Access gateway.

Pour limiter l'accès à une URL spécifique, saisissez l'URL dans le champ URL autorisées et cliquez sur Ajouter. Faites de même pour limiter l'accès à un chemin d'accès à une URL, mais ajoutez un astérisque (*) à l'URL. Répétez l'opération, si nécessaire.

Dans l'exemple suivant, la liste URL autorisées contient deux entrées :

  • La première entrée n'autorise l'accès qu'à https://mypublicrestservice.com/restricted/source.

  • La deuxième entrée autorise l'accès à https://mypublicrestservice.com/open et à tout chemin d'accès sous celui-ci, tel que https://mypublicrestservice.com/open/shared.

Pour modifier une URL, cliquez sur le bouton à la fin de la ligne, puis modifiez l'URL selon les besoins. Cliquez ensuite sur pour enregistrer vos modifications ou sur pour annuler.

Pour supprimer une URL, cliquez sur le bouton à la fin de la ligne.

Consultez également : Création d'une connexion REST (uniquement en anglais).

Limitation de la liste des chemins d'accès auxquels Direct Access gateway peut accéder via le connecteur File

Vous pouvez limiter l'accès à des chemins d'accès accessibles via le connecteur File. Vous pouvez également appairer un chemin d'accès à un ou plusieurs espaces afin de restreindre encore davantage l'accès au chemin d'accès spécifié.

Note Informations
  • Les espaces appairés sont supportés à partir de Direct Access gateway 1.7.6.

  • Lors de l'utilisation de Direct Access gateway 1.7.4 ou 1.7.5, les modifications apportées (ajout, modification ou suppression de chemins d'accès ou d'espaces) ne seront prises en compte qu'après redémarrage du service Direct Access gateway.

  • Seuls les utilisateurs disposant du rôle Peut consommer des données ou d'un rôle supérieur (Accès en écriture, Peut modifier des données dans des applications, Peut gérer) pourront accéder aux chemins d'accès.

  • Tous les systèmes de fichiers et les lecteurs réseau Windows sont supportés, y compris les chemins d'accès DOS standards et les chemins d'accès UNC.

Pour limiter l'accès à un chemin d'accès spécifique, saisissez le chemin d'accès dans le champ Chemins d'accès aux fichiers et cliquez sur Ajouter. Répétez l'opération, si nécessaire.

Pour appairer un espace à un chemin d'accès, après avoir ajouté le chemin d'accès, cliquez sur le bouton à la fin de la ligne et sélectionnez un ou plusieurs espaces dans la liste déroulante de la colonne Espaces appairés. Si un chemin d'accès est appairé à des espaces, seuls les utilisateurs appartenant à au moins un des espaces pourront accéder au chemin d'accès spécifié. Notez que les membres des espaces spécifiés pourront accéder au chemin d'accès depuis n'importe quel espace auquel ils appartiennent (même s'il n'est pas explicitement défini), y compris depuis leur espace personnel.

Dans l'exemple suivant, la liste Chemins d'accès aux fichiers contient deux entrées :

  • La première entrée permet à tout utilisateur ayant le rôle requis d'accéder à C:\mypath\source..

  • La deuxième entrée permet uniquement aux membres de l'espace mosheSharedSpace d'accéder à C:\restricted.

Pour modifier une entrée, cliquez sur le bouton à la fin de la ligne, puis modifiez l'entrée selon les besoins. Cliquez ensuite sur pour enregistrer vos modifications ou sur pour annuler vos modifications.

Pour supprimer une entrée, cliquez sur le bouton à la fin de la ligne.

Consultez également : File (via Direct Access gateway) (uniquement en anglais).

Redémarrage de Direct Access gateway après modification des paramètres

Certains paramètres ne seront appliqués qu'après le redémarrage du service Direct Access gateway. Dans ce cas, vous serez invité à redémarrer le service lorsque vous enregistrerez vos paramètres. En cas de chargements actifs, vous ne pourrez pas redémarrer le service tant qu'ils ne seront pas terminés. En l'absence de chargements actifs, vous pouvez redémarrer le service à tout moment comme suit :

  1. Dans votre client Qlik Cloud, accédez à Administration > Passerelles de données et localisez votre Direct Access gateway.

  2. Cliquez sur Plus à la fin de la ligne et sélectionnez Redémarrer le service.

Vous pouvez également redémarrer le service directement sur le poste Direct Access gateway, comme décrit dans la section Démarrage, arrêt ou redémarrage du service.

Configuration de Direct Access gateway directement sur le poste Direct Access gateway

Même si la plupart des paramètres de Direct Access gateway peuvent être configurés dans Qlik Cloud, certains paramètres ne peuvent être changés qu'en modifiant les fichiers de configuration directement sur le poste Direct Access gateway.

Remplacement du répertoire de cache de blocs par défaut

Note InformationsNécessite Direct Access gateway 1.7.1 ou une version ultérieure.

Pour chaque opération de chargement, Direct Access gateway peut mettre en cache des blocs de données en mémoire et les décharger sur le disque (lorsque la taille allouée à la mise en cache est dépassée). Vous pouvez remplacer le répertoire de cache de blocs par défaut (C:\ProgramData\Qlik\Gateway\tmp) si vous ne disposez pas de suffisamment d'espace disque sur le lecteur système.

Note InformationsPour garantir la stabilité et optimiser les performances, la meilleure pratique consiste à n'utiliser que des chemins d'accès locaux.

Pour effectuer cette action :

  1. À l'aide d'un éditeur de texte, ouvrez C:\ProgramData\Qlik\Gateway\configuration.properties en tant qu'administrateur. Si vous le faites via Windows Explorer, assurez-vous que l'option Afficher >Éléments masqués est sélectionnée.
  2. Localisez la propriété OVERRIDE_CHUNKS_CACHE_DIR et définissez-la sur le répertoire de votre choix.

    Exemple :

    OVERRIDE_CHUNKS_CACHE_DIR=C:\tmp

    Note InformationsNe placez pas le chemin d'accès entre guillemets.
  3. Enregistrez le fichier configuration.properties et redémarrez le service Passerelle de données Qlik - Accès direct.

Consultez aussi : Mémoire pour les blocs de données en cache

Remplacement du type de données Qlik Cloud par défaut lors de l'utilisation du connecteur ODBC (via Direct Access gateway)

Note InformationsNécessite Direct Access gateway 1.7.1 ou une version ultérieure.

Parfois, en raison d'un problème lié à la gestion des types de données sources par le pilote ODBC du fournisseur, une erreur se produit lors du chargement ou des données incorrectes sont chargées sur Qlik Cloud. Dans ce cas, vous pouvez remplacer le type de données Qlik Cloud ou sa spécification (échelle ou précision, par exemple).

Note AvertissementBien que de nombreux problèmes puissent être résolus en remplaçant simplement QlikDataType par String, s'il n'est pas possible de le faire, nous vous recommandons de contacter Qlik Support pour obtenir des conseils sur les types de données Qlik Cloud vers lesquels le type de données source peut être mappé.

Pour effectuer cette action :

  1. À l'aide d'un éditeur de texte, ouvrez C:\ProgramData\Qlik\Gateway\custom_type_mappings.json en tant qu'administrateur. Si vous le faites via Windows Explorer, assurez-vous que l'option Afficher >Éléments masqués est sélectionnée. Ce fichier contient un exemple de source mappé vers des types de données Qlik Cloud.
  2. Ajoutez une section qui mappe le type de données problématique au type de données Qlik Cloud souhaité.

    Dans l'exemple suivant (qui est inclus dans le fichier mappages_de_types_personnalisés.json), le client doit remplacer la taille du type de données Qlik Cloud DateTime par 27.

     

    Exemple :

    {
    "Identifier": "Amazon Athena ODBC (x64)",
    "NativeDataType": "timestamp with time zone",
    "QlikDataType": "DateTime",
    "Size": 27,
    "IsBit": false
    }

  3. Enregistrez le fichier mappages_de_types_personnalisés.json et redémarrez le service Passerelle de données Qlik - Accès direct.
  4. Rechargez les données.

Forcer Direct Access gateway à se reconnecter à Qlik Cloud

Par défaut, si Direct Access gateway se déconnecte de Qlik Cloud, il doit se reconnecter au bout de 45 secondes. Si vous notez que cela prend beaucoup plus de temps, vous pouvez forcer la passerelle à se reconnecter plus tôt.

Pour effectuer cette action :

  1. À l'aide d'un éditeur de texte, ouvrez C:\ProgramData\Qlik\Gateway\configuration.properties en tant qu'administrateur. Si vous le faites via Windows Explorer, assurez-vous que l'option Afficher >Éléments masqués est sélectionnée. Ce fichier contient un exemple de source mappé vers des types de données Qlik Cloud.
  2. Ajoutez AGENT_PONG_TIMEOUT_SECONDS=<time-in-seconds> à la section # Connector Agent au début du fichier.

    AGENT_PONG_TIMEOUT_SECONDS=30

    Note InformationsLa durée minimale est de 30 secondes.
  3. Enregistrez le fichier configuration.properties et redémarrez le service Passerelle de données Qlik - Accès direct.

Exécution asynchrone de requêtes Charger les données

Note Informations

Nécessite Direct Access gateway 1.7.5 ou une version ultérieure.

L'exécution asynchrone de requêtes Charger les données sur l'agent réduit considérablement le temps pendant lequel le service cloud doit attendre les réponses de l'agent.

Pour activer les requêtes Charger les données asynchrones :

  1. À l'aide d'un éditeur de texte, ouvrez C:\ProgramData\Qlik\Gateway\configuration.properties en tant qu'administrateur. Si vous le faites via Windows Explorer, assurez-vous que l'option Afficher >Éléments masqués est sélectionnée.
  2. Ajoutez la ligne suivante au fichier, si ce n'est pas déjà fait :

    OPTIONAL_CAPABILITIES=AsyncLoadDataRequest

    Si OPTIONAL_CAPABILITIES= existe déjà avec un autre paramètre (AsyncLoadSlotRequest, par exemple), il suffit de l'ajouter au paramètre existant, en la séparant à l'aide d'une virgule sans espace.

    OPTIONAL_CAPABILITIES=AsyncLoadSlotRequest,AsyncLoadDataRequest

  3. Enregistrez le fichier configuration.properties.
Note ConseilLes modifications sont prises en compte lors du chargement suivant, de sorte qu'il n'est pas nécessaire de redémarrer le service Direct Access gateway. Toutes les modifications seront consignées dans le fichier connector-agent_logs_[date].txt.

Pour désactiver les requêtes Charger les données asynchrones :

  1. À l'aide d'un éditeur de texte, ouvrez C:\ProgramData\Qlik\Gateway\configuration.properties en tant qu'administrateur. Si vous le faites via Windows Explorer, assurez-vous que l'option Afficher >Éléments masqués est sélectionnée.
  2. Définissez OPTIONAL_CAPABILITIES=None ou supprimez simplement AsyncLoadDataRequest s'il existe d'autres paramètres OPTIONAL_CAPABILITIES.

  3. Enregistrez le fichier configuration.properties.

Demande de créneaux de chargement de manière asynchrone

Note Informations

Nécessite Direct Access gateway 1.7.7 ou une version ultérieure.

Le fait de demander des créneaux de chargement de manière asynchrone permet d'atténuer l'encombrement temporaire du canal de commande vers Direct Access gateway lors de la création du WebSocket de chargement de données vers Qlik Cloud. Cela peut s'avérer utile lorsque vous effectuez un nombre considérable de chargements simultanés.

Note InformationsVous ne devez activer cette fonctionnalité que sur instruction du Support Qlik.

Pour activer les requêtes de créneaux de chargement asynchrones :

  1. À l'aide d'un éditeur de texte, ouvrez C:\ProgramData\Qlik\Gateway\configuration.properties en tant qu'administrateur. Si vous le faites via Windows Explorer, assurez-vous que l'option Afficher >Éléments masqués est sélectionnée.
  2. Ajoutez la ligne suivante au fichier, si ce n'est pas déjà fait :

    OPTIONAL_CAPABILITIES=AsyncLoadSlotRequest

    Si OPTIONAL_CAPABILITIES= existe déjà avec un autre paramètre (AsyncLoadDataRequest, par exemple), il suffit de l'ajouter au paramètre existant, en la séparant à l'aide d'une virgule sans espace :

    OPTIONAL_CAPABILITIES=AsyncLoadDataRequest,AsyncLoadSlotRequest

  3. Enregistrez le fichier configuration.properties.
Note ConseilLes modifications sont prises en compte lors du chargement suivant, de sorte qu'il n'est pas nécessaire de redémarrer le service Direct Access gateway. Toutes les modifications seront consignées dans le fichier connector-agent_logs_[date].txt.

Pour désactiver les requêtes de créneaux de chargement asynchrones :

  1. À l'aide d'un éditeur de texte, ouvrez C:\ProgramData\Qlik\Gateway\configuration.properties en tant qu'administrateur. Si vous le faites via Windows Explorer, assurez-vous que l'option Afficher >Éléments masqués est sélectionnée.
  2. Définissez OPTIONAL_CAPABILITIES=None ou supprimez simplement AsyncLoadSlotRequest s'il existe d'autres paramètres OPTIONAL_CAPABILITIES.

  3. Enregistrez le fichier configuration.properties.

Configuration du démarrage du connecteur

Vous pouvez augmenter la valeur de délai d'attente et le nombre de tentatives de démarrage du connecteur. Cela peut s'avérer utile lorsque vous effectuez un nombre considérable de chargements simultanés. Si vous augmentez ces paramètres, Direct Access gateway disposera de plus de temps et de tentatives pour exécuter le connecteur avant de le quitter pour cause d'échec et de demander un redémarrage.

Note InformationsVous ne devez activer cette fonctionnalité que sur instruction du Support Qlik.
Note Informations

Nécessite Direct Access gateway 1.7.7 ou une version ultérieure.

Pour ajuster les paramètres de démarrage du connecteur :

  1. À l'aide d'un éditeur de texte, ouvrez C:\ProgramData\Qlik\Gateway\configuration.properties en tant qu'administrateur. Si vous le faites via Windows Explorer, assurez-vous que l'option Afficher >Éléments masqués est sélectionnée.
  2. Ajoutez les lignes suivantes au fichier :

    # CONNECTOR STARTUP TIMEOUT between 30 and 120 seconds

    CONNECTOR_STARTUP_TIMEOUT_SECONDS=your-value

    # CONNECTOR STARTUP MAX ATTEMPTS between 1 and 5

    CONNECTOR_STARTUP_MAX_ATTEMPTS=your-value

    Note Informations Pour éviter l'encombrement du canal de commande, l'ajustement de ces valeurs nécessite l'activation de AsyncLoadDataRequest, comme décrit plus haut à la section Demande de créneaux de chargement de manière asynchrone. Ces paramètres reviendront aux valeurs fixes initiales 30 et 3, respectivement, lorsque AsyncLoadSlotRequest est désactivé.
  3. Enregistrez le fichier configuration.properties.

Remplacement du port de démarrage par défaut défini par l'isolation des processus

Lorsque l'isolation des processus est activée, vous pouvez désormais remplacer le port de démarrage par défaut (49152) que Direct Access gateway utilise pour la communication inter-processus avec tous les processus de connecteur isolés. Cela peut s'avérer utile lorsque le port par défaut est utilisé par un autre processus.

Note Informations
  • Vous ne devez activer cette fonctionnalité que sur instruction du Support Qlik.

  • Nécessite Direct Access gateway 1.7.8 ou une version ultérieure.

  • Cette fonctionnalité est également supportée via l'API publique.

Pour effectuer cette action :

  1. À l'aide d'un éditeur de texte, ouvrez C:\ProgramData\Qlik\Gateway\configuration.properties en tant qu'administrateur. Si vous le faites via Windows Explorer, assurez-vous que l'option Afficher >Éléments masqués est sélectionnée.
  2. Sous la section # Connector Agent, ajoutez la ligne suivante au fichier :

    DATA_PORT_RANGE_START=port-value

    port-value est le port de démarrage par défaut.

  3. Enregistrez le fichier configuration.properties et redémarrez le service Passerelle de données Qlik - Accès direct.

Augmentation du détail des messages d'erreur lors de la connexion à des sources de données ODBC

Pour des raisons de sécurité, le message d'erreur par défaut renvoyé par le pilote ODBC contient un minimum d'informations. Toutefois, dans certains cas, vous pourriez avoir besoin de plus d'informations pour résoudre un problème spécifique. Pour obtenir un message d'erreur plus détaillé, ajoutez la propriété ShowErrorDetailMessage à la section Avancé de la boîte de dialogue du connecteur et définissez-la sur True. Une fois le problème résolu, pour une sécurité optimale, il est vivement recommandé de supprimer la propriété ou de la définir sur False.

Collecteur de métriques

Dans l'environnement d'un client type, de nombreux chargements de données passent par Direct Access gateway dans Qlik Cloud Analytics au quotidien. La capacité à consigner et surveiller la consommation et l'utilisation des ressources impactées par ces chargements aidera les clients à planifier leurs chargements en conséquence.

Le nouveau collecteur de métriques (qui s'exécute en arrière-plan sur le poste Direct Access gateway) offre une journalisation et une surveillance de base de l'utilisation des ressources par Direct Access gateway, les connecteurs et le système d'exploitation. Le collecteur de métriques peut être configuré localement dans un fichier JSON ou via l'API publique.

Configuration du collecteur de métriques

Sur le poste Direct Access gateway, ouvrez le fichier suivant et configurez-le selon les besoins :

<INSTALL_DIR>\ConnectorAgent\MetricsCollector\metricscollectorsettings.json

Configuration des paramètres de collecteur (MetricsCollectorSettings)

  • Enabled : définissez ce paramètre sur true (par défaut) pour activer la collecte de métriques ou sur false pour la désactiver.

  • BaseScrapeIntervalSeconds : fréquence d'interrogation des métriques de connecteur en secondes. Chaque connecteur a son propre intervalle d'interrogation.

  • Port : port utilisé par l'API ou le connecteur de métriques (REST via Direct Access gateway).

  • LocalDataRetentionDays : les données plus anciennes que la valeur spécifiée seront supprimées de la base de données locale.

  • DataRetentionCheckIntervalMinutes : fréquence de vérification de la conservation.

  • LocalDatabaseFileLocation : emplacement de la base de données locale. Il peut également s'agir d'un chemin d'accès UNC. L'emplacement par défaut est C:\ProgramData\Qlik\Gateway\tmp.

Configuration des paramètres de connecteur (ConnectorConfigurations)

Pour tous les connecteurs Direct Access gateway, vous pouvez définir l'intervalle d'interrogation des métriques (ScrapeIntervalSeconds) et activer (true) ou désactiver (false) la collecte de métriques.

Exemple de fichier metricscollectorsettings.json

{
  "MetricsCollectorSettings": {
    "Enabled": true,
    "BaseScrapeIntervalSeconds": 1,
    "Port": 5052,
    "LocalDataRetentionDays": 30,
    "DataRetentionCheckIntervalMinutes": 60,
    "LocalDatabaseFileLocation": ""
  },
  "ConnectorConfigurations": {
    "OdbcConnector": {
      "MetricsCollectionEnabled": true,
      "ScrapeIntervalSeconds": 30
    },
    "SystemMetrics": {
      "MetricsCollectionEnabled": true,
      "ScrapeIntervalSeconds": 30
    },
    "ConnectorAgent": {
      "MetricsCollectionEnabled": false,
      "ScrapeIntervalSeconds": 30
    },
    "RestConnector": {
      "MetricsCollectionEnabled": false,
      "ScrapeIntervalSeconds": 30
    },
    "SapSqlConnector": {
      "MetricsCollectionEnabled": false,
      "ScrapeIntervalSeconds": 30
    },
    "SapBwConnector": {
      "MetricsCollectionEnabled": false,
      "ScrapeIntervalSeconds": 30
    },
    "SapPackageConnector": {
      "MetricsCollectionEnabled": false,
      "ScrapeIntervalSeconds": 30
    },
    "FileConnector": {
      "MetricsCollectionEnabled": false,
      "ScrapeIntervalSeconds": 30
    }
  }
}

Chargement de métriques

Utilisez le connecteur REST (via Direct Access gateway) pour collecter les métriques auprès du poste Direct Access gateway.

Pour effectuer cette action :

  1. Dans les paramètres de connexion REST (via Direct Access gateway), activez Autoriser la connexion avec localhost.

    Pour des informations détaillées, consultez Création d'une connexion REST (uniquement en anglais).

  2. Ajoutez http://localhost:5052/api/metrics à la liste des URL autorisées.

    Consultez la section Limitation des URL auxquelles Direct Access gateway peut accéder via le connecteur REST ci-dessus.

  3. Redémarrez le service Direct Access gateway.

  4. Créez une application et chargez les métriques depuis http://localhost:5052/api/metrics via la connexion REST (via Direct Access gateway).

Métriques supportées

  • Métriques système :

    • network_bytes_sent_total : nombre total d'octets transmis via Direct Access gateway depuis le démarrage du système

    • network_bytes_received_total : nombre total d'octets reçus via Direct Access gateway depuis le démarrage du système

  • Métriques de connecteur :

    • process_start_time_seconds : temps écoulé depuis le démarrage du processus en secondes

    • process_cpu_seconds_total : nombre cumulé de secondes pendant lesquelles une UC s'est trouvée dans un état spécifique

    • process_virtual_memory_bytes : taille actuelle, en octets, de la mémoire virtuelle consommée par le processus

    • process_working_set_bytes : taille actuelle, en octets, du Working Set (Ensemble de travail) du processus.

    • process_private_memory_bytes : taille actuelle, en octets, de la mémoire privée consommée par le processus

    • process_num_threads : nombre de threads utilisés par le processus.

Affichage et téléchargement de fichiers journaux

Les fichiers journaux fournissent des informations sur les opérations Direct Access gateway. Qlik Support peut vous demander de fournir des fichiers journaux à des fins de dépannage. Vous pouvez afficher ou télécharger les fichiers journaux dans la visionneuse du journal. Dans des circonstances normales, il n'y a pas de raison d'examiner les fichiers journaux ; mais si vous rencontrez des échecs répétés ou d'autres problèmes, les fichiers journaux permettront généralement de repérer la cause.

Note InformationsL'affichage et le téléchargement des journaux nécessitent le rôle Peut consommer des données.

Pour ouvrir la visionneuse du journal :

  1. Dans le centre d'activités Administration, accédez à Passerelles de données et repérez votre Direct Access gateway.

  2. Cliquez sur Plus à la fin de la ligne et sélectionnez Afficher les journaux.

    La fenêtre Visionneuse du journal s'ouvre.

  3. Dans la liste déroulante dans le coin supérieur gauche, sélectionnez le type de journal que Qlik Support vous a demandé d'afficher ou de télécharger.

    Les journaux suivants sont disponibles :

    • Journaux Direct Access gateway (DirectAccessAgent)
    • Journaux DCaaS(dcaas_logs)
    • Journaux de connecteur basé sur ODBC (odbc-connector_logs)
    • Journaux de connecteur SAP BW (QvSAPBwConnector-<date + timestamp>)
    • Journaux de connecteur SAP SQL (QvSqlBwConnector-<date + horodatage>)
    • Journaux d'agent de connecteur (connector-agent_logs_<date>)

    • Journaux de connecteurs SAP Report et SAP ODP(QvSapConnectorPackage-<process_id>)

    • Journaux de connecteur REST (rest-connector_logs_<horodatage>)

    • Journaux de connecteur File (file-connector_logs_<horodatage>)

    Note InformationsÀ partir de Direct Access gateway 1.7.1, les événements de démarrage, de sortie et de redémarrage du connecteur seront écrits dans le fichier journal Direct Access gateway(DirectAccessAgent). Dans les versions précédentes, ils étaient écrits dans le fichier journal Connector agent logs (connector-agent_logs_<date>).
  4. Dans la liste déroulante adjacente, sélectionnez le journal à afficher ou télécharger. Les fichiers journaux sont triés du plus récent (le fichier journal actuellement actif) au plus ancien. Après avoir sélectionné un fichier journal, vous pouvez utiliser les boutons Flèche de défilement vers le haut et Flèche de défilement vers le bas pour passer au début ou à la fin du fichier journal, respectivement.

    Note ConseilLa vue du fichier journal n'est pas mis à jour automatiquement avec les messages les plus récents. Pour mettre la vue à jour, cliquez sur Flèche de défilement vers le bas pour passer à la fin du fichier journal, qui sera actualisé à l'aide des messages les plus récents.
  5. Pour télécharger le fichier journal, cliquez sur Télécharger.

    Suivant les paramètres de votre navigateur, le fichier est téléchargé sur votre ordinateur ou vous serez invité à l'enregistrer.

Ouverture des journaux Direct Access gateway sur le poste Direct Access gateway

Outre le fait de pouvoir télécharger les journaux Direct Access gateway (DirectAccessAgent) depuis le centre d'activités Administration, vous pouvez également les ouvrir directement depuis le poste Direct Access gateway. Avec une installation par défaut, ces journaux sont placés dans :

C:\Program Files\Qlik\ConnectorAgent\data\logs

Modification du niveau de journalisation DirectAccessAgent

À des fins de dépannage, vous devrez peut-être modifier le niveau de journalisation des journaux DirectAccessAgent. DirectAccessAgent est responsable de la connexion aux services Qlik Cloud. Pour afficher et modifier le niveau de détail de journalisation des journaux DirectAccessAgent, exécutez les commandes suivantes depuis le sous-dossier ConnectorAgent (C:\Program Files\Qlik\ConnectorAgent\ConnectorAgent avec une installation par défaut) :

  • Pour afficher le niveau de journalisation existant, exécutez :

    connectoragent configuration getloggers
  • Pour définir le niveau de journalisation sur Trace, exécutez :

    connectoragent configuration setloggers -l Root -v DEBUG
  • Pour définir le niveau de journalisation sur Verbose, exécutez :

    connectoragent configuration setloggers -l Root –v DETAILED_DEBUG

Pour connaître les options de journalisation supplémentaires, consultez la section Configuration de Direct Access gateway dans Qlik Cloud ci-dessous.

Mise à jour de la clé d'inscription

Il peut être nécessaire de modifier la clé d'inscription en cas de corruption éventuelle de la clé ou si vous pensez qu'un utilisateur non autorisé a accédé au serveur de passerelles de données.

Pour mettre la clé d'inscription à jour :

  1. Sur le serveur de la passerelle Accès direct, ouvrez une invite de commande en tant qu'administrateur et définissez le répertoire de travail sur le sous-dossier ConnectorAgent (C:\Program Files\Qlik\ConnectorAgent\ConnectorAgent avec une installation par défaut).
  2. Exécutez les commandes suivantes :

    • Générez la nouvelle clé :

      connectoragent qcs generate_keys

    • Affichez la clé :

      connectoragent qcs get_registration

      La clé s'affiche :

      Image de la clé d'enregistrement Accès direct

  3. Copiez la clé complète, comme indiqué dans l'exemple ci-dessus.

  4. Dans le centre d'activités Administration, ouvrez les paramètres de la passerelle de données en cliquant sur le bouton Plus à la fin de la ligne correspondante et en sélectionnant Modifier.

  5. Collez la clé dans le champ Clé (en remplaçant la clé existante) et enregistrez les paramètres.

  6. Revenez au serveur de la passerelle Accès direct et redémarrez le service Passerelle de données Qlik - Accès direct, comme décrit dans Gestion du service Passerelle de données Qlik - Accès direct.

Cette page vous a-t-elle aidé ?

Si vous rencontrez des problèmes sur cette page ou dans son contenu – une faute de frappe, une étape manquante ou une erreur technique – faites-le-nous savoir.