eventlog.md

Certain notable events are reported using a structured format. Commonly, these notable events are also copied to the table system.eventlog, unless the cluster setting server.eventlog.enabled is unset.

Additionally, notable events are copied to specific external logging channels in log messages, where they can be collected for further processing.

The sections below document the possible notable event types in this version of CockroachDB. For each event type, a table documents the possible fields. A field may be omitted from an event if its value is empty or zero.

A field is also considered "Sensitive" if it may contain application-specific information or personally identifiable information (PII). In that case, the copy of the event sent to the external logging channel will contain redaction markers in a format that is compatible with the redaction facilities in cockroach debug zip and cockroach debug merge-logs, provided the redactable functionality is enabled on the logging sink.

Events not documented on this page will have an unstructured format in log messages.

Cluster-level events

Events in this category pertain to an entire cluster and are not relative to any particular tenant.

In a multi-tenant setup, the system.eventlog table for individual tenants cannot contain a copy of cluster-level events; conversely, the system.eventlog table in the system tenant cannot contain the SQL-level events for individual tenants.

Events in this category are logged to the OPS channel.

certs_reload

An event of type certs_reload is recorded when the TLS certificates are reloaded/rotated from disk.

Field	Description	Sensitive
Success	Whether the operation completed without errors.	no
ErrorMessage	If an error was encountered, the text of the error.	yes

Common fields

Field	Description	Sensitive
Timestamp	The timestamp of the event. Expressed as nanoseconds since the Unix epoch.	no
EventType	The type of the event.	no

node_decommissioned

An event of type node_decommissioned is recorded when a node is marked as decommissioned.

Common fields

Field	Description	Sensitive
Timestamp	The timestamp of the event. Expressed as nanoseconds since the Unix epoch.	no
EventType	The type of the event.	no
RequestingNodeID	The node ID where the event was originated.	no
TargetNodeID	The node ID affected by the operation.	no

node_decommissioning

An event of type node_decommissioning is recorded when a node is marked as decommissioning.

Common fields

Field	Description	Sensitive
Timestamp	The timestamp of the event. Expressed as nanoseconds since the Unix epoch.	no
EventType	The type of the event.	no
RequestingNodeID	The node ID where the event was originated.	no
TargetNodeID	The node ID affected by the operation.	no

node_join

An event of type node_join is recorded when a node joins the cluster.

Common fields

Field	Description	Sensitive
Timestamp	The timestamp of the event. Expressed as nanoseconds since the Unix epoch.	no
EventType	The type of the event.	no
NodeID	The node ID where the event was originated.	no
StartedAt	The time when this node was last started.	no
LastUp	The approximate last time the node was up before the last restart.	no

node_recommissioned

An event of type node_recommissioned is recorded when a decommissioning node is recommissioned.

Common fields

Field	Description	Sensitive
Timestamp	The timestamp of the event. Expressed as nanoseconds since the Unix epoch.	no
EventType	The type of the event.	no
RequestingNodeID	The node ID where the event was originated.	no
TargetNodeID	The node ID affected by the operation.	no

node_restart

An event of type node_restart is recorded when an existing node rejoins the cluster after being offline.

Common fields

Field	Description	Sensitive
Timestamp	The timestamp of the event. Expressed as nanoseconds since the Unix epoch.	no
EventType	The type of the event.	no
NodeID	The node ID where the event was originated.	no
StartedAt	The time when this node was last started.	no
LastUp	The approximate last time the node was up before the last restart.	no

Debugging events

Events in this category pertain to debugging operations performed by operators or (more commonly) Cockroach Labs employees. These operations can e.g. directly access and mutate internal state, breaking system invariants.

Events in this category are logged to the OPS channel.

debug_send_kv_batch

An event of type debug_send_kv_batch is recorded when an arbitrary KV BatchRequest is submitted to the cluster via the debug send-kv-batch CLI command.

Field	Description	Sensitive
BatchRequest		yes

Common fields

Field	Description	Sensitive
Timestamp	The timestamp of the event. Expressed as nanoseconds since the Unix epoch.	no
EventType	The type of the event.	no
NodeID	The node ID where the event originated.	no
User	The user which performed the operation.	yes

Health events

Events in this category pertain to the health of one or more servers.

Events in this category are logged to the HEALTH channel.

runtime_stats

An event of type runtime_stats is recorded every 10 seconds as server health metrics.

Field	Description	Sensitive
MemRSSBytes	The process resident set size. Expressed as bytes.	no
GoroutineCount	The number of goroutines.	no
MemStackSysBytes	The stack system memory used. Expressed as bytes.	no
GoAllocBytes	The memory allocated by Go. Expressed as bytes.	no
GoTotalBytes	The total memory allocated by Go but not released. Expressed as bytes.	no
GoStatsStaleness	The staleness of the Go memory statistics. Expressed in seconds.	no
HeapFragmentBytes	The amount of heap fragmentation. Expressed as bytes.	no
HeapReservedBytes	The amount of heap reserved. Expressed as bytes.	no
HeapReleasedBytes	The amount of heap released. Expressed as bytes.	no
CGoAllocBytes	The memory allocated outside of Go. Expressed as bytes.	no
CGoTotalBytes	The total memory allocated outside of Go but not released. Expressed as bytes.	no
CGoCallRate	The total number of calls outside of Go over time. Expressed as operations per second.	no
CPUUserPercent	The user CPU percentage.	no
CPUSysPercent	The system CPU percentage.	no
GCPausePercent	The GC pause percentage.	no
GCRunCount	The total number of GC runs.	no
NetHostRecvBytes	The bytes received on all network interfaces since this process started.	no
NetHostSendBytes	The bytes sent on all network interfaces since this process started.	no

Common fields

Field	Description	Sensitive
Timestamp	The timestamp of the event. Expressed as nanoseconds since the Unix epoch.	no
EventType	The type of the event.	no

Job events

Events in this category pertain to long-running jobs that are orchestrated by a node's job registry. These system processes can create and/or modify stored objects during the course of their execution.

A job might choose to emit multiple events during its execution when transitioning from one "state" to another. Egs: IMPORT/RESTORE will emit events on job creation and successful completion. If the job fails, events will be emitted on job creation, failure, and successful revert.

Events in this category are logged to the OPS channel.

import

An event of type import is recorded when an import job is created and successful completion. If the job fails, events will be emitted on job creation, failure, and successful revert.

Common fields

Field	Description	Sensitive
Timestamp	The timestamp of the event. Expressed as nanoseconds since the Unix epoch.	no
EventType	The type of the event.	no
JobID	The ID of the job that triggered the event.	no
JobType	The type of the job that triggered the event.	no
Description	A description of the job that triggered the event. Some jobs populate the description with an approximate representation of the SQL statement run to create the job.	yes
User	The user account that triggered the event.	yes
DescriptorIDs	The object descriptors affected by the job. Set to zero for operations that don't affect descriptors.	yes
Status	The status of the job that triggered the event. This allows the job to indicate which phase execution it is in when the event is triggered.	no

restore

An event of type restore is recorded when a restore job is created and successful completion. If the job fails, events will be emitted on job creation, failure, and successful revert.

Common fields

Field	Description	Sensitive
Timestamp	The timestamp of the event. Expressed as nanoseconds since the Unix epoch.	no
EventType	The type of the event.	no
JobID	The ID of the job that triggered the event.	no
JobType	The type of the job that triggered the event.	no
Description	A description of the job that triggered the event. Some jobs populate the description with an approximate representation of the SQL statement run to create the job.	yes
User	The user account that triggered the event.	yes
DescriptorIDs	The object descriptors affected by the job. Set to zero for operations that don't affect descriptors.	yes
Status	The status of the job that triggered the event. This allows the job to indicate which phase execution it is in when the event is triggered.	no

Miscellaneous SQL events

Events in this category report miscellaneous SQL events.

They are relative to a particular SQL tenant. In a multi-tenant setup, copies of these miscellaneous events are preserved in each tenant's own system.eventlog table.

Events in this category are logged to the DEV channel.

set_cluster_setting

An event of type set_cluster_setting is recorded when a cluster setting is changed.

Field	Description	Sensitive
SettingName	The name of the affected cluster setting.	no
Value	The new value of the cluster setting.	yes

Common fields

Field	Description	Sensitive
Timestamp	The timestamp of the event. Expressed as nanoseconds since the Unix epoch.	no
EventType	The type of the event.	no
Statement	A normalized copy of the SQL statement that triggered the event. The statement string contains a mix of sensitive and non-sensitive details (it is redactable).	partially
Tag	The statement tag. This is separate from the statement string, since the statement string can contain sensitive information. The tag is guaranteed not to.	no
User	The user account that triggered the event. The special usernames root and node are not considered sensitive.	depends
DescriptorID	The primary object descriptor affected by the operation. Set to zero for operations that don't affect descriptors.	no
ApplicationName	The application name for the session where the event was emitted. This is included in the event to ease filtering of logging output by application. Application names starting with a dollar sign ($) are not considered sensitive.	depends
PlaceholderValues	The mapping of SQL placeholders to their values, for prepared statements.	yes

SQL Access Audit Events

Events in this category are generated when a table has been marked as audited via ALTER TABLE ... EXPERIMENTAL_AUDIT SET.

{% include {{ page.version.version }}/misc/experimental-warning.md %}

Note: These events are not written to system.eventlog, even when the cluster setting system.eventlog.enabled is set. They are only emitted via external logging.

Events in this category are logged to the SENSITIVE_ACCESS channel.

admin_query

An event of type admin_query is recorded when a user with admin privileges (the user is directly or indirectly a member of the admin role) executes a query.

Common fields

Field	Description	Sensitive
Timestamp	The timestamp of the event. Expressed as nanoseconds since the Unix epoch.	no
EventType	The type of the event.	no
Statement	A normalized copy of the SQL statement that triggered the event. The statement string contains a mix of sensitive and non-sensitive details (it is redactable).	partially
Tag	The statement tag. This is separate from the statement string, since the statement string can contain sensitive information. The tag is guaranteed not to.	no
User	The user account that triggered the event. The special usernames root and node are not considered sensitive.	depends
DescriptorID	The primary object descriptor affected by the operation. Set to zero for operations that don't affect descriptors.	no
ApplicationName	The application name for the session where the event was emitted. This is included in the event to ease filtering of logging output by application. Application names starting with a dollar sign ($) are not considered sensitive.	depends
PlaceholderValues	The mapping of SQL placeholders to their values, for prepared statements.	yes
ExecMode	How the statement was being executed (exec/prepare, etc.)	no
NumRows	Number of rows returned. For mutation statements (INSERT, etc) that do not produce result rows, this field reports the number of rows affected.	no
SQLSTATE	The SQLSTATE code for the error, if an error was encountered. Empty/omitted if no error.	no
ErrorText	The text of the error if any.	yes
Age	Age of the query in milliseconds.	no
NumRetries	Number of retries, when the txn was reretried automatically by the server.	no
FullTableScan	Whether the query contains a full table scan.	no
FullIndexScan	Whether the query contains a full secondary index scan of a non-partial index.	no
TxnCounter	The sequence number of the SQL transaction inside its session.	no

sensitive_table_access

An event of type sensitive_table_access is recorded when an access is performed to a table marked as audited.

Field	Description	Sensitive
TableName	The name of the table being audited.	yes
AccessMode	How the table was accessed (r=read / rw=read/write).	no

Common fields

Field	Description	Sensitive
Timestamp	The timestamp of the event. Expressed as nanoseconds since the Unix epoch.	no
EventType	The type of the event.	no
Statement	A normalized copy of the SQL statement that triggered the event. The statement string contains a mix of sensitive and non-sensitive details (it is redactable).	partially
Tag	The statement tag. This is separate from the statement string, since the statement string can contain sensitive information. The tag is guaranteed not to.	no
User	The user account that triggered the event. The special usernames root and node are not considered sensitive.	depends
DescriptorID	The primary object descriptor affected by the operation. Set to zero for operations that don't affect descriptors.	no
ApplicationName	The application name for the session where the event was emitted. This is included in the event to ease filtering of logging output by application. Application names starting with a dollar sign ($) are not considered sensitive.	depends
PlaceholderValues	The mapping of SQL placeholders to their values, for prepared statements.	yes
ExecMode	How the statement was being executed (exec/prepare, etc.)	no
NumRows	Number of rows returned. For mutation statements (INSERT, etc) that do not produce result rows, this field reports the number of rows affected.	no
SQLSTATE	The SQLSTATE code for the error, if an error was encountered. Empty/omitted if no error.	no
ErrorText	The text of the error if any.	yes
Age	Age of the query in milliseconds.	no
NumRetries	Number of retries, when the txn was reretried automatically by the server.	no
FullTableScan	Whether the query contains a full table scan.	no
FullIndexScan	Whether the query contains a full secondary index scan of a non-partial index.	no
TxnCounter	The sequence number of the SQL transaction inside its session.	no

SQL Execution Log

Events in this category report executed queries.

Note: These events are not written to system.eventlog, even when the cluster setting system.eventlog.enabled is set. They are only emitted via external logging.

Events in this category are logged to the SQL_EXEC channel.

query_execute

An event of type query_execute is recorded when a query is executed, and the cluster setting sql.trace.log_statement_execute is set.

Common fields

Field	Description	Sensitive
Timestamp	The timestamp of the event. Expressed as nanoseconds since the Unix epoch.	no
EventType	The type of the event.	no
Statement	A normalized copy of the SQL statement that triggered the event. The statement string contains a mix of sensitive and non-sensitive details (it is redactable).	partially
Tag	The statement tag. This is separate from the statement string, since the statement string can contain sensitive information. The tag is guaranteed not to.	no
User	The user account that triggered the event. The special usernames root and node are not considered sensitive.	depends
DescriptorID	The primary object descriptor affected by the operation. Set to zero for operations that don't affect descriptors.	no
ApplicationName	The application name for the session where the event was emitted. This is included in the event to ease filtering of logging output by application. Application names starting with a dollar sign ($) are not considered sensitive.	depends
PlaceholderValues	The mapping of SQL placeholders to their values, for prepared statements.	yes
ExecMode	How the statement was being executed (exec/prepare, etc.)	no
NumRows	Number of rows returned. For mutation statements (INSERT, etc) that do not produce result rows, this field reports the number of rows affected.	no
SQLSTATE	The SQLSTATE code for the error, if an error was encountered. Empty/omitted if no error.	no
ErrorText	The text of the error if any.	yes
Age	Age of the query in milliseconds.	no
NumRetries	Number of retries, when the txn was reretried automatically by the server.	no
FullTableScan	Whether the query contains a full table scan.	no
FullIndexScan	Whether the query contains a full secondary index scan of a non-partial index.	no
TxnCounter	The sequence number of the SQL transaction inside its session.	no

SQL Logical Schema Changes

Events in this category pertain to DDL (Data Definition Language) operations performed by SQL statements that modify the SQL logical schema.

They are relative to a particular SQL tenant. In a multi-tenant setup, copies of DDL-related events are preserved in each tenant's own system.eventlog table.

Events in this category are logged to the SQL_SCHEMA channel.

alter_database_add_region

An event of type alter_database_add_region is recorded when a region is added to a database.

Field	Description	Sensitive
DatabaseName	The name of the database.	yes
RegionName	The region being added.	yes

Common fields

Field	Description	Sensitive
Timestamp	The timestamp of the event. Expressed as nanoseconds since the Unix epoch.	no
EventType	The type of the event.	no
Statement	A normalized copy of the SQL statement that triggered the event. The statement string contains a mix of sensitive and non-sensitive details (it is redactable).	partially
Tag	The statement tag. This is separate from the statement string, since the statement string can contain sensitive information. The tag is guaranteed not to.	no
User	The user account that triggered the event. The special usernames root and node are not considered sensitive.	depends
DescriptorID	The primary object descriptor affected by the operation. Set to zero for operations that don't affect descriptors.	no
ApplicationName	The application name for the session where the event was emitted. This is included in the event to ease filtering of logging output by application. Application names starting with a dollar sign ($) are not considered sensitive.	depends
PlaceholderValues	The mapping of SQL placeholders to their values, for prepared statements.	yes

alter_database_drop_region

AlterDatabaseAddRegion is recorded when a region is added to a database.

Field	Description	Sensitive
DatabaseName	The name of the database.	yes
RegionName	The region being dropped.	yes

Common fields

Field	Description	Sensitive
Timestamp	The timestamp of the event. Expressed as nanoseconds since the Unix epoch.	no
EventType	The type of the event.	no
Statement	A normalized copy of the SQL statement that triggered the event. The statement string contains a mix of sensitive and non-sensitive details (it is redactable).	partially
Tag	The statement tag. This is separate from the statement string, since the statement string can contain sensitive information. The tag is guaranteed not to.	no
User	The user account that triggered the event. The special usernames root and node are not considered sensitive.	depends
DescriptorID	The primary object descriptor affected by the operation. Set to zero for operations that don't affect descriptors.	no
ApplicationName	The application name for the session where the event was emitted. This is included in the event to ease filtering of logging output by application. Application names starting with a dollar sign ($) are not considered sensitive.	depends
PlaceholderValues	The mapping of SQL placeholders to their values, for prepared statements.	yes

alter_database_placement

An event of type alter_database_placement is recorded when the database placement is modified.

Field	Description	Sensitive
DatabaseName	The name of the database.	yes
Placement	The new placement policy.	yes

Common fields

Field	Description	Sensitive
Timestamp	The timestamp of the event. Expressed as nanoseconds since the Unix epoch.	no
EventType	The type of the event.	no
Statement	A normalized copy of the SQL statement that triggered the event. The statement string contains a mix of sensitive and non-sensitive details (it is redactable).	partially
Tag	The statement tag. This is separate from the statement string, since the statement string can contain sensitive information. The tag is guaranteed not to.	no
User	The user account that triggered the event. The special usernames root and node are not considered sensitive.	depends
DescriptorID	The primary object descriptor affected by the operation. Set to zero for operations that don't affect descriptors.	no
ApplicationName	The application name for the session where the event was emitted. This is included in the event to ease filtering of logging output by application. Application names starting with a dollar sign ($) are not considered sensitive.	depends
PlaceholderValues	The mapping of SQL placeholders to their values, for prepared statements.	yes

alter_database_primary_region

An event of type alter_database_primary_region is recorded when a primary region is added/modified.

Field	Description	Sensitive
DatabaseName	The name of the database.	yes
PrimaryRegionName	The new primary region.	yes

Common fields

Field	Description	Sensitive
Timestamp	The timestamp of the event. Expressed as nanoseconds since the Unix epoch.	no
EventType	The type of the event.	no
Statement	A normalized copy of the SQL statement that triggered the event. The statement string contains a mix of sensitive and non-sensitive details (it is redactable).	partially
Tag	The statement tag. This is separate from the statement string, since the statement string can contain sensitive information. The tag is guaranteed not to.	no
User	The user account that triggered the event. The special usernames root and node are not considered sensitive.	depends
DescriptorID	The primary object descriptor affected by the operation. Set to zero for operations that don't affect descriptors.	no
ApplicationName	The application name for the session where the event was emitted. This is included in the event to ease filtering of logging output by application. Application names starting with a dollar sign ($) are not considered sensitive.	depends
PlaceholderValues	The mapping of SQL placeholders to their values, for prepared statements.	yes

alter_database_survival_goal

An event of type alter_database_survival_goal is recorded when the survival goal is modified.

Field	Description	Sensitive
DatabaseName	The name of the database.	yes
SurvivalGoal	The new survival goal	yes

Common fields

Field	Description	Sensitive
Timestamp	The timestamp of the event. Expressed as nanoseconds since the Unix epoch.	no
EventType	The type of the event.	no
Statement	A normalized copy of the SQL statement that triggered the event. The statement string contains a mix of sensitive and non-sensitive details (it is redactable).	partially
Tag	The statement tag. This is separate from the statement string, since the statement string can contain sensitive information. The tag is guaranteed not to.	no
User	The user account that triggered the event. The special usernames root and node are not considered sensitive.	depends
DescriptorID	The primary object descriptor affected by the operation. Set to zero for operations that don't affect descriptors.	no
ApplicationName	The application name for the session where the event was emitted. This is included in the event to ease filtering of logging output by application. Application names starting with a dollar sign ($) are not considered sensitive.	depends
PlaceholderValues	The mapping of SQL placeholders to their values, for prepared statements.	yes

alter_index

An event of type alter_index is recorded when an index is altered.

Field	Description	Sensitive
TableName	The name of the table containing the affected index.	yes
IndexName	The name of the affected index.	yes
MutationID	The mutation ID for the asynchronous job that is processing the index update.	no

Common fields

Field	Description	Sensitive
Timestamp	The timestamp of the event. Expressed as nanoseconds since the Unix epoch.	no
EventType	The type of the event.	no
Statement	A normalized copy of the SQL statement that triggered the event. The statement string contains a mix of sensitive and non-sensitive details (it is redactable).	partially
Tag	The statement tag. This is separate from the statement string, since the statement string can contain sensitive information. The tag is guaranteed not to.	no
User	The user account that triggered the event. The special usernames root and node are not considered sensitive.	depends
DescriptorID	The primary object descriptor affected by the operation. Set to zero for operations that don't affect descriptors.	no
ApplicationName	The application name for the session where the event was emitted. This is included in the event to ease filtering of logging output by application. Application names starting with a dollar sign ($) are not considered sensitive.	depends
PlaceholderValues	The mapping of SQL placeholders to their values, for prepared statements.	yes

alter_sequence

An event of type alter_sequence is recorded when a sequence is altered.

Field	Description	Sensitive
SequenceName	The name of the affected sequence.	yes

Common fields

Field	Description	Sensitive
Timestamp	The timestamp of the event. Expressed as nanoseconds since the Unix epoch.	no
EventType	The type of the event.	no
Statement	A normalized copy of the SQL statement that triggered the event. The statement string contains a mix of sensitive and non-sensitive details (it is redactable).	partially
Tag	The statement tag. This is separate from the statement string, since the statement string can contain sensitive information. The tag is guaranteed not to.	no
User	The user account that triggered the event. The special usernames root and node are not considered sensitive.	depends
DescriptorID	The primary object descriptor affected by the operation. Set to zero for operations that don't affect descriptors.	no
ApplicationName	The application name for the session where the event was emitted. This is included in the event to ease filtering of logging output by application. Application names starting with a dollar sign ($) are not considered sensitive.	depends
PlaceholderValues	The mapping of SQL placeholders to their values, for prepared statements.	yes

alter_table

An event of type alter_table is recorded when a table is altered.

Field	Description	Sensitive
TableName	The name of the affected table.	yes
MutationID	The mutation ID for the asynchronous job that is processing the index update, if any.	no
CascadeDroppedViews	The names of the views dropped as a result of a cascade operation.	yes

Common fields

Field	Description	Sensitive
Timestamp	The timestamp of the event. Expressed as nanoseconds since the Unix epoch.	no
EventType	The type of the event.	no
Statement	A normalized copy of the SQL statement that triggered the event. The statement string contains a mix of sensitive and non-sensitive details (it is redactable).	partially
Tag	The statement tag. This is separate from the statement string, since the statement string can contain sensitive information. The tag is guaranteed not to.	no
User	The user account that triggered the event. The special usernames root and node are not considered sensitive.	depends
DescriptorID	The primary object descriptor affected by the operation. Set to zero for operations that don't affect descriptors.	no
ApplicationName	The application name for the session where the event was emitted. This is included in the event to ease filtering of logging output by application. Application names starting with a dollar sign ($) are not considered sensitive.	depends
PlaceholderValues	The mapping of SQL placeholders to their values, for prepared statements.	yes

alter_type

EventAlterType is recorded when a user-defined type is altered.

Field	Description	Sensitive
TypeName	The name of the affected type.	yes

Common fields

Field	Description	Sensitive
Timestamp	The timestamp of the event. Expressed as nanoseconds since the Unix epoch.	no
EventType	The type of the event.	no
Statement	A normalized copy of the SQL statement that triggered the event. The statement string contains a mix of sensitive and non-sensitive details (it is redactable).	partially
Tag	The statement tag. This is separate from the statement string, since the statement string can contain sensitive information. The tag is guaranteed not to.	no
User	The user account that triggered the event. The special usernames root and node are not considered sensitive.	depends
DescriptorID	The primary object descriptor affected by the operation. Set to zero for operations that don't affect descriptors.	no
ApplicationName	The application name for the session where the event was emitted. This is included in the event to ease filtering of logging output by application. Application names starting with a dollar sign ($) are not considered sensitive.	depends
PlaceholderValues	The mapping of SQL placeholders to their values, for prepared statements.	yes

