af94bd9955
Co-authored-by: Josh Gross <joshmgross@github.com> Co-authored-by: Brian Cristante <33549821+brcrista@users.noreply.github.com> Co-authored-by: John Bohannon <imjohnbo@github.com> Co-authored-by: Lucas Costi <lucascosti@users.noreply.github.com>
2.5 KiB
title, intro, product, versions
| title | intro | product | versions | ||||
|---|---|---|---|---|---|---|---|
| Enabling debug logging | If the workflow logs do not provide enough detail to diagnose why a workflow, job, or step is not working as expected, you can enable additional debug logging. | {% data reusables.gated-features.actions %} |
|
{% data reusables.actions.enterprise-beta %} {% data reusables.actions.enterprise-github-hosted-runners %}
These extra logs are enabled by setting secrets in the repository containing the workflow, so the same permissions requirements will apply:
- {% data reusables.github-actions.permissions-statement-secrets-repository %} {% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.0" %}
- {% data reusables.github-actions.permissions-statement-secrets-environment %} {% endif %}
- {% data reusables.github-actions.permissions-statement-secrets-organization %}
- {% data reusables.github-actions.permissions-statement-secrets-api %}
For more information on setting secrets, see "Creating and using encrypted secrets."
Enabling runner diagnostic logging
Runner diagnostic logging provides additional log files that contain information about how a runner is executing a job. Two extra log files are added to the log archive:
- The runner process log, which includes information about coordinating and setting up runners to execute jobs.
- The worker process log, which logs the execution of a job.
-
To enable runner diagnostic logging, set the following secret in the repository that contains the workflow:
ACTIONS_RUNNER_DEBUGtotrue. -
To download runner diagnostic logs, download the log archive of the workflow run. The runner diagnostic logs are contained in the
runner-diagnostic-logsfolder. For more information on downloading logs, see "Downloading logs."
Enabling step debug logging
Step debug logging increases the verbosity of a job's logs during and after a job's execution.
-
To enable step debug logging, you must set the following secret in the repository that contains the workflow:
ACTIONS_STEP_DEBUGtotrue. -
After setting the secret, more debug events are shown in the step logs. For more information, see "Viewing logs to diagnose failures".