Class Entry (11.2.0)
Create an entry object to define new data to insert into a meta.
Note,Cloud Logging Quotas and limits dictates that the maximum log entry size, including allLogEntry Resource properties, cannot exceed approximately 256 KB.
Package
@google-cloud/loggingExample
const{Logging}=require('@google-cloud/logging');constlogging=newLogging();constsyslog=logging.log('syslog');constmetadata={resource:{type:'gce_instance',labels:{zone:'global',instance_id:'3'}}};constentry=syslog.entry(metadata,{delegate:'my_username'});syslog.alert(entry,(err,apiResponse)=>{if(!err){// Log entry inserted successfully.}});//-// You will also receive `Entry` objects when using// Logging#getEntries() and Log#getEntries().//-logging.getEntries((err,entries)=>{if(!err){// entries[0].data = The data value from the log entry.}});Constructors
(constructor)(metadata, data)
constructor(metadata?:LogEntry,data?:Data);Constructs a new instance of theEntry class
| Parameters | |
|---|---|
| Name | Description |
metadata | LogEntry |
data | Data |
Properties
data
data:Data;metadata
metadata:LogEntry;Methods
fromApiResponse_(entry)
staticfromApiResponse_(entry:google.logging.v2.LogEntry):Entry;Create an Entry object from an API response, such asentries:list.
| Parameter | |
|---|---|
| Name | Description |
entry | LogEntryAn API representation of an entry. See aLogEntry. |
| Returns | |
|---|---|
| Type | Description |
Entry | {Entry} |
toJSON(options, projectId)
toJSON(options?:ToJsonOptions,projectId?:string):EntryJson;Serialize an entry to the format the API expects. Read more:https://cloud.google.com/logging/docs/reference/v2/rest/v2/LogEntry
| Parameters | |
|---|---|
| Name | Description |
options | ToJsonOptionsConfiguration object. |
projectId | stringGCP Project ID. |
| Returns | |
|---|---|
| Type | Description |
EntryJson | |
toStructuredJSON(projectId, useMessageField)
toStructuredJSON(projectId?:string,useMessageField?:boolean):StructuredJson;Serialize an entry to a standard format for any transports, e.g. agents. Read more:https://cloud.google.com/logging/docs/structured-logging
| Parameters | |
|---|---|
| Name | Description |
projectId | string |
useMessageField | boolean |
| Returns | |
|---|---|
| Type | Description |
StructuredJson | |
Except as otherwise noted, the content of this page is licensed under theCreative Commons Attribution 4.0 License, and code samples are licensed under theApache 2.0 License. For details, see theGoogle Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-10-30 UTC.