Protokollierung und Ablaufverfolgung für Streamlit in Snowflake¶

Protokollierungsmodul von Python¶

Verwenden Sie das in Python integrierte logging-Modul, um Protokollmeldungen von Ihrer App auszugeben. Im folgenden Beispiel wird ein Logger konfiguriert, der Meldungen auf INFO-Ebene und höher an die Standardausgabe schreibt:

import logging
import sys

logging.basicConfig(
    level=logging.INFO,
    format="%(asctime)s %(levelname)s %(name)s: %(message)s",
    stream=sys.stdout,
)

LOGGER = logging.getLogger("my_app")

In der Reihenfolge vom geringsten zum höchsten Schweregrad hat Python die folgenden Protokolliergrade:

• DEBUG

• INFO

• WARNING

• ERROR

Das Einstellen des Grads auf INFO erfasst INFO-, WARNING- und ERROR-Meldungen, aber nicht DEBUG-Meldungen.

Nachdem Sie den Logger konfiguriert haben, können Sie ihn verwenden, um Meldungen im gesamten App-Code zu protokollieren. Es ist üblich, einen Logger in einem separaten Modul zu definieren und ihn dann in den Code Ihrer App zu importieren:

source_directory/
├── my_logger.py
├── pyproject.toml
└── streamlit_app.py

import streamlit as st
from my_logger import LOGGER

LOGGER.info("Home page loaded")
st.title("My App")

if st.button("Run analysis"):
    LOGGER.info("Analysis button clicked")
    try:
        result = run_analysis()
        LOGGER.info("Analysis completed successfully")
    except Exception as e:
        LOGGER.error("Analysis failed: %s", e)
        st.error("Analysis failed: %s", e)

Live-Protokolle in Snowsight¶

Wenn Sie eine Container-Laufzeit-App in Snowsight bearbeiten, wird unterhalb des Editors ein Protokollbereich angezeigt. Dieser Bereich streamt Protokollmeldungen in Echtzeit, sobald Ihre App sie ausgibt. Wenn Sie zum ersten Mal eine Verbindung herstellen, wird ein kurzer Verlauf der neuesten Protokolle angezeigt.

Jeder Protokolleintrag enthält die folgenden Informationen:

Verfügbare Live-Protokoll-Aktionen¶

In der rechten oberen Ecke des Protokollbereichs können Sie die Protokolle durchsuchen und filtern, um die benötigten Informationen zu finden. Dazu gehören die Textsuche, das Filtern nach Quelle und das Filtern nach Schweregrad. Im Drei-Punkte-Menü können Sie die aktuellen Protokolle herunterladen, zu den historischen Protokollen navigieren oder den Bereich für die Live-Protokollierung löschen. Wenn Sie den Bereich löschen, werden die aktuellen Protokolleinträge aus Ihrer aktuellen Ansicht gelöscht, jedoch nicht aus der Ereignistabelle. Beim sofortigen Neuladen der Seite werden die jüngsten Protokolleinträge wiederhergestellt.

Erläuterungen zu Protokollquellen¶

Protokolle von Container-Laufzeit-Apps haben eine von zwei Quellen:

• MANAGER: Der Systemprozess innerhalb des Containers, der Ihre App vorbereitet und ausführt. Die Manager-Protokolle enthalten Meldungen zum Herunterladen Ihrer App-Dateien aus dem Stagingbereich, zum Installieren von Python-Abhängigkeiten und zum Starten des Streamlit-Serverprozesses. Wenn Sie die Abhängigkeitsdateien Ihrer App aktualisieren, während die App ausgeführt wird, installiert der Manager-Prozess die Abhängigkeiten neu und erstellt zusätzliche Manager-Protokolle.

• APP: Protokolle des laufenden Streamlit-Serverprozesses. Dazu gehören Meldungen von Ihren benutzerkonfigurierten Python-Loggern, dem integrierten Streamlit-Logger und allen anderen Ausgaben, die Ihre App auf die Standardausgabe oder den Standardfehler schreibt.

