com.dianping.cat.message

接口 Message

所有已知子接口:

Event, ForkedTransaction, Heartbeat, Metric, TaggedTransaction, Trace, Transaction

所有已知实现类:

AbstractMessage, DefaultEvent, DefaultForkedTransaction, DefaultHeartbeat, DefaultMetric, DefaultTaggedTransaction, DefaultTrace, DefaultTransaction, NullMessage

public interface Message

Message represents data collected during application runtime. It will be sent to back-end system asynchronous for further processing.

Super interface of Event, Heartbeat and Transaction.

作者:

Frankie Wu

另请参阅:

Event, Heartbeat, Transaction

字段概要

字段

限定符和类型	字段和说明
static String	SUCCESS

方法概要

限定符和类型	方法和说明
void	addData(String keyValuePairs) add one or multiple key-value pairs to the message.
void	addData(String key, Object value) add one key-value pair to the message.
void	complete() Complete the message construction.
Object	getData()
String	getName() Message name.
String	getStatus() Get the message status.
long	getTimestamp() The time stamp the message was created.
String	getType() Message type.
boolean	isCompleted() If the complete() method was called or not.
boolean	isSuccess()
void	setStatus(String status) Set the message status.
void	setStatus(Throwable e) Set the message status with exception class name.
void	setSuccessStatus()
void	setTimestamp(long timestamp)

字段详细资料

SUCCESS

static final String SUCCESS

另请参阅:

常量字段值

方法详细资料

addData

void addData(String keyValuePairs)

add one or multiple key-value pairs to the message.

参数:

keyValuePairs - key-value pairs like 'a=1&b=2&...'

addData

void addData(String key,
             Object value)

add one key-value pair to the message.

参数:

key -

value -

complete

void complete()

Complete the message construction.

getData

Object getData()

返回:

key value pairs data

getName

String getName()

Message name.

返回:

message name

getStatus

String getStatus()

Get the message status.

返回:

message status. "0" means success, otherwise error code.

setStatus

void setStatus(Throwable e)

Set the message status with exception class name.

参数:

e - exception.

getTimestamp

long getTimestamp()

The time stamp the message was created.

返回:

message creation time stamp in milliseconds

setTimestamp

void setTimestamp(long timestamp)

getType

String getType()

Message type.

Typical message types are:

• URL: maps to one method of an action
• Service: maps to one method of service call
• Search: maps to one method of search call
• SQL: maps to one SQL statement
• Cache: maps to one cache access
• Error: maps to java.lang.Throwable (java.lang.Exception and java.lang.Error)

返回:

message type

isCompleted

boolean isCompleted()

If the complete() method was called or not.

返回:

true means the complete() method was called, false otherwise.

isSuccess

boolean isSuccess()

返回:

setStatus

void setStatus(String status)

Set the message status.

参数:

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

setSuccessStatus

void setSuccessStatus()