Class Batch (1.14.0)

  Batch 
 ( 
 logger 
 , 
 client 
 , 
 resource 
 = 
 None 
 ) 
 

Context manager: collect entries to log via a single API call.

Helper returned by Logger.batch

Parameters

Name
Description
logger
Logger

the logger to which entries will be logged.

client
Client

The client to use.

resource
Resource

(Optional) Monitored resource of the batch, defaults to None, which requires that every entry should have a resource specified. Since the methods used to write entries default the entry's resource to the global resource type, this parameter is only required if explicitly set to None. If no entries' resource are set to None, this parameter will be ignored on the server.

Methods

commit

  commit 
 ( 
 client 
 = 
 None 
 ) 
 

Send saved log entries as a single API call.

Parameter
Name
Description
client
Client or NoneType

the client to use. If not passed, falls back to the client stored on the current batch.

log_empty

  log_empty 
 ( 
 ** 
 kw 
 ) 
 

Add a entry without payload to be logged during commit .

Parameter
Name
Description
kw
dict

(optional) additional keyword arguments for the entry. See LogEntry .

log_proto

  log_proto 
 ( 
 message 
 , 
 ** 
 kw 
 ) 
 

Add a protobuf entry to be logged during commit .

Parameters
Name
Description
kw
dict

(optional) additional keyword arguments for the entry. See LogEntry .

message
protobuf message

the protobuf entry

log_struct

  log_struct 
 ( 
 info 
 , 
 ** 
 kw 
 ) 
 

Add a struct entry to be logged during commit .

Parameters
Name
Description
kw
dict

(optional) additional keyword arguments for the entry. See LogEntry .

info
dict

the struct entry

log_text

  log_text 
 ( 
 text 
 , 
 ** 
 kw 
 ) 
 

Add a text entry to be logged during commit .

Parameters
Name
Description
kw
dict

(optional) additional keyword arguments for the entry. See LogEntry .

text
str

the text entry

Create a Mobile Website
View Site in Mobile | Classic
Share by: