com.google.cloud.logging.LogEntry Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of gcloud-java-logging Show documentation
Show all versions of gcloud-java-logging Show documentation
Java idiomatic client for Stackdriver Logging.
The newest version!
/*
* Copyright 2016 Google Inc. All Rights Reserved.
*
* 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.cloud.logging.spi.v2.LoggingServiceV2Api;
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.protobuf.Timestamp;
import java.io.Serializable;
import java.util.HashMap;
import java.util.Map;
import java.util.Objects;
/**
* A Stackdriver 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#operation()} and
* {@link LogEntry#httpRequest()}, respectively).
*
* @see Log Entries and Logs
*/
public class LogEntry implements Serializable {
private static final long serialVersionUID = -944788159728228219L;
private static final long NANOS_PER_MILLISECOND = 1000000;
private static final long MILLIS_PER_SECOND = 1000;
static final Function FROM_PB_FUNCTION =
new Function() {
@Override
public LogEntry apply(com.google.logging.v2.LogEntry pb) {
return fromPb(pb);
}
};
private final String logName;
private final MonitoredResource resource;
private final Long timestamp;
private final Severity severity;
private final String insertId;
private final HttpRequest httpRequest;
private final Map labels;
private final Operation operation;
private final Payload payload;
/**
* A builder for {@code LogEntry} objects.
*/
public static class Builder {
private String logName;
private MonitoredResource resource;
private Long timestamp;
private Severity severity = Severity.DEFAULT;
private String insertId;
private HttpRequest httpRequest;
private Map labels = new HashMap<>();
private Operation operation;
private Payload payload;
Builder(Payload payload) {
this.payload = payload;
}
Builder(LogEntry entry) {
this.logName = entry.logName;
this.resource = entry.resource;
this.timestamp = entry.timestamp;
this.severity = entry.severity;
this.insertId = entry.insertId;
this.httpRequest = entry.httpRequest;
this.labels = new HashMap<>(entry.labels);
this.operation = entry.operation;
this.payload = entry.payload;
}
/**
* 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 logName(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 resource(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.
*/
public Builder timestamp(long timestamp) {
this.timestamp = timestamp;
return this;
}
/**
* Sets the severity of the log entry. If not set, {@link Severity#DEFAULT} is used.
*/
public Builder severity(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 insertId(String insertId) {
this.insertId = insertId;
return this;
}
/**
* Sets information about the HTTP request associated with this log entry, if applicable.
*/
public Builder httpRequest(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 labels(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.
*/
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 operation(Operation operation) {
this.operation = operation;
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
*/
public Builder payload(Payload payload) {
this.payload = payload;
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.severity = builder.severity;
this.insertId = builder.insertId;
this.httpRequest = builder.httpRequest;
this.labels = ImmutableMap.copyOf(builder.labels);
this.operation = builder.operation;
this.payload = builder.payload;
}
/**
* 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 logName() {
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 resource() {
return resource;
}
/**
* Returns 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.
*/
public Long timestamp() {
return timestamp;
}
/**
* Returns the severity of the log entry. If not set, {@link Severity#DEFAULT} is used.
*/
public Severity severity() {
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 insertId() {
return insertId;
}
/**
* Returns information about the HTTP request associated with this log entry, if applicable.
*/
public HttpRequest httpRequest() {
return httpRequest;
}
/**
* Returns an optional set of user-defined (key, value) data that provides additional information
* about the log entry.
*/
public Map labels() {
return labels;
}
/**
* Returns information about an operation associated with the log entry, if applicable.
*/
public Operation operation() {
return operation;
}
/**
* 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 payload() {
return (T) payload;
}
@Override
public int hashCode() {
return Objects.hash(logName, resource, timestamp, severity, insertId, httpRequest, labels,
operation, payload);
}
@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(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(payload, other.payload);
}
@Override
public String toString() {
return MoreObjects.toStringHelper(this)
.add("logName", logName)
.add("resource", resource)
.add("timestamp", timestamp)
.add("severity", severity)
.add("insertId", insertId)
.add("httpRequest", httpRequest)
.add("labels", labels)
.add("operation", operation)
.add("payload", payload)
.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) {
builder.setLogName(LoggingServiceV2Api.formatLogName(projectId, logName));
}
if (resource != null) {
builder.setResource(resource.toPb());
}
if (timestamp != null) {
Timestamp.Builder tsBuilder = Timestamp.newBuilder();
tsBuilder.setSeconds(timestamp / MILLIS_PER_SECOND);
tsBuilder.setNanos((int) (timestamp % MILLIS_PER_SECOND * NANOS_PER_MILLISECOND));
builder.setTimestamp(tsBuilder.build());
}
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());
}
return builder.build();
}
/**
* Returns a builder for {@code LogEntry} objects given the entry payload.
*/
public static Builder builder(Payload payload) {
return new Builder(payload);
}
/**
* Creates a {@code LogEntry} object given the entry payload.
*/
public static LogEntry of(Payload payload) {
return builder(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 builder(payload).logName(logName).resource(resource).build();
}
static LogEntry fromPb(com.google.logging.v2.LogEntry entryPb) {
Builder builder = builder(Payload.fromPb(entryPb));
builder.labels(entryPb.getLabels());
builder.severity(Severity.fromPb(entryPb.getSeverity()));
if (!entryPb.getLogName().equals("")) {
builder.logName(LoggingServiceV2Api.parseLogFromLogName(entryPb.getLogName()));
}
if (!entryPb.getResource().equals(com.google.api.MonitoredResource.getDefaultInstance())) {
builder.resource(MonitoredResource.fromPb(entryPb.getResource()));
}
if (entryPb.hasTimestamp()) {
Timestamp ts = entryPb.getTimestamp();
Long millis = ts.getSeconds() * MILLIS_PER_SECOND + ts.getNanos() / NANOS_PER_MILLISECOND;
if (millis != 0) {
builder.timestamp(millis);
}
}
if (!entryPb.getInsertId().equals("")) {
builder.insertId(entryPb.getInsertId());
}
if (!entryPb.getHttpRequest().equals(
com.google.logging.type.HttpRequest.getDefaultInstance())) {
builder.httpRequest(HttpRequest.fromPb(entryPb.getHttpRequest()));
}
if (!entryPb.getOperation().equals(LogEntryOperation.getDefaultInstance())) {
builder.operation(Operation.fromPb(entryPb.getOperation()));
}
return builder.build();
}
static Function toPbFunction(final String projectId) {
return new Function() {
@Override
public com.google.logging.v2.LogEntry apply(LogEntry entry) {
return entry.toPb(projectId);
}
};
}
}