Class: Google::Apis::LoggingV2::LogEntry
- Inherits:
-
Object
- Object
- Google::Apis::LoggingV2::LogEntry
- Includes:
- Core::Hashable, Core::JsonObjectSupport
- Defined in:
- generated/google/apis/logging_v2/classes.rb,
generated/google/apis/logging_v2/representations.rb,
generated/google/apis/logging_v2/representations.rb
Overview
An individual entry in a log.
Instance Attribute Summary collapse
-
#http_request ⇒ Google::Apis::LoggingV2::HttpRequest
A common proto for logging HTTP requests.
-
#insert_id ⇒ String
Optional.
-
#json_payload ⇒ Hash<String,Object>
The log entry payload, represented as a structure that is expressed as a JSON object.
-
#labels ⇒ Hash<String,String>
Optional.
-
#log_name ⇒ String
Required.
-
#metadata ⇒ Google::Apis::LoggingV2::MonitoredResourceMetadata
Auxiliary metadata for a MonitoredResource object.
-
#operation ⇒ Google::Apis::LoggingV2::LogEntryOperation
Additional information about a potentially long-running operation with which a log entry is associated.
-
#proto_payload ⇒ Hash<String,Object>
The log entry payload, represented as a protocol buffer.
-
#receive_timestamp ⇒ String
Output only.
-
#resource ⇒ Google::Apis::LoggingV2::MonitoredResource
An object representing a resource that can be used for monitoring, logging, billing, or other purposes.
-
#severity ⇒ String
Optional.
-
#source_location ⇒ Google::Apis::LoggingV2::LogEntrySourceLocation
Additional information about the source code location that produced the log entry.
-
#span_id ⇒ String
Optional.
-
#text_payload ⇒ String
The log entry payload, represented as a Unicode string (UTF-8).
-
#timestamp ⇒ String
Optional.
-
#trace ⇒ String
Optional.
-
#trace_sampled ⇒ Boolean
(also: #trace_sampled?)
Optional.
Instance Method Summary collapse
-
#initialize(**args) ⇒ LogEntry
constructor
A new instance of LogEntry.
-
#update!(**args) ⇒ Object
Update properties of this object.
Methods included from Core::JsonObjectSupport
Methods included from Core::Hashable
Constructor Details
#initialize(**args) ⇒ LogEntry
Returns a new instance of LogEntry.
917 918 919 |
# File 'generated/google/apis/logging_v2/classes.rb', line 917 def initialize(**args) update!(**args) end |
Instance Attribute Details
#http_request ⇒ Google::Apis::LoggingV2::HttpRequest
A common proto for logging HTTP requests. Only contains semantics defined by
the HTTP specification. Product-specific logging information MUST be defined
in a separate message.
Corresponds to the JSON property httpRequest
769 770 771 |
# File 'generated/google/apis/logging_v2/classes.rb', line 769 def http_request @http_request end |
#insert_id ⇒ String
Optional. A unique identifier for the log entry. If you provide a value, then
Logging considers other log entries in the same project, with the same
timestamp, and with the same insert_id to be duplicates which are removed in a
single query result. However, there are no guarantees of de-duplication in the
export of logs.If the insert_id is omitted when writing a log entry, the
Logging API assigns its own unique identifier in this field.In queries, the
insert_id is also used to order log entries that have the same log_name and
timestamp values.
Corresponds to the JSON property insertId
781 782 783 |
# File 'generated/google/apis/logging_v2/classes.rb', line 781 def insert_id @insert_id end |
#json_payload ⇒ Hash<String,Object>
The log entry payload, represented as a structure that is expressed as a JSON
object.
Corresponds to the JSON property jsonPayload
787 788 789 |
# File 'generated/google/apis/logging_v2/classes.rb', line 787 def json_payload @json_payload end |
#labels ⇒ Hash<String,String>
Optional. A set of user-defined (key, value) data that provides additional
information about the log entry.
Corresponds to the JSON property labels
793 794 795 |
# File 'generated/google/apis/logging_v2/classes.rb', line 793 def labels @labels end |
#log_name ⇒ String
Required. The resource name of the log to which this log entry belongs:
"projects/[PROJECT_ID]/logs/[LOG_ID]"
"organizations/[ORGANIZATION_ID]/logs/[LOG_ID]"
"billingAccounts/[BILLING_ACCOUNT_ID]/logs/[LOG_ID]"
"folders/[FOLDER_ID]/logs/[LOG_ID]"
A project number may optionally be used in place of PROJECT_ID. The project
number is translated to its corresponding PROJECT_ID internally and the
log_name field will contain PROJECT_ID in queries and exports.[LOG_ID] must be
URL-encoded within log_name. Example: "organizations/1234567890/logs/
cloudresourcemanager.googleapis.com%2Factivity". [LOG_ID] must be less than
512 characters long and can only include the following characters: upper and
lower case alphanumeric characters, forward-slash, underscore, hyphen, and
period.For backward compatibility, if log_name begins with a forward-slash,
such as /projects/..., then the log entry is ingested as usual but the forward-
slash is removed. Listing the log entry will not show the leading slash and
filtering for a log name with a leading slash will never return any results.
Corresponds to the JSON property logName
813 814 815 |
# File 'generated/google/apis/logging_v2/classes.rb', line 813 def log_name @log_name end |
#metadata ⇒ Google::Apis::LoggingV2::MonitoredResourceMetadata
Auxiliary metadata for a MonitoredResource object. MonitoredResource objects
contain the minimum set of information to uniquely identify a monitored
resource instance. There is some other useful auxiliary metadata. Monitoring
and Logging use an ingestion pipeline to extract metadata for cloud resources
of all types, and store the metadata in this message.
Corresponds to the JSON property metadata
822 823 824 |
# File 'generated/google/apis/logging_v2/classes.rb', line 822 def @metadata end |
#operation ⇒ Google::Apis::LoggingV2::LogEntryOperation
Additional information about a potentially long-running operation with which a
log entry is associated.
Corresponds to the JSON property operation
828 829 830 |
# File 'generated/google/apis/logging_v2/classes.rb', line 828 def operation @operation end |
#proto_payload ⇒ Hash<String,Object>
The log entry payload, represented as a protocol buffer. Some Google Cloud
Platform services use this field for their log entry payloads.The following
protocol buffer types are supported; user-defined types are not supported:"
type.googleapis.com/google.cloud.audit.AuditLog" "type.googleapis.com/google.
appengine.logging.v1.RequestLog"
Corresponds to the JSON property protoPayload
837 838 839 |
# File 'generated/google/apis/logging_v2/classes.rb', line 837 def proto_payload @proto_payload end |
#receive_timestamp ⇒ String
Output only. The time the log entry was received by Logging.
Corresponds to the JSON property receiveTimestamp
842 843 844 |
# File 'generated/google/apis/logging_v2/classes.rb', line 842 def @receive_timestamp end |
#resource ⇒ Google::Apis::LoggingV2::MonitoredResource
An object representing a resource that can be used for monitoring, logging,
billing, or other purposes. Examples include virtual machine instances,
databases, and storage devices such as disks. The type field identifies a
MonitoredResourceDescriptor object that describes the resource's schema.
Information in the labels field identifies the actual resource and its
attributes according to the schema. For example, a particular Compute Engine
VM instance could be represented by the following object, because the
MonitoredResourceDescriptor for "gce_instance" has labels "instance_id" and "
zone":
"type": "gce_instance",
"labels":
"instance_id": "12345678901234",
"zone": "us-central1-a" `
Corresponds to the JSON property
resource`
858 859 860 |
# File 'generated/google/apis/logging_v2/classes.rb', line 858 def resource @resource end |
#severity ⇒ String
Optional. The severity of the log entry. The default value is LogSeverity.
DEFAULT.
Corresponds to the JSON property severity
864 865 866 |
# File 'generated/google/apis/logging_v2/classes.rb', line 864 def severity @severity end |
#source_location ⇒ Google::Apis::LoggingV2::LogEntrySourceLocation
Additional information about the source code location that produced the log
entry.
Corresponds to the JSON property sourceLocation
870 871 872 |
# File 'generated/google/apis/logging_v2/classes.rb', line 870 def source_location @source_location end |
#span_id ⇒ String
Optional. The span ID within the trace associated with the log entry.For Trace
spans, this is the same format that the Trace API v2 uses: a 16-character
hexadecimal encoding of an 8-byte array, such as "000000000000004a"</
code>.
Corresponds to the JSON property
spanId
878 879 880 |
# File 'generated/google/apis/logging_v2/classes.rb', line 878 def span_id @span_id end |
#text_payload ⇒ String
The log entry payload, represented as a Unicode string (UTF-8).
Corresponds to the JSON property textPayload
883 884 885 |
# File 'generated/google/apis/logging_v2/classes.rb', line 883 def text_payload @text_payload end |
#timestamp ⇒ String
Optional. The time the event described by the log entry occurred. This time is
used to compute the log entry's age and to enforce the logs retention period.
If this field is omitted in a new log entry, then Logging assigns it the
current time. Timestamps have nanosecond accuracy, but trailing zeros in the
fractional seconds might be omitted when the timestamp is displayed.Incoming
log entries should have timestamps that are no more than the logs retention
period in the past, and no more than 24 hours in the future. Log entries
outside those time boundaries will not be available when calling entries.list,
but those log entries can still be exported with LogSinks.
Corresponds to the JSON property timestamp
896 897 898 |
# File 'generated/google/apis/logging_v2/classes.rb', line 896 def @timestamp end |
#trace ⇒ String
Optional. Resource name of the trace associated with the log entry, if any. If
it contains a relative resource name, the name is assumed to be relative to //
tracing.googleapis.com. Example: projects/my-projectid/traces/
06796866738c859f2f19b7cfb3214824
Corresponds to the JSON property trace
904 905 906 |
# File 'generated/google/apis/logging_v2/classes.rb', line 904 def trace @trace end |
#trace_sampled ⇒ Boolean Also known as: trace_sampled?
Optional. The sampling decision of the trace associated with the log entry.
True means that the trace resource name in the trace field was sampled for
storage in a trace backend. False means that the trace was not sampled for
storage when this log entry was written, or the sampling decision was unknown
at the time. A non-sampled trace value is still useful as a request
correlation identifier. The default is False.
Corresponds to the JSON property traceSampled
914 915 916 |
# File 'generated/google/apis/logging_v2/classes.rb', line 914 def trace_sampled @trace_sampled end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 |
# File 'generated/google/apis/logging_v2/classes.rb', line 922 def update!(**args) @http_request = args[:http_request] if args.key?(:http_request) @insert_id = args[:insert_id] if args.key?(:insert_id) @json_payload = args[:json_payload] if args.key?(:json_payload) @labels = args[:labels] if args.key?(:labels) @log_name = args[:log_name] if args.key?(:log_name) @metadata = args[:metadata] if args.key?(:metadata) @operation = args[:operation] if args.key?(:operation) @proto_payload = args[:proto_payload] if args.key?(:proto_payload) @receive_timestamp = args[:receive_timestamp] if args.key?(:receive_timestamp) @resource = args[:resource] if args.key?(:resource) @severity = args[:severity] if args.key?(:severity) @source_location = args[:source_location] if args.key?(:source_location) @span_id = args[:span_id] if args.key?(:span_id) @text_payload = args[:text_payload] if args.key?(:text_payload) @timestamp = args[:timestamp] if args.key?(:timestamp) @trace = args[:trace] if args.key?(:trace) @trace_sampled = args[:trace_sampled] if args.key?(:trace_sampled) end |