comment_on_column

An event of type comment_on_column is recorded when a column is commented.

Field	Description	Sensitive
TableName	The name of the table containing the affected column.	yes
ColumnName	The affected column.	yes
Comment	The new comment.	yes
NullComment	Set to true if the comment was removed entirely.	no

Common fields

Field	Description	Sensitive
Timestamp	The timestamp of the event. Expressed as nanoseconds since the Unix epoch.	no
EventType	The type of the event.	no
Statement	A normalized copy of the SQL statement that triggered the event. The statement string contains a mix of sensitive and non-sensitive details (it is redactable).	partially
Tag	The statement tag. This is separate from the statement string, since the statement string can contain sensitive information. The tag is guaranteed not to.	no
User	The user account that triggered the event. The special usernames root and node are not considered sensitive.	depends
DescriptorID	The primary object descriptor affected by the operation. Set to zero for operations that don't affect descriptors.	no
ApplicationName	The application name for the session where the event was emitted. This is included in the event to ease filtering of logging output by application. Application names starting with a dollar sign ($) are not considered sensitive.	depends
PlaceholderValues	The mapping of SQL placeholders to their values, for prepared statements.	yes

comment_on_constraint

An event of type comment_on_constraint is recorded when an constraint is commented.

Field	Description	Sensitive
TableName	The name of the table containing the affected constraint.	yes
ConstraintName	The name of the affected constraint.	yes
Comment	The new comment.	yes
NullComment	Set to true if the comment was removed entirely.	no

Common fields

Field	Description	Sensitive
Timestamp	The timestamp of the event. Expressed as nanoseconds since the Unix epoch.	no
EventType	The type of the event.	no
Statement	A normalized copy of the SQL statement that triggered the event. The statement string contains a mix of sensitive and non-sensitive details (it is redactable).	partially
Tag	The statement tag. This is separate from the statement string, since the statement string can contain sensitive information. The tag is guaranteed not to.	no
User	The user account that triggered the event. The special usernames root and node are not considered sensitive.	depends
DescriptorID	The primary object descriptor affected by the operation. Set to zero for operations that don't affect descriptors.	no
ApplicationName	The application name for the session where the event was emitted. This is included in the event to ease filtering of logging output by application. Application names starting with a dollar sign ($) are not considered sensitive.	depends
PlaceholderValues	The mapping of SQL placeholders to their values, for prepared statements.	yes

comment_on_database

CommentOnTable is recorded when a database is commented.

Field	Description	Sensitive
DatabaseName	The name of the affected database.	yes
Comment	The new comment.	yes
NullComment	Set to true if the comment was removed entirely.	no

Common fields

Field	Description	Sensitive
Timestamp	The timestamp of the event. Expressed as nanoseconds since the Unix epoch.	no
EventType	The type of the event.	no
Statement	A normalized copy of the SQL statement that triggered the event. The statement string contains a mix of sensitive and non-sensitive details (it is redactable).	partially
Tag	The statement tag. This is separate from the statement string, since the statement string can contain sensitive information. The tag is guaranteed not to.	no
User	The user account that triggered the event. The special usernames root and node are not considered sensitive.	depends
DescriptorID	The primary object descriptor affected by the operation. Set to zero for operations that don't affect descriptors.	no
ApplicationName	The application name for the session where the event was emitted. This is included in the event to ease filtering of logging output by application. Application names starting with a dollar sign ($) are not considered sensitive.	depends
PlaceholderValues	The mapping of SQL placeholders to their values, for prepared statements.	yes

comment_on_index

An event of type comment_on_index is recorded when an index is commented.

Field	Description	Sensitive
TableName	The name of the table containing the affected index.	yes
IndexName	The name of the affected index.	yes
Comment	The new comment.	yes
NullComment	Set to true if the comment was removed entirely.	no

Common fields

Field	Description	Sensitive
Timestamp	The timestamp of the event. Expressed as nanoseconds since the Unix epoch.	no
EventType	The type of the event.	no
Statement	A normalized copy of the SQL statement that triggered the event. The statement string contains a mix of sensitive and non-sensitive details (it is redactable).	partially
Tag	The statement tag. This is separate from the statement string, since the statement string can contain sensitive information. The tag is guaranteed not to.	no
User	The user account that triggered the event. The special usernames root and node are not considered sensitive.	depends
DescriptorID	The primary object descriptor affected by the operation. Set to zero for operations that don't affect descriptors.	no
ApplicationName	The application name for the session where the event was emitted. This is included in the event to ease filtering of logging output by application. Application names starting with a dollar sign ($) are not considered sensitive.	depends
PlaceholderValues	The mapping of SQL placeholders to their values, for prepared statements.	yes

comment_on_table

An event of type comment_on_table is recorded when a table is commented.

Field	Description	Sensitive
TableName	The name of the affected table.	yes
Comment	The new comment.	yes
NullComment	Set to true if the comment was removed entirely.	no

Common fields

Field	Description	Sensitive
Timestamp	The timestamp of the event. Expressed as nanoseconds since the Unix epoch.	no
EventType	The type of the event.	no
Statement	A normalized copy of the SQL statement that triggered the event. The statement string contains a mix of sensitive and non-sensitive details (it is redactable).	partially
Tag	The statement tag. This is separate from the statement string, since the statement string can contain sensitive information. The tag is guaranteed not to.	no
User	The user account that triggered the event. The special usernames root and node are not considered sensitive.	depends
DescriptorID	The primary object descriptor affected by the operation. Set to zero for operations that don't affect descriptors.	no
ApplicationName	The application name for the session where the event was emitted. This is included in the event to ease filtering of logging output by application. Application names starting with a dollar sign ($) are not considered sensitive.	depends
PlaceholderValues	The mapping of SQL placeholders to their values, for prepared statements.	yes

convert_to_schema

An event of type convert_to_schema is recorded when a database is converted to a schema.

Field	Description	Sensitive
DatabaseName	The name of the database being converted to a schema.	yes
NewDatabaseParent	The name of the parent database for the new schema.	yes

Common fields

Field	Description	Sensitive
Timestamp	The timestamp of the event. Expressed as nanoseconds since the Unix epoch.	no
EventType	The type of the event.	no
Statement	A normalized copy of the SQL statement that triggered the event. The statement string contains a mix of sensitive and non-sensitive details (it is redactable).	partially
Tag	The statement tag. This is separate from the statement string, since the statement string can contain sensitive information. The tag is guaranteed not to.	no
User	The user account that triggered the event. The special usernames root and node are not considered sensitive.	depends
DescriptorID	The primary object descriptor affected by the operation. Set to zero for operations that don't affect descriptors.	no
ApplicationName	The application name for the session where the event was emitted. This is included in the event to ease filtering of logging output by application. Application names starting with a dollar sign ($) are not considered sensitive.	depends
PlaceholderValues	The mapping of SQL placeholders to their values, for prepared statements.	yes

create_database

An event of type create_database is recorded when a database is created.

Field	Description	Sensitive
DatabaseName	The name of the new database.	yes

Common fields

Field	Description	Sensitive
Timestamp	The timestamp of the event. Expressed as nanoseconds since the Unix epoch.	no
EventType	The type of the event.	no
Statement	A normalized copy of the SQL statement that triggered the event. The statement string contains a mix of sensitive and non-sensitive details (it is redactable).	partially
Tag	The statement tag. This is separate from the statement string, since the statement string can contain sensitive information. The tag is guaranteed not to.	no
User	The user account that triggered the event. The special usernames root and node are not considered sensitive.	depends
DescriptorID	The primary object descriptor affected by the operation. Set to zero for operations that don't affect descriptors.	no
ApplicationName	The application name for the session where the event was emitted. This is included in the event to ease filtering of logging output by application. Application names starting with a dollar sign ($) are not considered sensitive.	depends
PlaceholderValues	The mapping of SQL placeholders to their values, for prepared statements.	yes

create_index

An event of type create_index is recorded when an index is created.

Field	Description	Sensitive
TableName	The name of the table containing the new index.	yes
IndexName	The name of the new index.	yes
MutationID	The mutation ID for the asynchronous job that is processing the index update.	no

Common fields

Field	Description	Sensitive
Timestamp	The timestamp of the event. Expressed as nanoseconds since the Unix epoch.	no
EventType	The type of the event.	no
Statement	A normalized copy of the SQL statement that triggered the event. The statement string contains a mix of sensitive and non-sensitive details (it is redactable).	partially
Tag	The statement tag. This is separate from the statement string, since the statement string can contain sensitive information. The tag is guaranteed not to.	no
User	The user account that triggered the event. The special usernames root and node are not considered sensitive.	depends
DescriptorID	The primary object descriptor affected by the operation. Set to zero for operations that don't affect descriptors.	no
ApplicationName	The application name for the session where the event was emitted. This is included in the event to ease filtering of logging output by application. Application names starting with a dollar sign ($) are not considered sensitive.	depends
PlaceholderValues	The mapping of SQL placeholders to their values, for prepared statements.	yes

create_schema

An event of type create_schema is recorded when a schema is created.

Field	Description	Sensitive
SchemaName	The name of the new schema.	yes
Owner	The name of the owner for the new schema.	yes

Common fields

Field	Description	Sensitive
Timestamp	The timestamp of the event. Expressed as nanoseconds since the Unix epoch.	no
EventType	The type of the event.	no
Statement	A normalized copy of the SQL statement that triggered the event. The statement string contains a mix of sensitive and non-sensitive details (it is redactable).	partially
Tag	The statement tag. This is separate from the statement string, since the statement string can contain sensitive information. The tag is guaranteed not to.	no
User	The user account that triggered the event. The special usernames root and node are not considered sensitive.	depends
DescriptorID	The primary object descriptor affected by the operation. Set to zero for operations that don't affect descriptors.	no
ApplicationName	The application name for the session where the event was emitted. This is included in the event to ease filtering of logging output by application. Application names starting with a dollar sign ($) are not considered sensitive.	depends
PlaceholderValues	The mapping of SQL placeholders to their values, for prepared statements.	yes

create_sequence

An event of type create_sequence is recorded when a sequence is created.

Field	Description	Sensitive
SequenceName	The name of the new sequence.	yes
Owner	The name of the owner for the new sequence.	yes

Common fields

Field	Description	Sensitive
Timestamp	The timestamp of the event. Expressed as nanoseconds since the Unix epoch.	no
EventType	The type of the event.	no
Statement	A normalized copy of the SQL statement that triggered the event. The statement string contains a mix of sensitive and non-sensitive details (it is redactable).	partially
Tag	The statement tag. This is separate from the statement string, since the statement string can contain sensitive information. The tag is guaranteed not to.	no
User	The user account that triggered the event. The special usernames root and node are not considered sensitive.	depends
DescriptorID	The primary object descriptor affected by the operation. Set to zero for operations that don't affect descriptors.	no
ApplicationName	The application name for the session where the event was emitted. This is included in the event to ease filtering of logging output by application. Application names starting with a dollar sign ($) are not considered sensitive.	depends
PlaceholderValues	The mapping of SQL placeholders to their values, for prepared statements.	yes

create_statistics

An event of type create_statistics is recorded when statistics are collected for a table.

Events of this type are only collected when the cluster setting sql.stats.post_events.enabled is set.

Field	Description	Sensitive
TableName	The name of the table for which the statistics were created.	yes

Common fields

Field	Description	Sensitive
Timestamp	The timestamp of the event. Expressed as nanoseconds since the Unix epoch.	no
EventType	The type of the event.	no
Statement	A normalized copy of the SQL statement that triggered the event. The statement string contains a mix of sensitive and non-sensitive details (it is redactable).	partially
Tag	The statement tag. This is separate from the statement string, since the statement string can contain sensitive information. The tag is guaranteed not to.	no
User	The user account that triggered the event. The special usernames root and node are not considered sensitive.	depends
DescriptorID	The primary object descriptor affected by the operation. Set to zero for operations that don't affect descriptors.	no
ApplicationName	The application name for the session where the event was emitted. This is included in the event to ease filtering of logging output by application. Application names starting with a dollar sign ($) are not considered sensitive.	depends
PlaceholderValues	The mapping of SQL placeholders to their values, for prepared statements.	yes

create_table

An event of type create_table is recorded when a table is created.

Field	Description	Sensitive
TableName	The name of the new table.	yes
Owner	The name of the owner for the new table.	yes

