All Downloads are FREE. Search and download functionalities are using the official Maven repository.

com.apple.foundationdb.record.logging.KeyValueLogMessage Maven / Gradle / Ivy

Go to download

A record-oriented layer built for FoundationDB (proto2).

There is a newer version: 2.8.110.0
Show newest version
/*
 * KeyValueLogMessage.java
 *
 * This source file is part of the FoundationDB open source project
 *
 * Copyright 2015-2018 Apple Inc. and the FoundationDB project authors
 *
 * 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.apple.foundationdb.record.logging;

import com.apple.foundationdb.annotation.API;

import javax.annotation.Nonnull;
import javax.annotation.Nullable;
import java.util.Collections;
import java.util.List;
import java.util.Map;
import java.util.Optional;
import java.util.TreeMap;

/**
 * A formatter for log messages.
 *
 * A {@code KeyValueLogMessage} has an associated set of key-value pairs, which are output after the static portion of the message in {@code key=value} form.
 */
@API(API.Status.MAINTAINED)
public class KeyValueLogMessage {
    private final long timestamp;
    private final String staticMessage;

    private final Map keyValueMap;

    public static String of(@Nonnull final String staticMessage, @Nullable final Object... keysAndValues) {
        return new KeyValueLogMessage(staticMessage, keysAndValues).toString();
    }

    public static KeyValueLogMessage build(@Nonnull final String staticMessage, @Nullable final Object... keysAndValues) {
        return new KeyValueLogMessage(staticMessage, keysAndValues);
    }

    private KeyValueLogMessage(@Nonnull final String staticMessage, @Nullable final Object[] keysAndValues) {
        this.staticMessage = staticMessage;
        this.timestamp = System.currentTimeMillis();
        keyValueMap = new TreeMap<>();
        if (keysAndValues != null) {
            for (int i = 0; i < (keysAndValues.length / 2) * 2; i += 2) {
                addKeyValueImpl(keysAndValues[i + 0], keysAndValues[i + 1]);
            }
            if (keysAndValues.length % 2 == 1) {
                throw new IllegalArgumentException("keys and values don't match");
            }
        }
    }

    private void addKeyValueImpl(@Nullable final Object key, @Nullable Object value) {
        if (key == null) {
            throw new IllegalArgumentException("null key passed to KeyValueLogMessage"); // better to throw an exception rather than silently swallow the key
        }
        if (keyValueMap != null) {
            keyValueMap.put(sanitizeKey(key.toString()), sanitizeValue(Optional.ofNullable(value).orElse("null").toString()));
        }
    }

    public KeyValueLogMessage addKeysAndValues(@Nonnull final Map map) {
        for (Map.Entry entry : map.entrySet()) {
            addKeyValueImpl(entry.getKey(), entry.getValue());
        }
        return this;
    }

    public KeyValueLogMessage addKeysAndValues(@Nonnull final List keyValues) {
        for (int u = 0; u < (keyValues.size() / 2) * 2; u += 2) {
            addKeyValueImpl(keyValues.get(u), keyValues.get(u + 1));
        }
        return this;
    }

    @Nonnull
    private static String sanitizeValue(@Nonnull final String value) {
        return value.replace("\"", "'");
    }

    @Nonnull
    private static String sanitizeKey(@Nonnull final String key) {
        return key.replace("=", "");
    }

    @Override
    public String toString() {
        return getMessageWithKeys();
    }

    @Nonnull
    public String getMessageWithKeys() {
        final StringBuilder sb = new StringBuilder( keyValueMap.size() * 30);
        sb.append(staticMessage);
        for (Map.Entry entry: keyValueMap.entrySet()) {
            sb.append(" ");
            sb.append(entry.getKey());
            sb.append("=\"");
            sb.append(entry.getValue());
            sb.append("\"");
        }
        return sb.toString();
    }

    @Nonnull
    public Object[] getValues() {
        return keyValueMap.values().toArray();
    }

    public Object[] getValuesWithThrowable(@Nullable final Throwable t) {
        final Object[] ret = keyValueMap.values().toArray(new Object[keyValueMap.size() + 1]);
        ret[ret.length - 1] = t;
        return ret;
    }

    public KeyValueLogMessage addKeyAndValue(@Nonnull final Object key, @Nullable final Object value) {
        addKeyValueImpl(key, value);
        return this;
    }

    @Nonnull
    public String getStaticMessage() {
        return keyValueMap.get(LogMessageKeys.TITLE.toString());
    }

    public void setStaticMessage(@Nonnull final String staticMessage) {
        keyValueMap.put(LogMessageKeys.TITLE.toString(), staticMessage);
    }

    public long getTimeStamp() {
        return timestamp;
    }

    @Nonnull
    public Map getKeyValueMap() {
        return Collections.unmodifiableMap(keyValueMap);
    }
}

 















© 2015 - 2024 Weber Informatics LLC | Privacy Policy