Skip to content

Commit 20934dd

Browse files
committed
Rename Akka and Scala forkjoin modules
1 parent 4ef2d53 commit 20934dd

21 files changed

Lines changed: 52 additions & 35 deletions

File tree

.fossa.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -279,7 +279,7 @@ targets:
279279
target: ':instrumentation:runtime-telemetry:library'
280280
- type: gradle
281281
path: ./
282-
target: ':instrumentation:scala-fork-join-2.8:javaagent'
282+
target: ':instrumentation:scala-forkjoin-2.8:javaagent'
283283
- type: gradle
284284
path: ./
285285
target: ':instrumentation:spark-2.3:javaagent'
@@ -324,7 +324,7 @@ targets:
324324
target: ':instrumentation:akka:akka-actor-2.3:javaagent'
325325
- type: gradle
326326
path: ./
327-
target: ':instrumentation:akka:akka-actor-fork-join-2.5:javaagent'
327+
target: ':instrumentation:akka:akka-actor-forkjoin-2.5:javaagent'
328328
- type: gradle
329329
path: ./
330330
target: ':instrumentation:akka:akka-http-10.0:javaagent'

.github/scripts/check-javaagent-suppression-keys.sh

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -48,6 +48,12 @@ for file in $(find instrumentation -name "*Module.java"); do
4848

4949
matches=$(perl -0 -ne "print if /$expected/" "$file" | wc -l)
5050
if [ "$matches" == 0 ]; then
51+
if grep -q "expandDeprecatedNames" "$file" \
52+
&& grep -q "\"$simple_module_name|deprecated:" "$file" \
53+
&& { [ "$module_name" == "$simple_module_name" ] || grep -q "\"$module_name|deprecated:" "$file"; }
54+
then
55+
continue
56+
fi
5157
echo "Expected to find $expected in $file"
5258
exit 1
5359
fi

docs/contributing/documenting-instrumentation.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -124,7 +124,7 @@ Display name is mostly used for UI purposes, and has two main uses:
124124
- Providing a more user-friendly name for the instrumentation than the module name
125125
(e.g., "Apache CXF JAX-RS 2.x" instead of "jaxrs-2.0-cxf-3.2").
126126
- Collapsing multiple related modules into a single display name
127-
(e.g., "Akka Actors" for both "akka-actor-2.3" and "akka-actor-fork-join-2.5").
127+
(e.g., "Akka Actors" for both "akka-actor-2.3" and "akka-actor-forkjoin-2.5").
128128
129129
### Description (required)
130130

docs/instrumentation-list.yaml

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -103,16 +103,16 @@ libraries:
103103
- com.typesafe.akka:akka-actor_2.11:[2.3,)
104104
- com.typesafe.akka:akka-actor_2.12:[2.3,)
105105
- com.typesafe.akka:akka-actor_2.13:[2.3,)
106-
- name: akka-actor-fork-join-2.5
106+
- name: akka-actor-forkjoin-2.5
107107
display_name: Akka Actors
108108
description: This instrumentation provides context propagation for the Akka Fork-Join
109109
Pool, it does not emit any telemetry on its own.
110110
library_link: https://doc.akka.io/libraries/akka-core/current/typed/index.html
111111
features:
112112
- CONTEXT_PROPAGATION
113-
source_path: instrumentation/akka/akka-actor-fork-join-2.5
113+
source_path: instrumentation/akka/akka-actor-forkjoin-2.5
114114
scope:
115-
name: io.opentelemetry.akka-actor-fork-join-2.5
115+
name: io.opentelemetry.akka-actor-forkjoin-2.5
116116
has_javaagent: true
117117
javaagent_target_versions:
118118
- com.typesafe.akka:akka-actor_2.11:[2.5,)
@@ -13998,14 +13998,14 @@ libraries:
1399813998
Enables the experimental span attribute `rxjava.canceled`.
1399913999
type: boolean
1400014000
default: false
14001-
- name: scala-fork-join-2.8
14001+
- name: scala-forkjoin-2.8
1400214002
display_name: Scala ForkJoinPool
1400314003
description: |
1400414004
This instrumentation enables context propagation for Scala fork-join tasks, it does not emit any telemetry on its own.
1400514005
library_link: https://www.scala-lang.org/api/2.12.0/scala/concurrent/forkjoin/package$$ForkJoinPool$.html
14006-
source_path: instrumentation/scala-fork-join-2.8
14006+
source_path: instrumentation/scala-forkjoin-2.8
1400714007
scope:
14008-
name: io.opentelemetry.scala-fork-join-2.8
14008+
name: io.opentelemetry.scala-forkjoin-2.8
1400914009
has_javaagent: true
1401014010
javaagent_target_versions:
1401114011
- org.scala-lang:scala-library:[2.8.0,2.12.0)

