package cluster_agent

Get desktop application:
View/edit binary Protocol Buffers messages

LogMetadataService provides metadata for the log files in a directory.

• rpc List (LogMetadataListRequest, LogMetadataList)

  cluster_agent.proto:26

  List the log files and their metadata.

  message LogMetadataListRequest

  cluster_agent.proto:66

  • repeated string namespaces = 1

  message LogMetadataList

  cluster_agent.proto:62

  • repeated LogMetadata items = 1

• rpc Watch (LogMetadataWatchRequest, stream LogMetadataWatchEvent)

  cluster_agent.proto:29

  Subscribe for changes on a directory and its files (non-recursive).

  message LogMetadataWatchRequest

  cluster_agent.proto:70

  • repeated string namespaces = 1

  message LogMetadataWatchEvent

  cluster_agent.proto:75

  Represents an update of the metadata of the log file.

  • string type = 1

    Possible values: ADDED -> A new file was created. MODIFIED -> File has been modified. DELETED -> File was deleted.

  • optional LogMetadata object = 2

LogRecordsService is responsible for returing returning existing and newlog lines from the log files.

• rpc StreamBackward (LogRecordsStreamRequest, stream LogRecord)

  cluster_agent.proto:93

  Streams log lines from new to old ones.

• rpc StreamForward (LogRecordsStreamRequest, stream LogRecord)

  cluster_agent.proto:90

  Streams log lines from old to new ones. It is possible to tail the files and stream new entries as they happen.

Controls how the stream is going to follow new entries in the logs.

Used in: LogRecordsStreamRequest

• NOOP = 0

  No follow, return immediately.

• DEFAULT = 1

  Follow from the start_time argument if present, otherwise from the beginning of the file.

• END = 2

  Follow from the end of the file.

Metadata for a log file.

Used in: LogMetadataList, LogMetadataWatchEvent

• string id = 1

  Container id.

• optional LogMetadataSpec spec = 2

• optional LogMetadataFileInfo fileInfo = 3

Used in: LogMetadata

• int64 size = 1

  Size of the file in bytes.

• optional google.protobuf.Timestamp last_modified_at = 2

K8s metadata information.

Used in: LogMetadata

• string node_name = 1

• string namespace = 2

• string pod_name = 3

• string container_name = 4

• string container_id = 5

A log line

Used as response type in: LogRecordsService.StreamBackward, LogRecordsService.StreamForward

• optional google.protobuf.Timestamp timestamp = 1

• string message = 2

A request to initiate a log stream.

Used as request type in: LogRecordsService.StreamBackward, LogRecordsService.StreamForward

• string namespace = 1

  K8s namepsace.

• string pod_name = 2

  K8s pod name.

• string container_name = 3

• string container_id = 4

• string start_time = 5

  Return only the logs that happened after this timestamp.

• string stop_time = 6

  Return only the logs that happened before this timestamp.

• string grep = 7

  Filter the logs according to this grep.

• FollowFrom follow_from = 8

  Keep the stream connection open to keep receiving new log lines.