b3ab1aed81
* [Important] Namespace represents a subnet, such as kubernetes namespace, or 172.10.*.*. Make namespace concept as a part of service naming format.
* [Important] Add cluster concept, also as a part of service naming format. The cluster name would be
1. Add as {@link #SERVICE_NAME} suffix.
2. Add as exit span's peer, ${CLUSTER} / original peer
3. Cross Process Propagation Header's value addressUsedAtClient[index=8] (Target address of this request used on the client end).
* [Breaking Change] Remove deprecated `agent.instance_properties` configuration.
Recommend `agent.instance_properties_json`.
* The namespace and cluster would be reported as instance properties, keys are `namespace` and `cluster`. Notice, if
instance_properties_json includes these two keys, they would be overrided by the agent core.
* [Breaking Change] Remove the namespace from `cross process propagation` key.
|
||
|---|---|---|
| .. | ||
| agent-optional-plugins | ||
| Application-toolkit-log4j-1.x.md | ||
| Application-toolkit-log4j-2.x.md | ||
| Application-toolkit-logback-1.x.md | ||
| Application-toolkit-meter.md | ||
| Application-toolkit-micrometer.md | ||
| Application-toolkit-trace-cross-thread.md | ||
| Application-toolkit-trace.md | ||
| Bootstrap-plugins.md | ||
| Customize-enhance-trace.md | ||
| How-to-disable-plugin.md | ||
| How-to-tolerate-exceptions.md | ||
| Java-Plugin-Development-Guide.md | ||
| Namespace.md | ||
| Opentracing.md | ||
| Optional-plugins.md | ||
| Plugin-list.md | ||
| Plugin-test.md | ||
| README.md | ||
| Setting-override.md | ||
| Specified-agent-config.md | ||
| Supported-list.md | ||
| TLS.md | ||
| Token-auth.md | ||
| advanced-features.md | ||
| advanced-reporters.md | ||
| configuration-discovery.md | ||
| configurations.md | ||
| containerization.md | ||
| logic-endpoint.md | ||
README.md
Setup java agent
- Agent is available for JDK 8 - 17.
- Find
agentfolder in SkyWalking release package - Set
agent.service_nameinconfig/agent.config. Could be any String in English. - Set
collector.backend_serviceinconfig/agent.config. Default point to127.0.0.1:11800, only works for local backend. - Add
-javaagent:/path/to/skywalking-package/agent/skywalking-agent.jarto JVM argument. And make sure to add it before the-jarargument.
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
- Start your application.
Install javaagent FAQs
- Linux Tomcat 7, Tomcat 8, Tomcat 9
Change the first line oftomcat/bin/catalina.sh.
CATALINA_OPTS="$CATALINA_OPTS -javaagent:/path/to/skywalking-agent/skywalking-agent.jar"; export CATALINA_OPTS
- Windows Tomcat 7, Tomcat 8, Tomcat 9
Change the first line oftomcat/bin/catalina.bat.
set "CATALINA_OPTS=-javaagent:/path/to/skywalking-agent/skywalking-agent.jar"
- JAR file
Add-javaagentargument to command line in which you start your app. eg:
java -javaagent:/path/to/skywalking-agent/skywalking-agent.jar -jar yourApp.jar
- Jetty
Modifyjetty.sh, add-javaagentargument to command line in which you start your app. eg:
export JAVA_OPTIONS="${JAVA_OPTIONS} -javaagent:/path/to/skywalking-agent/skywalking-agent.jar"
Plugins
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 and bootstrap class plugin section to learn how to active it.
- All plugins in
/pluginsfolder are active. Remove the plugin jar, it disabled. - The default logging output folder is
/logs.