Common fields

Field	Description	Sensitive
Timestamp	The timestamp of the event. Expressed as nanoseconds since the Unix epoch.	no
EventType	The type of the event.	no
Statement	A normalized copy of the SQL statement that triggered the event. The statement string contains a mix of sensitive and non-sensitive details (it is redactable).	partially
Tag	The statement tag. This is separate from the statement string, since the statement string can contain sensitive information. The tag is guaranteed not to.	no
User	The user account that triggered the event. The special usernames root and node are not considered sensitive.	depends
DescriptorID	The primary object descriptor affected by the operation. Set to zero for operations that don't affect descriptors.	no
ApplicationName	The application name for the session where the event was emitted. This is included in the event to ease filtering of logging output by application. Application names starting with a dollar sign ($) are not considered sensitive.	depends
PlaceholderValues	The mapping of SQL placeholders to their values, for prepared statements.	yes

create_type

An event of type create_type is recorded when a user-defined type is created.

Field	Description	Sensitive
TypeName	The name of the new type.	yes
Owner	The name of the owner for the new type.	yes

Common fields

Field	Description	Sensitive
Timestamp	The timestamp of the event. Expressed as nanoseconds since the Unix epoch.	no
EventType	The type of the event.	no
Statement	A normalized copy of the SQL statement that triggered the event. The statement string contains a mix of sensitive and non-sensitive details (it is redactable).	partially
Tag	The statement tag. This is separate from the statement string, since the statement string can contain sensitive information. The tag is guaranteed not to.	no
User	The user account that triggered the event. The special usernames root and node are not considered sensitive.	depends
DescriptorID	The primary object descriptor affected by the operation. Set to zero for operations that don't affect descriptors.	no
ApplicationName	The application name for the session where the event was emitted. This is included in the event to ease filtering of logging output by application. Application names starting with a dollar sign ($) are not considered sensitive.	depends
PlaceholderValues	The mapping of SQL placeholders to their values, for prepared statements.	yes

create_view

An event of type create_view is recorded when a view is created.

Field	Description	Sensitive
ViewName	The name of the new view.	yes
Owner	The name of the owner of the new view.	yes
ViewQuery	The SQL selection clause used to define the view.	yes

Common fields

Field	Description	Sensitive
Timestamp	The timestamp of the event. Expressed as nanoseconds since the Unix epoch.	no
EventType	The type of the event.	no
Statement	A normalized copy of the SQL statement that triggered the event. The statement string contains a mix of sensitive and non-sensitive details (it is redactable).	partially
Tag	The statement tag. This is separate from the statement string, since the statement string can contain sensitive information. The tag is guaranteed not to.	no
User	The user account that triggered the event. The special usernames root and node are not considered sensitive.	depends
DescriptorID	The primary object descriptor affected by the operation. Set to zero for operations that don't affect descriptors.	no
ApplicationName	The application name for the session where the event was emitted. This is included in the event to ease filtering of logging output by application. Application names starting with a dollar sign ($) are not considered sensitive.	depends
PlaceholderValues	The mapping of SQL placeholders to their values, for prepared statements.	yes

drop_database

An event of type drop_database is recorded when a database is dropped.

Field	Description	Sensitive
DatabaseName	The name of the affected database.	yes
DroppedSchemaObjects	The names of the schemas dropped by a cascade operation.	yes

Common fields

Field	Description	Sensitive
Timestamp	The timestamp of the event. Expressed as nanoseconds since the Unix epoch.	no
EventType	The type of the event.	no
Statement	A normalized copy of the SQL statement that triggered the event. The statement string contains a mix of sensitive and non-sensitive details (it is redactable).	partially
Tag	The statement tag. This is separate from the statement string, since the statement string can contain sensitive information. The tag is guaranteed not to.	no
User	The user account that triggered the event. The special usernames root and node are not considered sensitive.	depends
DescriptorID	The primary object descriptor affected by the operation. Set to zero for operations that don't affect descriptors.	no
ApplicationName	The application name for the session where the event was emitted. This is included in the event to ease filtering of logging output by application. Application names starting with a dollar sign ($) are not considered sensitive.	depends
PlaceholderValues	The mapping of SQL placeholders to their values, for prepared statements.	yes

drop_index

An event of type drop_index is recorded when an index is dropped.

Field	Description	Sensitive
TableName	The name of the table containing the affected index.	yes
IndexName	The name of the affected index.	yes
MutationID	The mutation ID for the asynchronous job that is processing the index update.	no
CascadeDroppedViews	The names of the views dropped as a result of a cascade operation.	yes

Common fields

Field	Description	Sensitive
Timestamp	The timestamp of the event. Expressed as nanoseconds since the Unix epoch.	no
EventType	The type of the event.	no
Statement	A normalized copy of the SQL statement that triggered the event. The statement string contains a mix of sensitive and non-sensitive details (it is redactable).	partially
Tag	The statement tag. This is separate from the statement string, since the statement string can contain sensitive information. The tag is guaranteed not to.	no
User	The user account that triggered the event. The special usernames root and node are not considered sensitive.	depends
DescriptorID	The primary object descriptor affected by the operation. Set to zero for operations that don't affect descriptors.	no
ApplicationName	The application name for the session where the event was emitted. This is included in the event to ease filtering of logging output by application. Application names starting with a dollar sign ($) are not considered sensitive.	depends
PlaceholderValues	The mapping of SQL placeholders to their values, for prepared statements.	yes

drop_schema

An event of type drop_schema is recorded when a schema is dropped.

Field	Description	Sensitive
SchemaName	The name of the affected schema.	yes

Common fields

Field	Description	Sensitive
Timestamp	The timestamp of the event. Expressed as nanoseconds since the Unix epoch.	no
EventType	The type of the event.	no
Statement	A normalized copy of the SQL statement that triggered the event. The statement string contains a mix of sensitive and non-sensitive details (it is redactable).	partially
Tag	The statement tag. This is separate from the statement string, since the statement string can contain sensitive information. The tag is guaranteed not to.	no
User	The user account that triggered the event. The special usernames root and node are not considered sensitive.	depends
DescriptorID	The primary object descriptor affected by the operation. Set to zero for operations that don't affect descriptors.	no
ApplicationName	The application name for the session where the event was emitted. This is included in the event to ease filtering of logging output by application. Application names starting with a dollar sign ($) are not considered sensitive.	depends
PlaceholderValues	The mapping of SQL placeholders to their values, for prepared statements.	yes

drop_sequence

An event of type drop_sequence is recorded when a sequence is dropped.

Field	Description	Sensitive
SequenceName	The name of the affected sequence.	yes

Common fields

Field	Description	Sensitive
Timestamp	The timestamp of the event. Expressed as nanoseconds since the Unix epoch.	no
EventType	The type of the event.	no
Statement	A normalized copy of the SQL statement that triggered the event. The statement string contains a mix of sensitive and non-sensitive details (it is redactable).	partially
Tag	The statement tag. This is separate from the statement string, since the statement string can contain sensitive information. The tag is guaranteed not to.	no
User	The user account that triggered the event. The special usernames root and node are not considered sensitive.	depends
DescriptorID	The primary object descriptor affected by the operation. Set to zero for operations that don't affect descriptors.	no
ApplicationName	The application name for the session where the event was emitted. This is included in the event to ease filtering of logging output by application. Application names starting with a dollar sign ($) are not considered sensitive.	depends
PlaceholderValues	The mapping of SQL placeholders to their values, for prepared statements.	yes

drop_table

An event of type drop_table is recorded when a table is dropped.

Field	Description	Sensitive
TableName	The name of the affected table.	yes
CascadeDroppedViews	The names of the views dropped as a result of a cascade operation.	yes

Common fields

Field	Description	Sensitive
Timestamp	The timestamp of the event. Expressed as nanoseconds since the Unix epoch.	no
EventType	The type of the event.	no
Statement	A normalized copy of the SQL statement that triggered the event. The statement string contains a mix of sensitive and non-sensitive details (it is redactable).	partially
Tag	The statement tag. This is separate from the statement string, since the statement string can contain sensitive information. The tag is guaranteed not to.	no
User	The user account that triggered the event. The special usernames root and node are not considered sensitive.	depends
DescriptorID	The primary object descriptor affected by the operation. Set to zero for operations that don't affect descriptors.	no
ApplicationName	The application name for the session where the event was emitted. This is included in the event to ease filtering of logging output by application. Application names starting with a dollar sign ($) are not considered sensitive.	depends
PlaceholderValues	The mapping of SQL placeholders to their values, for prepared statements.	yes

drop_type

An event of type drop_type is recorded when a user-defined type is dropped.

Field	Description	Sensitive
TypeName	The name of the affected type.	yes

Common fields

Field	Description	Sensitive
Timestamp	The timestamp of the event. Expressed as nanoseconds since the Unix epoch.	no
EventType	The type of the event.	no
Statement	A normalized copy of the SQL statement that triggered the event. The statement string contains a mix of sensitive and non-sensitive details (it is redactable).	partially
Tag	The statement tag. This is separate from the statement string, since the statement string can contain sensitive information. The tag is guaranteed not to.	no
User	The user account that triggered the event. The special usernames root and node are not considered sensitive.	depends
DescriptorID	The primary object descriptor affected by the operation. Set to zero for operations that don't affect descriptors.	no
ApplicationName	The application name for the session where the event was emitted. This is included in the event to ease filtering of logging output by application. Application names starting with a dollar sign ($) are not considered sensitive.	depends
PlaceholderValues	The mapping of SQL placeholders to their values, for prepared statements.	yes

drop_view

An event of type drop_view is recorded when a view is dropped.

Field	Description	Sensitive
ViewName	The name of the affected view.	yes
CascadeDroppedViews	The names of the views dropped as a result of a cascade operation.	yes

Common fields

Field	Description	Sensitive
Timestamp	The timestamp of the event. Expressed as nanoseconds since the Unix epoch.	no
EventType	The type of the event.	no
Statement	A normalized copy of the SQL statement that triggered the event. The statement string contains a mix of sensitive and non-sensitive details (it is redactable).	partially
Tag	The statement tag. This is separate from the statement string, since the statement string can contain sensitive information. The tag is guaranteed not to.	no
User	The user account that triggered the event. The special usernames root and node are not considered sensitive.	depends
DescriptorID	The primary object descriptor affected by the operation. Set to zero for operations that don't affect descriptors.	no
ApplicationName	The application name for the session where the event was emitted. This is included in the event to ease filtering of logging output by application. Application names starting with a dollar sign ($) are not considered sensitive.	depends
PlaceholderValues	The mapping of SQL placeholders to their values, for prepared statements.	yes

finish_schema_change

An event of type finish_schema_change is recorded when a previously initiated schema change has completed.

Common fields

Field	Description	Sensitive
Timestamp	The timestamp of the event. Expressed as nanoseconds since the Unix epoch.	no
EventType	The type of the event.	no
InstanceID	The instance ID (not tenant ID) of the SQL server where the event was originated.	no
DescriptorID	The primary object descriptor affected by the operation. Set to zero for operations that don't affect descriptors.	no
MutationID	The descriptor mutation that this schema change was processing.	no

finish_schema_change_rollback

An event of type finish_schema_change_rollback is recorded when a previously initiated schema change rollback has completed.

Common fields

Field	Description	Sensitive
Timestamp	The timestamp of the event. Expressed as nanoseconds since the Unix epoch.	no
EventType	The type of the event.	no
InstanceID	The instance ID (not tenant ID) of the SQL server where the event was originated.	no
DescriptorID	The primary object descriptor affected by the operation. Set to zero for operations that don't affect descriptors.	no
MutationID	The descriptor mutation that this schema change was processing.	no

force_delete_table_data_entry

Field	Description	Sensitive
DescriptorID		no

Common fields

Field	Description	Sensitive
Timestamp	The timestamp of the event. Expressed as nanoseconds since the Unix epoch.	no
EventType	The type of the event.	no
Statement	A normalized copy of the SQL statement that triggered the event. The statement string contains a mix of sensitive and non-sensitive details (it is redactable).	partially
Tag	The statement tag. This is separate from the statement string, since the statement string can contain sensitive information. The tag is guaranteed not to.	no
User	The user account that triggered the event. The special usernames root and node are not considered sensitive.	depends
DescriptorID	The primary object descriptor affected by the operation. Set to zero for operations that don't affect descriptors.	no
ApplicationName	The application name for the session where the event was emitted. This is included in the event to ease filtering of logging output by application. Application names starting with a dollar sign ($) are not considered sensitive.	depends
PlaceholderValues	The mapping of SQL placeholders to their values, for prepared statements.	yes

