From 94e333fedb7ce2ab5c8d56e5a5e4f6afa1953e4e Mon Sep 17 00:00:00 2001 From: HonkingGoose <34918129+HonkingGoose@users.noreply.github.com> Date: Mon, 22 Jul 2024 15:51:29 +0200 Subject: [PATCH] docs(datasource/custom): rewrite debugging section (#30250) Co-authored-by: Sebastian Poxhofer <secustor@users.noreply.github.com> --- lib/modules/datasource/custom/readme.md | 17 ++++++++++++++--- 1 file changed, 14 insertions(+), 3 deletions(-) diff --git a/lib/modules/datasource/custom/readme.md b/lib/modules/datasource/custom/readme.md index 7660d51196..a4a964d638 100644 --- a/lib/modules/datasource/custom/readme.md +++ b/lib/modules/datasource/custom/readme.md @@ -83,10 +83,14 @@ All available options: ### Debugging -Renovate writes tracing log entries before transformation starts and after if Renovate finds an unexpected data format. -To surface this data you can use `logLevelRemap` to surface this data on the App or run Renovate in dryRun mode and log level set to `trace` locally. +Renovate writes tracing logs entries before transformation. +If Renovate finds an unexpected dataformat, it also writes a tracing log _after_ transformation. -```json +#### Getting trace level logs on hosted app + +If you use the Mend Renovate app, use the [`logLevelRemap` config option](../../../configuration-options.md#loglevelremap) to get the trace log. + +```json title="Getting trace logs from the Mend Renovate app" { "logLevelRemap": [ { @@ -97,6 +101,13 @@ To surface this data you can use `logLevelRemap` to surface this data on the App } ``` +#### Getting trace level logs when self-hosting + +If you self-host Renovate, follow these steps to get the trace logs: + +1. Set the [`logFileLevel` config option](../../../self-hosted-configuration.md#logfilelevel) to `trace` +1. Run Renovate in [`dryRun` mode](../../../self-hosted-configuration.md#dryrun) + ### Formats #### JSON -- GitLab