Guide du kit de développement logiciel Veritas NetBackup Parallel Streaming Framework pour développeurs

Activation de la consignation pour le plug-in

Cette section contient les rubriques suivantes :

NetBackup consigne les informations sur les divers processus de client et de serveur NetBackup dans un répertoire de journal. Un administrateur NetBackup peut configurer le niveau de consignation pour déterminer les informations à inclure dans les journaux. Le niveau de consignation peut aller de 0 à 5, où le nombre le plus élevé correspond aux journaux les plus détaillés.

Tous les journaux des opérations de politique BigData sont enregistrés dans les sous-répertoires des emplacements suivants :

Pour plus d'informations sur les journaux et la consignation, consultez les références suivantes :

Le tableau suivant répertorie les informations sur les journaux disponibles pour les plug-ins NetBackup :

L'API du kit de développement logiciel NetBackup PSF permet au plug-in de consigner les informations de manière cohérente avec les autres processus NetBackup. Le plug-in utilise la fonction aapi_session_def_t->sd_log pour consigner les messages dans le même fichier que NetBackup. Par exemple, les messages du journal de l'application de découverte et de la session de découverte du plug-in sont classés et placés dans le même fichier, dans le répertoire <chemin_installation> /NetBackup/logs/nbaapidiscv. Les messages de journal consolidés affichent les informations associées dans un ordre séquentiel et vous aident à résoudre les problèmes du plug-in. Les messages de journal contiennent un horodatage et l'ID de processus qui est utile quand plusieurs processus s'exécutent en même temps.

Plusieurs niveaux de débogage sont applicables aux fichiers journaux et les niveaux applicables pour le développeur de plug-in sont définis dans le fichier aapi_common.h. Utilisez l'un de ces niveaux dans le paramètre de gravité de la méthode sd_log. Assurez-vous que vous utilisez le bon niveau de gravité de débogage, afin que les journaux soient utiles pour le dépannage.

La liste suivante affiche les niveaux de consignation et leur description :

Les défaillances critiques, les avertissements et les erreurs sont consignés même si vous définissez le niveau de consignation sur le niveau minimal.

Pour plus d'informations sur les niveaux de consignation, consultez l'article suivant :

À propos des niveaux de consignation globaux

Vous pouvez activer le plug-in pour qu'il ajoute des entrées d'information dans les journaux NetBackup existants et appropriés pour les opérations de découverte, de sauvegarde ou de restauration. Le plug-in doit appeler la méthode sd_log fournie par l'objet de session, qui identifie la méthode de consignation propre à l'opération. L'objet de session est disponible avec l'API aapi_pgn_open_server initiale utilisée par le plug-in pour communiquer avec la charge de travail.

Voici un exemple qui illustre la manière dont vous pouvez utiliser l'objet de session dans le plug-in pour activer la consignation :

const aapi_session_def_t *g_session_definition;
//holds the session object globally

void setGlobalSessionDef(const aapi_session_def_t * sd)
{
	g_session_definition = sd;
}
const aapi_session_def_t * getGlobalSessionDef() {
return g_session_definition;
}

#define INFO getGlobalSessionDef(), AAPI_ESINFO, __FUNCTION__
#define WARNING getGlobalSessionDef(), AAPI_ESWARN, __FUNCTION__
#define DEBUG getGlobalSessionDef(), AAPI_ESDEBUG, __FUNCTION__
#define ERROR getGlobalSessionDef(), AAPI_ESERROR, __FUNCTION__
#define CRITICAL getGlobalSessionDef(), AAPI_ESCRITICAL, __FUNCTION__
#define SAMPLEPGN_LOG(x) LogMsg x;

//open_server implementation gets the session object stored
in the global session instance

pgn_open_server

(const aapi_session_def_t *session, const aapi_server_name_t aapi_server_name,
const aapi_cred_t *credentials, aapi_pgn_server_handle_t *sh)

{
	setGlobalSessionDef(session);
	SAMPLEPGN_LOG(DEBUG,"entering");
	...
}
//The wrapper log method is used to write to NetBackup logs.
//This method can either directly use the global session object, or
//accept the session instance as an input parameter for log writing

void LogMsg
(const aapi_session_def_v1_t *sd, aapi_severity_v1_t severity_level,
char *function, char *fmt, ...)

{
	//format the log message
	//log to NetBackup logs using session's sd_log method
	sd->sd_log("PLUGIN_APPTYPE_VERSION", formatted_message, severity_level);
}

Pour l'implémentation du code de consignation, consultez la rubrique À propos de l'exemple de plug-in.

Nous vous recommandons d'utiliser une chaîne unique et spécifique (dans l'idéal, le type et la version du plug-in) pour le plug-in en tant que premier paramètre dans l'appel sd_log. Cette chaîne spécifiée est le préfixe pour chaque message de journal et facilite l'identification des entrées spécifiques au plug-in dans le fichier journal