Rapports d’administration

Vous pouvez générer un rapport d’administration pour collecter les données d’utilisation du système, telles que le nombre de projets actifs et inactifs et la taille des référentiels et de la base de données.

Dans cette rubrique :

Données du rapport d’administration

Un rapport d’administration contient les données suivantes.

Données Détails
user-login-activities

Répertorie les utilisateurs inactifs qui ne se sont pas connectés au cours des derniers jours spécifiés.

  • username. Nom d’utilisateur de l’utilisateur inactif.

  • last-access-timestamp. Horodatage de la dernière connexion de l’utilisateur.

  • last-access-time. Dernière heure de connexion avec nom d’utilisateur/mot de passe.

  • last-apikey-access-time. Dernière heure de connexion avec la clé API.

Si un utilisateur ne s’est jamais connecté, seul le nom d’utilisateur est renvoyé.
projets-ping-résultat

Répertorie les projets qui ont fait l’objet d’un ping et le résultat du ping de chaque projet.

  • id. ID du projet.

  • project-name. Nom du projet.

  • domain-name. Domaine auquel appartient le projet.

  • status. Statut du projet.

  • ping-result. Résultat du ping, réussi ou échoué.

  • total-count. Nombre de projets qui ont fait l’objet d’un ping.
projects-last-login-activity

Répertorie la dernière heure de connexion de chaque projet.

  • id. ID du projet.

  • project-name. Nom du projet.

  • domain-name. Domaine auquel appartient le projet.

  • last-login-time. Date et heure de la dernière connexion au projet.
active-sessions

Répertorie le nombre de sessions actives dans chaque projet.

  • id. ID du projet.

  • project-name. Nom du projet.

  • domain-name. Domaine auquel appartient le projet.

  • session-info.

    • session-count. Nombre de sessions actives initiées depuis le client.

    • client-type. Nom du client
projects-repository-size

Répertorie la taille du référentiel, la taille recyclable et la taille des fichiers de chaque projet.

  • id. ID du projet.

  • project-name. Nom du projet.

  • domain-name. Domaine auquel appartient le projet.

  • repository-size. Taille du référentiel du projet.

  • recyclable-size. Taille recyclable du référentiel du projet. Elle indique l’espace du référentiel qui peut être vidé en démarrant manuellement le nettoyage du référentiel.

  • attach. Taille de toutes les pièces jointes du projet.

  • tests. Taille des fichiers liés aux tests.

  • runs. Taille des fichiers liés à l’exécution des tests.

  • scripts. Taille des scripts du projet.

  • script-templates. Taille des scripts du modèle.

  • report-data. Taille des fichiers du rapport.

  • report-templates. Taille des rapports de modèle dans le projet.

  • resources. Taille des fichiers liés aux ressources de test.

  • baseline. Taille des fichiers de repère.

  • results. Taille des fichiers de résultats d’exécution des tests d’automatisation.

  • analysis-item-files. Taille des fichiers d’éléments d’analyse.
projects-db-space-used

Taille de l’espace de base de données utilisé de chaque projet.

  • db-server-name. Adresse IP du nom d’hôte du serveur de base de données.

  • db-server-type. Type de serveur de base de données, MSSQL ou Oracle.

  • actual-space-used. Taille physique (en Ko) de l’espace utilisé.
project-entities-summary Répertorie le nombre de chaque type d’entité par projet.

Retour en haut

Déclencher la génération d’un rapport d’administration

Les autorisations des administrateurs du site sont obligatoires pour déclencher la génération d’un rapport d’administration.

Pour déclencher la génération d’un rapport d’administration :

Effectuer l’appel POST suivant pour déclencher une action afin de générer le rapport d’administration.

Copy code 
/qcbin/v2/sa/api/collectors/report-collector/execute

Exemple de demande

Copy code 
{
  "project-request-option": {
    "project-session-connection": {
      "fetch-or-not": true,
      "is-file-latest": true
    },
    "project-last-login-activity": {
      "fetch-or-not": true,
      "is-file-latest": true
    },
    "project-ping": {
      "fetch-or-not": true,
      "is-file-latest": true
    },
    "project-db-space-used": {
      "fetch-or-not": true,
      "is-file-latest": true
    },
    "project-entities-summary": {
      "fetch-or-not": true,
      "is-file-latest": true
    },
    "project-repository-used-size": {
      "fetch-or-not": true,
      "is-file-latest": true
    },
    "user-last-login-activity": {
      "fetch-or-not": true,
      "is-file-latest": true,
      "inactive-days": 1
    }
  }
}

Paramètre Description
fetch-or-not

Inclure ou non les données spécifiques dans le rapport d’administration.

Par exemple, si vous définissez fetch-or-not sur true pour project-ping-result, le rapport d’administration inclut les données ping du projet. Si vous définissez fetch-or-not sur false, le rapport d’administration n’inclut pas les données ping du projet.
is-file-latest

Ne fonctionne que lorsque fetch-or-not est défini sur true.

Il contrôle s’il faut vérifier si les données à récupérer existent déjà et si les données existantes sont à jour.

  • Lorsque is-file-latest est défini sur true,

    • Si les données n’existent pas, elles sont générées.

    • Si les données existent déjà et sont à jour, elles ne sont pas régénérées.

    • Si les données existent déjà mais ont expiré, elles sont régénérées.

  • Lorsque is-file-latest est défini sur false,

    • Si les données n’existent pas, elles sont générées.

    • Si les données existent déjà, elles ne sont pas régénérées, qu’elles expirent ou non.

inactive-days

Disponible pour : user-last-login-activity uniquement

Le rapport d’administration renvoie les utilisateurs inactifs qui ne se sont pas connectés au cours du nombre de jours spécifié ou plus.

Le numéro de port par défaut est 90. Les valeurs valides sont comprises entre 1 et 180 (inclus).

Exemple de réponse

L’appel POST renvoie un ID d’action qui est une chaîne codée qui contient le moment où le rapport d’administration a été déclenché et comment les paramètres ont été définis.

Copy code 
{
  "report-parameters": {
    "report-parameter": "string"
  }
}

Retour en haut

Obtenir un rapport d’administration

Une fois la génération d’un rapport d’administration déclenchée, un ID d’action est renvoyé. Vous appelez la demande suivante pour obtenir le rapport d’administration par l’ID d’action.

Copy code 
GET /qcbin/v2/sa/api/admin-reports/{action-id}

Note : Il faut du temps pour générer un rapport d’administration. Ne demandez pas le rapport d’administration immédiatement après avoir obtenu l’ID d’action. Patientez un peu, en fonction de la taille de votre projet.

En-tête de la demande

Vous pouvez obtenir un rapport d’administration au format JSON ou CSV. Spécifier le format dans l’en-tête Content-Type : application/json ou text/csv.

Retour en haut

Voir aussi :