com.google.cloud.logging.LogEntry Maven / Gradle / Ivy
Show all versions of google-cloud-logging Show documentation
/*
* 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.errorprone.annotations.CanIgnoreReturnValue;
import com.google.gson.Gson;
import com.google.gson.GsonBuilder;
import com.google.gson.JsonElement;
import com.google.gson.JsonObject;
import com.google.gson.JsonPrimitive;
import com.google.gson.JsonSerializationContext;
import com.google.gson.JsonSerializer;
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 Log Entries and Logs
*/
public class LogEntry implements Serializable {
private static final long serialVersionUID = -944788159728228219L;
static final Function FROM_PB_FUNCTION =
(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 ImmutableMap labels;
private final Operation operation;
private final String trace;
private final String 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 labels = new HashMap<>();
private Operation operation;
private String trace;
private String 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}.
*/
@CanIgnoreReturnValue
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.
*/
@CanIgnoreReturnValue
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.
* Use {@link #setTimestamp(Instant)} instead.
*/
@CanIgnoreReturnValue
@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.
*/
@CanIgnoreReturnValue
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.
*
Use {@link setReceiveTimestamp(Instant)} instead.
*/
@CanIgnoreReturnValue
@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.
*/
@CanIgnoreReturnValue
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. */
@CanIgnoreReturnValue
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.
*/
@CanIgnoreReturnValue
public Builder setInsertId(String insertId) {
this.insertId = insertId;
return this;
}
/** Sets information about the HTTP request associated with this log entry, if applicable. */
@CanIgnoreReturnValue
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.
*/
@CanIgnoreReturnValue
public Builder setLabels(Map 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.
*/
@CanIgnoreReturnValue
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.
*/
@CanIgnoreReturnValue
public Builder clearLabels() {
this.labels.clear();
return this;
}
/** Sets information about an operation associated with the log entry, if applicable. */
@CanIgnoreReturnValue
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`.
*/
@CanIgnoreReturnValue
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`.
*/
@CanIgnoreReturnValue
public Builder setTrace(Object trace) {
this.trace = trace != null ? trace.toString() : null;
return this;
}
/** Sets the ID of the trace span associated with the log entry, if any. */
@CanIgnoreReturnValue
public Builder setSpanId(String spanId) {
this.spanId = spanId;
return this;
}
/** Sets the ID of the trace span associated with the log entry, if any. */
@CanIgnoreReturnValue
public Builder setSpanId(Object spanId) {
this.spanId = spanId != null ? spanId.toString() : null;
return this;
}
/** Sets the sampling decision of the trace span associated with the log entry. */
@CanIgnoreReturnValue
public Builder setTraceSampled(boolean traceSampled) {
this.traceSampled = traceSampled;
return this;
}
/** Sets the source code location information associated with the log entry if any. */
@CanIgnoreReturnValue
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 Log Entries and Logs
*/
@CanIgnoreReturnValue
public Builder setPayload(Payload payload) {
this.payload = payload;
return this;
}
/** Sets the log path destination name type associated with the log entry. */
@CanIgnoreReturnValue
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.
* 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.
*
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 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 : 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 : 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 Log Entries and Logs
*/
@SuppressWarnings("unchecked")
public > 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 logName
*/
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())
&& (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();
}
/**
* Customized serializers to match the expected format for timestamp, source location and request
* method
*/
static final class InstantSerializer implements JsonSerializer {
@Override
public JsonElement serialize(
Instant src, java.lang.reflect.Type typeOfSrc, JsonSerializationContext context) {
return new JsonPrimitive(src.toString());
}
}
static final class SourceLocationSerializer implements JsonSerializer {
@Override
public JsonElement serialize(
SourceLocation src, java.lang.reflect.Type typeOfSrc, JsonSerializationContext context) {
JsonObject obj = new JsonObject();
if (src.getFile() != null) {
obj.addProperty("file", src.getFile());
}
if (src.getLine() != null) {
obj.addProperty("line", src.getLine().toString());
}
if (src.getFunction() != null) {
obj.addProperty("function", src.getFunction());
}
return obj;
}
}
static final class RequestMethodSerializer implements JsonSerializer {
@Override
public JsonElement serialize(
HttpRequest.RequestMethod src,
java.lang.reflect.Type typeOfSrc,
JsonSerializationContext context) {
return new JsonPrimitive(src.name());
}
}
/** Helper class to format one line Json representation of the LogEntry for structured log. */
static final class StructuredLogFormatter {
private final Gson gson;
private final StringBuilder builder;
public StructuredLogFormatter(StringBuilder builder) {
checkNotNull(builder);
this.gson =
new GsonBuilder()
.registerTypeAdapter(Instant.class, new InstantSerializer())
.registerTypeAdapter(SourceLocation.class, new SourceLocationSerializer())
.registerTypeAdapter(HttpRequest.RequestMethod.class, new RequestMethodSerializer())
.create();
this.builder = builder;
}
/**
* Adds a Json field and value pair to the current string representation. Method does not
* validate parameters to be multi-line strings. Nothing is added if {@code value} parameter is
* {@code null}.
*
* @param name a valid Json field name string.
* @param value an object to be serialized to Json using {@link Gson}.
* @param appendComma a flag to add a trailing comma.
* @return a reference to this object.
*/
@CanIgnoreReturnValue
public StructuredLogFormatter appendField(String name, Object value, boolean appendComma) {
checkNotNull(name);
if (value != null) {
builder.append(gson.toJson(name)).append(":").append(gson.toJson(value));
if (appendComma) {
builder.append(",");
}
}
return this;
}
@CanIgnoreReturnValue
public StructuredLogFormatter appendField(String name, Object value) {
return appendField(name, value, true);
}
/**
* Serializes a dictionary of key, values as Json fields.
*
* @param value a {@link Map} of key, value arguments to be serialized using {@link Gson}.
* @param appendComma a flag to add a trailing comma.
* @return a reference to this object.
*/
@CanIgnoreReturnValue
public StructuredLogFormatter appendDict(Map value, boolean appendComma) {
if (value != null) {
String json = gson.toJson(value);
// append json object without brackets
if (json.length() > 1) {
builder.append(json.substring(0, json.length() - 1).substring(1));
if (appendComma) {
builder.append(",");
}
}
}
return this;
}
}
/**
* Serializes the object to a one line JSON string in the simplified format that can be parsed by
* the logging agents that run on Google Cloud resources.
*/
public String toStructuredJsonString() {
if (payload.getType() == Payload.Type.PROTO) {
throw new UnsupportedOperationException("LogEntry with protobuf payload cannot be converted");
}
if (severity == Severity.NONE) {
throw new IllegalArgumentException("Severity.NONE cannot be used for LogEntry");
}
final StringBuilder builder = new StringBuilder("{");
final StructuredLogFormatter formatter = new StructuredLogFormatter(builder);
formatter
.appendField("severity", severity)
.appendField("time", timestamp)
.appendField("httpRequest", httpRequest)
.appendField("logging.googleapis.com/insertId", insertId)
.appendField("logging.googleapis.com/labels", labels)
.appendField("logging.googleapis.com/operation", operation)
.appendField("logging.googleapis.com/sourceLocation", sourceLocation)
.appendField("logging.googleapis.com/spanId", spanId)
.appendField("logging.googleapis.com/trace", trace)
.appendField("logging.googleapis.com/trace_sampled", traceSampled);
if (payload.getType() == Payload.Type.STRING) {
formatter.appendField("message", payload.getData(), false);
} else if (payload.getType() == Payload.Type.JSON) {
Payload.JsonPayload jsonPayload = (Payload.JsonPayload) payload;
formatter.appendDict(jsonPayload.getDataAsMap(), false);
}
builder.append("}");
return builder.toString();
}
/** 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();
}
public 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().isEmpty()) {
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().isEmpty()) {
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().isEmpty()) {
builder.setTrace(entryPb.getTrace());
}
if (!entryPb.getSpanId().isEmpty()) {
builder.setSpanId(entryPb.getSpanId());
}
builder.setTraceSampled(entryPb.getTraceSampled());
if (!entryPb.getSourceLocation().equals(LogEntrySourceLocation.getDefaultInstance())) {
builder.setSourceLocation(SourceLocation.fromPb(entryPb.getSourceLocation()));
}
return builder.build();
}
public static Function toPbFunction(
final String projectId) {
return (LogEntry entry) -> {
return entry.toPb(projectId);
};
}
}