Skip to content

Log Related APIs

Get list if log files

Application GET /apis/v1/logfiles/applications/{appId}/{instanceId}/list

Task GET /apis/v1/logfiles/tasks/{sourceAppName}/{taskId}/list

Local Service GET /apis/v1/logfiles/localservices/{serviceId}/{instanceId}/list

Request 

curl --location 'http://drove.local:7000/apis/v1/logfiles/applications/TEST_APP-1/AI-5efbb94f-835c-4c62-a073-a68437e60339/list' \
--header 'Authorization: Basic YWRtaW46YWRtaW4='

Response 

{
    "files": [
        "output.log-2024-07-04",
        "output.log-2024-07-03",
        "output.log"
    ]
}

Local Service Request 

curl --location 'http://drove.local:7000/apis/v1/logfiles/localservices/NODE_EXPORTER-1/LSI-5efbb94f-835c-4c62-a073-a68437e60339/list' \
--header 'Authorization: Basic YWRtaW46YWRtaW4='

Download Log Files

Application GET /apis/v1/logfiles/applications/{appId}/{instanceId}/download/{fileName}

Task GET /apis/v1/logfiles/tasks/{sourceAppName}/{taskId}/download/{fileName}

Local Service GET /apis/v1/logfiles/localservices/{serviceId}/{instanceId}/download/{fileName}

Query Parameter Validation Description
rename true/false If true, response filename is renamed to include deployable and instance ids with timestamp.

Request 

curl --location 'http://drove.local:7000/apis/v1/logfiles/applications/TEST_APP-1/AI-5efbb94f-835c-4c62-a073-a68437e60339/download/output.log' \
--header 'Authorization: Basic YWRtaW46YWRtaW4='

Response

Local Service Request 

curl --location 'http://drove.local:7000/apis/v1/logfiles/localservices/NODE_EXPORTER-1/LSI-5efbb94f-835c-4c62-a073-a68437e60339/download/output.log?rename=true' \
--header 'Authorization: Basic YWRtaW46YWRtaW4='

Note

The Content-Disposition header is set properly to the response filename. For the above example it would be set to attachment; filename=output.log.

Note

Download APIs support binary files (for example compressed logs) and set Content-Type based on filename where possible.

Read chunks from log

Application GET /apis/v1/logfiles/applications/{appId}/{instanceId}/read/{fileName}

Task GET /apis/v1/logfiles/tasks/{sourceAppName}/{taskId}/read/{fileName}

Local Service GET /apis/v1/logfiles/localservices/{serviceId}/{instanceId}/read/{fileName}

Query Parameter Validation Description
offset Default -1, should be positive number The offset of the file to read from.
length Should be a positive number Number of bytes to read.

Request 

curl --location 'http://drove.local:7000/apis/v1/logfiles/applications/TEST_APP-1/AI-5efbb94f-835c-4c62-a073-a68437e60339/read/output.log' \
--header 'Authorization: Basic YWRtaW46YWRtaW4='

Response 

{
    "data": "", //(1)!
    "offset": 43318 //(2)!
}

Local Service Request 

curl --location 'http://drove.local:7000/apis/v1/logfiles/localservices/NODE_EXPORTER-1/LSI-5efbb94f-835c-4c62-a073-a68437e60339/read/output.log?offset=-1&length=4096' \
--header 'Authorization: Basic YWRtaW46YWRtaW4='

  1. Will contain raw data or empty string (in case of first call)
  2. Offset to be passed in the next call

How to tail logs

  1. Have a fixed buffer size in ming 1024/4096 etc
  2. Make a call to /read api with offset=-1, length = buffer size
  3. The call will return no data, but will have a valid offset
  4. Pass this offset in the next call, data will be returned if available (or empty). The response will also return the offset to pass in the .ext call.
  5. The data returned might be empty or less than length depending on availability.
  6. Keep repeating (4) to keep tailing log

Warning

  • Offset = 0 means start of the file
  • First call must be -1 for tail type functionality