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 Java agent 8.14.0 release notes and compatibility docs #18445

Merged
merged 2 commits into from
Aug 21, 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
Original file line number Diff line number Diff line change
Expand Up @@ -222,7 +222,7 @@ The agent automatically instruments these frameworks and libraries:
* Apache Httpclient from 3.1 to 5.x
* java.net.HttpURLConnection
* JMS from 1.1 to latest
* [Kafka Client Metrics](/docs/agents/java-agent/instrumentation/java-agent-instrument-kafka-message-queues) 0.10.0.0 to 3.6.x (for metrics)
* [Kafka Client Metrics](/docs/agents/java-agent/instrumentation/java-agent-instrument-kafka-message-queues) 0.10.0.0 to latest (for metrics)
* [Kafka Client Spans](/docs/agents/java-agent/instrumentation/java-agent-instrument-kafka-message-queues) 0.11.0.0 to 3.6.x (for distributed tracing)
* [Kafka Connect](/docs/agents/java-agent/instrumentation/java-agent-instrument-kafka-message-queues) 1.0.0 to 3.6.x (for metrics)
* [Kafka Connect](/docs/agents/java-agent/instrumentation/java-agent-instrument-kafka-message-queues) 2.0.0 to 3.6.x (for distributed tracing and transaction data)
Expand Down Expand Up @@ -263,7 +263,7 @@ The agent automatically instruments these frameworks and libraries:
* HSQL 1.7.2.2 to latest
* INet Oracle Driver (Oranxo) 3.06, 3.14
* INet MERLIA 7.0.3, 8.04.03, and 8.06
* Jedis Redis driver 1.4.0 to 2.10.x, 3.0.0 to 4.x
* Jedis Redis driver 1.4.0 to 2.10.x, 3.0.0 to 4.x, 5.x to latest
* jTDS 1.2 to latest
* Lettuce Redis driver 4.3 to latest
* MariaDB 1.1.7 or higher
Expand All @@ -285,6 +285,7 @@ The agent automatically instruments these frameworks and libraries:
* Solr 4.0 to latest
* Spymemcached 2.11 to latest
* Sybase (jConnect) JDBC 3 driver 6.0 to latest
* Vert.x SQL Client 4.4.2 to latest
</Collapser>

<Collapser
Expand All @@ -299,7 +300,7 @@ The agent automatically instruments these frameworks and libraries:
* Amazon DynamoDB 1.11.106 or higher
* Amazon v2 DynamoDB 2.1.0 to latest
* DataStax Cassandra driver 3.0.0 to latest
* Jedis Redis driver 1.4 to 2.10.x, 3.0.0 to 4.x
* Jedis Redis driver 1.4 to 2.10.x, 3.0.0 to 4.x, 5.x to latest
* MongoDB
* Synchronous clients: 3.1.0-rc0 to latest
* Asynchronous/Reactive streams clients: 3.4.0 thru 4.1.2
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,101 @@
---
subject: Java agent
releaseDate: '2024-08-21'
version: 8.14.0
downloadLink: 'https://download.newrelic.com/newrelic/java-agent/newrelic-agent/8.14.0/'
features: [“Java agent supports disabling AI Monitoring at the account/organization level”, ”HikariCP instrumentation now captures additional metrics”, ”Adds new instrumentation module for kafka-clients-metrics-3.7.0”, ”Adds new instrumentation module for jedis-5.0.0”, ”Adds new instrumentation module for vertx-sqlclient-4.4.2”, ”The newrelic-scala-api for Scala 3 will now be published to Maven”, ”New AWS MQ attributes will be added to spans”, ”Clarify Javadoc comments for @Trace API”]
bugs: [“Fixes a netty-reactor issue that was causing high memory usage”, ”Netty instrumentation will start transactions for HTTP/2 requests”]
security: []
---
<ButtonGroup>
<ButtonLink
role="button"
to="https://download.newrelic.com/newrelic/java-agent/newrelic-agent/8.14.0/"
variant="primary"
>
Download this agent version
</ButtonLink>
</ButtonGroup>

## New features and improvements