instrumentation-docs/src/main/java/io/opentelemetry/instrumentation/docs/auditors/SuppressionListAuditor.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ public class SuppressionListAuditor implements DocumentationAuditor {
3131

3232
// Used for consolidating instrumentation groups where we override the key with the value
3333
private static final Map<String, String> INSTRUMENTATION_DISABLE_OVERRIDES =
34-
Map.of("akka-actor-fork-join", "akka-actor");
34+
Map.of("akka-actor-forkjoin", "akka-actor");
3535

3636
private static final List<String> INSTRUMENTATION_EXCLUSIONS =
3737
List.of("resources", "spring-boot-resources");

instrumentation-docs/src/test/java/io/opentelemetry/instrumentation/docs/auditors/SuppressionListAuditorTest.java

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -139,10 +139,10 @@ void testParseInstrumentationList() {
139139
- com.typesafe.akka:akka-actor_2.11:[2.3,)
140140
- com.typesafe.akka:akka-actor_2.12:[2.3,)
141141
- com.typesafe.akka:akka-actor_2.13:[2.3,)
142-
- name: akka-actor-fork-join-2.5
143-
source_path: instrumentation/akka/akka-actor-fork-join-2.5
142+
- name: akka-actor-forkjoin-2.5
143+
source_path: instrumentation/akka/akka-actor-forkjoin-2.5
144144
scope:
145-
name: io.opentelemetry.akka-actor-fork-join-2.5
145+
name: io.opentelemetry.akka-actor-forkjoin-2.5
146146
target_versions:
147147
javaagent:
148148
- com.typesafe.akka:akka-actor_2.12:[2.5,2.6)
@@ -160,7 +160,7 @@ void testParseInstrumentationList() {
160160
assertThat(result).hasSize(4);
161161
assertThat(result)
162162
.containsExactlyInAnyOrder(
163-
"activej-http-6.0", "akka-actor-2.3", "akka-actor-fork-join-2.5", "akka-http-10.0");
163+
"activej-http-6.0", "akka-actor-2.3", "akka-actor-forkjoin-2.5", "akka-http-10.0");
164164
}
165165

166166
@Test
@@ -171,7 +171,7 @@ void testIdentifyMissingItems() {
171171
"methods",
172172
"akka-actor-2.3",
173173
"activej-http-6.0",
174-
"akka-actor-fork-join-2.5",
174+
"akka-actor-forkjoin-2.5",
175175
"camel-2.20");
176176

177177
var missingItems =

instrumentation/akka/akka-actor-fork-join-2.5/javaagent/build.gradle.kts renamed to instrumentation/akka/akka-actor-forkjoin-2.5/javaagent/build.gradle.kts

File renamed without changes.

instrumentation/akka/akka-actor-fork-join-2.5/javaagent/src/main/java/io/opentelemetry/javaagent/instrumentation/akkaforkjoin/AkkaActorForkJoinInstrumentationModule.java renamed to instrumentation/akka/akka-actor-forkjoin-2.5/javaagent/src/main/java/io/opentelemetry/javaagent/instrumentation/akka/actor/forkjoin/v2_5/AkkaActorForkJoinInstrumentationModule.java

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,9 @@
33
* SPDX-License-Identifier: Apache-2.0
44
*/
55

6-
package io.opentelemetry.javaagent.instrumentation.akkaforkjoin;
6+
package io.opentelemetry.javaagent.instrumentation.akka.actor.forkjoin.v2_5;
77

8+
import static io.opentelemetry.javaagent.extension.instrumentation.internal.DeprecatedInstrumentationNames.expandDeprecatedNames;
89
import static java.util.Arrays.asList;
910

1011
import com.google.auto.service.AutoService;
@@ -15,7 +16,12 @@
1516
@AutoService(InstrumentationModule.class)
1617
public class AkkaActorForkJoinInstrumentationModule extends InstrumentationModule {
1718
public AkkaActorForkJoinInstrumentationModule() {
18-
super("akka-actor-fork-join", "akka-actor-fork-join-2.5", "akka-actor");
19+
super(
20+
"akka-actor-forkjoin",
21+
expandDeprecatedNames(
22+
"akka-actor-forkjoin|deprecated:akka-actor-fork-join",
23+
"akka-actor-forkjoin-2.5|deprecated:akka-actor-fork-join-2.5",
24+
"akka-actor"));
1925
}
2026

2127
@Override

instrumentation/akka/akka-actor-fork-join-2.5/javaagent/src/main/java/io/opentelemetry/javaagent/instrumentation/akkaforkjoin/AkkaForkJoinPoolInstrumentation.java renamed to instrumentation/akka/akka-actor-forkjoin-2.5/javaagent/src/main/java/io/opentelemetry/javaagent/instrumentation/akka/actor/forkjoin/v2_5/AkkaForkJoinPoolInstrumentation.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
* SPDX-License-Identifier: Apache-2.0
44
*/
55

6-
package io.opentelemetry.javaagent.instrumentation.akkaforkjoin;
6+
package io.opentelemetry.javaagent.instrumentation.akka.actor.forkjoin.v2_5;
77

88
import static net.bytebuddy.matcher.ElementMatchers.named;
99
import static net.bytebuddy.matcher.ElementMatchers.takesArgument;

instrumentation/akka/akka-actor-fork-join-2.5/javaagent/src/main/java/io/opentelemetry/javaagent/instrumentation/akkaforkjoin/AkkaForkJoinTaskInstrumentation.java renamed to instrumentation/akka/akka-actor-forkjoin-2.5/javaagent/src/main/java/io/opentelemetry/javaagent/instrumentation/akka/actor/forkjoin/v2_5/AkkaForkJoinTaskInstrumentation.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
* SPDX-License-Identifier: Apache-2.0
44
*/
55

6-
package io.opentelemetry.javaagent.instrumentation.akkaforkjoin;
6+
package io.opentelemetry.javaagent.instrumentation.akka.actor.forkjoin.v2_5;
77

88
import static io.opentelemetry.javaagent.extension.matcher.AgentElementMatchers.extendsClass;
99
import static io.opentelemetry.javaagent.extension.matcher.AgentElementMatchers.hasClassesNamed;

0 commit comments

Comments
 (0)