app.myoss.cloud.apm.constants.ApmConstants Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of myoss-starter-apm Show documentation
myoss open source project, myoss-starter written in Java
There is a newer version: 2.3.1.RELEASE
/*
 * Copyright 2018-2018 https://github.com/myoss
 *
 * 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 app.myoss.cloud.apm.constants;

import app.myoss.cloud.core.constants.MyossConstants;

/**
 * 应用性能监控常量
 *
 * @author Jerry.Chen
 * @since 2018年8月30日 上午10:14:38
 */
public class ApmConstants {
    /**
     * APM配置前缀
     */
    public static final String CONFIG_PREFIX                       = MyossConstants.CONFIG_PREFIX + ".log";
    /**
     * 使用slf4j记录方法的入参和出参，配置前缀
     */
    public static final String MONITOR_METHOD_CONFIG_PREFIX        = CONFIG_PREFIX + ".method";
    /**
     * 使用slf4j记录 {@link org.springframework.stereotype.Controller} 的信息，配置前缀
     */
    public static final String MONITOR_CONTROLLER_CONFIG_PREFIX    = CONFIG_PREFIX + ".controller";
    /**
     * 每天定时检查日志文件，是否已经滚动生成新的文件，没有就触发生成新的文件，配置前缀
     */
    public static final String AUTO_ROLLING_LOG_FILE_CONFIG_PREFIX = CONFIG_PREFIX + ".auto-rolling-log-file";

    /**
     * add property to MDC context "spanExportable"
     *
     * @see org.springframework.cloud.sleuth.log.Slf4jCurrentTraceContext
     */
    public static final String SPAN_EXPORTABLE_NAME                = "spanExportable";
    /**
     * add property to MDC context "parentId"
     *
     * @see org.springframework.cloud.sleuth.log.Slf4jCurrentTraceContext
     */
    public static final String PARENT_ID_NAME                      = "parentId";
    /**
     * add property to MDC context "traceId"
     *
     * @see org.springframework.cloud.sleuth.log.Slf4jCurrentTraceContext
     */
    public static final String TRACE_ID_NAME                       = "traceId";
    /**
     * add property to MDC context "spanId"
     *
     * @see org.springframework.cloud.sleuth.log.Slf4jCurrentTraceContext
     */
    public static final String SPAN_ID_NAME                        = "spanId";

    /**
     * adding legacy "X-B3" entries to MDC context "X-B3-Export"
     *
     * @see org.springframework.cloud.sleuth.log.Slf4jCurrentTraceContext
     */
    public static final String LEGACY_EXPORTABLE_NAME              = "X-Span-Export";
    /**
     * adding legacy "X-B3" entries to MDC context "X-B3-ParentSpanId"
     *
     * @see org.springframework.cloud.sleuth.log.Slf4jCurrentTraceContext
     */
    public static final String LEGACY_PARENT_ID_NAME               = "X-B3-ParentSpanId";
    /**
     * adding legacy "X-B3" entries to MDC context "X-B3-TraceId"
     *
     * @see org.springframework.cloud.sleuth.log.Slf4jCurrentTraceContext
     */
    public static final String LEGACY_TRACE_ID_NAME                = "X-B3-TraceId";
    /**
     * adding legacy "X-B3" entries to MDC context "X-B3-SpanId"
     *
     * @see org.springframework.cloud.sleuth.log.Slf4jCurrentTraceContext
     */
    public static final String LEGACY_SPAN_ID_NAME                 = "X-B3-SpanId";
}