io.dapr.actors.ActorTrace Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of dapr-sdk-actors Show documentation
SDK for Actors on Dapr
The newest version!
/*
 * Copyright 2021 The Dapr 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 io.dapr.actors;

import java.util.logging.Level;
import java.util.logging.Logger;

// TODO: Implement distributed tracing.
// TODO: Make this generic to the SDK and not only for Actors.

/**
 * Class to emit trace log messages.
 */
public final class ActorTrace {

  /**
   * Gets the default Logger.
   */
  private static final Logger LOGGER = Logger.getLogger(ActorTrace.class.getName());

  /**
   * Writes an information trace log.
   *
   * @param type      Type of log.
   * @param id        Instance identifier.
   * @param msgFormat Message or message format (with type and id input as well).
   * @param params    Params for the message.
   */
  public void writeInfo(String type, String id, String msgFormat, Object... params) {
    this.write(Level.INFO, type, id, msgFormat, params);
  }

  /**
   * Writes an warning trace log.
   *
   * @param type      Type of log.
   * @param id        Instance identifier.
   * @param msgFormat Message or message format (with type and id input as well).
   * @param params    Params for the message.
   */
  public void writeWarning(String type, String id, String msgFormat, Object... params) {
    this.write(Level.WARNING, type, id, msgFormat, params);
  }

  /**
   * Writes an error trace log.
   *
   * @param type      Type of log.
   * @param id        Instance identifier.
   * @param msgFormat Message or message format (with type and id input as well).
   * @param params    Params for the message.
   */
  public void writeError(String type, String id, String msgFormat, Object... params) {
    this.write(Level.SEVERE, type, id, msgFormat, params);
  }

  /**
   * Writes a trace log.
   *
   * @param level     Severity level of the log.
   * @param type      Type of log.
   * @param id        Instance identifier.
   * @param msgFormat Message or message format (with type and id input as well).
   * @param params    Params for the message.
   */
  private void write(Level level, String type, String id, String msgFormat, Object... params) {
    String formatString = String.format("%s:%s %s", emptyIfNul(type), emptyIfNul(id), emptyIfNul(msgFormat));
    if ((params == null) || (params.length == 0)) {
      LOGGER.log(level, formatString);
    } else {
      LOGGER.log(level, String.format(formatString, params));
    }
  }

  /**
   * Utility method that returns empty if String is null.
   *
   * @param s String to be checked.
   * @return String (if not null) or empty (if null).
   */
  private static String emptyIfNul(String s) {
    if (s == null) {
      return "";
    }

    return s;
  }
}