對應于源碼/apm-sniffer/apm-agent-core/src/main/java/org/apache/skywalking/apm/agent/core/conf/Config.java 類
/*
* 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 org.apache.skywalking.apm.agent.core.conf;
import org.apache.skywalking.apm.agent.core.context.trace.TraceSegment;
import org.apache.skywalking.apm.agent.core.logging.core.LogLevel;
import org.apache.skywalking.apm.agent.core.logging.core.WriterFactory;
/**
* This is the core config in sniffer agent.
*
* @author wusheng
*/
public class Config {
public static class Agent {
/**
* Namespace isolates headers in cross process propagation. The HEADER name will be `HeaderName:Namespace`.
*/
public static String NAMESPACE = ""; //此參數(shù)用以表明跨進程鏈路之中的header搀崭；不同的namespace在一次跨進程鏈路中會導致鏈路中斷
/**
* Application code is showed in sky-walking-ui. Suggestion: set an unique name for each application, one
* application's nodes share the same code.
*/
public static String APPLICATION_CODE = ""; //一個項目的唯一標示婉称，用來展示在web之上
/**
* Authentication active is based on backend setting, see application.yml for more details.
* For most scenarios, this needs backend extensions, only basic match auth provided in default implementation.
*/
public static String AUTHENTICATION = ""; //與Coilector進行通信的token，需要與collector設置的一樣
/**
* Negative or zero means off, by default. {@link #SAMPLE_N_PER_3_SECS} means sampling N {@link TraceSegment} in
* 10 seconds tops.
*/
public static int SAMPLE_N_PER_3_SECS = -1; //每三秒收集的TraceSegment的數(shù)量
/**
* If the operation name of the first span is included in this set, this segment should be ignored.
*/
public static String IGNORE_SUFFIX = ".jpg,.jpeg,.js,.css,.png,.bmp,.gif,.ico,.mp3,.mp4,.html,.svg"; //需要忽略的調(diào)用
/**
* The max number of spans in a single segment. Through this config item, skywalking keep your application
* memory cost estimated.
*/
public static int SPAN_LIMIT_PER_SEGMENT = 300; //每個Segment中最多有多少個Span
/**
* If true, skywalking agent will save all instrumented classes files in `/debugging` folder.
* Skywalking team may ask for these files in order to resolve compatible problem.
*/
public static boolean IS_OPEN_DEBUGGING_CLASS = false; //是否保存增強后的字節(jié)碼文件
}
public static class Collector {
/**
* grpc channel status check interval
*/
public static long GRPC_CHANNEL_CHECK_INTERVAL = 30; //grpc通道心跳的間隔
/**
* application and service registry check interval
*/
public static long APP_AND_SERVICE_REGISTER_CHECK_INTERVAL = 3; //應用和調(diào)用注冊的心跳間隔
/**
* discovery rest check interval
*/
public static long DISCOVERY_CHECK_INTERVAL = 60; //發(fā)現(xiàn)服務的心跳間隔
/**
* Collector naming/jetty service addresses.
* Primary address setting.
*
* e.g.
* SERVERS="127.0.0.1:10800" for single collector node.
* SERVERS="10.2.45.126:10800,10.2.45.127:10800" for multi collector nodes.
*/
public static String SERVERS = ""; //collector公布的naming/jetty地址和端口
/**
* Collector agent_gRPC/grpc service addresses.
* Secondary address setting, only effect when #SERVERS is empty.
*
* By using this, no discovery mechanism provided. The agent only uses these addresses to uplink data.
*
*/
public static String DIRECT_SERVERS = ""; //直連gRpc的地址
/**
* Collector service discovery REST service name
*/
public static String DISCOVERY_SERVICE_NAME = "/agent/gRPC"; //collector收集agent的參數(shù)的path
}
public static class Jvm {
/**
* The buffer size of collected JVM info.
*/
public static int BUFFER_SIZE = 60 * 10; //jvm參數(shù)的通道緩存數(shù)量
}
public static class Buffer {
public static int CHANNEL_SIZE = 5; // 用于發(fā)送至collector的內(nèi)存通道的數(shù)量
public static int BUFFER_SIZE = 300; //每個內(nèi)存通道之中保存的traceSegment的數(shù)量
}
public static class Dictionary {
/**
* The buffer size of application codes and peer
*/
public static int APPLICATION_CODE_BUFFER_SIZE = 10 * 10000;
public static int OPERATION_NAME_BUFFER_SIZE = 1000 * 10000;
}
public static class Logging {
/**
* Log file name.
*/
public static String FILE_NAME = "skywalking-api.log"; //日志的文件名
/**
* Log files directory. Default is blank string, means, use "system.out" to output logs.
*
* Ref to {@link WriterFactory#getLogWriter()}
*/
public static String DIR = ""; //日志打印的目錄
/**
* The max size of log file. If the size is bigger than this, archive the current file, and write into a new
* file.
*/
public static int MAX_FILE_SIZE = 300 * 1024 * 1024; //日志更換新文件的閾值
/**
* The log level. Default is debug.
*/
public static LogLevel LEVEL = LogLevel.DEBUG; //日志打印的等級
}
public static class Plugin {
public static class MongoDB {
/**
* If true, trace all the parameters, default is false. Only trace the operation, not include parameters.
*/
public static boolean TRACE_PARAM = false;
}
}
}