rename_database

An event of type rename_database is recorded when a database is renamed.

Field	Description	Sensitive
DatabaseName	The old name of the affected database.	yes
NewDatabaseName	The new name of the affected database.	yes

Common fields

Field	Description	Sensitive
Timestamp	The timestamp of the event. Expressed as nanoseconds since the Unix epoch.	no
EventType	The type of the event.	no
Statement	A normalized copy of the SQL statement that triggered the event. The statement string contains a mix of sensitive and non-sensitive details (it is redactable).	partially
Tag	The statement tag. This is separate from the statement string, since the statement string can contain sensitive information. The tag is guaranteed not to.	no
User	The user account that triggered the event. The special usernames root and node are not considered sensitive.	depends
DescriptorID	The primary object descriptor affected by the operation. Set to zero for operations that don't affect descriptors.	no
ApplicationName	The application name for the session where the event was emitted. This is included in the event to ease filtering of logging output by application. Application names starting with a dollar sign ($) are not considered sensitive.	depends
PlaceholderValues	The mapping of SQL placeholders to their values, for prepared statements.	yes

rename_schema

An event of type rename_schema is recorded when a schema is renamed.

Field	Description	Sensitive
SchemaName	The old name of the affected schema.	yes
NewSchemaName	The new name of the affected schema.	yes

Common fields

Field	Description	Sensitive
Timestamp	The timestamp of the event. Expressed as nanoseconds since the Unix epoch.	no
EventType	The type of the event.	no
Statement	A normalized copy of the SQL statement that triggered the event. The statement string contains a mix of sensitive and non-sensitive details (it is redactable).	partially
Tag	The statement tag. This is separate from the statement string, since the statement string can contain sensitive information. The tag is guaranteed not to.	no
User	The user account that triggered the event. The special usernames root and node are not considered sensitive.	depends
DescriptorID	The primary object descriptor affected by the operation. Set to zero for operations that don't affect descriptors.	no
ApplicationName	The application name for the session where the event was emitted. This is included in the event to ease filtering of logging output by application. Application names starting with a dollar sign ($) are not considered sensitive.	depends
PlaceholderValues	The mapping of SQL placeholders to their values, for prepared statements.	yes

rename_table

An event of type rename_table is recorded when a table, sequence or view is renamed.

Field	Description	Sensitive
TableName	The old name of the affected table.	yes
NewTableName	The new name of the affected table.	yes

Common fields

Field	Description	Sensitive
Timestamp	The timestamp of the event. Expressed as nanoseconds since the Unix epoch.	no
EventType	The type of the event.	no
Statement	A normalized copy of the SQL statement that triggered the event. The statement string contains a mix of sensitive and non-sensitive details (it is redactable).	partially
Tag	The statement tag. This is separate from the statement string, since the statement string can contain sensitive information. The tag is guaranteed not to.	no
User	The user account that triggered the event. The special usernames root and node are not considered sensitive.	depends
DescriptorID	The primary object descriptor affected by the operation. Set to zero for operations that don't affect descriptors.	no
ApplicationName	The application name for the session where the event was emitted. This is included in the event to ease filtering of logging output by application. Application names starting with a dollar sign ($) are not considered sensitive.	depends
PlaceholderValues	The mapping of SQL placeholders to their values, for prepared statements.	yes

rename_type

An event of type rename_type is recorded when a user-defined type is renamed.

Field	Description	Sensitive
TypeName	The old name of the affected type.	yes
NewTypeName	The new name of the affected type.	yes

Common fields

Field	Description	Sensitive
Timestamp	The timestamp of the event. Expressed as nanoseconds since the Unix epoch.	no
EventType	The type of the event.	no
Statement	A normalized copy of the SQL statement that triggered the event. The statement string contains a mix of sensitive and non-sensitive details (it is redactable).	partially
Tag	The statement tag. This is separate from the statement string, since the statement string can contain sensitive information. The tag is guaranteed not to.	no
User	The user account that triggered the event. The special usernames root and node are not considered sensitive.	depends
DescriptorID	The primary object descriptor affected by the operation. Set to zero for operations that don't affect descriptors.	no
ApplicationName	The application name for the session where the event was emitted. This is included in the event to ease filtering of logging output by application. Application names starting with a dollar sign ($) are not considered sensitive.	depends
PlaceholderValues	The mapping of SQL placeholders to their values, for prepared statements.	yes

reverse_schema_change

An event of type reverse_schema_change is recorded when an in-progress schema change encounters a problem and is reversed.

Field	Description	Sensitive
Error	The error encountered that caused the schema change to be reversed. The specific format of the error is variable and can change across releases without warning.	yes
SQLSTATE	The SQLSTATE code for the error.	no

Common fields

Field	Description	Sensitive
Timestamp	The timestamp of the event. Expressed as nanoseconds since the Unix epoch.	no
EventType	The type of the event.	no
InstanceID	The instance ID (not tenant ID) of the SQL server where the event was originated.	no
DescriptorID	The primary object descriptor affected by the operation. Set to zero for operations that don't affect descriptors.	no
MutationID	The descriptor mutation that this schema change was processing.	no

set_schema

An event of type set_schema is recorded when a table, view, sequence or type's schema is changed.

Field	Description	Sensitive
DescriptorName	The old name of the affected descriptor.	yes
NewDescriptorName	The new name of the affected descriptor.	yes
DescriptorType	The descriptor type being changed (table, view, sequence, type).	yes

Common fields

Field	Description	Sensitive
Timestamp	The timestamp of the event. Expressed as nanoseconds since the Unix epoch.	no
EventType	The type of the event.	no
Statement	A normalized copy of the SQL statement that triggered the event. The statement string contains a mix of sensitive and non-sensitive details (it is redactable).	partially
Tag	The statement tag. This is separate from the statement string, since the statement string can contain sensitive information. The tag is guaranteed not to.	no
User	The user account that triggered the event. The special usernames root and node are not considered sensitive.	depends
DescriptorID	The primary object descriptor affected by the operation. Set to zero for operations that don't affect descriptors.	no
ApplicationName	The application name for the session where the event was emitted. This is included in the event to ease filtering of logging output by application. Application names starting with a dollar sign ($) are not considered sensitive.	depends
PlaceholderValues	The mapping of SQL placeholders to their values, for prepared statements.	yes

truncate_table

An event of type truncate_table is recorded when a table is truncated.

Field	Description	Sensitive
TableName	The name of the affected table.	yes

Common fields

Field	Description	Sensitive
Timestamp	The timestamp of the event. Expressed as nanoseconds since the Unix epoch.	no
EventType	The type of the event.	no
Statement	A normalized copy of the SQL statement that triggered the event. The statement string contains a mix of sensitive and non-sensitive details (it is redactable).	partially
Tag	The statement tag. This is separate from the statement string, since the statement string can contain sensitive information. The tag is guaranteed not to.	no
User	The user account that triggered the event. The special usernames root and node are not considered sensitive.	depends
DescriptorID	The primary object descriptor affected by the operation. Set to zero for operations that don't affect descriptors.	no
ApplicationName	The application name for the session where the event was emitted. This is included in the event to ease filtering of logging output by application. Application names starting with a dollar sign ($) are not considered sensitive.	depends
PlaceholderValues	The mapping of SQL placeholders to their values, for prepared statements.	yes

unsafe_delete_descriptor

An event of type unsafe_delete_descriptor is recorded when a descriptor is written using crdb_internal.unsafe_delete_descriptor().

The fields of this event type are reserved and can change across patch releases without advance notice.

Field	Description	Sensitive
ParentID		no
ParentSchemaID		no
Name		yes
Force		no
ForceNotice		yes

Common fields

Field	Description	Sensitive
Timestamp	The timestamp of the event. Expressed as nanoseconds since the Unix epoch.	no
EventType	The type of the event.	no
Statement	A normalized copy of the SQL statement that triggered the event. The statement string contains a mix of sensitive and non-sensitive details (it is redactable).	partially
Tag	The statement tag. This is separate from the statement string, since the statement string can contain sensitive information. The tag is guaranteed not to.	no
User	The user account that triggered the event. The special usernames root and node are not considered sensitive.	depends
DescriptorID	The primary object descriptor affected by the operation. Set to zero for operations that don't affect descriptors.	no
ApplicationName	The application name for the session where the event was emitted. This is included in the event to ease filtering of logging output by application. Application names starting with a dollar sign ($) are not considered sensitive.	depends
PlaceholderValues	The mapping of SQL placeholders to their values, for prepared statements.	yes

unsafe_delete_namespace_entry

An event of type unsafe_delete_namespace_entry is recorded when a namespace entry is written using crdb_internal.unsafe_delete_namespace_entry().

The fields of this event type are reserved and can change across patch releases without advance notice.

Field	Description	Sensitive
ParentID		no
ParentSchemaID		no
Name		yes
Force		no
ForceNotice		yes

Common fields

Field	Description	Sensitive
Timestamp	The timestamp of the event. Expressed as nanoseconds since the Unix epoch.	no
EventType	The type of the event.	no
Statement	A normalized copy of the SQL statement that triggered the event. The statement string contains a mix of sensitive and non-sensitive details (it is redactable).	partially
Tag	The statement tag. This is separate from the statement string, since the statement string can contain sensitive information. The tag is guaranteed not to.	no
User	The user account that triggered the event. The special usernames root and node are not considered sensitive.	depends
DescriptorID	The primary object descriptor affected by the operation. Set to zero for operations that don't affect descriptors.	no
ApplicationName	The application name for the session where the event was emitted. This is included in the event to ease filtering of logging output by application. Application names starting with a dollar sign ($) are not considered sensitive.	depends
PlaceholderValues	The mapping of SQL placeholders to their values, for prepared statements.	yes

unsafe_upsert_descriptor

An event of type unsafe_upsert_descriptor is recorded when a descriptor is written using crdb_internal.unsafe_upsert_descriptor().

Field	Description	Sensitive
PreviousDescriptor		yes
NewDescriptor		yes
Force		no
ForceNotice		yes

Common fields

Field	Description	Sensitive
Timestamp	The timestamp of the event. Expressed as nanoseconds since the Unix epoch.	no
EventType	The type of the event.	no
Statement	A normalized copy of the SQL statement that triggered the event. The statement string contains a mix of sensitive and non-sensitive details (it is redactable).	partially
Tag	The statement tag. This is separate from the statement string, since the statement string can contain sensitive information. The tag is guaranteed not to.	no
User	The user account that triggered the event. The special usernames root and node are not considered sensitive.	depends
DescriptorID	The primary object descriptor affected by the operation. Set to zero for operations that don't affect descriptors.	no
ApplicationName	The application name for the session where the event was emitted. This is included in the event to ease filtering of logging output by application. Application names starting with a dollar sign ($) are not considered sensitive.	depends
PlaceholderValues	The mapping of SQL placeholders to their values, for prepared statements.	yes

unsafe_upsert_namespace_entry

An event of type unsafe_upsert_namespace_entry is recorded when a namespace entry is written using crdb_internal.unsafe_upsert_namespace_entry().

The fields of this event type are reserved and can change across patch releases without advance notice.

Field	Description	Sensitive
ParentID		no
ParentSchemaID		no
Name		yes
PreviousID		no
Force		no
FailedValidation		no
ValidationErrors		yes

Common fields

Field	Description	Sensitive
Timestamp	The timestamp of the event. Expressed as nanoseconds since the Unix epoch.	no
EventType	The type of the event.	no
Statement	A normalized copy of the SQL statement that triggered the event. The statement string contains a mix of sensitive and non-sensitive details (it is redactable).	partially
Tag	The statement tag. This is separate from the statement string, since the statement string can contain sensitive information. The tag is guaranteed not to.	no
User	The user account that triggered the event. The special usernames root and node are not considered sensitive.	depends
DescriptorID	The primary object descriptor affected by the operation. Set to zero for operations that don't affect descriptors.	no
ApplicationName	The application name for the session where the event was emitted. This is included in the event to ease filtering of logging output by application. Application names starting with a dollar sign ($) are not considered sensitive.	depends
PlaceholderValues	The mapping of SQL placeholders to their values, for prepared statements.	yes

