opentelemetry-java-instrume.../examples/distro
dependabot[bot] 4bcb876c08
Bump mockito-core from 4.11.0 to 5.0.0 in /examples/distro (#7587)
Bumps [mockito-core](https://github.com/mockito/mockito) from 4.11.0 to
5.0.0.
<details>
<summary>Release notes</summary>
<p><em>Sourced from <a
href="https://github.com/mockito/mockito/releases">mockito-core's
releases</a>.</em></p>
<blockquote>
<h2>v5.0.0</h2>
<h1>Mockito 5: prepare for future JDK versions</h1>
<p>For a while now, we have seen an increase in
problems/incompatibilities with recent versions of the JDK due to our
usage of JVM-internal API.
Most notably, JDK 17 made some changes which are incompatible with the
current subclass mockmaker.
Therefore, to prepare for the future of JDK, we are making some core
changes to ensure Mockito keeps on working.</p>
<h2>Switch the default mockmaker to <code>mockito-inline</code></h2>
<p>Back in Mockito 2.7.6, we published a new mockmaker based on the
&quot;inline bytecode&quot; principle.
This mockmaker creates mocks manipulating bytecode equivalent within the
original class such that its method implementations hook into the normal
Mockito machinery.
As a comparison, the subclass mockmaker generates &quot;real&quot;
subclasses for mocks, to mimic the same behavior.
While the approaches are similar, the inline mockmaker avoids certain
restrictions that the JDK imposes.
For example, it does not violate module boundaries (introduced in JDK 9,
but more heavily used in JDK 17) and avoids the leaking of the creation
of the subclass.</p>
<p>Massive thanks to community member <a
href="https://github.com/reta"><code>@​reta</code></a> who implemented
this change.</p>
<h3>When should I still be using the subclass mockmaker?</h3>
<p>There are legitimate remaining use cases for the subclass mockmaker.
For example, on the Graal VM's native image, the inline mockmaker will
not work and the subclass mockmaker is the appropriate choice.
Additionally, if you would like to avoid mocking final classes, using
the subclass mockmaker is a possibibility.
Note however that if you solely want to use the subclass mockmaker to
avoid mocking final, you will run into the above mentioned issues on JDK
17+.
We want to leave this choice up to our users, which is why we will keep
on supporting the subclass mockmaker.</p>
<p>If you want to use the subclass mockmaker instead, you can use the
new <code>mockito-subclass</code> artifact (published <a
href="https://search.maven.org/artifact/org.mockito/mockito-subclass">on
Maven Central</a> along with all our other artifacts).</p>
<h2>Update the minimum supported Java version to 11</h2>
<p>Mockito 4 supports Java 8 and above.
Similar to other open source projects, we are moving away from JDK 8 and
to newer versions.
The primary reason for moving away from JDK 8 is the increasing
maintenance costs with keeping our own infrastructure working.
Lately we have been running into more and more JDK 8 breakages.
Additionally, while we want to support the newest JDK API's, our current
solution to support both JDK 8 and newer versions causes <a
href="https://github-redirect.dependabot.com/mockito/mockito/issues/2798">issues
with the <code>SecurityManager</code></a>.
Since we want Mockito to work on the newest version and more and more
businesses adopting JDK 11, we have decided to make the switch as
well.</p>
<p>Massive thanks to community member <a
href="https://github.com/reta"><code>@​reta</code></a> who implemented
this change.</p>
<h3>What should I do if I still run JDK 8?</h3>
<p>For JDK 8 and below, you can keep on using Mockito 4.
This is similar to if you are using JDK 6, for which you can keep on
using Mockito 2.
The changes in Mockito 5 (for now) are primarily focused on the latest
JDK versions, which means the API differences between Mockito 4 and 5
are minimal.
However, over time this will most likely widen, so we do recommend
adopting JDK 11 in the future.</p>
<h2>New <code>type()</code> method on <code>ArgumentMatcher</code></h2>
<p>One of our most used public API's for customizing Mockito is the <a
href="https://javadoc.io/doc/org.mockito/mockito-core/latest/org/mockito/ArgumentMatcher.html"><code>ArgumentMatcher</code>
interface</a>.
The interface allows you to define a custom matcher, which you can pass
into method arguments to provide more targeted matches.
One major shortcoming of the <code>ArgumentMatcher</code> was the lack
of varargs support.</p>
<!-- raw HTML omitted -->
</blockquote>
<p>... (truncated)</p>
</details>
<details>
<summary>Commits</summary>
<ul>
<li><a
href="adf528d173"><code>adf528d</code></a>
Bump versions.bytebuddy from 1.12.21 to 1.12.22 (<a
href="https://github-redirect.dependabot.com/mockito/mockito/issues/2864">#2864</a>)</li>
<li><a
href="2418419a19"><code>2418419</code></a>
Bump versions.junitJupiter from 5.9.1 to 5.9.2 (<a
href="https://github-redirect.dependabot.com/mockito/mockito/issues/2858">#2858</a>)</li>
<li><a
href="3d40cd51d3"><code>3d40cd5</code></a>
Bump junit-platform-launcher from 1.9.1 to 1.9.2 (<a
href="https://github-redirect.dependabot.com/mockito/mockito/issues/2859">#2859</a>)</li>
<li><a
href="9bec8e3a1a"><code>9bec8e3</code></a>
Bump versions.errorprone from 2.17.0 to 2.18.0 (<a
href="https://github-redirect.dependabot.com/mockito/mockito/issues/2857">#2857</a>)</li>
<li><a
href="a9595f559c"><code>a9595f5</code></a>
Switch the default mockmaker to the inline mockmaker on JDK 17+ (<a
href="https://github-redirect.dependabot.com/mockito/mockito/issues/2834">#2834</a>)</li>
<li><a
href="c5d7fbc532"><code>c5d7fbc</code></a>
Bump assertj-core from 3.23.1 to 3.24.1 (<a
href="https://github-redirect.dependabot.com/mockito/mockito/issues/2854">#2854</a>)</li>
<li><a
href="dbd7f2ff4a"><code>dbd7f2f</code></a>
Bump versions.bytebuddy from 1.12.20 to 1.12.21 (<a
href="https://github-redirect.dependabot.com/mockito/mockito/issues/2852">#2852</a>)</li>
<li><a
href="4d62fa75c7"><code>4d62fa7</code></a>
Bump junit from 1.1.4 to 1.1.5 (<a
href="https://github-redirect.dependabot.com/mockito/mockito/issues/2850">#2850</a>)</li>
<li><a
href="b1b6d6afcb"><code>b1b6d6a</code></a>
Bump espresso-core from 3.5.0 to 3.5.1 (<a
href="https://github-redirect.dependabot.com/mockito/mockito/issues/2849">#2849</a>)</li>
<li><a
href="7b5b8dd840"><code>7b5b8dd</code></a>
Remove use case for non-existent method VerificationWithTimeout#never
(<a
href="https://github-redirect.dependabot.com/mockito/mockito/issues/2848">#2848</a>)</li>
<li>Additional commits viewable in <a
href="https://github.com/mockito/mockito/compare/v4.11.0...v5.0.0">compare
view</a></li>
</ul>
</details>
<br />


[![Dependabot compatibility
score](https://dependabot-badges.githubapp.com/badges/compatibility_score?dependency-name=org.mockito:mockito-core&package-manager=gradle&previous-version=4.11.0&new-version=5.0.0)](https://docs.github.com/en/github/managing-security-vulnerabilities/about-dependabot-security-updates#about-compatibility-scores)

You can trigger a rebase of this PR by commenting `@dependabot rebase`.

[//]: # (dependabot-automerge-start)
[//]: # (dependabot-automerge-end)

---

<details>
<summary>Dependabot commands and options</summary>
<br />

You can trigger Dependabot actions by commenting on this PR:
- `@dependabot rebase` will rebase this PR
- `@dependabot recreate` will recreate this PR, overwriting any edits
that have been made to it
- `@dependabot merge` will merge this PR after your CI passes on it
- `@dependabot squash and merge` will squash and merge this PR after
your CI passes on it
- `@dependabot cancel merge` will cancel a previously requested merge
and block automerging
- `@dependabot reopen` will reopen this PR if it is closed
- `@dependabot close` will close this PR and stop Dependabot recreating
it. You can achieve the same result by closing it manually
- `@dependabot ignore this major version` will close this PR and stop
Dependabot creating any more for this major version (unless you reopen
the PR or upgrade to it yourself)
- `@dependabot ignore this minor version` will close this PR and stop
Dependabot creating any more for this minor version (unless you reopen
the PR or upgrade to it yourself)
- `@dependabot ignore this dependency` will close this PR and stop
Dependabot creating any more for this dependency (unless you reopen the
PR or upgrade to it yourself)


</details>

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
2023-01-16 11:17:15 +01:00
..
agent Upgrade to otel java 1.19.0 (#6757) 2022-10-12 09:19:37 -07:00
bootstrap Improve sample distro (#6531) 2022-09-02 12:40:29 +02:00
custom Improve sample distro (#6531) 2022-09-02 12:40:29 +02:00
gradle Stop relocating :instrumentation:resources:library (#7136) 2022-11-15 22:37:17 +00:00
instrumentation Bump jetty-servlet from 8.0.0.v20110901 to 8.2.0.v20160908 in /examples/distro (#7113) 2022-11-08 23:20:27 +00:00
smoke-tests Bump protobuf-java-util from 3.21.11 to 3.21.12 in /examples/distro (#7425) 2022-12-15 08:23:25 -08:00
testing/agent-for-testing Upgrade to otel java 1.19.0 (#6757) 2022-10-12 09:19:37 -07:00
README.md Introduce markdown lint check (#7175) 2022-11-16 20:48:42 -08:00
build.gradle Bump mockito-core from 4.11.0 to 5.0.0 in /examples/distro (#7587) 2023-01-16 11:17:15 +01:00
gradle.properties Run Gradle and compile code with Java 17 (#5623) 2022-03-18 15:38:51 -07:00
gradlew Update gradle to 7.5.1 (#6359) 2022-08-12 12:03:43 +02:00
gradlew.bat Update gradle to 7.5.1 (#6359) 2022-08-12 12:03:43 +02:00
settings.gradle Improve sample distro (#6531) 2022-09-02 12:40:29 +02:00

README.md

Distro

Introduction

This repository serves as a collection of examples of extending functionality of OpenTelemetry Java instrumentation agent. It demonstrates how to repackage the aforementioned agent adding custom functionality. For every extension point provided by OpenTelemetry Java instrumentation, this repository contains an example of its usage.

General structure

This repository has four main submodules:

  • custom contains all custom functionality, SPI and other extensions
  • agent contains the main repackaging functionality and, optionally, an entry point to the agent, if one wishes to customize that
  • instrumentation contains custom instrumentations added by vendor
  • smoke-tests contains simple tests to verify that resulting agent builds and applies correctly

Extensions examples

Instrumentation customisation

There are several options to override or customise instrumentation provided by the upstream agent. The following description follows one specific use-case:

Instrumentation X from Otel distribution creates span that I don't like and I want to change it in my vendor distro.

As an example, let us take some database client instrumentation that creates a span for database call and extracts data from db connection to provide attributes for that span.

I don't want this span at all

The easiest case. You can just pre-configure your distribution and disable given instrumentation.

I want to add/modify some attributes and their values does NOT depend on a specific db connection instance

E.g. you want to add some data from call stack as span attribute. In this case just provide your custom SpanProcessor. No need for touching instrumentation itself.

I want to add/modify some attributes and their values depend on a specific db connection instance

Write a new instrumentation which injects its own advice into the same method as the original one. Use getOrder method to ensure it is run after the original instrumentation. Now you can augment current span with new information.

See DemoServlet3Instrumentation.

I want to remove some attributes

Write custom exporter or use attribute filtering functionality in Collector.

I don't like Otel span at all. I want to significantly modify it and its lifecycle

Disable existing instrumentation. Write a new one, which injects Advice into the same (or better) method as the original instrumentation. Write your own Advice for this. Use existing Tracer directly or extend it. As you have your own Advice, you can control which Tracer you use.