com.dianping.cat.message

接口 MessageProducer

所有已知实现类:

DefaultMessageProducer, NullMessageProducer

public interface MessageProducer

Message factory is used to create new transaction,event and/or heartbeat.

Normally, application code logs message in following ways, for example:

• Event

   public class MyClass {
      public static MessageFactory CAT = Cat.getFactory();
  
      public void bizMethod() {
         Event event = CAT.newEvent("Review", "New");
  
         event.addData("id", 12345);
         event.addData("user", "john");
         ...
         event.setStatus("0");
         event.complete();
      }
      ...
   }
   

• Heartbeat

   public class MyClass {
      public static MessageFactory CAT = Cat.getFactory();
  
      public void bizMethod() {
         Heartbeat event = CAT.newHeartbeat("System", "Status");
  
         event.addData("ip", "192.168.10.111");
         event.addData("host", "host-1");
         event.addData("load", "2.1");
         event.addData("cpu", "0.12,0.10");
         event.addData("memory.total", "2G");
         event.addData("memory.free", "456M");
         event.setStatus("0");
         event.complete();
      }
      ...
   }
   

• Transaction

   public class MyClass {
      public static MessageFactory CAT = Cat.getFactory();
  
      public void bizMethod() {
         Transaction t = CAT.newTransaction("URL", "MyPage");
  
         try {
            // do your business here
            t.addData("k1", "v1");
            t.addData("k2", "v2");
            t.addData("k3", "v3");
            Thread.sleep(30);
  
            t.setStatus("0");
         } catch (Exception e) {
            t.setStatus(e);
         } finally {
            t.complete();
         }
      }
      ...
   }
   

or logs event or heartbeat in one shot, for example:

• Event

   public class MyClass {
      public static MessageFactory CAT = Cat.getFactory();
  
      public void bizMethod() {
         CAT.logEvent("Review", "New", "0", "id=12345&user=john");
      }
      ...
   }
   

• Heartbeat

   public class MyClass {
      public static MessageFactory CAT = Cat.getFactory();
  
      public void bizMethod() {
         CAT.logHeartbeat("System", "Status", "0", "ip=192.168.10.111&host=host-1&load=2.1&cpu=0.12,0.10&memory.total=2G&memory.free=456M");
      }
      ...
   }
   

作者:

Frankie Wu

方法概要

限定符和类型	方法和说明
String	createMessageId() Create a new message id.
String	createRpcServerId(String domain) Create rpc server message id.
boolean	isEnabled() Check if the CAT client is enabled for current domain.
void	logError(String message, Throwable cause) Log an error.
void	logError(Throwable cause) Log an error.
void	logEvent(String type, String name) Log an event in one shot with SUCCESS status.
void	logEvent(String type, String name, String status, String nameValuePairs) Log an event in one shot.
void	logHeartbeat(String type, String name, String status, String nameValuePairs) Log a heartbeat in one shot.
void	logMetric(String name, String status, String nameValuePairs) Log a metric in one shot.
void	logTrace(String type, String name) Log an trace in one shot with SUCCESS status.
void	logTrace(String type, String name, String status, String nameValuePairs) Log an trace in one shot.
Event	newEvent(String type, String name) Create a new event with given type and name.
ForkedTransaction	newForkedTransaction(String type, String name) Create a forked transaction for child thread.
Heartbeat	newHeartbeat(String type, String name) Create a new heartbeat with given type and name.
Metric	newMetric(String type, String name) Create a new metric with given type and name.
TaggedTransaction	newTaggedTransaction(String type, String name, String tag) Create a tagged transaction for another process or thread.
Trace	newTrace(String type, String name) Create a new trace with given type and name.
Transaction	newTransaction(String type, String name) Create a new transaction with given type and name.

方法详细资料

createRpcServerId

String createRpcServerId(String domain)

Create rpc server message id.

domain is the rpc server

返回:

new message id

createMessageId

String createMessageId()

Create a new message id.

返回:

new message id

isEnabled

boolean isEnabled()

Check if the CAT client is enabled for current domain.

返回:

true if CAT client is enabled, false means CAT client is disabled.

logError

void logError(String message,
              Throwable cause)

Log an error.

参数:

cause - root cause exception

logError

void logError(Throwable cause)

Log an error.

参数:

cause - root cause exception

logEvent

void logEvent(String type,
              String name)

Log an event in one shot with SUCCESS status.

参数:

type - event type

name - event name

logEvent

void logEvent(String type,
              String name,
              String status,
              String nameValuePairs)

Log an event in one shot.

参数:

type - event type

name - event name

status - "0" means success, otherwise means error code

nameValuePairs - name value pairs in the format of "a=1&b=2&..."

logHeartbeat

void logHeartbeat(String type,
                  String name,
                  String status,
                  String nameValuePairs)

Log a heartbeat in one shot.

参数:

type - heartbeat type

name - heartbeat name

status - "0" means success, otherwise means error code

nameValuePairs - name value pairs in the format of "a=1&b=2&..."

logMetric

void logMetric(String name,
               String status,
               String nameValuePairs)

Log a metric in one shot.

参数:

name - metric name

status - "0" means success, otherwise means error code

nameValuePairs - name value pairs in the format of "a=1&b=2&..."

logTrace

void logTrace(String type,
              String name)

Log an trace in one shot with SUCCESS status.

参数:

type - trace type

name - trace name

logTrace

void logTrace(String type,
              String name,
              String status,
              String nameValuePairs)

Log an trace in one shot.

参数:

type - trace type

name - trace name

status - "0" means success, otherwise means error code

nameValuePairs - name value pairs in the format of "a=1&b=2&..."

newEvent

Event newEvent(String type,
               String name)

Create a new event with given type and name.

参数:

type - event type

name - event name

newForkedTransaction

ForkedTransaction newForkedTransaction(String type,
                                       String name)

Create a forked transaction for child thread.

参数:

type - transaction type

name - transaction name

返回:

forked transaction

newHeartbeat

Heartbeat newHeartbeat(String type,
                       String name)

Create a new heartbeat with given type and name.

参数:

type - heartbeat type

name - heartbeat name

newMetric

Metric newMetric(String type,
                 String name)

Create a new metric with given type and name.

参数:

type - metric type

name - metric name

newTaggedTransaction

TaggedTransaction newTaggedTransaction(String type,
                                       String name,
                                       String tag)

Create a tagged transaction for another process or thread.

参数:

type - transaction type

name - transaction name

tag - tag applied to the transaction

返回:

tagged transaction

newTrace

Trace newTrace(String type,
               String name)

Create a new trace with given type and name.

参数:

type - trace type

name - trace name

newTransaction

Transaction newTransaction(String type,
                           String name)

Create a new transaction with given type and name.

参数:

type - transaction type

name - transaction name