Skip to content

Get Container Log

lightsail_get_container_log R Documentation

Returns the log events of a container of your Amazon Lightsail container service

Description

Returns the log events of a container of your Amazon Lightsail container service.

If your container service has more than one node (i.e., a scale greater than 1), then the log events that are returned for the specified container are merged from all nodes on your container service.

Container logs are retained for a certain amount of time. For more information, see Amazon Lightsail endpoints and quotas in the Amazon Web Services General Reference.

Usage

lightsail_get_container_log(serviceName, containerName, startTime,
  endTime, filterPattern, pageToken)

Arguments

serviceName

[required] The name of the container service for which to get a container log.
containerName

[required] The name of the container that is either running or previously ran on the container service for which to return a log.
startTime

The start of the time interval for which to get log data.

Constraints:

  • Specified in Coordinated Universal Time (UTC).

  • Specified in the Unix time format.

    For example, if you wish to use a start time of October 1, 2018, at 8 PM UTC, specify 1538424000 as the start time.

You can convert a human-friendly time to Unix time format using a converter like Epoch converter.
endTime

The end of the time interval for which to get log data.

Constraints:

  • Specified in Coordinated Universal Time (UTC).

  • Specified in the Unix time format.

    For example, if you wish to use an end time of October 1, 2018, at 9 PM UTC, specify 1538427600 as the end time.

You can convert a human-friendly time to Unix time format using a converter like Epoch converter.
filterPattern

The pattern to use to filter the returned log events to a specific term.

The following are a few examples of filter patterns that you can specify:

  • To return all log events, specify a filter pattern of "".

  • To exclude log events that contain the ERROR term, and return all other log events, specify a filter pattern of "-ERROR".

  • To return log events that contain the ERROR term, specify a filter pattern of "ERROR".

  • To return log events that contain both the ERROR and Exception terms, specify a filter pattern of "ERROR Exception".

  • To return log events that contain the ERROR or the Exception term, specify a filter pattern of "?ERROR ?Exception".
pageToken

The token to advance to the next page of results from your request.

To get a page token, perform an initial get_container_log request. If your results are paginated, the response will return a next page token that you can specify as the page token in a subsequent request.

Value

A list with the following syntax:

list(
  logEvents = list(
    list(
      createdAt = as.POSIXct(
        "2015-01-01"
      ),
      message = "string"
    )
  ),
  nextPageToken = "string"
)

Request syntax

svc$get_container_log(
  serviceName = "string",
  containerName = "string",
  startTime = as.POSIXct(
    "2015-01-01"
  ),
  endTime = as.POSIXct(
    "2015-01-01"
  ),
  filterPattern = "string",
  pageToken = "string"
)