You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: content/code-security/reference/code-scanning/troubleshoot-analysis-errors/logs-not-detailed-enough.md
+15-6Lines changed: 15 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,7 +1,7 @@
1
1
---
2
2
title: Logs are not detailed enough
3
3
shortTitle: Logs not detailed enough
4
-
intro: If you'd like to increase the level of detail in your logs, try these steps.
4
+
intro: Increase log verbosity and generate debugging artifacts when logs lack diagnostic detail.
5
5
allowTitleToDifferFromFilename: true
6
6
versions:
7
7
fpt: '*'
@@ -16,9 +16,18 @@ contentType: reference
16
16
17
17
If your logs are not detailed enough to troubleshoot a problem, there are several steps you can take to obtain extra information and make logs more useful.
18
18
19
-
## Enable step debug logging
19
+
## Enabling step debug logging
20
20
21
-
You can enable step debug logging in {% data variables.product.prodname_actions %} to increase the verbosity of a job's logs during a job's execution. For more information, see [AUTOTITLE](/actions/monitoring-and-troubleshooting-workflows/enabling-debug-logging#enabling-step-debug-logging).
21
+
Step debug logging increases the verbosity of a job’s logs during and after execution.
22
+
23
+
To enable step debug logging:
24
+
25
+
1. In the repository that contains the workflow, set the following secret or variable: `ACTIONS_STEP_DEBUG` to `true`. If both the secret and variable are set, the value of the secret takes precedence over the variable.
26
+
1. Re-run the workflow or trigger a new run.
27
+
28
+
After setting the secret or variable, more debug events are shown in the step logs. See [AUTOTITLE](/actions/monitoring-and-troubleshooting-workflows/using-workflow-run-logs#viewing-logs-to-diagnose-failures).
29
+
30
+
You can also use the `runner.debug` context to conditionally run steps only when debug logging is enabled. See [AUTOTITLE](/actions/reference/workflows-and-actions/contexts#runner-context).
22
31
23
32
## Creating {% data variables.product.prodname_codeql %} debugging artifacts
24
33
@@ -28,11 +37,11 @@ You can enable step debug logging in {% data variables.product.prodname_actions
28
37
You can obtain artifacts to help you debug {% data variables.product.prodname_codeql %}.
29
38
The debug artifacts will be uploaded to the workflow run as artifacts with names starting with `debug-artifacts`. If {% data variables.product.prodname_codeql %} analyzes multiple languages concurrently as part of the workflow run, there will be one such artifact for every language. The data contains the {% data variables.product.prodname_codeql %} logs, {% data variables.product.prodname_codeql %} databases, extracted source code files, and any SARIF files produced by the workflow. For more information about downloading {% data variables.product.prodname_codeql %} artifacts, see [AUTOTITLE](/actions/managing-workflow-runs/downloading-workflow-artifacts).
30
39
31
-
These artifacts will help you debug problems with {% data variables.product.prodname_codeql %} {% data variables.product.prodname_code_scanning %}. If you contact GitHub support, they might ask for this data.
40
+
These artifacts will help you debug problems with {% data variables.product.prodname_codeql %} {% data variables.product.prodname_code_scanning %}. If you contact {% data variables.contact.github_support %}, they might ask for this data.
32
41
33
42
### Creating {% data variables.product.prodname_codeql %} debugging artifacts for {% data variables.product.prodname_codeql %} default setup
34
43
35
-
You can create {% data variables.product.prodname_codeql %} debugging artifacts by enabling {% data variables.product.prodname_actions %} step debug logging and triggering a new {% data variables.product.prodname_codeql %} analysis by, for example, pushing a new commit to a pull request branch. For information on how to enable {% data variables.product.prodname_actions %} step debug logging, see [AUTOTITLE](/actions/monitoring-and-troubleshooting-workflows/enabling-debug-logging#enabling-step-debug-logging).
44
+
You can create {% data variables.product.prodname_codeql %} debugging artifacts by enabling step debug logging (see [Enabling step debug logging](#enabling-step-debug-logging)) and triggering a new {% data variables.product.prodname_codeql %} analysis, for example, by pushing a new commit to a pull request branch.
36
45
37
46
{% ifversion org-private-registry %}
38
47
@@ -63,4 +72,4 @@ You can create {% data variables.product.prodname_codeql %} debugging artifacts
63
72
64
73
#### Using {% data variables.product.prodname_actions %} step debug logging
65
74
66
-
If you have enabled {% data variables.product.prodname_actions %} step debug logging, {% data variables.product.prodname_codeql %} will also produce debugging artifacts and upload them. See [AUTOTITLE](/actions/monitoring-and-troubleshooting-workflows/enabling-debug-logging#enabling-step-debug-logging).
75
+
If you enable {% data variables.product.prodname_actions %} step debug logging, {% data variables.product.prodname_codeql %} will also produce debugging artifacts and upload them as part of the workflow run. For instructions, see [Enabling step debuglogging](#enabling-step-debug-logging).
0 commit comments