Skip to content
Search
DSL · Pg query

postgresql_telemetry_options

Definition

/**
 * Create telemetry options for PostgreSQL client instrumentation.
 *
 * Controls which telemetry signals (traces, metrics, logs) are enabled
 * and how query information is captured.
 *
 * @param bool $traceQueries Create spans for query execution (default: true)
 * @param bool $traceTransactions Create spans for transactions (default: true)
 * @param bool $collectMetrics Collect duration and row count metrics (default: true)
 * @param bool $logQueries Log executed queries (default: false)
 * @param null|int $maxQueryLength Maximum query text length in telemetry (default: 1000, null = unlimited)
 * @param bool $includeParameters Include query parameters in telemetry (default: false, security consideration)
 *
 * @example
 * // Default options (traces and metrics enabled)
 * $options = postgresql_telemetry_options();
 *
 * // Enable query logging
 * $options = postgresql_telemetry_options(logQueries: true);
 *
 * // Disable all but metrics
 * $options = postgresql_telemetry_options(
 *     traceQueries: false,
 *     traceTransactions: false,
 *     collectMetrics: true,
 * );
 */
postgresql_telemetry_options(bool $traceQueries, bool $traceTransactions, bool $collectMetrics, bool $logQueries, ?int $maxQueryLength, bool $includeParameters, ?int $maxParameters, ?int $maxParameterLength) : PostgreSqlTelemetryOptions

Contributors

Built in the open.

Join us on GitHub
scroll back to top