com.dianping.cat.message

接口 Transaction

所有超级接口:

Message

所有已知子接口:

ForkedTransaction, TaggedTransaction

所有已知实现类:

DefaultForkedTransaction, DefaultTaggedTransaction, DefaultTransaction, NullMessage

public interface Transaction
extends Message

Transaction is any interesting unit of work that takes time to complete and may fail.

Basically, all data access across the boundary needs to be logged as a Transaction since it may fail and time consuming. For example, URL request, disk IO, JDBC query, search query, HTTP request, 3rd party API call etc.

Sometime if A needs call B which is owned by another team, although A and B are deployed together without any physical boundary. To make the ownership clear, there could be some Transaction logged when A calls B.

Most of Transaction should be logged in the infrastructure level or framework level, which is transparent to the application.

All CAT message will be constructed as a message tree and send to back-end for further analysis, and for monitoring. Only Transaction can be a tree node, all other message will be the tree leaf.　The transaction without other messages nested is an atomic transaction.

作者:

Frankie Wu

字段概要

从接口继承的字段 com.dianping.cat.message.Message

SUCCESS

方法概要

限定符和类型	方法和说明
Transaction	addChild(Message message) Add one nested child message to current transaction.
List<Message>	getChildren() Get all children message within current transaction.
long	getDurationInMicros() How long the transaction took from construction to complete.
long	getDurationInMillis() How long the transaction took from construction to complete.
boolean	hasChildren() Has children or not.
boolean	isStandalone() Check if the transaction is stand-alone or belongs to another one.
void	setDurationInMillis(long durationInMills) set duration in millisecond.

从接口继承的方法 com.dianping.cat.message.Message

addData, addData, complete, getData, getName, getStatus, getTimestamp, getType, isCompleted, isSuccess, setStatus, setStatus, setSuccessStatus, setTimestamp

方法详细资料

addChild

Transaction addChild(Message message)

Add one nested child message to current transaction.

参数:

message - to be added

getChildren

List<Message> getChildren()

Get all children message within current transaction.

Typically, a Transaction can nest other Transactions, Events and Heartbeat s, while an Event or Heartbeat can't nest other messages.

返回:

all children messages, empty if there is no nested children.

getDurationInMicros

long getDurationInMicros()

How long the transaction took from construction to complete. Time unit is microsecond.

返回:

duration time in microsecond

getDurationInMillis

long getDurationInMillis()

How long the transaction took from construction to complete. Time unit is millisecond.

返回:

duration time in millisecond

setDurationInMillis

void setDurationInMillis(long durationInMills)

set duration in millisecond.

hasChildren

boolean hasChildren()

Has children or not. An atomic transaction does not have any children message.

返回:

true if child exists, else false.

isStandalone

boolean isStandalone()

Check if the transaction is stand-alone or belongs to another one.

返回:

true if it's an root transaction.