google-adk-kotlin-integrations-bigquery/com.google.adk.kt.plugins.agentanalytics/BigQueryLoggerConfig

BigQueryLoggerConfig

data class BigQueryLoggerConfig @JvmOverloads constructor(val projectId: String, val datasetId: String, val enabled: Boolean = true, val location: String = "US", val tableName: String = "agent_events", val credentials: Credentials? = null, val eventAllowlist: Set<String> = emptySet(), val eventDenylist: Set<String> = emptySet(), val maxContentLength: Int = 500 * 1024, val clusteringFields: List<String> = BigQuerySchema.getDefaultClusteringFields(), val logMultiModalContent: Boolean = true, val logSessionMetadata: Boolean = true, val customTags: Map<String, Any?> = emptyMap(), val autoSchemaUpgrade: Boolean = true, val createViews: Boolean = false, val viewPrefix: String = "v", val contentFormatter: (Any, String) -> Any?? = null)

Configuration for the BigQueryAgentAnalyticsPlugin.

Constructors

@JvmOverloads

constructor(projectId: String, datasetId: String, enabled: Boolean = true, location: String = "US", tableName: String = "agent_events", credentials: Credentials? = null, eventAllowlist: Set<String> = emptySet(), eventDenylist: Set<String> = emptySet(), maxContentLength: Int = 500 * 1024, clusteringFields: List<String> = BigQuerySchema.getDefaultClusteringFields(), logMultiModalContent: Boolean = true, logSessionMetadata: Boolean = true, customTags: Map<String, Any?> = emptyMap(), autoSchemaUpgrade: Boolean = true, createViews: Boolean = false, viewPrefix: String = "v", contentFormatter: (Any, String) -> Any?? = null)

Types

Builder

class Builder

Fluent builder for BigQueryLoggerConfig, provided primarily for Java callers. Any property left unset falls back to the same default as the constructor.

Companion

object Companion

Properties

autoSchemaUpgrade

val autoSchemaUpgrade: Boolean

Whether to add missing columns to an existing table, which needs the bigquery.tables.update permission; rows are dropped until the upgrade succeeds. When off, the table must already have every column.

clusteringFields

val clusteringFields: List<String>

Clustering columns for a newly created table.

contentFormatter

val contentFormatter: (Any, String) -> Any??

Called with each event's content and type; its result is logged in place of the content. If it throws, [FORMATTER_FAILED] is logged instead.

createViews

val createViews: Boolean

Whether to create or replace one view per event type when the first event is logged.

credentials

val credentials: Credentials?

Credentials for BigQuery; null uses Application Default Credentials.

customTags

val customTags: Map<String, Any?>

Tags logged with every event under attributes.custom_tags.

datasetId

val datasetId: String

BigQuery dataset that holds the events table.

enabled

val enabled: Boolean

Whether the plugin logs anything.

eventAllowlist

val eventAllowlist: Set<String>

Event types to log, such as LLM_REQUEST; empty logs every type.

eventDenylist

val eventDenylist: Set<String>

Event types never to log, even when allowlisted.

location

val location: String

BigQuery location of the dataset, such as US.

logMultiModalContent

val logMultiModalContent: Boolean

Whether to fill the content_parts column.

logSessionMetadata

val logSessionMetadata: Boolean

Whether to log the session ids and state under attributes.session_metadata.

maxContentLength

val maxContentLength: Int

Budget for each logged string in UTF-8 bytes, including the ...[TRUNCATED] marker; -1 is unlimited.

projectId

val projectId: String

Google Cloud project that holds the dataset.

tableName

val tableName: String

Events table, created on first use if it does not exist.

viewPrefix

val viewPrefix: String

Prefix of the view names, so v gives v_llm_request. Views are skipped if this prefix or the table's project, dataset or name has characters other than letters, digits, _ and -.

Functions

toBuilder

fun toBuilder(): BigQueryLoggerConfig.Builder

Returns a Builder initialized with this instance's properties, primarily for Java callers. Prefer it over copy from Java: copy takes every property positionally, so its signature changes whenever a property is added.