Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

add documentation section for default instrumentation #1681

Merged
merged 1 commit into from
Dec 19, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Original file line number Diff line number Diff line change
@@ -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 )

Original file line number Diff line number Diff line change
@@ -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/)
4 changes: 4 additions & 0 deletions inspectit-ocelot-documentation/website/sidebars.json
Original file line number Diff line number Diff line change
Expand Up @@ -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",
Expand Down
Loading