agent folder in SkyWalking release packageagent.service_name in config/agent.config. Could be any String in English.collector.backend_service in config/agent.config. Default point to 127.0.0.1:11800, only works for local backend.-javaagent:/path/to/skywalking-package/agent/skywalking-agent.jar to JVM argument. And make sure to add it before the -jar argument.The agent release dist is included in Apache official release. New agent package looks like this.
+-- agent
+-- activations
apm-toolkit-log4j-1.x-activation.jar
apm-toolkit-log4j-2.x-activation.jar
apm-toolkit-logback-1.x-activation.jar
...
+-- config
agent.config
+-- plugins
apm-dubbo-plugin.jar
apm-feign-default-http-9.x.jar
apm-httpClient-4.x-plugin.jar
.....
+-- optional-plugins
apm-gson-2.x-plugin.jar
.....
+-- bootstrap-plugins
jdk-http-plugin.jar
.....
+-- logs
skywalking-agent.jar
SkyWalking agent has supported various middlewares, frameworks and libraries. Read supported list to get them and supported version. If the plugin is in Optional² catalog, go to optional plugins section to learn how to active it.
/plugins folder. The plugin jar is active when it is in there. Remove the plugin jar, it disabled./logs.tomcat/bin/catalina.sh.CATALINA_OPTS="$CATALINA_OPTS -javaagent:/path/to/skywalking-agent/skywalking-agent.jar"; export CATALINA_OPTS
tomcat/bin/catalina.bat.set "CATALINA_OPTS=-javaagent:/path/to/skywalking-agent/skywalking-agent.jar"
-javaagent argument to command line in which you start your app. eg:java -javaagent:/path/to/skywalking-agent/skywalking-agent.jar -jar yourApp.jar
jetty.sh, add -javaagent argument to command line in which you start your app. eg:export JAVA_OPTIONS="${JAVA_OPTIONS} -javaagent:/path/to/skywalking-agent/skywalking-agent.jar"
This is the properties list supported in agent/config/agent.config.
| property key | Description | Default |
|---|---|---|
agent.namespace | Namespace isolates headers in cross process propagation. The HEADER name will be HeaderName:Namespace. | Not set |
agent.service_name | The service name to represent a logic group providing the same capabilities/logic. Suggestion: set a unique name for every logic service group, service instance nodes share the same code, Max length is 50(UTF-8 char) | Your_ApplicationName |
agent.sample_n_per_3_secs | Negative or zero means off, by default.SAMPLE_N_PER_3_SECS means sampling N TraceSegment in 3 seconds tops. | Not set |
agent.authentication | 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. | Not set |
agent.span_limit_per_segment | The max number of spans in a single segment. Through this config item, SkyWalking keep your application memory cost estimated. | 300 |
agent.ignore_suffix | If the operation name of the first span is included in this set, this segment should be ignored. | Not set |
agent.is_open_debugging_class | 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. | Not set |
agent.instance_name | Instance name is the identity of an instance, should be unique in the service. If empty, SkyWalking agent will generate an 32-bit uuid. Default, use UUID@hostname as the instance name. Max length is 50(UTF-8 char) | "" |
agent.instance_properties[key]=value | Add service instance custom properties. | Not set |
agent.cause_exception_depth | How depth the agent goes, when log all cause exceptions. | 5 |
agent.force_reconnection_period | Force reconnection period of grpc, based on grpc_channel_check_interval. | 1 |
agent.operation_name_threshold | The operationName max length, setting this value > 190 is not recommended. | 150 |
agent.keep_tracing | Keep tracing even the backend is not available if this value is true. | false |
collector.grpc_channel_check_interval | grpc channel status check interval. | 30 |
collector.heartbeat_period | agent heartbeat report period. Unit, second. | 30 |
collector.backend_service | Collector SkyWalking trace receiver service addresses. | 127.0.0.1:11800 |
collector.grpc_upstream_timeout | How long grpc client will timeout in sending data to upstream. Unit is second. | 30 seconds |
collector.get_profile_task_interval | Sniffer get profile task list interval. | 20 |
logging.level | The log level. Default is debug. | DEBUG |
logging.file_name | Log file name. | skywalking-api.log |
logging.output | Log output. Default is FILE. Use CONSOLE means output to stdout. | FILE |
logging.dir | Log files directory. Default is blank string, means, use "{theSkywalkingAgentJarDir}/logs " to output logs. {theSkywalkingAgentJarDir} is the directory where the skywalking agent jar file is located | "" |
logging.pattern | logging format. There are all conversion specifiers: * %level means log level. * %timestamp means now of time with format yyyy-MM-dd HH:mm:ss:SSS.* %thread means name of current thread.* %msg means some message which user logged. * %class means SimpleName of TargetClass. * %throwable means a throwable which user called. * %agent_name means agent.service_name | %level %timestamp %thread %class : %msg %throwable |
logging.max_file_size | The max size of log file. If the size is bigger than this, archive the current file, and write into a new file. | 300 * 1024 * 1024 |
logging.max_history_files | The max history log files. When rollover happened, if log files exceed this number,then the oldest file will be delete. Negative or zero means off, by default. | -1 |
jvm.buffer_size | The buffer size of collected JVM info. | 60 * 10 |
buffer.channel_size | The buffer channel size. | 5 |
buffer.buffer_size | The buffer size. | 300 |
profile.active | If true, skywalking agent will enable profile when user create a new profile task. Otherwise disable profile. | true |
profile.max_parallel | Parallel monitor segment count | 5 |
profile.duration | Max monitor segment time(minutes), if current segment monitor time out of limit, then stop it. | 10 |
profile.dump_max_stack_depth | Max dump thread stack depth | 500 |
profile.snapshot_transport_buffer_size | Snapshot transport to backend buffer size | 50 |
plugin.peer_max_length | Peer maximum description limit. | 200 |
plugin.mongodb.trace_param | If true, trace all the parameters in MongoDB access, default is false. Only trace the operation, not include parameters. | false |
plugin.mongodb.filter_length_limit | If set to positive number, the WriteRequest.params would be truncated to this length, otherwise it would be completely saved, which may cause performance problem. | 256 |
plugin.elasticsearch.trace_dsl | If true, trace all the DSL(Domain Specific Language) in ElasticSearch access, default is false. | false |
plugin.springmvc.use_qualified_name_as_endpoint_name | If true, the fully qualified method name will be used as the endpoint name instead of the request URL, default is false. | false |
plugin.toolit.use_qualified_name_as_operation_name | If true, the fully qualified method name will be used as the operation name instead of the given operation name, default is false. | false |
plugin.mysql.trace_sql_parameters | If set to true, the parameters of the sql (typically java.sql.PreparedStatement) would be collected. | false |
plugin.mysql.sql_parameters_max_length | If set to positive number, the db.sql.parameters would be truncated to this length, otherwise it would be completely saved, which may cause performance problem. | 512 |
plugin.postgresql.trace_sql_parameters | If set to true, the parameters of the sql (typically java.sql.PreparedStatement) would be collected. | false |
plugin.postgresql.sql_parameters_max_length | If set to positive number, the db.sql.parameters would be truncated to this length, otherwise it would be completely saved, which may cause performance problem. | 512 |
plugin.mariadb.trace_sql_parameters | If set to true, the parameters of the sql (typically java.sql.PreparedStatement) would be collected. | false |
plugin.mariadb.sql_parameters_max_length | If set to positive number, the db.sql.parameters would be truncated to this length, otherwise it would be completely saved, which may cause performance problem. | 512 |
plugin.solrj.trace_statement | If true, trace all the query parameters(include deleteByIds and deleteByQuery) in Solr query request, default is false. | false |
plugin.solrj.trace_ops_params | If true, trace all the operation parameters in Solr request, default is false. | false |
plugin.light4j.trace_handler_chain | If true, trace all middleware/business handlers that are part of the Light4J handler chain for a request. | false |
plugin.opgroup.* | Support operation name customize group rules in different plugins. Read Group rule supported plugins | Not set |
plugin.springtransaction.simplify_transaction_definition_name | If true, the transaction definition name will be simplified. | false |
plugin.jdkthreading.threading_class_prefixes | Threading classes (java.lang.Runnable and java.util.concurrent.Callable) and their subclasses, including anonymous inner classes whose name match any one of the THREADING_CLASS_PREFIXES (splitted by ,) will be instrumented, make sure to only specify as narrow prefixes as what you're expecting to instrument, (java. and javax. will be ignored due to safety issues) | Not set |
plugin.tomcat.collect_http_params | This config item controls that whether the Tomcat plugin should collect the parameters of the request. Also, activate implicitly in the profiled trace. | false |
plugin.springmvc.collect_http_params | This config item controls that whether the SpringMVC plugin should collect the parameters of the request, when your Spring application is based on Tomcat, consider only setting either plugin.tomcat.collect_http_params or plugin.springmvc.collect_http_params. Also, activate implicitly in the profiled trace. | false |
plugin.http.http_params_length_threshold | When COLLECT_HTTP_PARAMS is enabled, how many characters to keep and send to the OAP backend, use negative values to keep and send the complete parameters, NB. this config item is added for the sake of performance. | 1024 |
correlation.element_max_number | Max element count of the correlation context. | 3 |
correlation.value_max_length | Max value length of correlation context element. | 128 |
Java agent plugins are all pluggable. Optional plugins could be provided in optional-plugins folder under agent or 3rd party repositories. For using these plugins, you need to put the target plugin jar file into /plugins.
Now, we have the following known optional plugins.
All bootstrap plugins are optional, due to unexpected risk. Bootstrap plugins are provided in bootstrap-plugins folder. For using these plugins, you need to put the target plugin jar file into /plugins.
Now, we have the following known bootstrap plugins.
getting trace id, setting tags, propagating custom data etc.. Try SkyWalking manual APIs.SkyWalking java agent supports plugin to extend the supported list. Please follow our Plugin Development Guide.
If some RPC framework endpoints(server side) could include parameter, please read Operation Name Group Rule, and consider to add this feature.
If you are interested in plugin compatible tests or agent performance, see the following reports.
¹ Due to gRPC didn't support JDK 1.6 since 2018, SkyWalking abandoned the JDK 6/7 supports in all 7.x releases. But, with gRPC back forward compatibility(at least for now), all SkyWalking 6.x agents could work with 7.x, including the agent and backend.