Contact UsGet started
© 2024 Iron Hive LLC Belgrade

Managed Service for MySQL API, gRPC: ClusterService.StreamLogs

Written by
Updated at October 28, 2024

Retrieves a log stream for a cluster.

This method is similar to ListLogs, but uses server-side streaming, which allows for the tail -f command semantics.

gRPC request

rpc StreamLogs (StreamClusterLogsRequest) returns (stream StreamLogRecord)

StreamClusterLogsRequest

{
  "clusterId": "string",
  "columnFilter": [
    "string"
  ],
  "serviceType": "ServiceType",
  "fromTime": "google.protobuf.Timestamp",
  "toTime": "google.protobuf.Timestamp",
  "recordToken": "string",
  "filter": "string"
}

Field

Description

clusterId

string

Required field. ID of the cluster to stream logs for.

To get this ID, make a ClusterService.List request.

columnFilter[]

string

Columns from the logs table to request.
If no columns are specified, complete log records are returned.

serviceType

enum ServiceType

The log type.

  • SERVICE_TYPE_UNSPECIFIED
  • MYSQL_ERROR: MySQL error log.
  • MYSQL_GENERAL: MySQL general query log.
  • MYSQL_SLOW_QUERY: MySQL slow query log.
  • MYSQL_AUDIT: MySQL audit log.

fromTime

google.protobuf.Timestamp

Start timestamp for the logs request.

toTime

google.protobuf.Timestamp

End timestamp for the logs request.
If this field is not set, all existing log records beginning from fromTime will be returned first, and then the new records will be returned as they appear.

In essence it has tail -f command semantics.

recordToken

string

Record token that can be used to control logs streaming.

Set recordToken to the StreamLogRecord.nextRecordToken, returned by the previous ClusterService.StreamLogs request to start streaming from the next log record.

filter

string

A filter expression that selects clusters logs listed in the response.

The expression must specify:

  1. The field name. Currently filtering can be applied to the [LogRecord.logs.hostname] field.
  2. An = operator.
  3. The value in double quotes ("). Must be 3-63 characters long and match the regular expression [a-z][-a-z0-9]{1,61}[a-z0-9].
    Examples of a filter: message.hostname='node1.db.cloud.yandex.net'

StreamLogRecord

{
  "record": {
    "timestamp": "google.protobuf.Timestamp",
    "message": "string"
  },
  "nextRecordToken": "string"
}

A single log record in the logs stream.

Field

Description

record

LogRecord

One of the requested log records.

nextRecordToken

string

The token that can be used to continue streaming logs starting from the exact same record.
To continue streaming, specify value of nextRecordToken as the StreamClusterLogsRequest.recordToken value in the next ClusterService.StreamLogs request.

This value is interchangeable with ListClusterLogsResponse.nextPageToken from ClusterService.ListLogs method.

LogRecord

A single log record.

Field

Description

timestamp

google.protobuf.Timestamp

Timestamp of the log record.

message

string

Contents of the log record.
Previous
ListLogs
Next
ListOperations