Die Grenze zwischen den Quellen ist der streamlit run-Befehl. Alles, was der Container vor dem Start des Streamlit-Prozesses ausführt, erzeugt MANAGER-Protokolle. Nachdem der Streamlit-Prozess gestartet ist, erzeugt die Ausgabe dieses Prozesses APP-Protokolle.

Historische Protokolle in Snowsight anzeigen¶

Die folgenden Schritte gelten nur für Container-Laufzeit-Apps. Warehouse-Laufzeit-Apps haben keinen Protokollbereich.

1. Melden Sie sich bei Snowsight an.

2. Wählen Sie im Navigationsmenü die Option Projects » Streamlit und dann Ihre App aus.

3. Wählen Sie in der rechten oberen Ecke der Seite die Option Edit aus.

4. Wählen Sie in der rechten oberen Ecke des Protokollbereichs das Drei-Punkte-Menü aus (Other actions) » Historical logs.

Dadurch wird die Snowpark Container Services-Überwachungsseite für den Dienst geöffnet, der im Hintergrund Ihrer App ausgeführt wird. Die Tabelle der Protokolle enthält die folgenden Spalten:

Weitere Informationen zur Überwachungsseite finden Sie unter Snowpark Container Services: Überwachen von Diensten.

Abfrageprotokolle mit SQL¶

Sie können die Ereignistabelle direkt abfragen, um die Protokolle Ihrer Container-Laufzeit-App zu analysieren. Die folgende Abfrage ruft Protokolle von einer bestimmten Streamlit-App ab:

SELECT
    TIMESTAMP,
    RECORD['severity_text']::VARCHAR AS level,
    VALUE::VARCHAR AS message,
    RESOURCE_ATTRIBUTES['snow.database.name']::VARCHAR AS database_name,
    RESOURCE_ATTRIBUTES['snow.schema.name']::VARCHAR AS schema_name,
    RESOURCE_ATTRIBUTES['snow.executable.name']::VARCHAR AS app_name,
    RECORD_ATTRIBUTES['log.iostream']::VARCHAR AS stream
FROM <event_table>
WHERE RESOURCE_ATTRIBUTES['snow.database.name'] = '<database_name>'
  AND RESOURCE_ATTRIBUTES['snow.schema.name'] = '<schema_name>'
  AND RESOURCE_ATTRIBUTES['snow.executable.name'] = '<app_name>'
  AND RECORD_TYPE = 'LOG'
  AND TIMESTAMP > DATEADD(hour, -1, CURRENT_TIMESTAMP())
ORDER BY TIMESTAMP DESC
LIMIT 100;

Ersetzen Sie <event_table> mit dem Namen der Ereignistabelle, die vom SHOW PARAMETERS-Befehl zurückgegeben wird, und ersetzen Sie <database_name>, <schema_name> und <app_name> mit den Werten für Ihre Streamlit-App.

Weitere Informationen zu den Spalten der Ereignistabelle finden Sie unter Spalten von Ereignistabellen.

Beispiel: Protokollierung von einer Warehouse-Laufzeit-App¶

import logging
import streamlit as st

logger = logging.getLogger("simple_logger")

# Write directly to the app
st.title("Simple Logging Example")

# Get the current credentials
session = st.connection('snowflake').session()

def get_log_messages_query() -> str:
    return """
            SELECT
                TIMESTAMP,
                RECORD:"severity_text"::VARCHAR AS SEVERITY,
                RESOURCE_ATTRIBUTES:"db.user"::VARCHAR AS USER,
                VALUE::VARCHAR AS VALUE
            FROM
                SAMPLE_EVENTS
            WHERE
                SCOPE:"name" = 'simple_logger'
            ORDER BY
                TIMESTAMP DESC;
            """

button = st.button("Log a message")

if button:
    try:
        logger.info("Logging an info message through Streamlit App.")
        st.success('Logged a message')
    except Exception as e:
        logger.error("Logging an error message through Streamlit App: %s",e)
        st.error('Logged an error')

sql = get_log_messages_query()

df = session.sql(sql).to_pandas()

with st.expander("**Show All Messages**"):
     st.dataframe(df, use_container_width=True)