Skip to main content

Download execution logs

note

Currently, this feature is behind the feature flag SPG_LOG_SERVICE_ENABLE_DOWNLOAD_LOGS. Contact Harness Support to enable the feature.

You can download pipeline or step execution logs via the UI. You can download pipeline, stage, and step execution logs via the API.

The process of downloading logs is the same for all Harness modules. Your access to certain modules and settings limits the functionality available to you.

After you download the execution log files, you can view the JSON logs.

info

The extracted files have many levels of nested directories. To locate specific log files, you might need to navigate through several levels.

Important notes​

  • You might encounter the error message Prefix Key Exceeds Maximum Download Limit if your execution exceeds the maximum number of log files.
    • Log files are stored in chunks for optimization purposes.
    • There is a hard limit of 2000 log files per execution. Contact Harness Support if this limitation causes issues for you.
  • Windows users may encounter issues extracting logs.zip with the native extraction tool. To avoid this, we recommend using a third-party tool such as 7-Zip or similar.

Download pipeline log files​

To download pipeline log files, do the following:

  1. In Harness, select your pipeline.

  2. Select More Options (⋮), and then select Download Logs.

    Harness queries the log service, exports the log, and downloads the logs.zip file.

  3. Open the logs.zip file, and extract the contents.

  4. Drill down into the extracted files to locate the log you want to examine.

Download step log files​

To download step log files, do the following:

  1. In Harness, select your pipeline.

  2. Select the step for which you want to download the execution log.

  3. Under Details, select the download icon.

    Harness queries the log service, exports the log, and downloads the logs.zip file.

  4. Open the logs.zip file, and extract the contents.

  5. Drill down into the extracted files to locate the log you want to examine.

Download logs via API​

You can download pipeline, stage, and step execution logs via the Log Service API /log-service/blob/download. Authentication by Harness API token is required. For more information, go to the Harness API reference.

The response contains a link to download the requested log file.

Download logs with simplified log key​

note

Currently, the simplified log key to download logs is behind the feature flag PIE_SIMPLIFY_LOG_BASE_KEY. Contact Harness Support to enable the feature.

This feature requires delegate version 23.10.81010 or later.

After enabling this feature flag, you must re-run your pipelines to apply the change.

The simplified log key makes it easier to call the Log Service API.

The log download endpoint is asynchronous; the downloadable log file is available after the endpoint returns a success status only.

cURL command to download pipeline logs​

This cURL command downloads pipeline log files based on the given pipeline execution key.

curl 'https://app.harness.io/gateway/log-service/blob/download?accountID=ACCOUNT_ID&prefix=PIPELINE_EXECUTION_PREFIX_KEY' \
  -X 'POST' \
  -H 'content-type: application/json' \
  -H 'x-api-key: <HARNESS-PERSONAL-ACCESS-TOKEN>'
  • ACCOUNT_ID: Your Harness account identifier.
  • PIPELINE_EXECUTION_PREFIX_KEY: A multi-part value consisting of ACCOUNT_ID/pipeline/PIPELINE_ID/RUN_SEQUENCE/-PLAN_EXECUTION_ID. For example, 12345abcd/pipeline/My_Cool_Pipeline/12/-dfstsh.
    • ACCOUNT_ID: Your Harness account identifier.
    • PIPELINE_ID: The identifier of the pipeline that you want to get logs for.
    • RUN_SEQUENCE: The incremental execution/build identifier of the specific pipeline run that you want logs for.
    • -PLAN_EXECUTION_ID: A hyphen (-) followed by the identifier of the pipeline execution that you want to get logs for.
  • TOKEN: Harness API token

cURL command to download step logs​

This cURL command downloads pipeline log files based on the given step key.

curl 'https://app.harness.io/gateway/log-service/blob/download?accountID=ACCOUNT_ID&prefix=STEP_PREFIX_KEY' \
  -X 'POST' \
  -H 'content-type: application/json' \
  -H 'x-api-key: <HARNESS-PERSONAL-ACCESS-TOKEN>'
  • ACCOUNT_ID: Your Harness account identifier.
  • STEP_PREFIX_KEY: A multi-part value consisting of ACCOUNT_ID/pipeline/PIPELINE_ID/RUN_SEQUENCE/-PLAN_EXECUTION_ID/STAGE_ID/STEP_ID. For example, 12345abcd/pipeline/My_Cool_Pipeline/12/-dfstsh/My_Cool_Stage/My_Cool_Step.
    • ACCOUNT_ID: Your Harness account identifier.
    • PIPELINE_ID: The identifier of the pipeline that has the step that you want to get logs for.
    • RUN_SEQUENCE: The incremental execution/build identifier of a specific pipeline run.
    • -PLAN_EXECUTION_ID: A hyphen (-) followed by the identifier of the pipeline execution that you want to get logs for.
    • STAGE_ID: The identifier of the stage that has the step that you want to get logs for.
    • STEP_ID: The identifier of the step that you want to get logs for.
  • TOKEN: Harness API token

Currently, the generated download link for the logs.zip file is wrapped around a Harness URL, for example, https://app.harness.io/storage/harness-download/\<PATH_TO_YOUR_LOG_KEY>. However, if you want the vanity URL link for the logs.zip file, you can add the IPs below to your account's allowlist.

34.82.155.149
34.168.179.66

For more information, go to Allowlist Harness domains and IPs.