SQL Privilege changes

Events in this category pertain to DDL (Data Definition Language) operations performed by SQL statements that modify the privilege grants for stored objects.

They are relative to a particular SQL tenant. In a multi-tenant setup, copies of DDL-related events are preserved in each tenant's own system.eventlog table.

Events in this category are logged to the PRIVILEGES channel.

alter_database_owner

An event of type alter_database_owner is recorded when a database's owner is changed.

Field	Description	Sensitive
DatabaseName	The name of the database being affected.	yes
Owner	The name of the new owner.	yes

Common fields

Field	Description	Sensitive
Timestamp	The timestamp of the event. Expressed as nanoseconds since the Unix epoch.	no
EventType	The type of the event.	no
Statement	A normalized copy of the SQL statement that triggered the event. The statement string contains a mix of sensitive and non-sensitive details (it is redactable).	partially
Tag	The statement tag. This is separate from the statement string, since the statement string can contain sensitive information. The tag is guaranteed not to.	no
User	The user account that triggered the event. The special usernames root and node are not considered sensitive.	depends
DescriptorID	The primary object descriptor affected by the operation. Set to zero for operations that don't affect descriptors.	no
ApplicationName	The application name for the session where the event was emitted. This is included in the event to ease filtering of logging output by application. Application names starting with a dollar sign ($) are not considered sensitive.	depends
PlaceholderValues	The mapping of SQL placeholders to their values, for prepared statements.	yes

alter_default_privileges

An event of type alter_default_privileges is recorded when default privileges are changed.

Field	Description	Sensitive
DatabaseName	The name of the affected database.	yes
RoleName	Either role_name should be populated or for_all_roles should be true. The role having its default privileges altered.	yes
ForAllRoles	Identifies if FOR ALL ROLES is used.	no
SchemaName	The names of the affected schema.	yes

Common fields

Field	Description	Sensitive
Timestamp	The timestamp of the event. Expressed as nanoseconds since the Unix epoch.	no
EventType	The type of the event.	no
Statement	A normalized copy of the SQL statement that triggered the event. The statement string contains a mix of sensitive and non-sensitive details (it is redactable).	partially
Tag	The statement tag. This is separate from the statement string, since the statement string can contain sensitive information. The tag is guaranteed not to.	no
User	The user account that triggered the event. The special usernames root and node are not considered sensitive.	depends
DescriptorID	The primary object descriptor affected by the operation. Set to zero for operations that don't affect descriptors.	no
ApplicationName	The application name for the session where the event was emitted. This is included in the event to ease filtering of logging output by application. Application names starting with a dollar sign ($) are not considered sensitive.	depends
PlaceholderValues	The mapping of SQL placeholders to their values, for prepared statements.	yes
Grantee	The user/role affected by the grant or revoke operation.	yes
GrantedPrivileges	The privileges being granted to the grantee.	no
RevokedPrivileges	The privileges being revoked from the grantee.	no

alter_schema_owner

An event of type alter_schema_owner is recorded when a schema's owner is changed.

Field	Description	Sensitive
SchemaName	The name of the affected schema.	yes
Owner	The name of the new owner.	yes

Common fields

Field	Description	Sensitive
Timestamp	The timestamp of the event. Expressed as nanoseconds since the Unix epoch.	no
EventType	The type of the event.	no
Statement	A normalized copy of the SQL statement that triggered the event. The statement string contains a mix of sensitive and non-sensitive details (it is redactable).	partially
Tag	The statement tag. This is separate from the statement string, since the statement string can contain sensitive information. The tag is guaranteed not to.	no
User	The user account that triggered the event. The special usernames root and node are not considered sensitive.	depends
DescriptorID	The primary object descriptor affected by the operation. Set to zero for operations that don't affect descriptors.	no
ApplicationName	The application name for the session where the event was emitted. This is included in the event to ease filtering of logging output by application. Application names starting with a dollar sign ($) are not considered sensitive.	depends
PlaceholderValues	The mapping of SQL placeholders to their values, for prepared statements.	yes

alter_table_owner

An event of type alter_table_owner is recorded when the owner of a table, view or sequence is changed.

Field	Description	Sensitive
TableName	The name of the affected object.	yes
Owner	The name of the new owner.	yes

Common fields

Field	Description	Sensitive
Timestamp	The timestamp of the event. Expressed as nanoseconds since the Unix epoch.	no
EventType	The type of the event.	no
Statement	A normalized copy of the SQL statement that triggered the event. The statement string contains a mix of sensitive and non-sensitive details (it is redactable).	partially
Tag	The statement tag. This is separate from the statement string, since the statement string can contain sensitive information. The tag is guaranteed not to.	no
User	The user account that triggered the event. The special usernames root and node are not considered sensitive.	depends
DescriptorID	The primary object descriptor affected by the operation. Set to zero for operations that don't affect descriptors.	no
ApplicationName	The application name for the session where the event was emitted. This is included in the event to ease filtering of logging output by application. Application names starting with a dollar sign ($) are not considered sensitive.	depends
PlaceholderValues	The mapping of SQL placeholders to their values, for prepared statements.	yes

alter_type_owner

An event of type alter_type_owner is recorded when the owner of a user-defiend type is changed.

Field	Description	Sensitive
TypeName	The name of the affected type.	yes
Owner	The name of the new owner.	yes

Common fields

Field	Description	Sensitive
Timestamp	The timestamp of the event. Expressed as nanoseconds since the Unix epoch.	no
EventType	The type of the event.	no
Statement	A normalized copy of the SQL statement that triggered the event. The statement string contains a mix of sensitive and non-sensitive details (it is redactable).	partially
Tag	The statement tag. This is separate from the statement string, since the statement string can contain sensitive information. The tag is guaranteed not to.	no
User	The user account that triggered the event. The special usernames root and node are not considered sensitive.	depends
DescriptorID	The primary object descriptor affected by the operation. Set to zero for operations that don't affect descriptors.	no
ApplicationName	The application name for the session where the event was emitted. This is included in the event to ease filtering of logging output by application. Application names starting with a dollar sign ($) are not considered sensitive.	depends
PlaceholderValues	The mapping of SQL placeholders to their values, for prepared statements.	yes

change_database_privilege

An event of type change_database_privilege is recorded when privileges are added to / removed from a user for a database object.

Field	Description	Sensitive
DatabaseName	The name of the affected database.	yes

Common fields

Field	Description	Sensitive
Timestamp	The timestamp of the event. Expressed as nanoseconds since the Unix epoch.	no
EventType	The type of the event.	no
Statement	A normalized copy of the SQL statement that triggered the event. The statement string contains a mix of sensitive and non-sensitive details (it is redactable).	partially
Tag	The statement tag. This is separate from the statement string, since the statement string can contain sensitive information. The tag is guaranteed not to.	no
User	The user account that triggered the event. The special usernames root and node are not considered sensitive.	depends
DescriptorID	The primary object descriptor affected by the operation. Set to zero for operations that don't affect descriptors.	no
ApplicationName	The application name for the session where the event was emitted. This is included in the event to ease filtering of logging output by application. Application names starting with a dollar sign ($) are not considered sensitive.	depends
PlaceholderValues	The mapping of SQL placeholders to their values, for prepared statements.	yes
Grantee	The user/role affected by the grant or revoke operation.	yes
GrantedPrivileges	The privileges being granted to the grantee.	no
RevokedPrivileges	The privileges being revoked from the grantee.	no

change_schema_privilege

An event of type change_schema_privilege is recorded when privileges are added to / removed from a user for a schema object.

Field	Description	Sensitive
SchemaName	The name of the affected schema.	yes

Common fields

Field	Description	Sensitive
Timestamp	The timestamp of the event. Expressed as nanoseconds since the Unix epoch.	no
EventType	The type of the event.	no
Statement	A normalized copy of the SQL statement that triggered the event. The statement string contains a mix of sensitive and non-sensitive details (it is redactable).	partially
Tag	The statement tag. This is separate from the statement string, since the statement string can contain sensitive information. The tag is guaranteed not to.	no
User	The user account that triggered the event. The special usernames root and node are not considered sensitive.	depends
DescriptorID	The primary object descriptor affected by the operation. Set to zero for operations that don't affect descriptors.	no
ApplicationName	The application name for the session where the event was emitted. This is included in the event to ease filtering of logging output by application. Application names starting with a dollar sign ($) are not considered sensitive.	depends
PlaceholderValues	The mapping of SQL placeholders to their values, for prepared statements.	yes
Grantee	The user/role affected by the grant or revoke operation.	yes
GrantedPrivileges	The privileges being granted to the grantee.	no
RevokedPrivileges	The privileges being revoked from the grantee.	no

change_table_privilege

An event of type change_table_privilege is recorded when privileges are added to / removed from a user for a table, sequence or view object.

Field	Description	Sensitive
TableName	The name of the affected table.	yes

Common fields

Field	Description	Sensitive
Timestamp	The timestamp of the event. Expressed as nanoseconds since the Unix epoch.	no
EventType	The type of the event.	no
Statement	A normalized copy of the SQL statement that triggered the event. The statement string contains a mix of sensitive and non-sensitive details (it is redactable).	partially
Tag	The statement tag. This is separate from the statement string, since the statement string can contain sensitive information. The tag is guaranteed not to.	no
User	The user account that triggered the event. The special usernames root and node are not considered sensitive.	depends
DescriptorID	The primary object descriptor affected by the operation. Set to zero for operations that don't affect descriptors.	no
ApplicationName	The application name for the session where the event was emitted. This is included in the event to ease filtering of logging output by application. Application names starting with a dollar sign ($) are not considered sensitive.	depends
PlaceholderValues	The mapping of SQL placeholders to their values, for prepared statements.	yes
Grantee	The user/role affected by the grant or revoke operation.	yes
GrantedPrivileges	The privileges being granted to the grantee.	no
RevokedPrivileges	The privileges being revoked from the grantee.	no

change_type_privilege

An event of type change_type_privilege is recorded when privileges are added to / removed from a user for a type object.

Field	Description	Sensitive
TypeName	The name of the affected type.	yes

Common fields

Field	Description	Sensitive
Timestamp	The timestamp of the event. Expressed as nanoseconds since the Unix epoch.	no
EventType	The type of the event.	no
Statement	A normalized copy of the SQL statement that triggered the event. The statement string contains a mix of sensitive and non-sensitive details (it is redactable).	partially
Tag	The statement tag. This is separate from the statement string, since the statement string can contain sensitive information. The tag is guaranteed not to.	no
User	The user account that triggered the event. The special usernames root and node are not considered sensitive.	depends
DescriptorID	The primary object descriptor affected by the operation. Set to zero for operations that don't affect descriptors.	no
ApplicationName	The application name for the session where the event was emitted. This is included in the event to ease filtering of logging output by application. Application names starting with a dollar sign ($) are not considered sensitive.	depends
PlaceholderValues	The mapping of SQL placeholders to their values, for prepared statements.	yes
Grantee	The user/role affected by the grant or revoke operation.	yes
GrantedPrivileges	The privileges being granted to the grantee.	no
RevokedPrivileges	The privileges being revoked from the grantee.	no

SQL Session events

Events in this category report SQL client connections and sessions.

They are relative to a particular SQL tenant. In a multi-tenant setup, copies of these miscellaneous events are preserved in each tenant's own system.eventlog table.

Events in this category are logged to the SESSIONS channel.

client_authentication_failed

An event of type client_authentication_failed is reported when a client session did not authenticate successfully.

Events of this type are only emitted when the cluster setting server.auth_log.sql_sessions.enabled is set.

Field	Description	Sensitive
Reason	The reason for the authentication failure. See below for possible values for type AuthFailReason.	no
Detail	The detailed error for the authentication failure.	yes
Method	The authentication method used.	no

Common fields

Field	Description	Sensitive
Timestamp	The timestamp of the event. Expressed as nanoseconds since the Unix epoch.	no
EventType	The type of the event.	no
InstanceID	The instance ID (not tenant ID) of the SQL server where the event was originated.	no
Network	The network protocol for this connection: tcp4, tcp6, unix, etc.	no
RemoteAddress	The remote address of the SQL client. Note that when using a proxy or other intermediate server, this field will contain the address of the intermediate server.	yes
Transport	The connection type after transport negotiation.	no
User	The database username the session is for. This username will have undergone case-folding and Unicode normalization.	yes
SystemIdentity	The original system identity provided by the client, if an identity mapping was used per Host-Based Authentication rules. This may be a GSSAPI or X.509 principal or any other external value, so no specific assumptions should be made about the contents of this field.	yes

