Définition des niveaux de journalisation, des métriques et du traçage¶
Vous pouvez définir les niveaux de seuil pour les données de journalisation, de traçage ou de télémétrie capturées dans un tableau des événements.
Chaque type de données de télémétrie prend en charge son propre ensemble de niveaux spécifiques à son objectif. Vous pouvez définir ces niveaux en utilisant le paramètre que Snowflake pourvoit à chacun. Vous pouvez également définir certains niveaux en utilisant Snowsight, qui représente les paramètres de niveau de manière simplifiée.
Pour chaque type de données de télémétrie, vous pouvez effectuer les opérations suivantes :
Définissez des niveaux spécifiques à chaque type de données de télémétrie.
Définissez des niveaux à l’échelle du système pour chacun d’eux qui sont en vigueur sauf s’ils sont remplacés.
Remplacez les niveaux à l’échelle du système en définissant le niveau pour une session ou sur des objets spécifiques (tels que les procédures et UDFs).
Les niveaux sont représentés à la fois comme des paramètres de session et des paramètres d’objet.
Note
Vous pouvez utiliser le code du gestionnaire pour remplacer le niveau de journalisation que vous avez défini avec SQL (comme décrit dans cette rubrique) lorsque votre gestionnaire est écrit en Python. Pour plus d’informations, voir Remplacement des niveaux de seuil de journalisation avec Python.
Portée¶
Pour chaque type de données télémétriques, vous pouvez définir des niveaux afin qu’ils s’appliquent à la portée qui correspond le mieux à vos exigences. Dans de nombreux cas, vous pouvez remplacer les niveaux définis dans une portée plus large en les définissant dans une portée plus restreinte, comme décrit dans Comment Snowflake détermine le niveau en vigueur. Par exemple, vous pouvez souhaiter disposer d’un ensemble de niveaux par défaut dans la portée du compte, puis définir différents niveaux pour les objets d’une base de données particulière.
Vous pouvez définir chacun d’entre eux selon les portées suivantes :
- Compte:
Un niveau défini pour le compte est en vigueur partout dans le compte, sauf lorsqu’il est remplacé par un niveau défini au niveau de l’objet ou de la session.
- Objet:
Vous pouvez définir les niveaux de télémétrie sur les types d’objets suivants :
Base de données ou schéma contenant des procédures et des fonctions
Procédure stockée
Fonction définie par l’utilisateur (UDF) ou fonction de table définie par l’utilisateur (UDTF)
Par exemple, pour définir le niveau de journalisation pour une UDF spécifique, utilisez ALTER FUNCTION pour définir le paramètre LOG_LEVEL pour cette UDF. Autre exemple, pour définir le niveau de journalisation par défaut pour toutes les fonctions et procédures d’une base de données, utilisez ALTER DATABASE pour définir le paramètre LOG_LEVEL sur cette base de données.
Note
Vous ne pouvez pas définir le niveau que sur les objets Streamlit. Définissez plutôt le niveau sur la base de données ou le schéma contenant l’objet.
- Session:
Vous pouvez définir le niveau de télémétrie des appels aux fonctions et aux procédures effectués dans la session en cours.
Niveaux¶
Vous pouvez définir les niveaux suivants pour chaque type de données télémétriques :
- Connexion:
Lorsque vous définissez un niveau, seules les données à ce niveau et aux niveaux de sévérité supérieurs sont capturées dans un tableau des événements et visibles dans l’Snowsight. Par exemple, si le paramètre LOG_LEVEL est réglé sur WARN, les messages des niveaux WARN, ERROR et FATAL sont saisis dans la table d’événements.
Définissez le paramètre LOG_LEVEL.
- Métriques:
Vous pouvez actuellement capturer toutes les données de métriques ou aucune.
Définissez le paramètre METRIC_LEVEL.
- Traçage:
Vous pouvez spécifier les caractéristiques suivantes :
Portée des données des événements tracés stockées dans le tableau des événements
Définissez le paramètre TRACE_LEVEL.
S’il faut capturer le texte SQL dans une instruction SQL tracée
Cela est déterminé par le paramètre SQL_TRACE_QUERY_TEXT. Pour plus d’informations, voir Traçage des instructions SQL.
Privilèges nécessaires¶
Pour définir des niveaux sur un objet, vous devez utiliser un rôle qui bénéficie ou hérite des privilèges décrits dans cette section.
Par exemple, le code de l’exemple suivant accorde les privilèges nécessaires à une personne utilisant le rôle central_log_admin
permettant de définir le niveau de journalisation du compte :
GRANT MODIFY LOG LEVEL ON ACCOUNT TO ROLE central_log_admin;
Pour plus d’informations sur ces privilèges, voir Privilèges de contrôle d’accès.
Niveau à modifier |
Paramètre à définir |
Privilèges nécessaires |
---|---|---|
Niveau de journalisation |
Compte
Objet
Session
|
|
Niveau de métrique |
Compte
Objet
Session
|
|
Niveau de trace |
Compte
Objet
Session
|
|
Texte SQL dans le SQL |
Compte
|
Définition des niveaux de télémétrie¶
Vous pouvez définir les niveaux de télémétrie à l’aide de SQL ou, dans certains cas, de l’Snowsight. Dans de nombreux cas, vous pouvez remplacer les niveaux définis dans une portée plus large en les définissant dans une portée plus restreinte, comme décrit dans Comment Snowflake détermine le niveau en vigueur.
Avant de définir les niveaux, vérifiez que vous avez accès à un rôle avec les privilèges nécessaires.
Vous pouvez utiliser Snowsight pour définir les niveaux de télémétrie au niveau du compte.
Connectez-vous à Snowsight.
Dans le menu de navigation, sélectionnez Monitoring » Traces and Logs.
Sur la page Traces & Logs , sélectionnez Set Event Level.
Pour Set logging & tracing for, sélectionnez la portée de votre choix parmi l’une des portées suivantes :
Account
La base de données et, éventuellement, le schéma
Sélectionnez les niveaux de données télémétriques que vous souhaitez ajuster.
All Events
On pour activer la collecte pour tous les types de données de télémétrie ; Off pour désactiver la collecte de tous les types de données.
Traces
On pour définir la collecte de données de trace sur
ALWAYS
; Off pour définir la collecte de données de trace surOFF
. Pour plus d’informations sur les niveaux, voir TRACE_LEVEL.Logs
On pour définir la collecte des données du journal sur
INFO
. Pour plus d’informations sur les niveaux, voir LOG_LEVEL.Metrics
On pour définir la collecte de données de trace sur
ALL
; Off pour définir la collecte de données de trace surNONE
. Pour plus d’informations sur les niveaux, voir METRIC_LEVEL.
Vous pouvez utiliser le SQL pour définir les niveaux de télémétrie pour le compte et pour des objets tels que les bases de données, les fonctions et les procédures.
Utilisez la commande ALTER ACCOUNT pour définir le paramètre approprié, basé sur les données de télémétrie que vous souhaitez collecter.
L’exemple suivant définit le niveau de journalisation sur ERROR pour le compte :
-- Set the log level on the account
ALTER ACCOUNT SET LOG_LEVEL = ERROR;
Utilisez la commande ALTER <objet> pour définir le paramètre LOG_LEVEL sur l’objet.
L’exemple suivant définit le niveau de journalisation sur ERROR pour toutes les fonctions et procédures de la base de données db
. L’exemple remplace ce niveau par WARN pour l’UDF f1(int)
.
USE ROLE central_log_admin;
-- Set the log levels on a database and UDF.
ALTER DATABASE db1 SET LOG_LEVEL = ERROR;
ALTER FUNCTION f1(int) SET LOG_LEVEL = WARN;
-- Set the log levels on a Snowpark Container Services service.
ALTER SERVICE test_service SET LOG_LEVEL = ERROR;
Pour plus de détails sur la façon dont Snowflake détermine le niveau de journalisation effectif lorsque le LOG LEVEL est défini sur différents objets, voir Comment Snowflake détermine le niveau en vigueur.
Utilisez la commande ALTER SESSION pour définir le paramètre LOG_LEVEL de la session en cours.
USE ROLE developer_debugging;
-- Set the logging level to DEBUG for the current session.
ALTER SESSION SET LOG_LEVEL = DEBUG;
Si le paramètre de niveau est défini sur différents niveaux pour la session en cours et pour les fonctions et procédures appelées dans cette session, Snowflake détermine le niveau effectif à utiliser. Voir Comment Snowflake détermine le niveau en vigueur.
Comment Snowflake détermine le niveau en vigueur¶
Vous pouvez remplacer les paramètres de niveau de télémétrie (à la fois pour les objets et les sessions) en utilisant une hiérarchie de niveaux.
Par exemple, vous pouvez définir un niveau sur une valeur pour le compte, puis le remplacer en définissant le niveau pour un objet qui est plus bas dans la hiérarchie.
La hiérarchie des paramètres au niveau de la session et de l’objet est décrite ci-après.
Pour les paramètres de session, la hiérarchie est Compte » Utilisateur » Session.
Cela signifie que vous pouvez définir le paramètre pour un compte, remplacer le paramètre au niveau du compte pour un utilisateur et remplacer le paramètre au niveau de l’utilisateur pour la session en cours.
Pour les paramètres de l’objet, la hiérarchie est Compte » Base de données » Schéma » Objet.
Cela signifie que vous pouvez définir le paramètre pour un compte, remplacer le paramètre au niveau du compte pour une base de données ou un schéma, et remplacer le paramètre au niveau de la base de données ou du schéma pour des procédures stockées spécifiques et des UDFs dans cette base de données ou ce schéma.
Par exemple, le LOG_LEVEL d’une fonction remplace le LOG_LEVEL du compte qui contient la fonction. Si le LOG_LEVEL du compte est FATAL et le LOG_LEVEL de l’UDF Java du compte est INFO, le LOG_LEVEL effectif est INFO (le niveau de la fonction, pas du compte) :
ALTER ACCOUNT SET LOG_LEVEL = FATAL;
ALTER FUNCTION MyJavaUDF SET LOG_LEVEL = INFO;
-- The INFO log level is used because the FUNCTION MYJAVAUDF
-- is lower than the ACCOUNT in the hierarchy.
Dans les cas où le niveau est défini à la fois dans les hiérarchies de paramètres de session et d’objet, le niveau le plus verbeux est utilisé.
Pour le niveau de journalisation, le tableau suivant présente des exemples de la manière dont les paramètres définis pour la session et l’objet affectent le niveau de journalisation utilisé.
Valeur de la session
Valeur de l’objet, du schéma, de la base de données ou du compte
Niveau de journalisation utilisé
(non défini)
WARN
WARN
DEBUG
(non défini)
DEBUG
WARN
ERROR
WARN
INFO
DEBUG
DEBUG
(non défini)
(non défini)
OFF
Pour le niveau métrique —
ALL
remplaceNONE
.Pour le niveau de trace —
ALWAYS
remplaceON_EVENT
etOFF
;ON_EVENT
remplaceOFF
.