Open Telemetry settings
Open Telemetry settings configure support for Open Telemetry in Open Banking Connector.
Open Telemetry allows centralised collection of logging, distributed tracing and metrics data from running applications/services such as Open Banking Connector. The data format is standardised and vendor-neutral.
The service name used by Open Banking Connector for Open Telemetry can be customised using the setting OpenBankingConnector:OpenTelemetry:ServiceName. The service version used for Open Telemetry will be set to the product version of Open Banking Connector.
Support for Open Telemetry logging
Support for Open Telemetry logging can be enabled by specifying an exporter URL in OpenBankingConnector:OpenTelemetry:Logging:OtlpExporterUrl.
By default, Open Telemetry trace and span IDs (related to tracing) are included with all logs including console logs.
Support for Open Telemetry tracing
Support for Open Telemetry tracing can be enabled by setting OpenBankingConnector:OpenTelemetry:UseConsoleExporter to true (for console output) or specifying an exporter URL in OpenBankingConnector:OpenTelemetry:Tracing:OtlpExporterUrl. You can control the level of output by means of OpenBankingConnector:OpenTelemetry:Tracing:ProviderFilter.
To propagate trace IDs from a service making requests to Open Banking Connector, please include the traceparent header as described here in requests to Open Banking Connector.
Support for Open Telemetry metrics
Support for Open Telemetry metrics can be enabled by setting OpenBankingConnector:OpenTelemetry:UseConsoleExporter to true (for console output) or specifying an exporter URL in OpenBankingConnector:OpenTelemetry:Metrics:OtlpExporterUrl. You can control the reporting frequency and type of metrics export by means of OpenBankingConnector:OpenTelemetry:Metrics:MetricReaderExportIntervalMilliseconds and OpenBankingConnector:OpenTelemetry:Metrics:MetricReaderTemporality.
Currently only TPP Reporting metrics (see here for more info) are produced.
Settings
| Name | Valid Values | Default Value(s) | Description |
|---|---|---|---|
| OpenBankingConnector |
string | "OpenBankingConnector" |
Use to customise the service name used with Open Telemetry |
| OpenBankingConnector |
string | "FinnovationLabs" |
Use to customise the service namespace used with Open Telemetry |
| OpenBankingConnector |
string | "Default" |
Use to customise the service instance ID used with Open Telemetry |
| OpenBankingConnector |
{"true", "false"} |
"false" |
Add console exporter to tracing and metrics. Will send tracing and metrics output to the console. |
| OpenBankingConnector |
string | "" |
When non-empty, add OTLP (Open Telemetry Protocol) exporter to logging with target URL as specified. |
| OpenBankingConnector |
string | "" |
When non-empty, add OTLP (Open Telemetry Protocol) exporter to tracing with target URL as specified. |
| OpenBankingConnector |
int | "3" (AspNetCore and HttpClient only) |
Use to control tracing providers. Provide sum of desired providers where AspNetCore (top-level) = 1, HttpClient (bank requests) = 2, EFCore (database ORM) = 4. |
| OpenBankingConnector |
string | "" |
When non-empty, add OTLP (Open Telemetry Protocol) exporter to metrics with target URL as specified. |
| OpenBankingConnector |
int | "30000" |
Use to control frequency of export of metrics data (e.g. daily, hourly or more frequently when testing). |
| OpenBankingConnector |
{"Cumulative", "Delta"} |
"Cumulative" |
Use to control whether metric counters use cumulative or delta temporality for data export. |