Partager cette page
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.
Ce que comprend un rapport d’administration
Un rapport d’administration contient les sections suivantes :
| Section | Inclut |
|---|---|
| projets-ping-résultat |
Répertorie les projets qui ont fait l’objet d’un ping et le statut du ping de chaque projet. Les informations de cette section sont générées à nouveau toutes les 2 heures. |
| projets-dernière-connexion-activité |
Répertorie la dernière heure de connexion de chaque projet. Les informations de cette section sont générées à nouveau toutes les 5 minutes. |
| sessions-actives |
Répertorie le nombre de sessions actives dans chaque projet. Les informations de cette section sont générées à nouveau toutes les 5 minutes. |
| projets-référentiel-taille |
Répertorie la taille du référentiel et la taille recyclable de chaque projet. La taille recyclable correspond aux fichiers physiques du référentiel dont les fichiers logiques ont été supprimés afin qu’ils puissent être nettoyés en promouvant le processus GC manuellement. Les informations contenues dans cette section sont générées à nouveau toutes les 2 heures. |
| projets-bd-espace-utilisé |
La taille de l’espace utilisé pour la base de données de chaque projet (serveur SQL ou serveur Oracle). Les informations contenues dans cette section sont générées à nouveau toutes les 2 heures. |
Comment générer des rapports d’administration
Les autorisations des administrateurs du site sont obligatoires pour générer un rapport d’administration.
Pour générer un rapport d’administration :
-
Effectuer l’appel POST suivant pour déclencher une action afin de générer le rapport d’administration et obtenir l’ID de l’action.
Copy code/qcbin/v2/sa/api/collectors/report-collector/executeExemple de demande Copy code{
"project-request-option": {
"project-ping": {
"fetch-or-not":"true",
"is-file-latest": "false"
},
"project-last-login-activity": {
"fetch-or-not": "true",
"is-file-latest": "false"
},
"project-session-connection": {
"fetch-or-not": "true",
"is-file-latest": "false"
},
"project-repository-used-size": {
"fetch-or-not": "true",
"is-file-latest": "false"
},
"project-db-space-used": {
"fetch-or-not": "true",
"is-file-latest": "false"
}
}
}Drapeaux :
-
fetch-or-not. Inclure ou non les données du module correspondant dans le rapport d’administration.
Example: Si vous définissez fetch-or-not sur true pour projet-ping, 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. Contrôle s’il faut obtenir les dernières données du fichier JSON de l’API correspondante pour le rapport d’administration.
Example: Si vous définissez is-file-latest de projet-ping sur true, le rapport d’administration inclut les dernières données du fichier JSON de l’API ping du projet. Il se peut que ce soit un autre utilisateur de l’administration du site qui ait appelé l’API le plus récemment.
Si vous définissez is-file-latest de projet-ping sur false, le rapport d’administration inclut les données du fichier JSON de l’API ping du projet qui est déclenché lorsque vous définissez fetch-or-not sur true.
Exemple de réponse Copy code{
"report-parameters": {
"report-parameter": "string"
}
}Le paramètre de rapport (ID action) est une chaîne codée qui contient le moment où le rapport d’administration a été déclenché et comment les drapeaux ont été définis.
-
-
Effectuer l’appel GET suivant pour récupérer le rapport d’administration avec l’ID action (paramètre de rapport) obtenu à l’étape 1.
Copy code/qcbin/v2/sa/api/admin-reports/{action-id}En-tête de la demande :
Vous pouvez récupérer 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.
Exemple de réponse :
Copy code{
"admin-reports": {
"projects-ping-result": {
"total-count": "16",
"created-time": "1656309069018",
"project-ping-result": [
{
"id": 1,
"project-name": "p1",
"domain-name": "DEFAULT",
"status": "Inactive",
"ping-result": "SUCCEEDED"
},
…
{
"id": 24,
"project-name": "new_p2",
"domain-name": "A",
"status": "Active",
"ping-result": "SUCCEEDED"
}
]
},
"projects-last-login-activity": {
"total-count": "9",
"created-time": "1656309066384",
"project-last-login-activity": [
{
"id": 23,
"project-name": "new_p",
"domain-name": "A",
"last-login-time": 1656298885000
},
…
{
"id": 24,
"project-name": "new_p2",
"domain-name": "A",
"last-login-time": 1656145476000
}
]
},
"active-sessions": {
"total-count": "1",
"created-time": "1656309066371",
"active-session": [
{
"project-id": 23,
"project-name": "new_p",
"domain-name": "A",
"session-info": [
{
"client-type": "Application Lifecycle Management Client UI",
"session-count": 1
}
]
}
]
},
"projects-repository-size": {
"total-results": "8",
"created-time": "1656309110153",
"project-repository-size": [
{
"id": 1,
"project-name": "p1",
"domain-name": "DEFAULT",
"repository-size": 1509338,
"recyclable-size": 22248
},
…
{
"id": 24,
"project-name": "new_p2",
"domain-name": "A",
"repository-size": 1531586,
"recyclable-size": 22248
}
]
},
"projects-db-space-used": {
"total-count": "16",
"created-time": "1656309068342",
"project-db-space-used": [
{
"id": 1,
"project-name": "p1",
"domain-name": "DEFAULT",
"db-server-name": "127.0.0.1",
"db-server-type": "ORACLE",
"actual-space-used": 4388683776
},
…
{
"id": 24,
"project-name": "new_p2",
"domain-name": "A",
"db-server-name": "127.0.0.1",
"db-server-type": "ORACLE",
"actual-space-used": 4388683776
}
]
}
}
}
Voir aussi :