client_authentication_info

An event of type client_authentication_info is reported for intermediate steps during the authentication process.

Events of this type are only emitted when the cluster setting server.auth_log.sql_sessions.enabled is set.

Field	Description	Sensitive
Method	The authentication method used, once known.	no
Info	The authentication progress message.	yes

Common fields

Field	Description	Sensitive
Timestamp	The timestamp of the event. Expressed as nanoseconds since the Unix epoch.	no
EventType	The type of the event.	no
InstanceID	The instance ID (not tenant ID) of the SQL server where the event was originated.	no
Network	The network protocol for this connection: tcp4, tcp6, unix, etc.	no
RemoteAddress	The remote address of the SQL client. Note that when using a proxy or other intermediate server, this field will contain the address of the intermediate server.	yes
Transport	The connection type after transport negotiation.	no
User	The database username the session is for. This username will have undergone case-folding and Unicode normalization.	yes
SystemIdentity	The original system identity provided by the client, if an identity mapping was used per Host-Based Authentication rules. This may be a GSSAPI or X.509 principal or any other external value, so no specific assumptions should be made about the contents of this field.	yes

client_authentication_ok

An event of type client_authentication_ok is reported when a client session was authenticated successfully.

Events of this type are only emitted when the cluster setting server.auth_log.sql_sessions.enabled is set.

Field	Description	Sensitive
Method	The authentication method used.	no

Common fields

Field	Description	Sensitive
Timestamp	The timestamp of the event. Expressed as nanoseconds since the Unix epoch.	no
EventType	The type of the event.	no
InstanceID	The instance ID (not tenant ID) of the SQL server where the event was originated.	no
Network	The network protocol for this connection: tcp4, tcp6, unix, etc.	no
RemoteAddress	The remote address of the SQL client. Note that when using a proxy or other intermediate server, this field will contain the address of the intermediate server.	yes
Transport	The connection type after transport negotiation.	no
User	The database username the session is for. This username will have undergone case-folding and Unicode normalization.	yes
SystemIdentity	The original system identity provided by the client, if an identity mapping was used per Host-Based Authentication rules. This may be a GSSAPI or X.509 principal or any other external value, so no specific assumptions should be made about the contents of this field.	yes

client_connection_end

An event of type client_connection_end is reported when a client connection is closed. This is reported even when authentication fails, and even for simple cancellation messages.

Events of this type are only emitted when the cluster setting server.auth_log.sql_connections.enabled is set.

Field	Description	Sensitive
Duration	The duration of the connection in nanoseconds.	no

Common fields

Field	Description	Sensitive
Timestamp	The timestamp of the event. Expressed as nanoseconds since the Unix epoch.	no
EventType	The type of the event.	no
InstanceID	The instance ID (not tenant ID) of the SQL server where the event was originated.	no
Network	The network protocol for this connection: tcp4, tcp6, unix, etc.	no
RemoteAddress	The remote address of the SQL client. Note that when using a proxy or other intermediate server, this field will contain the address of the intermediate server.	yes

client_connection_start

An event of type client_connection_start is reported when a client connection is established. This is reported even when authentication fails, and even for simple cancellation messages.

Events of this type are only emitted when the cluster setting server.auth_log.sql_connections.enabled is set.

Common fields

Field	Description	Sensitive
Timestamp	The timestamp of the event. Expressed as nanoseconds since the Unix epoch.	no
EventType	The type of the event.	no
InstanceID	The instance ID (not tenant ID) of the SQL server where the event was originated.	no
Network	The network protocol for this connection: tcp4, tcp6, unix, etc.	no
RemoteAddress	The remote address of the SQL client. Note that when using a proxy or other intermediate server, this field will contain the address of the intermediate server.	yes

client_session_end

An event of type client_session_end is reported when a client session is completed.

Events of this type are only emitted when the cluster setting server.auth_log.sql_sessions.enabled is set.

Field	Description	Sensitive
Duration	The duration of the connection in nanoseconds.	no

Common fields

Field	Description	Sensitive
Timestamp	The timestamp of the event. Expressed as nanoseconds since the Unix epoch.	no
EventType	The type of the event.	no
InstanceID	The instance ID (not tenant ID) of the SQL server where the event was originated.	no
Network	The network protocol for this connection: tcp4, tcp6, unix, etc.	no
RemoteAddress	The remote address of the SQL client. Note that when using a proxy or other intermediate server, this field will contain the address of the intermediate server.	yes
Transport	The connection type after transport negotiation.	no
User	The database username the session is for. This username will have undergone case-folding and Unicode normalization.	yes
SystemIdentity	The original system identity provided by the client, if an identity mapping was used per Host-Based Authentication rules. This may be a GSSAPI or X.509 principal or any other external value, so no specific assumptions should be made about the contents of this field.	yes

SQL Slow Query Log

Events in this category report slow query execution.

Note: these events are not written to system.eventlog, even when the cluster setting system.eventlog.enabled is set. They are only emitted via external logging.

Events in this category are logged to the SQL_PERF channel.

large_row

An event of type large_row is recorded when a statement tries to write a row larger than cluster setting sql.guardrails.max_row_size_log to the database. Multiple LargeRow events will be recorded for statements writing multiple large rows. LargeRow events are recorded before the transaction commits, so in the case of transaction abort there will not be a corresponding row in the database.

Common fields

Field	Description	Sensitive
Timestamp	The timestamp of the event. Expressed as nanoseconds since the Unix epoch.	no
EventType	The type of the event.	no
RowSize		no
TableID		no
FamilyID		no
PrimaryKey		yes

slow_query

An event of type slow_query is recorded when a query triggers the "slow query" condition.

As of this writing, the condition requires:

• the cluster setting sql.log.slow_query.latency_threshold set to a non-zero value, AND
• EITHER of the following conditions:
• the actual age of the query exceeds the configured threshold; AND/OR
• the query performs a full table/index scan AND the cluster setting sql.log.slow_query.experimental_full_table_scans.enabled is set.

Common fields

Field	Description	Sensitive
Timestamp	The timestamp of the event. Expressed as nanoseconds since the Unix epoch.	no
EventType	The type of the event.	no
Statement	A normalized copy of the SQL statement that triggered the event. The statement string contains a mix of sensitive and non-sensitive details (it is redactable).	partially
Tag	The statement tag. This is separate from the statement string, since the statement string can contain sensitive information. The tag is guaranteed not to.	no
User	The user account that triggered the event. The special usernames root and node are not considered sensitive.	depends
DescriptorID	The primary object descriptor affected by the operation. Set to zero for operations that don't affect descriptors.	no
ApplicationName	The application name for the session where the event was emitted. This is included in the event to ease filtering of logging output by application. Application names starting with a dollar sign ($) are not considered sensitive.	depends
PlaceholderValues	The mapping of SQL placeholders to their values, for prepared statements.	yes
ExecMode	How the statement was being executed (exec/prepare, etc.)	no
NumRows	Number of rows returned. For mutation statements (INSERT, etc) that do not produce result rows, this field reports the number of rows affected.	no
SQLSTATE	The SQLSTATE code for the error, if an error was encountered. Empty/omitted if no error.	no
ErrorText	The text of the error if any.	yes
Age	Age of the query in milliseconds.	no
NumRetries	Number of retries, when the txn was reretried automatically by the server.	no
FullTableScan	Whether the query contains a full table scan.	no
FullIndexScan	Whether the query contains a full secondary index scan of a non-partial index.	no
TxnCounter	The sequence number of the SQL transaction inside its session.	no

txn_rows_read_limit

An event of type txn_rows_read_limit is recorded when a transaction tries to read more rows than cluster setting sql.defaults.transaction_rows_read_log. There will only be a single record for a single transaction (unless it is retried) even if there are more statement within the transaction that haven't been executed yet.

Common fields

Field	Description	Sensitive
Timestamp	The timestamp of the event. Expressed as nanoseconds since the Unix epoch.	no
EventType	The type of the event.	no
Statement	A normalized copy of the SQL statement that triggered the event. The statement string contains a mix of sensitive and non-sensitive details (it is redactable).	partially
Tag	The statement tag. This is separate from the statement string, since the statement string can contain sensitive information. The tag is guaranteed not to.	no
User	The user account that triggered the event. The special usernames root and node are not considered sensitive.	depends
DescriptorID	The primary object descriptor affected by the operation. Set to zero for operations that don't affect descriptors.	no
ApplicationName	The application name for the session where the event was emitted. This is included in the event to ease filtering of logging output by application. Application names starting with a dollar sign ($) are not considered sensitive.	depends
PlaceholderValues	The mapping of SQL placeholders to their values, for prepared statements.	yes
TxnID	TxnID is the ID of the transaction that hit the row count limit.	no
SessionID	SessionID is the ID of the session that initiated the transaction.	no
NumRows	NumRows is the number of rows written/read (depending on the event type) by the transaction that reached the corresponding guardrail.	no

txn_rows_written_limit

An event of type txn_rows_written_limit is recorded when a transaction tries to write more rows than cluster setting sql.defaults.transaction_rows_written_log. There will only be a single record for a single transaction (unless it is retried) even if there are more mutation statements within the transaction that haven't been executed yet.

Common fields

Field	Description	Sensitive
Timestamp	The timestamp of the event. Expressed as nanoseconds since the Unix epoch.	no
EventType	The type of the event.	no
Statement	A normalized copy of the SQL statement that triggered the event. The statement string contains a mix of sensitive and non-sensitive details (it is redactable).	partially
Tag	The statement tag. This is separate from the statement string, since the statement string can contain sensitive information. The tag is guaranteed not to.	no
User	The user account that triggered the event. The special usernames root and node are not considered sensitive.	depends
DescriptorID	The primary object descriptor affected by the operation. Set to zero for operations that don't affect descriptors.	no
ApplicationName	The application name for the session where the event was emitted. This is included in the event to ease filtering of logging output by application. Application names starting with a dollar sign ($) are not considered sensitive.	depends
PlaceholderValues	The mapping of SQL placeholders to their values, for prepared statements.	yes
TxnID	TxnID is the ID of the transaction that hit the row count limit.	no
SessionID	SessionID is the ID of the session that initiated the transaction.	no
NumRows	NumRows is the number of rows written/read (depending on the event type) by the transaction that reached the corresponding guardrail.	no

SQL Slow Query Log (Internal)

Events in this category report slow query execution by internal executors, i.e., when CockroachDB internally issues SQL statements.

Note: these events are not written to system.eventlog, even when the cluster setting system.eventlog.enabled is set. They are only emitted via external logging.

Events in this category are logged to the SQL_INTERNAL_PERF channel.

large_row_internal

An event of type large_row_internal is recorded when an internal query tries to write a row larger than cluster settings sql.guardrails.max_row_size_log or sql.guardrails.max_row_size_err to the database.

Common fields

Field	Description	Sensitive
Timestamp	The timestamp of the event. Expressed as nanoseconds since the Unix epoch.	no
EventType	The type of the event.	no
RowSize		no
TableID		no
FamilyID		no
PrimaryKey		yes

slow_query_internal

An event of type slow_query_internal is recorded when a query triggers the "slow query" condition, and the cluster setting sql.log.slow_query.internal_queries.enabled is set. See the documentation for the event type slow_query for details about the "slow query" condition.

Common fields

Field	Description	Sensitive
Timestamp	The timestamp of the event. Expressed as nanoseconds since the Unix epoch.	no
EventType	The type of the event.	no
Statement	A normalized copy of the SQL statement that triggered the event. The statement string contains a mix of sensitive and non-sensitive details (it is redactable).	partially
Tag	The statement tag. This is separate from the statement string, since the statement string can contain sensitive information. The tag is guaranteed not to.	no
User	The user account that triggered the event. The special usernames root and node are not considered sensitive.	depends
DescriptorID	The primary object descriptor affected by the operation. Set to zero for operations that don't affect descriptors.	no
ApplicationName	The application name for the session where the event was emitted. This is included in the event to ease filtering of logging output by application. Application names starting with a dollar sign ($) are not considered sensitive.	depends
PlaceholderValues	The mapping of SQL placeholders to their values, for prepared statements.	yes
ExecMode	How the statement was being executed (exec/prepare, etc.)	no
NumRows	Number of rows returned. For mutation statements (INSERT, etc) that do not produce result rows, this field reports the number of rows affected.	no
SQLSTATE	The SQLSTATE code for the error, if an error was encountered. Empty/omitted if no error.	no
ErrorText	The text of the error if any.	yes
Age	Age of the query in milliseconds.	no
NumRetries	Number of retries, when the txn was reretried automatically by the server.	no
FullTableScan	Whether the query contains a full table scan.	no
FullIndexScan	Whether the query contains a full secondary index scan of a non-partial index.	no
TxnCounter	The sequence number of the SQL transaction inside its session.	no

