From da1be48b49d275f9a7aebbfbfc40dae6d4c5d9c7 Mon Sep 17 00:00:00 2001 From: samugi Date: Mon, 27 Jan 2025 19:20:48 +0100 Subject: [PATCH] docs(opentelemetry): better description of OTel logs this commit follows up to https://github.com/Kong/kong/issues/14068 and tries to make the OTel logs description more clear / less open for interpretation. --- app/_hub/kong-inc/opentelemetry/overview/_index.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/app/_hub/kong-inc/opentelemetry/overview/_index.md b/app/_hub/kong-inc/opentelemetry/overview/_index.md index ed5611daa587..751661406a93 100644 --- a/app/_hub/kong-inc/opentelemetry/overview/_index.md +++ b/app/_hub/kong-inc/opentelemetry/overview/_index.md @@ -126,15 +126,15 @@ This plugin supports [OpenTelemetry Logging](https://opentelemetry.io/docs/specs #### Log scopes Two different kinds of logs are exported: **Request** and **Non-Request** scoped. - * Request logs are directly associated with requests. They are produced during the request lifecycle. For example, this could be logs generated during a plugin's Access phase. - * Non-request logs are not directly associated with a request. They are produced outside the request lifecycle. For examples, this could be logs generated asynchronously or during a worker's startup. + * Request logs are directly associated with requests. These application logs are produced during the request lifecycle. For example, these could be logs generated by a plugin during its Access or Response phase, or by Kong's core logic. + * Non-request logs are not directly associated with a request. They are produced outside the request lifecycle. For examples, this could be logs generated asynchronously (in a timer) or during a worker's startup. #### Log level -Logs are reported based on the log level that is configured for {{site.base_gateway}}. If a log is emitted with a level that is lower than the configured log level, it is not exported. +Logs are recorded based on the log level that is configured for {{site.base_gateway}}. If a log is emitted with a level that is lower than the configured log level, it is not recorded or exported. {:.note} -> **Note:** Not all logs are guaranteed to be exported. Logs that are not exported include those produced by the Nginx master process and low-level errors produced by Nginx. Operators are expected to capture the Nginx `error.log` file in addition to using this feature for observability purposes. +> **Note:** Not all logs are guaranteed to be recorded. Logs that are not recorded include those produced by the Nginx master process and low-level errors produced by Nginx. Operators are expected to still capture the Nginx `error.log` file (which always includes all of such logs) in addition to using this feature, to avoid losing any detail that might be useful for deeper troubleshooting. #### Log entry