Skip to main content

types

Destination​

One of destination​

Entry destination.

  • logGroupId : string​

    Entry should be written to log group resolved by ID.

  • folderId : string​

    Entry should be written to default log group for the folder.

Export​

id : string​

Export ID.

folderId : string​

Export folder ID.

cloudId : string​

Export cloud ID.

createdAt : google.protobuf.Timestamp​

Export creation time.

name : string​

Export name.

description : string​

Export description.

labels : string​

Export lables.

groupId : string​

Group logs are exported from.

sinkId : string​

Sink logs are exported to.

params : ExportParams​

Parameters of logs filtration.

ExportParams​

resourceTypes : string​
resourceIds : string​
streamNames : string​
levels : LogLevel.Level​
filter : string​

IncomingLogEntry​

timestamp : google.protobuf.Timestamp​

Timestamp of the entry.

level : LogLevel.Level​

Entry severity.

See LogLevel.Level for details.

message : string​

Entry text message.

jsonPayload : google.protobuf.Struct​

Entry annotation.

streamName : string​

Entry stream name.

LogEntry​

uid : string​

Unique entry ID.

Useful for logs deduplication.

resource : LogEntryResource​

Entry resource specification.

May contain information about source service and resource ID. Also may be provided by the user.

timestamp : google.protobuf.Timestamp​

Timestamp of the entry.

ingestedAt : google.protobuf.Timestamp​

Entry ingestion time observed by LogIngestionService.

savedAt : google.protobuf.Timestamp​

Entry save time.

Entry is ready to be read since this moment.

level : LogLevel.Level​

Entry severity.

See LogLevel.Level for details.

message : string​

Entry text message.

jsonPayload : google.protobuf.Struct​

Entry annotation.

streamName : string​

Entry stream name.

LogEntryDefaults​

level : LogLevel.Level​

Default entry severity. Will be applied if entry level is unspecified.

See LogLevel.Level for details.

jsonPayload : google.protobuf.Struct​

Default entry annotation. Will be merged with entry annotation. Any conflict will be resolved in favor of entry own annotation.

streamName : string​

Entry stream name.

LogEntryResource​

Log entry resource specification.

May be used either by services and by user.

type : string​

Resource type, i.e., serverless.function

id : string​

Resource ID, i.e., ID of the function producing logs.

LogGroup​

Status​

Possible log group statuses.

  • STATUS_UNSPECIFIED

    Unknown status. Should never occur.

  • CREATING

    Log group is creating.

  • ACTIVE

    Log group is ready to accept messages,

  • DELETING

    Log group is being deleted. No messages will be accepted.

  • ERROR

    Log group is in failed state.

id : string​

Log group ID.

folderId : string​

Log group folder ID.

cloudId : string​

Log group cloud ID.

createdAt : google.protobuf.Timestamp​

Log group creation time.

name : string​

Log group name.

description : string​

Log group description.

labels : string​

Log group labels.

status : Status​

Status of the log group.

retentionPeriod : google.protobuf.Duration​

Log group entry retention period.

Entries will be present in group during this period.

dataStream : string​

Data stream name

LogGroupResource​

Log group resource.

type : string​

Resource type.

Collected from log entries inside log group.

ids : string​

List of resource IDs with the same resource type.

LogLevel​

Level​

Possible log levels for entries.

  • LEVEL_UNSPECIFIED

    Default log level. Equivalent to not specifying log level at all.

  • TRACE

    Trace log level. Possible use case: verbose logging of some business logic.

  • DEBUG

    Debug log level. Possible use case: debugging special cases in application logic.

  • INFO

    Info log level. Mostly used for information messages.

  • WARN

    Warn log level. May be used to alert about significant events.

  • ERROR

    Error log level. May be used to alert about errors in infrastructure, logic, etc.

  • FATAL

    Fatal log level. May be used to alert about unrecoverable failures and events.

level : Level​

Entry level.

See Level for possible values.

Sink​

Yds​

streamName : string​

Fully qualified name of data stream

S3​

bucket : string​

Object storage bucket

prefix : string​

Prefix to use for saved log object names

id : string​

Sink ID.

folderId : string​

Sink folder ID.

cloudId : string​

Sink cloud ID.

createdAt : google.protobuf.Timestamp​

Sink creation time.

name : string​

Sink name.

description : string​

Sink description.

labels : string​

Sink labels.

serviceAccountId : string​

Logs will be written to the sink on behalf of this service account

One of sink​

Logs destination

  • yds : Yds​

    Yandex data stream

  • s3 : S3​

    Object storage