How-to enable application tracing
Introduction
If you want to profile the CoreOne Suite you can simply activate the appropriate tracing in the configuration.
Step 1 - Prepare your OpenTelemetry infrastructure
You will need an Open Telementry Collector and a data visualization tool such as ELK-stack and APM.
Step 2 - Configure OpenTelemetry in CoreOne
Frontends
Each of the front-ends has an application configuration file. I.e C:\ProgramData\itsense\Configuration
when installed as a Windows Services.
These are the files that matter:
Application Part | File |
---|---|
CoreOne Authentication Services |
|
CoreOne Self-Service Portal |
|
CoreOne Admin User Interfaces |
|
CoreOne Admin User Interfaces 2.0 |
|
In that file, you can add the following settings (by using Machine Crypto
of COS Configuration Manager) :
"UseOpenTelemetry": true,
"OpenTelemetryCollectorEndpoint": "https://otlp-gateway-prod-eu-west-2.grafana.net/otlp/v1/traces",
"OpenTelemetryCollectorMetricsEndpoint": "https://otlp-gateway-prod-eu-west-2.grafana.net/otlp/v1/metrics",
"OpenTelemetryCollectorHeaders": "Authorization=Basic NjkyODA0...2prd01EUTVPSDA9",
"OpenTelemetryCollectorProtocol": "HttpProtobuf"
Simply enable OpenTelemetry and configure the appropriate endpoints, headers and the protocol.
Please note that OpenTelemetryCollectorHeaders
contains how we authenticate to the telemetry system. This can be a Bearer Token, Basic Auth or an API key. It may also be empty if no authentication is needed.
Backend
For the backend, the settings are stored in the database.
update config_setting_value
set int_value = 0
where config_setting_code_id = 54;
update config_setting_value
set string_value = 'http://localhost:4318/v1/traces'
where config_setting_code_id = 55;
update config_setting_value
set string_value = ''
where config_setting_code_id = 56;
update config_setting_value
set string_value = 'HttpProtobuf'
where config_setting_code_id = 57;
update config_setting_value
set string_value = 'http://localhost:4318/v1/metrics'
where config_setting_code_id = 58;
Step 3 - Restart for settings to take effect
After you have applied the settings, you will need to restart the corresponding parts:
For Frontend Applications, the Application Pools within IIS need to be recycled
For Backend / WF Runner, the corresponding services need to be restarted.
© ITSENSE AG. Alle Rechte vorbehalten. ITSENSE und CoreOne sind eingetragene Marken der ITSENSE AG.