pydo.apps.get_logs()

Generated on 25 November 2024 from pydo version v0.6.0

Description

Retrieve the logs of a past, in-progress, or active deployment. 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

Name	Type	Required	Description	Default Value
`app_id`	string	True	The app ID
`deployment_id`	string	True	The deployment ID
`component_name`	string	True	An optional component name. If set, logs will be limited to this component only.
`follow`	boolean	False	Whether the logs should follow live updates.
`type`	string	True	The type of logs to retrieve - BUILD: Build-time logs - DEPLOY: Deploy-time logs - RUN: Live run-time logs - RUN_RESTARTED: Logs of crashed/restarted instances during runtime	UNSPECIFIED
`pod_connection_timeout`	string	False	An optional time duration to wait if the underlying component instance is not immediately available. Default: `3m`.

Request Sample

import os
from pydo import Client

client = Client(token=os.environ.get("DIGITALOCEAN_TOKEN"))

get_resp = client.apps.get_logs(app_id="4f6c71e2", deployment_id="3aa4d20e", component_name="component")

Responses

See the API spec for this endpoint to view additional detail on responses, headers, parameters, and more.

200
401
404
429
500
default

A JSON object with urls that point to archived logs

Click to expand an example response for logs.

{
  "value": {
    "live_url": "https://logs-example/build.log",
    "url": "https://logs/build.log",
    "historic_logs": [
      "https://logs-example/archive/build.log"
    ]
  }
}

Unauthorized