LogsSettingsinterface
Properties (25)
| Property | Type | Default | Required | Description |
|---|---|---|---|---|
| additionalAttributes⚓︎ | { [x: string]: unknown } | (() => { [x: string]: unknown }) | x | x | Additional logs attributes to publish as part of each log entry, specified as key/value pairs. You can use environment variables as values. Environment variables must start and end with a percent sign (e.g., |
| additionalResourceAttributes⚓︎ | { [x: string]: unknown } | (() => { [x: string]: unknown }) | x | x | Additional attributes to publish as part of the OTEL resource definition, specified as key/value pairs. You can use environment variables as values. Environment variables must start and end with a percent sign (e.g., |
| addResourceAttributesToAttributes⚓︎ | boolean | false | x | Whether to add resource attributes to log entry attributes. |
| compression⚓︎ | CompressionAlgorithm | x | x | Compression algorithm to use when exporting logs. |
| concurrencyLimit⚓︎ | number | x | x | Maximum number of concurrent logs export requests. |
| defaults⚓︎ | LogOptions | x | x | Default settings if appropriate entries aren't found in 'filters' collection. |
| enabled⚓︎ | boolean | false | Whether logging functionality is enabled. If disabled, API is still usable, but methods are no-ops. |
|
| exporterSettings⚓︎ | OTLPExporterConfigBase | x | x | Settings for the OTLP exporter used to send logs. |
| filters⚓︎ | LogFilter[] | x | x | Array of filter entries used to determine whether a particular log entry will be emitted, and which attributes will be included. If no matching filter entry is found, the settings from 'defaults' are used. |
| headers⚓︎ | { [x: string]: string } | (() => { [x: string]: string }) | x | x | Additional headers to send in HTTP requests, e.g. when using HTTP exporters. |
| keepAlive⚓︎ | boolean | true | x | Whether to keep the connection alive when sending logs. |
| levelCountMetric⚓︎ | string | insights_log_level_count | x | Name of log level counter metric, set to null to disable. |
| logExporters⚓︎ | (exporterSettings: OTLPExporterNodeConfigBase, settings: LogsSettings, otelSettings: Settings) => LogRecordExporter[] | x | x | Log record exporters. |
| loggerProvider⚓︎ | (loggerProviderSettings: LoggerProviderConfig, settings: LogsSettings, otelSettings: Settings) => LoggerProvider | x | x | Logger provider instance. |
| loggerProviderSettings⚓︎ | LoggerProviderConfig | x | x | Configuration for the logger provider. |
| logProcessors⚓︎ | (processorSettings: BatchSpanProcessorBrowserConfig | undefined, exporterSettings: OTLPExporterNodeConfigBase, settings: LogsSettings, otelSettings: Settings) => LogRecordProcessor[] | x | x | Log record processors. |
| maxAttributeDepth⚓︎ | number | x | x | Maximum length for log attribute object nesting. |
| processorSettings⚓︎ | BatchLogRecordProcessorBrowserConfig | x | x | Settings for batching log records before export. |
| publishInterval⚓︎ | number | x | x | Interval in milliseconds between logs export batches. |
| startupTraceAssociationTimeoutMs⚓︎ | number | x | x | How long after application startup will any log entries automatically be associated with the application startup trace. |
| timeoutMillis⚓︎ | number | 10000ms. | x | Maximum time the OTLP exporter will wait for each batch export. |
| url⚓︎ | string | x | x | OTLP logs exporter endpoint URL. |
| useDefaultFilters⚓︎ | boolean | true | x | If true, use a predefined list of filters for well-known platform logs. |
| useSSOAuth⚓︎ | boolean | false | x | If |
| useSSOAuthRawToken⚓︎ | boolean | true | x | Used if io.Connect's SSO login information contains a |