net.snowflake.ingest.utils.Logging Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of snowflake-ingest-sdk Show documentation
Snowflake Ingest SDK
There is a newer version: 3.0.0
/*
 * Copyright (c) 2021 Snowflake Computing Inc. All rights reserved.
 */

package net.snowflake.ingest.utils;

import java.util.Objects;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

/** Base Logging Utility */
public class Logging {
  private final Logger log;

  public Logging(Class name) {
    log = LoggerFactory.getLogger(name);
  }

  // only message
  public void logInfo(String msg) {
    if (log.isInfoEnabled()) {
      log.info(logMessage(msg));
    }
  }

  public void logTrace(String msg) {
    if (log.isTraceEnabled()) {
      log.trace(logMessage(msg));
    }
  }

  /** @return true if trace is enabled */
  public boolean isTraceEnabled() {
    return log.isTraceEnabled();
  }

  public void logDebug(String msg) {
    if (log.isDebugEnabled()) {
      log.debug(logMessage(msg));
    }
  }

  public void logWarn(String msg) {
    if (log.isWarnEnabled()) {
      log.warn(logMessage(msg));
    }
  }

  public void logError(String msg) {
    if (log.isErrorEnabled()) {
      log.error(logMessage(msg));
    }
  }

  // format and variables
  public void logInfo(String format, Object... vars) {
    if (log.isInfoEnabled()) {
      log.info(logMessage(format, vars));
    }
  }

  public void logTrace(String format, Object... vars) {
    if (log.isTraceEnabled()) {
      log.trace(logMessage(format, vars));
    }
  }

  public void logDebug(String format, Object... vars) {
    if (log.isDebugEnabled()) {
      log.debug(logMessage(format, vars));
    }
  }

  public void logWarn(String format, Throwable e) {
    if (log.isWarnEnabled()) {
      log.warn(format, e);
    }
  }

  public void logWarn(String format, Object... vars) {
    if (log.isWarnEnabled()) {
      log.warn(format, vars);
    }
  }

  public void logError(String format, Object... vars) {
    if (log.isErrorEnabled()) {
      log.error(logMessage(format, vars));
    }
  }

  public Logger getLogger() {
    return log;
  }

  // static elements

  // log message tag
  static final String SF_LOG_TAG = "[SF_INGEST]";

  /*
   * the following methods wrap log message with Snowflake tag. For example,
   *
   * [SF_INGEST] this is a log message
   * [SF_INGEST] this is the second line
   *
   * All log messages should be wrapped by Snowflake tag.
   */

  /**
   * wrap a message without variable
   *
   * @param msg log message
   * @return log message wrapped by snowflake tag
   */
  private static String logMessage(String msg) {
    return SF_LOG_TAG + " " + msg;
  }

  /**
   * wrap a message contains multiple variables, each {} will be replaced with the input variable
   *
   * @param format log message format string
   * @param vars variable list
   * @return log message wrapped by snowflake tag
   */
  private static String logMessage(String format, Object... vars) {
    for (int i = 0; i < vars.length; i++) {
      format = format.replaceFirst("\\{}", Objects.toString(vars[i]).replaceAll("\\$", "\\\\\\$"));
    }
    return logMessage(format);
  }
}