txn_rows_read_limit_internal

An event of type txn_rows_read_limit_internal is recorded when an internal transaction tries to read more rows than cluster setting sql.defaults.transaction_rows_read_log or sql.defaults.transaction_rows_read_err. There will only be a single record for a single transaction (unless it is retried) even if there are more mutation statements within the transaction that haven't been executed yet.

Common fields

Field	Description	Sensitive
Timestamp	The timestamp of the event. Expressed as nanoseconds since the Unix epoch.	no
EventType	The type of the event.	no
Statement	A normalized copy of the SQL statement that triggered the event. The statement string contains a mix of sensitive and non-sensitive details (it is redactable).	partially
Tag	The statement tag. This is separate from the statement string, since the statement string can contain sensitive information. The tag is guaranteed not to.	no
User	The user account that triggered the event. The special usernames root and node are not considered sensitive.	depends
DescriptorID	The primary object descriptor affected by the operation. Set to zero for operations that don't affect descriptors.	no
ApplicationName	The application name for the session where the event was emitted. This is included in the event to ease filtering of logging output by application. Application names starting with a dollar sign ($) are not considered sensitive.	depends
PlaceholderValues	The mapping of SQL placeholders to their values, for prepared statements.	yes
TxnID	TxnID is the ID of the transaction that hit the row count limit.	no
SessionID	SessionID is the ID of the session that initiated the transaction.	no
NumRows	NumRows is the number of rows written/read (depending on the event type) by the transaction that reached the corresponding guardrail.	no

txn_rows_written_limit_internal

An event of type txn_rows_written_limit_internal is recorded when an internal transaction tries to write more rows than cluster setting sql.defaults.transaction_rows_written_log or sql.defaults.transaction_rows_written_err. There will only be a single record for a single transaction (unless it is retried) even if there are more mutation statements within the transaction that haven't been executed yet.

Common fields

Field	Description	Sensitive
Timestamp	The timestamp of the event. Expressed as nanoseconds since the Unix epoch.	no
EventType	The type of the event.	no
Statement	A normalized copy of the SQL statement that triggered the event. The statement string contains a mix of sensitive and non-sensitive details (it is redactable).	partially
Tag	The statement tag. This is separate from the statement string, since the statement string can contain sensitive information. The tag is guaranteed not to.	no
User	The user account that triggered the event. The special usernames root and node are not considered sensitive.	depends
DescriptorID	The primary object descriptor affected by the operation. Set to zero for operations that don't affect descriptors.	no
ApplicationName	The application name for the session where the event was emitted. This is included in the event to ease filtering of logging output by application. Application names starting with a dollar sign ($) are not considered sensitive.	depends
PlaceholderValues	The mapping of SQL placeholders to their values, for prepared statements.	yes
TxnID	TxnID is the ID of the transaction that hit the row count limit.	no
SessionID	SessionID is the ID of the session that initiated the transaction.	no
NumRows	NumRows is the number of rows written/read (depending on the event type) by the transaction that reached the corresponding guardrail.	no

SQL User and Role operations

Events in this category pertain to SQL statements that modify the properties of users and roles.

They are relative to a particular SQL tenant. In a multi-tenant setup, copies of DDL-related events are preserved in each tenant's own system.eventlog table.

Events in this category are logged to the USER_ADMIN channel.

alter_role

An event of type alter_role is recorded when a role is altered.

Field	Description	Sensitive
RoleName	The name of the affected user/role.	yes
Options	The options set on the user/role.	no

Common fields

Field	Description	Sensitive
Timestamp	The timestamp of the event. Expressed as nanoseconds since the Unix epoch.	no
EventType	The type of the event.	no
Statement	A normalized copy of the SQL statement that triggered the event. The statement string contains a mix of sensitive and non-sensitive details (it is redactable).	partially
Tag	The statement tag. This is separate from the statement string, since the statement string can contain sensitive information. The tag is guaranteed not to.	no
User	The user account that triggered the event. The special usernames root and node are not considered sensitive.	depends
DescriptorID	The primary object descriptor affected by the operation. Set to zero for operations that don't affect descriptors.	no
ApplicationName	The application name for the session where the event was emitted. This is included in the event to ease filtering of logging output by application. Application names starting with a dollar sign ($) are not considered sensitive.	depends
PlaceholderValues	The mapping of SQL placeholders to their values, for prepared statements.	yes

create_role

An event of type create_role is recorded when a role is created.

Field	Description	Sensitive
RoleName	The name of the new user/role.	yes

Common fields

Field	Description	Sensitive
Timestamp	The timestamp of the event. Expressed as nanoseconds since the Unix epoch.	no
EventType	The type of the event.	no
Statement	A normalized copy of the SQL statement that triggered the event. The statement string contains a mix of sensitive and non-sensitive details (it is redactable).	partially
Tag	The statement tag. This is separate from the statement string, since the statement string can contain sensitive information. The tag is guaranteed not to.	no
User	The user account that triggered the event. The special usernames root and node are not considered sensitive.	depends
DescriptorID	The primary object descriptor affected by the operation. Set to zero for operations that don't affect descriptors.	no
ApplicationName	The application name for the session where the event was emitted. This is included in the event to ease filtering of logging output by application. Application names starting with a dollar sign ($) are not considered sensitive.	depends
PlaceholderValues	The mapping of SQL placeholders to their values, for prepared statements.	yes

drop_role

An event of type drop_role is recorded when a role is dropped.

Field	Description	Sensitive
RoleName	The name of the affected user/role.	yes

Common fields

Field	Description	Sensitive
Timestamp	The timestamp of the event. Expressed as nanoseconds since the Unix epoch.	no
EventType	The type of the event.	no
Statement	A normalized copy of the SQL statement that triggered the event. The statement string contains a mix of sensitive and non-sensitive details (it is redactable).	partially
Tag	The statement tag. This is separate from the statement string, since the statement string can contain sensitive information. The tag is guaranteed not to.	no
User	The user account that triggered the event. The special usernames root and node are not considered sensitive.	depends
DescriptorID	The primary object descriptor affected by the operation. Set to zero for operations that don't affect descriptors.	no
ApplicationName	The application name for the session where the event was emitted. This is included in the event to ease filtering of logging output by application. Application names starting with a dollar sign ($) are not considered sensitive.	depends
PlaceholderValues	The mapping of SQL placeholders to their values, for prepared statements.	yes

Telemetry events

Events in this category are logged to the TELEMETRY channel.

sampled_query

An event of type sampled_query is the SQL query event logged to the telemetry channel. It contains common SQL event/execution details.

Field	Description	Sensitive
SkippedQueries	skipped_queries indicate how many SQL statements were not considered for sampling prior to this one. If the field is omitted, or its value is zero, this indicates that no statement was omitted since the last event.	no
CostEstimate	Cost of the query as estimated by the optimizer.	no
Distribution	The distribution of the DistSQL query plan (local, full, or partial).	no

Common fields

Field	Description	Sensitive
Timestamp	The timestamp of the event. Expressed as nanoseconds since the Unix epoch.	no
EventType	The type of the event.	no
Statement	A normalized copy of the SQL statement that triggered the event. The statement string contains a mix of sensitive and non-sensitive details (it is redactable).	partially
Tag	The statement tag. This is separate from the statement string, since the statement string can contain sensitive information. The tag is guaranteed not to.	no
User	The user account that triggered the event. The special usernames root and node are not considered sensitive.	depends
DescriptorID	The primary object descriptor affected by the operation. Set to zero for operations that don't affect descriptors.	no
ApplicationName	The application name for the session where the event was emitted. This is included in the event to ease filtering of logging output by application. Application names starting with a dollar sign ($) are not considered sensitive.	depends
PlaceholderValues	The mapping of SQL placeholders to their values, for prepared statements.	yes
ExecMode	How the statement was being executed (exec/prepare, etc.)	no
NumRows	Number of rows returned. For mutation statements (INSERT, etc) that do not produce result rows, this field reports the number of rows affected.	no
SQLSTATE	The SQLSTATE code for the error, if an error was encountered. Empty/omitted if no error.	no
ErrorText	The text of the error if any.	yes
Age	Age of the query in milliseconds.	no
NumRetries	Number of retries, when the txn was reretried automatically by the server.	no
FullTableScan	Whether the query contains a full table scan.	no
FullIndexScan	Whether the query contains a full secondary index scan of a non-partial index.	no
TxnCounter	The sequence number of the SQL transaction inside its session.	no

Zone config events

Events in this category pertain to zone configuration changes on the SQL schema or system ranges.

When zone configs apply to individual tables or other objects in a SQL logical schema, they are relative to a particular SQL tenant. In a multi-tenant setup, copies of these zone config events are preserved in each tenant's own system.eventlog table.

When they apply to cluster-level ranges (e.g., the system zone config), they are stored in the system tenant's own system.eventlog table.

Events in this category are logged to the OPS channel.

remove_zone_config

An event of type remove_zone_config is recorded when a zone config is removed.

Common fields

Field	Description	Sensitive
Timestamp	The timestamp of the event. Expressed as nanoseconds since the Unix epoch.	no
EventType	The type of the event.	no
Statement	A normalized copy of the SQL statement that triggered the event. The statement string contains a mix of sensitive and non-sensitive details (it is redactable).	partially
Tag	The statement tag. This is separate from the statement string, since the statement string can contain sensitive information. The tag is guaranteed not to.	no
User	The user account that triggered the event. The special usernames root and node are not considered sensitive.	depends
DescriptorID	The primary object descriptor affected by the operation. Set to zero for operations that don't affect descriptors.	no
ApplicationName	The application name for the session where the event was emitted. This is included in the event to ease filtering of logging output by application. Application names starting with a dollar sign ($) are not considered sensitive.	depends
PlaceholderValues	The mapping of SQL placeholders to their values, for prepared statements.	yes
Target	The target object of the zone config change.	yes
Config	The applied zone config in YAML format.	yes
Options	The SQL representation of the applied zone config options.	yes

set_zone_config

An event of type set_zone_config is recorded when a zone config is changed.

Common fields

Field	Description	Sensitive
Timestamp	The timestamp of the event. Expressed as nanoseconds since the Unix epoch.	no
EventType	The type of the event.	no
Statement	A normalized copy of the SQL statement that triggered the event. The statement string contains a mix of sensitive and non-sensitive details (it is redactable).	partially
Tag	The statement tag. This is separate from the statement string, since the statement string can contain sensitive information. The tag is guaranteed not to.	no
User	The user account that triggered the event. The special usernames root and node are not considered sensitive.	depends
DescriptorID	The primary object descriptor affected by the operation. Set to zero for operations that don't affect descriptors.	no
ApplicationName	The application name for the session where the event was emitted. This is included in the event to ease filtering of logging output by application. Application names starting with a dollar sign ($) are not considered sensitive.	depends
PlaceholderValues	The mapping of SQL placeholders to their values, for prepared statements.	yes
Target	The target object of the zone config change.	yes
Config	The applied zone config in YAML format.	yes
Options	The SQL representation of the applied zone config options.	yes

Enumeration types

AuthFailReason

AuthFailReason is the inventory of possible reasons for an authentication failure.

Value	Textual alias in code or documentation	Description
0	UNKNOWN	is reported when the reason is unknown.
1	USER_RETRIEVAL_ERROR	occurs when there was an internal error accessing the principals.
2	USER_NOT_FOUND	occurs when the principal is unknown.
3	LOGIN_DISABLED	occurs when the user does not have LOGIN privileges.
4	METHOD_NOT_FOUND	occurs when no HBA rule matches or the method does not exist.
5	PRE_HOOK_ERROR	occurs when the authentication handshake encountered a protocol error.
6	CREDENTIALS_INVALID	occurs when the client-provided credentials were invalid.
7	CREDENTIALS_EXPIRED	occur when the credentials provided by the client are expired.