Configure logging and event tracing for an app¶
This topic describes how providers can configure a Snowflake Native App to record log messages and trace events.
About log messages and trace events in an app¶
The Snowflake Native App Framework supports using the Snowflake logging and tracing functionality to gather information about an app. Providers can configure an app to record and analyze the following:
Log messages — Independent, detailed messages with information about the state of a specific piece app code.
Trace events — Structured data that providers can use to get information spanning and grouping multiple parts of your code. Trace events allows an app to emit information related to its performance and behavior.
To configure an app to emit log messages and trace events, providers set the log and trace levels in the manifest file. See Set the log and trace levels for an app.
Providers can also configure an app to use event sharing to allow the consumer to share the log messages and trace events with the provider. See About event sharing for more information.
About event sharing¶
Event sharing allows the provider to collect information about an app’s performance and behavior. A provider can configure an app to request that the consumers share the log messages and trace events with the provider. Event sharing requires that the provider and consumer configure an event table in their account to store the log messages and trace events emitted by the app.
When event sharing is enabled, the log messages and trace events that are inserted into the event table in the consumer account are also inserted into the event table in provider account.
Considerations when using event sharing¶
Before configuring logging and event sharing for an app, providers must consider the following:
Providers are responsible for all costs associated with event sharing on the provider side, including data ingestion and storage.
Providers must have an account to store shared events in each region where you want to support event sharing.
Providers must define the default log level and trace level for an app in the manifest file.
Note
Event sharing cannot be enabled for an app that is installed in the same account as the application package it is based on. To test event sharing for an app, providers must use multiple accounts.
Considerations when migrating from the previous event sharing functionality¶
When migrating from the existing event sharing functionality to use event definitions, providers should consider the following.
The previous event sharing functionality is equivalent to the OPTIONAL ALL event definition.
Published versions and patches of an app that used the previous functionality will have the OPTIONAL ALL event definition by default. Providers do not need to add this event definition to the manifest file.
To begin using event definitions, providers can add supported event definitions to the manifest file. This is applicable to new apps as well as new versions and patches of existing apps.
Note
To being begin requesting more granular log and event sharing, providers only have to add event definitions to the manifest file. No other actions are required for providers.
Workflow - Set up event sharing for an app¶
Event sharing allows consumers to share log messages and trace events with the provider.
The following workflow shows how to set up and enable event sharing for an app:
The provider sets the log and trace levels for the app.
The provider adds event definitions to the manifest file.
Event definitions act as filters on the log messages and trace events emitted by the app. Providers can configure event definitions to be required or optional.
The provider sets up an event table in their organization.
The provider publishes the app.
When a consumer installs an app, they can set up an event table and enable event sharing. See Enable logging and event sharing for an app for more information on the consumer requirements for event sharing.