Journalisation des messages en Python¶

Utilisation du nom du journaliseur pour définir le niveau de journalisation¶

Vous pouvez utiliser le nom du journaliseur enregistré dans la table d’événements pour définir un seuil pour les entrées de journalisation de ce journaliseur. Cela peut s’avérer utile lorsque vous souhaitez définir le seuil d’un journaliseur de manière à ce qu’il filtre les entrées d’enregistrement indésirables dépassant un certain niveau.

Pour ce faire, vous devez d’abord interroger la table d’événements pour découvrir le nom du journaliseur associé aux entrées pour lesquelles vous souhaitez capturer un niveau de journalisation différent. Ensuite, en utilisant le nom du journaliseur, vous définissez le niveau de journalisation au seuil que vous souhaitez.

Le code de l’exemple suivant demande des entrées de journal, en incluant le nom du journaliseur dans les données renvoyées. Vous pouvez obtenir le nom comme valeur de la colonne de portée.

SET event_table_name='my_db.public.my_event_table';

SELECT
  TIMESTAMP as time,
  RECORD['severity_text'] as log_level,
  SCOPE['name'] as logger_name,
  VALUE as message
FROM
  IDENTIFIER($event_table_name)
WHERE
  RECORD_TYPE = 'LOG';

Cette requête peut renvoyer de nombreuses entrées provenant de plusieurs journaliseurs. Si, après avoir examiné les résultats, vous décidez que vous obtenez de nombreux messages INFO que vous ne souhaitez pas recevoir du journaliseur numpy, vous pouvez utiliser Python pour définir le seuil de ce journaliseur afin de capturer les entrées de journal au niveau ERROR et au-dessus.

numpy_logger = logging.getLogger('numpy_logs')
numpy_logger.setLevel(logging.ERROR)

Pour en savoir plus sur l’interrogation de la table d’événements, voir Affichage des messages de journalisation.

Exemple de procédure stockée¶

Le code de l’exemple suivant importe le module logging, obtient un enregistreur et enregistre un message au niveau INFO.

Pour plus d’informations sur les niveaux de journalisation pris en charge par Python, voir la documentation sur les niveaux de journalisation.

CREATE OR REPLACE PROCEDURE do_logging()
RETURNS VARCHAR
LANGUAGE PYTHON
PACKAGES=('snowflake-snowpark-python')
RUNTIME_VERSION = 3.9
HANDLER='do_things'
AS $$
import logging

logger = logging.getLogger("python_logger")
logger.info("Logging from Python module.")

def do_things(session):
  logger.info("Logging from Python function start.")

  try:
    throw_exception()
  except Exception:
    logger.error("Logging an error from Python handler: ")
    return "ERROR"

  return "SUCCESS"

def throw_exception():
  raise Exception("Something went wrong.")

$$;

Vous pouvez accéder aux messages du journal en exécutant une commande SELECT sur la table d’événements. Pour plus d’informations, voir Affichage des messages de journalisation.

Le code de l’exemple suivant interroge la table d’événements dans laquelle sont stockés les messages du journal. La requête indique la gravité et le message de chaque entrée de journal de la classe du gestionnaire.

SET event_table_name='my_db.public.my_event_table';

SELECT
  RECORD['severity_text'] AS SEVERITY,
  VALUE AS MESSAGE
FROM
  IDENTIFIER($event_table_name)
WHERE
  SCOPE['name'] = 'python_logger'
  AND RECORD_TYPE = 'LOG';

L’exemple précédent génère la sortie suivante.

---------------------------------------------------------------------------
| SEVERITY | MESSAGE                                                      |
---------------------------------------------------------------------------
| "INFO"   | "Logging from Python module."                                |
---------------------------------------------------------------------------
| "INFO"   | "Logging from Python function start."                        |
---------------------------------------------------------------------------
| "ERROR"  | "Logging an error from Python handler."                      |
---------------------------------------------------------------------------

Exemples Streamlit¶

Le code de l’exemple suivant importe le module logging, obtient un enregistreur et enregistre un message au niveau INFO.

Pour plus d’informations sur les niveaux de journalisation pris en charge par Python, voir la documentation sur les niveaux de journalisation.

import streamlit as st
import logging

logger = logging.getLogger('app_logger')

st.title("Streamlit logging example")

hifives_val = st.slider("Number of high-fives", min_value=0, max_value=90, value=60)

if st.button("Submit"):
    logger.info(f"Submitted with high-fives: {hifives_val}")