All Downloads are FREE. Search and download functionalities are using the official Maven repository.
Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance.
Project price only 1 $
You can buy this project and download/modify it how often you want.
biz.paluch.logging.gelf.intern.GelfMessage Maven / Gradle / Ivy
package biz.paluch.logging.gelf.intern;
import java.io.ByteArrayOutputStream;
import java.io.IOException;
import java.math.BigDecimal;
import java.nio.ByteBuffer;
import java.util.Arrays;
import java.util.HashMap;
import java.util.Map;
import java.util.zip.GZIPOutputStream;
import org.json.simple.JSONValue;
/**
* @author https://github.com/t0xa/gelfj
* @author Mark Paluch
*/
public class GelfMessage {
public static final String FIELD_HOST = "host";
public static final String FIELD_SHORT_MESSAGE = "short_message";
public static final String FIELD_FULL_MESSAGE = "full_message";
public static final String FIELD_TIMESTAMP = "timestamp";
public static final String FIELD_LEVEL = "level";
public static final String FIELD_FACILITY = "facility";
public static final String ID_NAME = "id";
/**
* Discover the field type by trying to parse it.
*/
public static final String FIELD_TYPE_DISCOVER = "discover";
/**
* String field type.
*/
public static final String FIELD_TYPE_STRING = "String";
/**
* long field type. Zero if value cannot be converted.
*/
public static final String FIELD_TYPE_LONG = "long";
/**
* Long field type. Null if value cannot be converted.
*/
public static final String FIELD_TYPE_LONG2 = "Long";
/**
* double field type. Zero if value cannot be converted.
*/
public static final String FIELD_TYPE_DOUBLE = "double";
/**
* Double field type. Null if value cannot be converted.
*/
public static final String FIELD_TYPE_DOUBLE2 = "Double";
/*
* Default field type: Discover
*/
public static final String FIELD_TYPE_DEFAULT = FIELD_TYPE_DISCOVER;
public static final String GELF_VERSION_1_0 = "1.0";
public static final String GELF_VERSION_1_1 = "1.1";
public static final String GELF_VERSION = GELF_VERSION_1_0;
public static final String DEFAULT_FACILITY = "logstash-gelf";
public static final int DEFAULT_MESSAGE_SIZE = 8192;
public static final int DEFAUL_LEVEL = 7;
private static final byte[] GELF_CHUNKED_ID = new byte[] { 0x1e, 0x0f };
private static final BigDecimal TIME_DIVISOR = new BigDecimal(1000);
private String version = GELF_VERSION;
private String host;
private byte[] hostBytes = lastFourAsciiBytes("none");
private String shortMessage;
private String fullMessage;
private long javaTimestamp;
private String level;
private String facility = DEFAULT_FACILITY;
private Map additonalFields = new HashMap();
private Map additionalFieldTypes = new HashMap();
private int maximumMessageSize = DEFAULT_MESSAGE_SIZE;
public GelfMessage() {
}
public GelfMessage(String shortMessage, String fullMessage, long timestamp, String level) {
this.shortMessage = shortMessage;
this.fullMessage = fullMessage;
this.javaTimestamp = timestamp;
this.level = level;
}
public String toJson(String additionalFieldPrefix) {
Map map = new HashMap();
if (!isEmpty(getHost())) {
map.put(FIELD_HOST, getHost());
}
if (!isEmpty(shortMessage)) {
map.put(FIELD_SHORT_MESSAGE, getShortMessage());
}
if (!isEmpty(getFullMessage())) {
map.put(FIELD_FULL_MESSAGE, getFullMessage());
}
if (getJavaTimestamp() != 0) {
if (GELF_VERSION_1_1.equals(version)) {
map.put(FIELD_TIMESTAMP, getTimestampAsBigDecimal().doubleValue());
} else {
map.put(FIELD_TIMESTAMP, getTimestamp());
}
}
if (!isEmpty(getLevel())) {
if (GELF_VERSION_1_1.equals(version)) {
int level;
try {
level = Integer.parseInt(getLevel());
} catch (NumberFormatException ex) {
// fallback on the default value
level = DEFAUL_LEVEL;
}
map.put(FIELD_LEVEL, level);
} else {
map.put(FIELD_LEVEL, getLevel());
}
}
if (!isEmpty(getFacility())) {
map.put(FIELD_FACILITY, getFacility());
}
for (Map.Entry additionalField : additonalFields.entrySet()) {
if (!ID_NAME.equals(additionalField.getKey()) && additionalField.getValue() != null) {
String value = additionalField.getValue();
String fieldType = additionalFieldTypes.get(additionalField.getKey());
if (fieldType == null) {
fieldType = FIELD_TYPE_DEFAULT;
}
Object result = getAdditionalFieldValue(value, fieldType);
if (result != null) {
map.put(additionalFieldPrefix + additionalField.getKey(), result);
}
}
}
return JSONValue.toJSONString(map);
}
/**
* Get the field value as requested data type.
* @param value the value as string
* @param fieldType see field types
* @return the field value in the appropriate data type or {@literal null}.
*/
protected Object getAdditionalFieldValue(String value, String fieldType) {
Object result = null;
if (fieldType.equalsIgnoreCase(FIELD_TYPE_DISCOVER)) {
try {
try {
// try adding the value as a long
result = Long.parseLong(value);
} catch (NumberFormatException ex) {
// fallback on the double value
result = Double.parseDouble(value);
}
} catch (NumberFormatException ex) {
// fallback on the string value
result = value;
}
}
if (fieldType.equalsIgnoreCase(FIELD_TYPE_STRING)) {
result = value;
}
if (fieldType.equals(FIELD_TYPE_DOUBLE) || fieldType.equalsIgnoreCase(FIELD_TYPE_DOUBLE2)) {
try {
result = Double.parseDouble(value);
} catch (NumberFormatException ex) {
if (fieldType.equals(FIELD_TYPE_DOUBLE)) {
result = Double.valueOf(0);
}
}
}
if (fieldType.equals(FIELD_TYPE_LONG) || fieldType.equalsIgnoreCase(FIELD_TYPE_LONG2)) {
try {
result = (long) Double.parseDouble(value);
} catch (NumberFormatException ex) {
if (fieldType.equals(FIELD_TYPE_LONG)) {
result = Long.valueOf(0);
}
}
}
return result;
}
public String toJson() {
return toJson("_");
}
public ByteBuffer[] toUDPBuffers() {
byte[] messageBytes = gzipMessage(toJson());
// calculate the length of the datagrams array
int diagrams_length = messageBytes.length / maximumMessageSize;
// In case of a remainder, due to the integer division, add a extra datagram
if (messageBytes.length % maximumMessageSize != 0) {
diagrams_length++;
}
ByteBuffer[] datagrams = new ByteBuffer[diagrams_length];
if (messageBytes.length > maximumMessageSize) {
sliceDatagrams(messageBytes, datagrams);
} else {
datagrams[0] = ByteBuffer.allocate(messageBytes.length);
datagrams[0].put(messageBytes);
datagrams[0].flip();
}
return datagrams;
}
public ByteBuffer toTCPBuffer() {
byte[] messageBytes;
// Do not use GZIP, as the headers will contain \0 bytes
// graylog2-server uses \0 as a delimiter for TCP frames
// see: https://github.com/Graylog2/graylog2-server/issues/127
String json = toJson();
json += '\0';
messageBytes = Charsets.utf8(json);
ByteBuffer buffer = ByteBuffer.allocate(messageBytes.length);
buffer.put(messageBytes);
buffer.flip();
return buffer;
}
private void sliceDatagrams(byte[] messageBytes, ByteBuffer[] datagrams) {
int messageLength = messageBytes.length;
byte[] messageId = ByteBuffer.allocate(8).putInt(getCurrentMillis()) // 4 least-significant-bytes of the time in millis
.put(hostBytes) // 4 least-significant-bytes of the host
.array();
// Reuse length of datagrams array since this is supposed to be the correct number of datagrams
int num = datagrams.length;
for (int idx = 0; idx < num; idx++) {
byte[] header = concatByteArray(GELF_CHUNKED_ID, concatByteArray(messageId, new byte[] { (byte) idx, (byte) num }));
int from = idx * maximumMessageSize;
int to = from + maximumMessageSize;
if (to >= messageLength) {
to = messageLength;
}
byte[] datagram = concatByteArray(header, Arrays.copyOfRange(messageBytes, from, to));
datagrams[idx] = ByteBuffer.allocate(datagram.length);
datagrams[idx].put(datagram);
datagrams[idx].flip();
}
}
public int getCurrentMillis() {
return (int) System.currentTimeMillis();
}
private byte[] gzipMessage(String message) {
ByteArrayOutputStream bos = new ByteArrayOutputStream();
try {
GZIPOutputStream stream = new GZIPOutputStream(bos);
byte[] bytes = Charsets.utf8(message);
stream.write(bytes);
stream.finish();
Closer.close(stream);
byte[] zipped = bos.toByteArray();
Closer.close(bos);
return zipped;
} catch (IOException e) {
return null;
}
}
private byte[] lastFourAsciiBytes(String host) {
final String shortHost = host.length() >= 4 ? host.substring(host.length() - 4) : host;
return Charsets.ascii(shortHost);
}
public String getVersion() {
return version;
}
public void setVersion(String version) {
this.version = version;
}
public String getHost() {
return host;
}
public void setHost(String host) {
this.host = host;
if (host != null) {
this.hostBytes = lastFourAsciiBytes(host);
}
}
public String getShortMessage() {
return !isEmpty(shortMessage) ? shortMessage : "";
}
public void setShortMessage(String shortMessage) {
this.shortMessage = shortMessage;
}
public String getFullMessage() {
return fullMessage;
}
public void setFullMessage(String fullMessage) {
this.fullMessage = fullMessage;
}
public BigDecimal getTimestampAsBigDecimal() {
return new BigDecimal(javaTimestamp).divide(TIME_DIVISOR);
}
public String getTimestamp() {
return getTimestampAsBigDecimal().toPlainString();
}
public Long getJavaTimestamp() {
return javaTimestamp;
}
public void setJavaTimestamp(long javaTimestamp) {
this.javaTimestamp = javaTimestamp;
}
public String getLevel() {
return level;
}
public void setLevel(String level) {
this.level = level;
}
public String getFacility() {
return facility;
}
public void setFacility(String facility) {
this.facility = facility;
}
public Map getAdditionalFieldTypes() {
return additionalFieldTypes;
}
public void setAdditionalFieldTypes(Map additionalFieldTypes) {
this.additionalFieldTypes = additionalFieldTypes;
}
/**
* Add multiple fields (key/value pairs)
*
* @param fields map of fields
* @return the current GelfMessage.
*/
public GelfMessage addFields(Map fields) {
if (fields == null) {
throw new IllegalArgumentException("fields is null");
}
getAdditonalFields().putAll(fields);
return this;
}
/**
* Add a particular field.
*
* @param key the key
* @param value the value
* @return the current GelfMessage.
*/
public GelfMessage addField(String key, String value) {
getAdditonalFields().put(key, value);
return this;
}
public Map getAdditonalFields() {
return additonalFields;
}
public boolean isValid() {
return isShortOrFullMessagesExists() && !isEmpty(version) && !isEmpty(host);
}
private boolean isShortOrFullMessagesExists() {
return !isEmpty(shortMessage) || !isEmpty(fullMessage);
}
public static boolean isEmpty(String str) {
return str == null || "".equals(str.trim());
}
private byte[] concatByteArray(byte[] first, byte[] second) {
byte[] result = Arrays.copyOf(first, first.length + second.length);
System.arraycopy(second, 0, result, first.length, second.length);
return result;
}
public int getMaximumMessageSize() {
return maximumMessageSize;
}
public void setMaximumMessageSize(int maximumMessageSize) {
this.maximumMessageSize = maximumMessageSize;
}
public String getField(String fieldName) {
return getAdditonalFields().get(fieldName);
}
@Override
public boolean equals(Object o) {
if (this == o) {
return true;
}
if (!(o instanceof GelfMessage)) {
return false;
}
GelfMessage that = (GelfMessage) o;
if (javaTimestamp != that.javaTimestamp) {
return false;
}
if (maximumMessageSize != that.maximumMessageSize) {
return false;
}
if (additonalFields != null ? !additonalFields.equals(that.additonalFields) : that.additonalFields != null) {
return false;
}
if (facility != null ? !facility.equals(that.facility) : that.facility != null) {
return false;
}
if (fullMessage != null ? !fullMessage.equals(that.fullMessage) : that.fullMessage != null) {
return false;
}
if (host != null ? !host.equals(that.host) : that.host != null) {
return false;
}
if (!Arrays.equals(hostBytes, that.hostBytes)) {
return false;
}
if (level != null ? !level.equals(that.level) : that.level != null) {
return false;
}
if (shortMessage != null ? !shortMessage.equals(that.shortMessage) : that.shortMessage != null) {
return false;
}
if (version != null ? !version.equals(that.version) : that.version != null) {
return false;
}
return true;
}
@Override
public int hashCode() {
int result = version != null ? version.hashCode() : 0;
result = 31 * result + (host != null ? host.hashCode() : 0);
result = 31 * result + (hostBytes != null ? Arrays.hashCode(hostBytes) : 0);
result = 31 * result + (shortMessage != null ? shortMessage.hashCode() : 0);
result = 31 * result + (fullMessage != null ? fullMessage.hashCode() : 0);
result = 31 * result + (int) (javaTimestamp ^ (javaTimestamp >>> 32));
result = 31 * result + (level != null ? level.hashCode() : 0);
result = 31 * result + (facility != null ? facility.hashCode() : 0);
result = 31 * result + (additonalFields != null ? additonalFields.hashCode() : 0);
result = 31 * result + maximumMessageSize;
return result;
}
}
