com.dianping.cat.message.spi.MessageManager Maven / Gradle / Ivy
/*
* Copyright (c) 2011-2018, Meituan Dianping. All Rights Reserved.
*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership.
* The ASF licenses this file to You 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 com.dianping.cat.message.spi;
import com.dianping.cat.configuration.ClientConfigManager;
import com.dianping.cat.message.Message;
import com.dianping.cat.message.Transaction;
/**
* Message manager to help build CAT message.
*
*
* Notes: This method is reserved for internal usage only. Application developer should never call this method directly.
*/
public interface MessageManager {
public void add(Message message);
/**
* Be triggered when a transaction ends, whatever it's the root transaction or nested transaction. However, if it's
* the root transaction then it will be flushed to back-end CAT server asynchronously.
*
*
* @param transaction
*/
public void end(Transaction transaction);
/**
* Get peek transaction for current thread.
*
* @return peek transaction for current thread, null if no transaction there.
*/
public Transaction getPeekTransaction();
/**
* Get thread local message information.
*
* @return message tree, null means current thread is not setup correctly.
*/
public MessageTree getThreadLocalMessageTree();
/**
* Check if the thread context is setup or not.
*
* @return true if the thread context is setup, false otherwise
*/
public boolean hasContext();
/**
* Check if current context logging is enabled or disabled.
*
* @return true if current context is enabled
*/
public boolean isMessageEnabled();
/**
* Check if CAT logging is enabled or disabled.
*
* @return true if CAT is enabled
*/
public boolean isCatEnabled();
/**
* Check if CAT trace mode is enabled or disabled.
*
* @return true if CAT is trace mode
*/
public boolean isTraceMode();
/**
* Set CAT trace mode.
*/
public void setTraceMode(boolean traceMode);
/**
* Do cleanup for current thread environment in order to release resources in thread local objects.
*/
public void reset();
/**
* Do setup for current thread environment in order to prepare thread local objects.
*/
public void setup();
/**
* Be triggered when a new transaction starts, whatever it's the root transaction or nested transaction.
*
* @param transaction
* @param forked
*/
public void start(Transaction transaction, boolean forked);
/**
* Binds the current message tree to the transaction tagged with tag.
*
* @param tag tag name of the tagged transaction
* @param title title shown in the logview
*/
public void bind(String tag, String title);
/**
* get domain
*/
public String getDomain();
public ClientConfigManager getConfigManager();
}