GSLog - Champ d’application, global

  • Rversion finale: Xanadu
  • Mis à jour 1 août 2024
  • 3 minutes de lecture

    • GSLog est un include de script qui simplifie la journalisation et le débogage des scripts en implémentant des niveaux de sortie de journal, sélectionnables par les valeurs de sys_properties identifiées par appelant.

    Les logs peuvent être au niveau du débogage, de l’info, de l’avis, de l’avertissement, de l’erreur ou du critique (après BSD syslog.h et suiveurs). Le niveau de journalisation par défaut est notice, les niveaux doivent donc être choisis en conséquence.

    À utiliser pour n’importe quel script côté serveur dans lequel vous souhaitez implémenter la journalisation des événements.

    Pour plus d’informations, consultez Débogage de scripts.

    GSLog – GSLog()

    Instancie un objet GSLog .

    Tableau 1. Paramètres
    Nom Type Description
    traceProperty (en anglais seulement) Chaîne Propriété système qui contient une valeur indiquant le niveau auquel ou au-dessus duquel les messages seront écrits dans le journal.
    appelant Chaîne Nom du script appelant l’enregistreur. 
    var gl = new GSLog("com.snc.sla.tasksla.log", "TaskSLA");

    GSLog – debugOn()

    Détermine si le débogage est activé.

    Tableau 2. Paramètres
    Nom Type Description
    Aucun
    Tableau 3. Renvoie
    Type Description
    Booléen

    Marqueur indiquant si le débogage est activé ou désactivé.

    Valeurs valides :
    • true : le débogage est activé.
    • faux : le débogage est désactivé.
    		 
    var gl = new GSLog("com.snc.sla.tasksla.log", "TaskSLA"); 
gl.setLevel("debug");
gs.print(gl.debugOn());

    Sortie :

    *** Script : true

    GSLog – getLevel(niveau de la chaîne)

    Renvoie le niveau de journalisation.

    Tableau 4. Paramètres
    Nom Type Description
    niveau Chaîne Facultatif. Niveau de journal.
    Tableau 5. Renvoie
    Type Description
    Chaîne Niveau de journal. 
    var gl = new GSLog("com.snc.sla.tasksla.log", "TaskSLA"); 
gl.setLevel("debug");
gs.print(gl.getLevel());

    Sortie :

    *** Script: debug

    GSLog – initialize(String traceProperty, String caller)

    Appelé par le Prototype JavaScript Framework lors de la création d’un objet pour initialiser une nouvelle instance de cette classe. Fournissez les paramètres d’entrée, mais n’appelez pas cette méthode directement.

    Tableau 6. Paramètres
    Nom Type Description
    traceProperty (en anglais seulement) Chaîne Propriété système qui contient une valeur indiquant le niveau auquel ou au-dessus duquel les messages seront écrits dans le journal.
    appelant Chaîne Nom du script appelant l’enregistreur.
    Tableau 7. Renvoie
    Type Description
    Aucun 
    var gl = new GSLog("com.snc.sla.tasksla.log", "TaskSLA");

    GSLog – log(niveau de la chaîne, message de la chaîne)

    Consigne un message au niveau spécifié.

    Tableau 8. Paramètres
    Nom Type Description
    niveau Chaîne Niveau de journal.
    msg Chaîne Message à écrire dans le journal.
    Tableau 9. Renvoie
    Type Description
    Aucun 
    var gl = new GSLog("com.snc.sla.tasksla.log", "TaskSLA"); 
gl.log("debug", "debug message");

    GSLog – logAlert(String msg)

    Consigne les événements d’alerte.

    Tableau 10. Paramètres
    Nom Type Description
    msg Chaîne Message à écrire dans le journal.
    Tableau 11. Renvoie
    Type Description
    Aucun 
    var gl = new GSLog("com.snc.sla.tasksla.log", "TaskSLA"); 
gl.logAlert("This is an alert");

    Sortie :

    *** Script [TaskSLA]: This is an alert

    GSLog – logCrit(String msg)

    Consigne les événements critiques.

    Tableau 12. Paramètres
    Nom Type Description
    msg Chaîne Message à écrire dans le journal.
    Tableau 13. Renvoie
    Type Description
    Aucun 
    var gl = new GSLog("com.snc.sla.tasksla.log", "TaskSLA"); 
gl.logCrit("This is a critical message");

    Sortie :

    *** Script [TaskSLA]: This is a critical message

    GSLog – logDebug(String msg)

    Consigne les événements de débogage.

    Tableau 14. Paramètres
    Nom Type Description
    msg Chaîne Message à écrire dans le journal.
    Tableau 15. Renvoie
    Type Description
    Aucun 
    var gl = new GSLog("com.snc.sla.tasksla.log", "TaskSLA"); 
gl.logDebug("This is a debug message");

    Sortie :

    *** Script [TaskSLA]: This is a debug message

    GSLog – logEmerg(chaîne msg)

    Consigne les événements d’urgence.

    Tableau 16. Paramètres
    Nom Type Description
    msg Chaîne Message à écrire dans le journal.
    Tableau 17. Renvoie
    Type Description
    Aucun 
    var gl = new GSLog("com.snc.sla.tasksla.log", "TaskSLA"); 
gl.logEmerg("This is an emergency message");

    Sortie :

    *** Script  [TaskSLA ] : This is an emergency message

    GSLog – logErr(String msg)

    Consigne les événements d’erreur.

    Tableau 18. Paramètres
    Nom Type Description
    msg Chaîne Message à écrire dans le journal.
    Tableau 19. Renvoie
    Type Description
    Aucun 
    var gl = new GSLog("com.snc.sla.tasksla.log", "TaskSLA"); 
gl.logErr("This is an error message");

    Sortie :

    *** Script [TaskSLA]: This is an error message

    GSLog – logInfo(String msg)

    Consigne les événements d’information.

    Tableau 20. Paramètres
    Nom Type Description
    msg Chaîne Message à écrire dans le journal.
    Tableau 21. Renvoie
    Type Description
    Aucun 
    var gl = new GSLog("com.snc.sla.tasksla.log", "TaskSLA"); 
gl.logInfo("This is an info message");

    GSLog – logNotice(String msg)

    Les journaux signalent des événements.

    Tableau 22. Paramètres
    Nom Type Description
    msg Chaîne Message à écrire dans le journal.
    Tableau 23. Renvoie
    Type Description
    Aucun 
    var gl = new GSLog("com.snc.sla.tasksla.log", "TaskSLA"); 
gl.logNotice("This is a notice");

    Sortie :

    *** Script [TaskSLA]: This is a notice

    GSLog – logWarning(String msg)

    Consigne les événements d’avertissement.

    Tableau 24. Paramètres
    Nom Type Description
    msg Chaîne Message à écrire dans le journal.
    Tableau 25. Renvoie
    Type Description
    Aucun 
    var gl = new GSLog("com.snc.sla.tasksla.log", "TaskSLA"); 
gl.logWarning("This is a warning message");

    Sortie :

    *** Script [TaskSLA]: This is a warning message

    GSLog – setLevel(Niveau de la chaîne)

    Définit le niveau de journalisation.

    Tableau 26. Paramètres
    Nom Type Description
    niveau Chaîne Niveau de journal à définir.
    Tableau 27. Renvoie
    Type Description
    Aucun 
    var gl = new GSLog("com.snc.sla.tasksla.log", "TaskSLA"); 
gl.setLevel("debug");