Server settings in log4net.config: Difference between revisions

From QPR ProcessAnalyzer Wiki
Jump to navigation Jump to search
 
(6 intermediate revisions by the same user not shown)
Line 8: Line 8:
* log4net > appender > '''lockingModel''': By default, the server log works in the ''ExclusiveLock'' mode, i.e. the log file is reserved by the QPR ProcessAnalyzer process for the entire time QPR ProcessAnalyzer is running. Thus it's not possible to edit or delete log files during that time.
* log4net > appender > '''lockingModel''': By default, the server log works in the ''ExclusiveLock'' mode, i.e. the log file is reserved by the QPR ProcessAnalyzer process for the entire time QPR ProcessAnalyzer is running. Thus it's not possible to edit or delete log files during that time.


==Send logs to OpenTelemetry==
==Send logs, metrics and traces to OpenTelemetry==
=== Traces ===
QPR ProcessAnalyzer can write traces and uses the OpenTelemetry (https://opentelemetry.io/docs) exporter to write them into the provided endpoint.


There are the following standard traces written:
=== Logs ===
* '''_Microsoft.EntityFrameworkCore_''' to trace EntityFramework queries.
QPR ProcessAnalyzer can write logs using the OpenTelemetry (https://opentelemetry.io/docs) exporter into the provided endpoint. If an endpoint is not configured, logs are not exported.
* '''_Microsoft.AspNetCore_''' to trace QPR ProcessAnalyzer API calls.


In addition, there are the following custom traces:
The following environment variables are used to control collecting and exporting telemetry data using OpenTelemetry Protocol Exporter (https://opentelemetry.io/docs/specs/otel/protocol/exporter):
* '''_QPR.ProcessAnalyzer.ExpressionQuery_''' to trace expression query evaluation.
* '''OTEL_EXPORTER_OTLP_ENDPOINT''' sends all signals to the same collector.
* '''_QPR.ProcessAnalyzer.DatabaseOperation_''' to trace queries to external data source.
* '''OTEL_EXPORTER_OTLP_TRACES_ENDPOINT''' collector endpoint for traces.
* '''_QPR.ProcessAnalyzer.ExpressionLanguage_''' to trace calls to expression language function and property calls.
* '''OTEL_EXPORTER_OTLP_METRICS_ENDPOINT''' collector endopint for metrics.
* '''OTEL_EXPORTER_OTLP_LOGS_ENDPOINT''' collector endpoint for logs.


If an endpoint is not configured, traces are not collected and exported.
QPR ProcessAnalyzer writes logs with level '''WARN''' by default. Logs with level '''WARN''', '''ERROR''', and '''FATAL''' additionally written into Snowflake events table utilizing event's severity. Logs are written into container's stdout stream using JSON format for structured logging (https://learn.microsoft.com/en-us/dotnet/core/extensions/console-log-formatter#json).


=== Metrics ===
=== Metrics ===
QPR ProcessAnalyzer can write write metrics and uses the OpenTelemetry (https://opentelemetry.io/docs) exporter to write them into the provided endpoint.
QPR ProcessAnalyzer can write metrics using the OpenTelemetry (https://opentelemetry.io/docs) exporter into the provided endpoint.


There are the following standard metrics are written:
There are the following standard metrics:
* '''_Microsoft.AspNetCore_''' to track QPR ProcessAnalyzer API calls.
* '''_Microsoft.AspNetCore_''' to track QPR ProcessAnalyzer API calls.
* '''_Microsoft.EntityFrameworkCore_''' to track EntityFramework status.
* '''_Microsoft.EntityFrameworkCore_''' to track EntityFramework status.
* '''_Microsoft.Data.SqlClient.EventSource_''' to track SqlClient status.
* '''_Microsoft.Data.SqlClient.EventSource_''' to track SQL Server client status.


If an endpoint is not configured, metrics are not collected and exported.
If an endpoint is not configured, metrics are not collected and exported.


=== Logs ===
=== Traces ===
QPR ProcessAnalyzer can write write logs and uses the OpenTelemetry (https://opentelemetry.io/docs) exporter to write them into the provided endpoint. If an endpoint is not configured, logs are not exported.
QPR ProcessAnalyzer can write traces using the OpenTelemetry (https://opentelemetry.io/docs) exporter into the provided endpoint.


The following environment variables are used to control collecting and exporting telemetry data using OpenTelemetry Protocol Exporter (https://opentelemetry.io/docs/specs/otel/protocol/exporter):
There are the following standard traces:
* '''OTEL_EXPORTER_OTLP_ENDPOINT''' sends all signals to the same collector.
* '''_Microsoft.EntityFrameworkCore_''' to trace EntityFramework queries.
* '''OTEL_EXPORTER_OTLP_TRACES_ENDPOINT''' collector endpoint for traces.
* '''_Microsoft.AspNetCore_''' to trace QPR ProcessAnalyzer API calls.
* '''OTEL_EXPORTER_OTLP_METRICS_ENDPOINT''' collector endopint for metrics.
* '''OTEL_EXPORTER_OTLP_LOGS_ENDPOINT''' collector endpoint for logs.


QPR ProcessAnalyzer writes logs with level '''WARN''' by default. Logs with level '''WARN''', '''ERROR''', and '''FATAL''' additionally written into Snowflake events table utilizing event's severity. Logs are written into container's stdout stream using '''JSON format for structured logging''' (https://learn.microsoft.com/en-us/dotnet/core/extensions/console-log-formatter#json).  
In addition, there are the following custom traces:
* '''_QPR.ProcessAnalyzer.ExpressionQuery_''' to trace expression language query evaluation.
* '''_QPR.ProcessAnalyzer.DatabaseOperation_''' to trace queries to external data source.
* '''_QPR.ProcessAnalyzer.ExpressionLanguage_''' to trace calls to expression language function and property calls.


=== OpenTelemetry in Snowflake Native App ===
If an endpoint is not configured, traces are not collected and exported.
Writing logs is controlled by the '''LOG_LEVEL''' option for '''METADATA''' schema. If it is not set, than '''WARN''' level used. See [Snowflake documentation](https://docs.snowflake.com/en/sql-reference/parameters#label-log-level) for details. To take new `LOG_LEVEL` into use service must be restarted.
 
Application writes traces into [endpoint, provided by Snowflake](https://docs.snowflake.com/en/developer-guide/snowpark-container-services/monitoring-services#publishing-otlp-application-metrics-and-traces). Writing traces controlled by `TRACE_LEVEL` option for `METADATA` schema. If it is not set, than `ALWAYS` level used. See [Snowflake documentation](https://docs.snowflake.com/en/sql-reference/parameters#label-trace-level) for details.
 
To take new `TRACE_LEVEL` into use service must be restarted. Application writes metrics into [endpoint, provided by Snowflake](https://docs.snowflake.com/en/developer-guide/snowpark-container-services/monitoring-services#publishing-otlp-application-metrics-and-traces).
 
[Snowflake metrics](https://docs.snowflake.com/en/developer-guide/snowpark-container-services/monitoring-services#label-spcs-available-platform-metrics) that should be written:
* '''_system_ to track CPU and memory usage.
* '''_system_limits_''' to check CPU and memory limits for container.
* '''_storage_''' to track storage volume used by SQL Server.
 
Writing metrics controlled by `METRIC_LEVEL` option for `METADATA` schema. If it is not set, than `ALL` level used. See [Snowflake documentation](https://docs.snowflake.com/en/sql-reference/parameters#label-metric-level) for details. To take new `METRIC_LEVEL` into use service must be restarted

Latest revision as of 23:32, 26 November 2025

QPR ProcessAnalyzer uses the log4net component (https://logging.apache.org/log4net/) for logging, allowing to flexibly define what is logged and where the logs are stored.

Write logs to file

For example, the following settings can be set in the log4net.config file (located in the bin folder in the server application files):

Send logs, metrics and traces to OpenTelemetry

Logs

QPR ProcessAnalyzer can write logs using the OpenTelemetry (https://opentelemetry.io/docs) exporter into the provided endpoint. If an endpoint is not configured, logs are not exported.

The following environment variables are used to control collecting and exporting telemetry data using OpenTelemetry Protocol Exporter (https://opentelemetry.io/docs/specs/otel/protocol/exporter):

  • OTEL_EXPORTER_OTLP_ENDPOINT sends all signals to the same collector.
  • OTEL_EXPORTER_OTLP_TRACES_ENDPOINT collector endpoint for traces.
  • OTEL_EXPORTER_OTLP_METRICS_ENDPOINT collector endopint for metrics.
  • OTEL_EXPORTER_OTLP_LOGS_ENDPOINT collector endpoint for logs.

QPR ProcessAnalyzer writes logs with level WARN by default. Logs with level WARN, ERROR, and FATAL additionally written into Snowflake events table utilizing event's severity. Logs are written into container's stdout stream using JSON format for structured logging (https://learn.microsoft.com/en-us/dotnet/core/extensions/console-log-formatter#json).

Metrics

QPR ProcessAnalyzer can write metrics using the OpenTelemetry (https://opentelemetry.io/docs) exporter into the provided endpoint.

There are the following standard metrics:

  • _Microsoft.AspNetCore_ to track QPR ProcessAnalyzer API calls.
  • _Microsoft.EntityFrameworkCore_ to track EntityFramework status.
  • _Microsoft.Data.SqlClient.EventSource_ to track SQL Server client status.

If an endpoint is not configured, metrics are not collected and exported.

Traces

QPR ProcessAnalyzer can write traces using the OpenTelemetry (https://opentelemetry.io/docs) exporter into the provided endpoint.

There are the following standard traces:

  • _Microsoft.EntityFrameworkCore_ to trace EntityFramework queries.
  • _Microsoft.AspNetCore_ to trace QPR ProcessAnalyzer API calls.

In addition, there are the following custom traces:

  • _QPR.ProcessAnalyzer.ExpressionQuery_ to trace expression language query evaluation.
  • _QPR.ProcessAnalyzer.DatabaseOperation_ to trace queries to external data source.
  • _QPR.ProcessAnalyzer.ExpressionLanguage_ to trace calls to expression language function and property calls.

If an endpoint is not configured, traces are not collected and exported.

Retrieved from "https://wiki.onqpr.com/pa/index.php?title=Server_settings_in_log4net.config&oldid=27470"