* The Java agent supports disabling AI Monitoring at the account/organization level [1972](https://github.com/newrelic/newrelic-java-agent/pull/1972)
* HikariCP instrumentation now captures additional metrics [1976](https://github.com/newrelic/newrelic-java-agent/pull/1976)
* Adds new instrumentation module for `kafka-clients-metrics-3.7.0` [2001](https://github.com/newrelic/newrelic-java-agent/pull/2001)
* Adds new instrumentation module for `jedis-5.0.0` [1969](https://github.com/newrelic/newrelic-java-agent/pull/1969)
* Adds new instrumentation module for `vertx-sqlclient-4.4.2` [2004](https://github.com/newrelic/newrelic-java-agent/pull/2004)
* The `newrelic-scala-api` for Scala 3 will now be published to Maven [1995](https://github.com/newrelic/newrelic-java-agent/pull/1995)
* New AWS MQ attributes will be added to spans [1977](https://github.com/newrelic/newrelic-java-agent/pull/1977)
* Clarify Javadoc comments for `@Trace` API [2009](https://github.com/newrelic/newrelic-java-agent/pull/2009)

## Fixes

* Fixes a `netty-reactor` issue that was causing high memory usage [1978](https://github.com/newrelic/newrelic-java-agent/pull/1978)
* Netty instrumentation will start transactions for HTTP/2 requests [1994](https://github.com/newrelic/newrelic-java-agent/pull/1994)

## Deprecations

The following instrumentation modules are deprecated and will be removed in the next major release:

- `aws-wrap-0.7.0`
- `java.completable-future-jdk8`
- `play-2.3`
- `spring-3.0.0`
- `netty-3.4`
- `Struts v1`

## IAST

- CSEC Version bump to 1.4.1 [2010](https://github.com/newrelic/newrelic-java-agent/pull/2010)
- Changelog: https://github.com/newrelic/csec-java-agent/releases/tag/1.4.1

## Update to latest version [#procedures]

To identify which version of the Java agent you're currently using, run `java -jar newrelic.jar -v`. Your Java agent version will be printed to your console.

Then, to update to the latest Java agent version:

1. Back up the **entire** [Java agent root directory](/docs/agents/manage-apm-agents/troubleshooting/find-agent-root-directory#java-agent) to another location. Rename that directory to `NewRelic_Agent#.#.#`, where `#.#.#` is the agent version number.
2. [Download the agent.](/docs/release-notes/agent-release-notes/java-release-notes).
3. Unzip the new agent download file, then copy `newrelic-api.jar` and `newrelic.jar` into the original [Java agent root directory](/docs/agents/manage-apm-agents/troubleshooting/find-agent-root-directory#java-agent).
4. Compare your old `newrelic.yml` with the newly downloaded `newrelic.yml` from the zip, and [update the file if needed](#diff).
5. Restart your Java dispatcher.

If you experience issues after the Java agent update, restore from the backed-up New Relic agent directory.

## Update agent config differences [#diff]

We add new settings to `newrelic.yml` as we release new versions of the agent. You can use `diff` or another diffing utility to see what's changed, and add the new config settings to your old file. Make sure not to overwrite any customizations you've made to the file, such as your license key, app name, or changes to default settings.

For example, if you `diff` the default `newrelic.yml` files for Java agent versions 7.10.0 and 7.11.0, the results printed to the console will be like:

```yaml
➜ diff newrelic_7.10.0.yml newrelic_7.11.0.yml
...
107a108,119
> # Whether the log events should include context from loggers with support for that.
> include_context_data:
>
> # When true, application logs will contain context data.
> enabled: false
>
> # A comma separated list of attribute keys whose values should be sent to New Relic.
> #include:
>
> # A comma separated list of attribute keys whose values should not be sent to New Relic.
> #exclude:
>
125a138
>
128c141
< enabled: false
---
> enabled: true
...
```

In this example, these lines were added to the default `newrelic.yml` in Java agent version 7.11.0. If you're moving to 7.11.0 or higher, you should add these new lines to your original `newrelic.yml`.

## Support statement:

* New Relic recommends that you upgrade the agent regularly to ensure that you're getting the latest features and performance benefits. Additionally, older releases will no longer be supported when they reach [end-of-life](https://docs.newrelic.com/docs/using-new-relic/cross-product-functions/install-configure/notification-changes-new-relic-saas-features-distributed-software/).
Loading