Skip to content

PodLog

POST
/otterscale.runtime.v1.RuntimeService/PodLog

PodLog streams log output from a container, similar to kubectl logs -f.

Connect-Protocol-Version
required
Connect-Protocol-Version

Define the version of the Connect protocol

number
Allowed values: 1
Connect-Timeout-Ms
Connect-Timeout-Ms

Define the timeout, in ms

number
PodLogRequest

PodLogRequest defines the parameters for streaming container logs. Fields align with corev1.PodLogOptions.

object
cluster
cluster

The target Kubernetes cluster identifier.

string
namespace
namespace

The namespace of the pod.

string
name
name

The name of the pod.

string
container
container

The container name. If omitted, the first container in the pod is used.

string
follow
follow

If true, stream logs as they are produced (like kubectl logs -f).

boolean
tailLines
tail_lines

Number of lines from the end of the logs to show. If not set, all logs are shown.

integer | string format: int64
sinceSeconds
since_seconds

A relative time in seconds before the current time from which to show logs.

integer | string format: int64
sinceTime
since_time

An absolute time from which to show logs. Mutually exclusive with since_seconds.

string format: date-time
previous
previous

If true, return the logs for the previous terminated container instance.

boolean
timestamps
timestamps

If true, add an RFC3339 timestamp at the beginning of every line of log output.

boolean
limitBytes
limit_bytes

Limit the number of bytes returned from the server.

integer | string format: int64

Success

PodLogResponse

PodLogResponse contains a chunk of log data.

object
data
data

Raw log data bytes.

string format: byte

Error

Connect Error
object
code

The status code, which should be an enum value of [google.rpc.Code][google.rpc.Code].

string
Allowed values: canceled unknown invalid_argument deadline_exceeded not_found already_exists permission_denied resource_exhausted failed_precondition aborted out_of_range unimplemented internal unavailable data_loss unauthenticated
message

A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the [google.rpc.Status.details][google.rpc.Status.details] field, or localized by the client.

string
details

A list of messages that carry the error details. There is no limit on the number of messages.

Array<object>

Contains an arbitrary serialized message along with a @type that describes the type of the serialized message, with an additional debug field for ConnectRPC error details.

object
type

A URL that acts as a globally unique identifier for the type of the serialized message. For example: type.googleapis.com/google.rpc.ErrorInfo. This is used to determine the schema of the data in the value field and is the discriminator for the debug field.

string
value

The Protobuf message, serialized as bytes and base64-encoded. The specific message type is identified by the type field.

string format: binary
debug
One of: discriminator: type
Any

Detailed error information.

object
key
additional properties
any
key
additional properties
any
key
additional properties
any