/
LogEntry.java
649 lines (588 loc) · 22.2 KB
/
LogEntry.java
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
/*
* Copyright 2016 Google LLC
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package com.google.cloud.logging;
import static com.google.common.base.Preconditions.checkNotNull;
import com.google.cloud.MonitoredResource;
import com.google.common.base.Function;
import com.google.common.base.MoreObjects;
import com.google.common.collect.ImmutableMap;
import com.google.logging.v2.LogEntryOperation;
import com.google.logging.v2.LogEntrySourceLocation;
import com.google.logging.v2.LogName;
import java.io.Serializable;
import java.time.Instant;
import java.util.HashMap;
import java.util.Map;
import java.util.Objects;
/**
* A Cloud Logging log entry. All log entries are represented via objects of this class. Log entries
* can have different type of payloads: an UTF-8 string (see {@link Payload.StringPayload}), a JSON
* object (see {@link Payload.JsonPayload}, or a protobuf object (see {@link Payload.ProtoPayload}).
* Entries can also store additional information about the operation or the HTTP request that
* generated the log (see {@link LogEntry#getOperation()} and {@link LogEntry#getHttpRequest()},
* respectively).
*
* @see <a href="https://cloud.google.com/logging/docs/view/logs_index">Log Entries and Logs</a>
*/
public class LogEntry implements Serializable {
private static final long serialVersionUID = -944788159728228219L;
static final Function<com.google.logging.v2.LogEntry, LogEntry> FROM_PB_FUNCTION =
new Function<com.google.logging.v2.LogEntry, LogEntry>() {
@Override
public LogEntry apply(com.google.logging.v2.LogEntry pb) {
return fromPb(pb);
}
};
private final String logName;
private final MonitoredResource resource;
private final Instant timestamp;
private final Instant receiveTimestamp;
private final Severity severity;
private final String insertId;
private final HttpRequest httpRequest;
private final Map<String, String> labels;
private final Operation operation;
private final Object trace;
private final Object spanId;
private final boolean traceSampled;
private final SourceLocation sourceLocation;
private final Payload<?> payload;
private final LogDestinationName destination;
/** A builder for {@code LogEntry} objects. */
public static class Builder {
private String logName;
private MonitoredResource resource;
private Instant timestamp;
private Instant receiveTimestamp;
private Severity severity = Severity.DEFAULT;
private String insertId;
private HttpRequest httpRequest;
private Map<String, String> labels = new HashMap<>();
private Operation operation;
private Object trace;
private Object spanId;
private boolean traceSampled;
private SourceLocation sourceLocation;
private Payload<?> payload;
private LogDestinationName destination;
Builder(Payload<?> payload) {
this.payload = payload;
}
Builder(LogEntry entry) {
this.logName = entry.logName;
this.resource = entry.resource;
this.timestamp = entry.timestamp;
this.receiveTimestamp = entry.receiveTimestamp;
this.severity = entry.severity;
this.insertId = entry.insertId;
this.httpRequest = entry.httpRequest;
this.labels = new HashMap<>(entry.labels);
this.operation = entry.operation;
this.trace = entry.trace;
this.spanId = entry.spanId;
this.traceSampled = entry.traceSampled;
this.sourceLocation = entry.sourceLocation;
this.payload = entry.payload;
this.destination = entry.destination;
}
/**
* Sets the name of the log to which this log entry belongs. The log name must be less than 512
* characters long and can only include the following characters: upper and lower case
* alphanumeric characters: {@code [A-Za-z0-9]}; and punctuation characters: {@code _-./}. The
* forward-slash ({@code /}) characters in the log name must be URL-encoded. Examples: {@code
* syslog}, {@code library.googleapis.com%2Fbook_log}.
*/
public Builder setLogName(String logName) {
this.logName = logName;
return this;
}
/**
* Sets the monitored resource associated with this log entry. Example: a log entry that reports
* a database error would be associated with the monitored resource designating the particular
* database that reported the error.
*/
public Builder setResource(MonitoredResource resource) {
this.resource = resource;
return this;
}
/**
* Sets the time at which the event described by the log entry occurred, in milliseconds. If
* omitted, the Logging service will use the time at which the log entry is received.
*
* @deprecated This method is no longer recommended to setup the entry timestamp.
* <p>Use {@link setTimeStamp(Instant)} instead.
*/
@Deprecated
public Builder setTimestamp(long milliseconds) {
this.timestamp = Instant.ofEpochMilli(milliseconds);
return this;
}
/**
* Sets the time at which the event described by the log entry occurred. If omitted, the Logging
* service will use the time at which the log entry is received.
*/
public Builder setTimestamp(Instant timestamp) {
this.timestamp = timestamp;
return this;
}
/**
* Sets the time the log entry was received by Cloud Logging, in milliseconds. If omitted, the
* Logging service will set the time at which the log entry is received.
*
* @deprecated This method is no longer recommended to setup the receive time timestamp.
* <p>Use {@link setReceiveTimestamp(Instant)} instead.
*/
@Deprecated
public Builder setReceiveTimestamp(long milliseconds) {
this.receiveTimestamp = Instant.ofEpochMilli(milliseconds);
;
return this;
}
/**
* Sets the time the log entry was received by Cloud Logging. If omitted, the Logging service
* will set the time at which the log entry is received.
*/
public Builder setReceiveTimestamp(Instant receiveTimestamp) {
this.receiveTimestamp = receiveTimestamp;
return this;
}
/** Sets the severity of the log entry. If not set, {@link Severity#DEFAULT} is used. */
public Builder setSeverity(Severity severity) {
this.severity = severity;
return this;
}
/**
* Sets a unique ID for the log entry. If you provide this field, the Logging service considers
* other log entries in the same log with the same ID as duplicates which can be removed. If
* omitted, the Logging service will generate a unique ID for this log entry.
*/
public Builder setInsertId(String insertId) {
this.insertId = insertId;
return this;
}
/** Sets information about the HTTP request associated with this log entry, if applicable. */
public Builder setHttpRequest(HttpRequest httpRequest) {
this.httpRequest = httpRequest;
return this;
}
/**
* Sets an optional set of user-defined (key, value) data that provides additional information
* about the log entry.
*/
public Builder setLabels(Map<String, String> labels) {
this.labels = new HashMap<>(checkNotNull(labels));
return this;
}
/**
* Adds a label to the log entry's labels. Labels are user-defined (key, value) data that
* provides additional information about the log entry.
*/
public Builder addLabel(String key, String value) {
this.labels.put(key, value);
return this;
}
/**
* Clears all the labels of the log entry. Labels are user-defined (key, value) data that
* provides additional information about the log entry.
*/
public Builder clearLabels() {
this.labels.clear();
return this;
}
/** Sets information about an operation associated with the log entry, if applicable. */
public Builder setOperation(Operation operation) {
this.operation = operation;
return this;
}
/**
* Sets the 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`.
*/
public Builder setTrace(String trace) {
this.trace = trace;
return this;
}
/**
* Sets the 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`.
*/
public Builder setTrace(Object trace) {
this.trace = trace;
return this;
}
/** Sets the ID of the trace span associated with the log entry, if any. */
public Builder setSpanId(String spanId) {
this.spanId = spanId;
return this;
}
/** Sets the ID of the trace span associated with the log entry, if any. */
public Builder setSpanId(Object spanId) {
this.spanId = spanId;
return this;
}
/** Sets the sampling decision of the trace span associated with the log entry. */
public Builder setTraceSampled(boolean traceSampled) {
this.traceSampled = traceSampled;
return this;
}
/** Sets the source code location information associated with the log entry if any. */
public Builder setSourceLocation(SourceLocation sourceLocation) {
this.sourceLocation = sourceLocation;
return this;
}
/**
* Sets the payload for this log entry. The log entry payload can be provided as an UTF-8 string
* (see {@link Payload.StringPayload}), a JSON object (see {@link Payload.JsonPayload}, or a
* protobuf object (see {@link Payload.ProtoPayload}).
*
* @see <a href="https://cloud.google.com/logging/docs/view/logs_index">Log Entries and Logs</a>
*/
public Builder setPayload(Payload<?> payload) {
this.payload = payload;
return this;
}
/** Sets the log path destination name type associated with the log entry. */
public Builder setDestination(LogDestinationName destination) {
this.destination = destination;
return this;
}
/** Creates a {@code LogEntry} object for this builder. */
public LogEntry build() {
return new LogEntry(this);
}
}
LogEntry(Builder builder) {
this.logName = builder.logName;
this.resource = builder.resource;
this.timestamp = builder.timestamp;
this.receiveTimestamp = builder.receiveTimestamp;
this.severity = builder.severity;
this.insertId = builder.insertId;
this.httpRequest = builder.httpRequest;
this.labels = ImmutableMap.copyOf(builder.labels);
this.operation = builder.operation;
this.trace = builder.trace;
this.spanId = builder.spanId;
this.traceSampled = builder.traceSampled;
this.sourceLocation = builder.sourceLocation;
this.payload = builder.payload;
this.destination = builder.destination;
}
/**
* Returns the name of the log to which this log entry belongs. The log name must be less than 512
* characters long and can only include the following characters: upper and lower case
* alphanumeric characters: {@code [A-Za-z0-9]}; and punctuation characters: {@code _-./}. The
* forward-slash ({@code /}) characters in the log name must be URL-encoded. Examples: {@code
* syslog}, {@code library.googleapis.com%2Fbook_log}.
*/
public String getLogName() {
return logName;
}
/**
* Returns the monitored resource associated with this log entry. Example: a log entry that
* reports a database error would be associated with the monitored resource designating the
* particular database that reported the error.
*/
public MonitoredResource getResource() {
return resource;
}
/**
* Returns the time at which the event described by the log entry occurred, in milliseconds.
*
* @deprecated This method is no longer recommended to get the entry timestamp.
* <p>Use {@link getInstantTimestamp()} instead.
* @return timestamp in milliseconds
*/
@Deprecated
public Long getTimestamp() {
return timestamp != null ? timestamp.toEpochMilli() : null;
}
/**
* Returns the time at which the event described by the log entry occurred.
*
* @return timestamp as {@link Instant}
*/
public Instant getInstantTimestamp() {
return timestamp;
}
/**
* Returns the time the log entry was received by Cloud Logging, in milliseconds.
*
* @deprecated This method is no longer recommended to get the received time timestamp.
* <p>Use {@link getInstantReceiveTimestamp()} instead.
* @return timestamp in milliseconds
*/
@Deprecated
public Long getReceiveTimestamp() {
return receiveTimestamp != null ? receiveTimestamp.toEpochMilli() : null;
}
/**
* Returns the time the log entry was received by Cloud Logging, in milliseconds.
*
* @return timestamp as {@link Instant}
*/
public Instant getInstantReceiveTimestamp() {
return receiveTimestamp;
}
/** Returns the severity of the log entry. If not set, {@link Severity#DEFAULT} is used. */
public Severity getSeverity() {
return severity;
}
/**
* Returns a unique ID for the log entry. The Logging service considers other log entries in the
* same log with the same ID as duplicates which can be removed.
*/
public String getInsertId() {
return insertId;
}
/** Returns information about the HTTP request associated with this log entry, if applicable. */
public HttpRequest getHttpRequest() {
return httpRequest;
}
/**
* Returns an optional set of user-defined (key, value) data that provides additional information
* about the log entry.
*/
public Map<String, String> getLabels() {
return labels;
}
/** Returns information about an operation associated with the log entry, if applicable. */
public Operation getOperation() {
return operation;
}
/**
* Returns the 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`.
*/
public String getTrace() {
// For backwards compatibility return null when trace not set instead of "null".
return trace == null ? null : String.valueOf(trace);
}
/** Returns the ID of the trace span associated with the log entry, if any. */
public String getSpanId() {
// For backwards compatibility return null when spanId not set instead of "null".
return spanId == null ? null : String.valueOf(spanId);
}
/**
* Returns the sampling decision of the trace span associated with the log entry, or {@code false}
* if there is no trace span.
*/
public boolean getTraceSampled() {
return traceSampled;
}
/** Returns the source code location information associated with the log entry, if any. */
public SourceLocation getSourceLocation() {
return sourceLocation;
}
/**
* Returns the payload for this log entry. The log entry payload can be an UTF-8 string (see
* {@link Payload.StringPayload}), a JSON object (see {@link Payload.JsonPayload}, or a protobuf
* object (see {@link Payload.ProtoPayload}).
*
* @see <a href="https://cloud.google.com/logging/docs/view/logs_index">Log Entries and Logs</a>
*/
@SuppressWarnings("unchecked")
public <T extends Payload<?>> T getPayload() {
return (T) payload;
}
/**
* Returns the log path destination name type associated with log entry. By default, project name
* based destination is used.
*
* @see <a href="https://cloud.google.com/logging/docs/reference/v2/rest/v2/LogEntry">logName</a>
*/
public LogDestinationName getDestination() {
return destination;
}
@Override
public int hashCode() {
return Objects.hash(
logName,
resource,
timestamp,
receiveTimestamp,
severity,
insertId,
httpRequest,
labels,
operation,
getTrace(),
getSpanId(),
traceSampled,
sourceLocation,
payload,
destination);
}
@Override
public boolean equals(Object obj) {
if (obj == this) {
return true;
}
if (!(obj instanceof LogEntry)) {
return false;
}
LogEntry other = (LogEntry) obj;
return Objects.equals(logName, other.logName)
&& Objects.equals(resource, other.resource)
&& Objects.equals(timestamp, other.timestamp)
&& Objects.equals(receiveTimestamp, other.receiveTimestamp)
&& Objects.equals(severity, other.severity)
&& Objects.equals(insertId, other.insertId)
&& Objects.equals(httpRequest, other.httpRequest)
&& Objects.equals(labels, other.labels)
&& Objects.equals(operation, other.operation)
&& Objects.equals(getTrace(), other.getTrace())
&& Objects.equals(getSpanId(), other.getSpanId())
&& Objects.equals(traceSampled, other.traceSampled)
&& Objects.equals(sourceLocation, other.sourceLocation)
&& Objects.equals(payload, other.payload)
&& Objects.equals(destination, other.destination);
}
@Override
public String toString() {
return MoreObjects.toStringHelper(this)
.add("logName", logName)
.add("resource", resource)
.add("timestamp", timestamp)
.add("receiveTimestamp", receiveTimestamp)
.add("severity", severity)
.add("insertId", insertId)
.add("httpRequest", httpRequest)
.add("labels", labels)
.add("operation", operation)
.add("trace", trace)
.add("spanId", spanId)
.add("traceSampled", traceSampled)
.add("sourceLocation", sourceLocation)
.add("payload", payload)
.add("destination", destination)
.toString();
}
/** Returns a {@code Builder} for this log entry. */
public Builder toBuilder() {
return new Builder(this);
}
com.google.logging.v2.LogEntry toPb(String projectId) {
com.google.logging.v2.LogEntry.Builder builder = payload.toPb();
builder.putAllLabels(labels);
if (logName != null) {
if (destination == null) {
builder.setLogName(LogName.ofProjectLogName(projectId, logName).toString());
} else {
builder.setLogName(destination.toLogName(logName).toString());
}
}
if (resource != null) {
builder.setResource(resource.toPb());
}
if (timestamp != null) {
builder.setTimestamp(JavaTimeConversions.toProtoTimestamp(timestamp));
}
if (receiveTimestamp != null) {
builder.setReceiveTimestamp(JavaTimeConversions.toProtoTimestamp(receiveTimestamp));
}
if (severity != null) {
builder.setSeverity(severity.toPb());
}
if (insertId != null) {
builder.setInsertId(insertId);
}
if (httpRequest != null) {
builder.setHttpRequest(httpRequest.toPb());
}
if (operation != null) {
builder.setOperation(operation.toPb());
}
if (trace != null) {
builder.setTrace(getTrace());
}
if (spanId != null) {
builder.setSpanId(getSpanId());
}
builder.setTraceSampled(traceSampled);
if (sourceLocation != null) {
builder.setSourceLocation(sourceLocation.toPb());
}
return builder.build();
}
/** Returns a builder for {@code LogEntry} objects given the entry payload. */
public static Builder newBuilder(Payload<?> payload) {
return new Builder(payload);
}
/** Creates a {@code LogEntry} object given the entry payload. */
public static LogEntry of(Payload<?> payload) {
return newBuilder(payload).build();
}
/**
* Creates a {@code LogEntry} object given the log name, the monitored resource and the entry
* payload.
*/
public static LogEntry of(String logName, MonitoredResource resource, Payload<?> payload) {
return newBuilder(payload).setLogName(logName).setResource(resource).build();
}
static LogEntry fromPb(com.google.logging.v2.LogEntry entryPb) {
Builder builder = newBuilder(Payload.fromPb(entryPb));
builder.setLabels(entryPb.getLabelsMap());
builder.setSeverity(Severity.fromPb(entryPb.getSeverity()));
if (!entryPb.getLogName().equals("")) {
LogName name = LogName.parse(entryPb.getLogName());
builder.setLogName(name.getLog());
LogDestinationName resource = LogDestinationName.fromLogName(name);
if (resource != null) {
builder.setDestination(resource);
}
}
if (!entryPb.getResource().equals(com.google.api.MonitoredResource.getDefaultInstance())) {
builder.setResource(MonitoredResource.fromPb(entryPb.getResource()));
}
if (entryPb.hasTimestamp()) {
builder.setTimestamp(JavaTimeConversions.toJavaInstant(entryPb.getTimestamp()));
}
if (entryPb.hasReceiveTimestamp()) {
builder.setReceiveTimestamp(JavaTimeConversions.toJavaInstant(entryPb.getReceiveTimestamp()));
}
if (!entryPb.getInsertId().equals("")) {
builder.setInsertId(entryPb.getInsertId());
}
if (!entryPb
.getHttpRequest()
.equals(com.google.logging.type.HttpRequest.getDefaultInstance())) {
builder.setHttpRequest(HttpRequest.fromPb(entryPb.getHttpRequest()));
}
if (!entryPb.getOperation().equals(LogEntryOperation.getDefaultInstance())) {
builder.setOperation(Operation.fromPb(entryPb.getOperation()));
}
if (!entryPb.getTrace().equals("")) {
builder.setTrace(entryPb.getTrace());
}
if (!entryPb.getSpanId().equals("")) {
builder.setSpanId(entryPb.getSpanId());
}
builder.setTraceSampled(entryPb.getTraceSampled());
if (!entryPb.getSourceLocation().equals(LogEntrySourceLocation.getDefaultInstance())) {
builder.setSourceLocation(SourceLocation.fromPb(entryPb.getSourceLocation()));
}
return builder.build();
}
static Function<LogEntry, com.google.logging.v2.LogEntry> toPbFunction(final String projectId) {
return new Function<LogEntry, com.google.logging.v2.LogEntry>() {
@Override
public com.google.logging.v2.LogEntry apply(LogEntry entry) {
return entry.toPb(projectId);
}
};
}
}