job_invocation_logs
Creates, updates, deletes, gets or lists a job_invocation_logs resource.
Overview
| Name | job_invocation_logs |
| Type | Resource |
| Id | digitalocean.apps.job_invocation_logs |
Fields
The following fields are returned by SELECT queries:
- apps_get_job_invocation_logs
A JSON object with urls that point to Job Invocation logs
| Name | Datatype | Description |
|---|---|---|
historic_urls | array | (title: A list of URLs to archived log files) |
live_url | string | A URL of the real-time live logs. This URL may use either the https:// or wss:// protocols and will keep pushing live logs as they become available. (example: ws://logs/build) |
Methods
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
apps_get_job_invocation_logs | select | app_id, job_name, job_invocation_id, type | deployment_id, follow, pod_connection_timeout, tail_lines | Retrieve the logs of a past, in-progress, or active deployment. If a component name is specified, the logs will be limited to only that component. If deployment is omitted the active deployment will be selected (if available). The response will include links to either real-time logs of an in-progress or active deployment or archived logs of a past deployment. |
Parameters
Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.
| Name | Datatype | Description |
|---|---|---|
app_id | string | The app ID (example: 4f6c71e2-1e90-4762-9fee-6cc4a0a9f2cf) |
job_invocation_id | string | The ID of the job invocation to retrieve. (example: 123e4567-e89b-12d3-a456-426) |
job_name | string | The job name to list job invocations for. (example: component) |
type | string | The type of logs to retrieve (example: JOB_INVOCATION) |
deployment_id | string | The deployment ID (example: 3aa4d20e-5527-4c00-b496-601fbd22520a) |
follow | boolean | Whether the logs should follow live updates. (example: true) |
pod_connection_timeout | string | An optional time duration to wait if the underlying component instance is not immediately available. Default: 3m. (example: 3m) |
tail_lines | string (int64) | The number of lines from the end of the logs to retrieve. (example: 100) |
SELECT examples
- apps_get_job_invocation_logs
Retrieve the logs of a past, in-progress, or active deployment. If a component name is specified, the logs will be limited to only that component. If deployment is omitted the active deployment will be selected (if available). The response will include links to either real-time logs of an in-progress or active deployment or archived logs of a past deployment.
SELECT
historic_urls,
live_url
FROM digitalocean.apps.job_invocation_logs
WHERE app_id = '{{ app_id }}' -- required
AND job_name = '{{ job_name }}' -- required
AND job_invocation_id = '{{ job_invocation_id }}' -- required
AND type = '{{ type }}' -- required
AND deployment_id = '{{ deployment_id }}'
AND follow = '{{ follow }}'
AND pod_connection_timeout = '{{ pod_connection_timeout }}'
AND tail_lines = '{{ tail_lines }}'
;