diff --git a/inspectit-ocelot-documentation/docs/assets/default-instrumentation.png b/inspectit-ocelot-documentation/docs/assets/default-instrumentation.png new file mode 100644 index 0000000000..9707ba2284 Binary files /dev/null and b/inspectit-ocelot-documentation/docs/assets/default-instrumentation.png differ diff --git a/inspectit-ocelot-documentation/docs/default-instrumentation/default-instrumentation.md b/inspectit-ocelot-documentation/docs/default-instrumentation/default-instrumentation.md new file mode 100644 index 0000000000..74eae18e36 --- /dev/null +++ b/inspectit-ocelot-documentation/docs/default-instrumentation/default-instrumentation.md @@ -0,0 +1,28 @@ +--- +id: default-instrumentation +title: Default Instrumentation +--- +The inspectIT Ocelot Java agent already comes with an extensive default instrumentation, +which collects traces and metrics for several technologies, +like JDBC, Apache Client, HttpURLConnection or the Javax HTTP Servlet. + +The default instrumentation can always be overwritten by your custom instrumentation. You can also turn off +parts of the instrumentation by disabling the particular rules. + +- You can examine the default instrumentation in GitHub: +[inspectit-ocelot-default-instrumentation](https://github.com/inspectIT/inspectit-ocelot/tree/master/inspectit-ocelot-config/src/main/resources/rocks/inspectit/ocelot/config/default/instrumentation) + +- You can find more detailed information about instrumentation in the section [Instrumentation](instrumentation/instrumentation.md). + +- Furthermore, you can view the complete default configuration in [GitHub](https://github.com/inspectIT/inspectit-ocelot/tree/master/inspectit-ocelot-config/src/main/resources/rocks/inspectit/ocelot/config/default) +or in the [Configuration Server](config-server/overview.md) + +> **Note that the default instrumentation does not always apply for more modern technologies**, like Spring Boot 3 or Tomcat 10. +> As the agent was originally developed to support mainly Java 8 applications, +> you have to overwrite the default instrumentation so that it works again. +> - View [Upgrade to Jakarta Namespace](default-instrumentation/jakarta.md) to enable instrumentation for the Jakarta HTTP Servlet. + +--- +The default configuration in the Configuration Server: +![Default-Instrumentation-Files](assets/default-instrumentation.png ) + diff --git a/inspectit-ocelot-documentation/docs/default-instrumentation/jakarta.md b/inspectit-ocelot-documentation/docs/default-instrumentation/jakarta.md new file mode 100644 index 0000000000..f49be79de9 --- /dev/null +++ b/inspectit-ocelot-documentation/docs/default-instrumentation/jakarta.md @@ -0,0 +1,23 @@ +--- +id: jakarta +title: Upgrade to Jakarta Namespace +--- + +The release of Jakarta EE 9 in December 2020 did replace the previous **javax** namespace with the **jakarta** namespace. +Because of this transition, several technologies had to **rename their interfaces**. +For example the _javax.servlet.Servlet_ was moved to _jakarta.servlet.Servlet_. + +Since the default instrumentation of inspectIT Ocelot only addresses the javax namespace, +you have to include an additional configuration to instrument the jakarta namespace for traces and metrics. + +You can find the configuration in GitHub: [inspectit-ocelot-jakarta-configuration](https://github.com/inspectIT/inspectit-ocelot-configurations/blob/master/extensions/jakarta/servlet-api.yml) + +--- +Some technologies, which use the jakarta namespace: + +- Tomcat 10+ +- Jetty 11+ +- Spring 6+ +- Spring Boot 3+ + +You can find more information about the namespace transition on [https://jakarta.ee](https://jakarta.ee/blogs/javax-jakartaee-namespace-ecosystem-progress/) diff --git a/inspectit-ocelot-documentation/website/sidebars.json b/inspectit-ocelot-documentation/website/sidebars.json index 1f32b88ff1..1bab5d78cd 100644 --- a/inspectit-ocelot-documentation/website/sidebars.json +++ b/inspectit-ocelot-documentation/website/sidebars.json @@ -41,6 +41,10 @@ "instrumentation/special-sensors", "instrumentation/process" ], + "Default Instrumentation": [ + "default-instrumentation/default-instrumentation", + "default-instrumentation/jakarta" + ], "End User Monitoring": [ "enduser-monitoring/enduser-monitoring-server", "enduser-monitoring/eum-server-setup",