Skip to content

Commit 334ee1d

Browse files
jaydelucajaydeluca
committed
small touchups
1 parent 1681d50 commit 334ee1d

File tree

5 files changed

+81
-68
lines changed

5 files changed

+81
-68
lines changed

‎docs/instrumentation-list.yaml‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -258,8 +258,8 @@ libraries:
258258
apache:
259259
- name: apache-dbcp-2.0
260260
description: |
261-
Provides OpenTelemetry auto-instrumentation for Apache DBCP.
262-
This auto-instrumentation uses `MBeanRegistration` methods for lifecycle detection, therefore it only activates if the `BasicDataSource` is registered to an `MBeanServer`. If using Spring Boot, this happens automatically as all Spring beans that support JMX registration are automatically registered by default.
261+
This instrumentation provides database connection pools metrics for Apache DBCP.
262+
The instrumentation uses `MBeanRegistration` methods for lifecycle detection, therefore it only activates if the `BasicDataSource` is registered to an `MBeanServer`. If using Spring Boot, this happens automatically as all Spring beans that support JMX registration are automatically registered by default.
263263
source_path: instrumentation/apache-dbcp-2.0
264264
scope:
265265
name: io.opentelemetry.apache-dbcp-2.0

‎instrumentation-docs/collect.sh‎

Lines changed: 57 additions & 57 deletions
Original file line numberDiff line numberDiff line change
@@ -14,64 +14,64 @@ fi
1414

1515
readonly INSTRUMENTATIONS=(
1616
# <module path (colon-separated)> : <javaagent|library> : [ gradle-task-suffix ]
17-
# "activej-http-6.0:javaagent:test"
18-
# "akka:akka-http-10.0:javaagent:test"
19-
# "apache-httpasyncclient-4.1:javaagent:test"
20-
# "alibaba-druid-1.0:javaagent:test"
21-
# "alibaba-druid-1.0:javaagent:testStableSemconv"
22-
# "apache-dbcp-2.0:javaagent:test"
23-
# "apache-dbcp-2.0:javaagent:testStableSemconv"
24-
# "apache-httpclient:apache-httpclient-2.0:javaagent:test"
25-
# "apache-httpclient:apache-httpclient-4.0:javaagent:test"
17+
"activej-http-6.0:javaagent:test"
18+
"akka:akka-http-10.0:javaagent:test"
19+
"apache-httpasyncclient-4.1:javaagent:test"
20+
"alibaba-druid-1.0:javaagent:test"
21+
"alibaba-druid-1.0:javaagent:testStableSemconv"
22+
"apache-dbcp-2.0:javaagent:test"
23+
"apache-dbcp-2.0:javaagent:testStableSemconv"
24+
"apache-httpclient:apache-httpclient-2.0:javaagent:test"
25+
"apache-httpclient:apache-httpclient-4.0:javaagent:test"
2626
"apache-httpclient:apache-httpclient-4.3:library:test"
27-
# "apache-httpclient:apache-httpclient-5.0:javaagent:test"
28-
# "apache-dubbo-2.7:javaagent:testDubbo"
29-
# "c3p0-0.9:javaagent:test"
30-
# "c3p0-0.9:javaagent:testStableSemconv"
31-
# "clickhouse-client-0.5:javaagent:test"
32-
# "clickhouse-client-0.5:javaagent:testStableSemconv"
33-
# "aws-sdk:aws-sdk-1.11:javaagent:test"
34-
# "google-http-client-1.19:javaagent:test"
35-
# "http-url-connection:javaagent:test"
36-
# "java-http-client:javaagent:test"
37-
# "jetty-httpclient:jetty-httpclient-9.2:javaagent:test"
38-
# "jetty-httpclient:jetty-httpclient-12.0:javaagent:test"
39-
# "jodd-http-4.2:javaagent:test"
40-
# "netty:netty-3.8:javaagent:test"
41-
# "netty:netty-4.0:javaagent:test"
42-
# "netty:netty-4.1:javaagent:test"
43-
# "okhttp:okhttp-2.2:javaagent:test"
44-
# "okhttp:okhttp-3.0:javaagent:test"
45-
# "pekko:pekko-http-1.0:javaagent:test"
46-
# "play:play-ws:play-ws-1.0:javaagent:test"
47-
# "play:play-ws:play-ws-2.0:javaagent:test"
48-
# "play:play-ws:play-ws-2.1:javaagent:test"
49-
# "reactor:reactor-netty:reactor-netty-0.9:javaagent:test"
50-
# "reactor:reactor-netty:reactor-netty-1.0:javaagent:test"
51-
# "spring:spring-webflux:spring-webflux-5.0:javaagent:test"
52-
# "vertx:vertx-http-client:vertx-http-client-3.0:javaagent:test"
53-
# "vertx:vertx-http-client:vertx-http-client-4.0:javaagent:test"
54-
# "vertx:vertx-http-client:vertx-http-client-5.0:javaagent:test"
55-
# "vertx:vertx-redis-client-4.0:javaagent:test"
56-
# "vertx:vertx-redis-client-4.0:javaagent:testStableSemconv"
57-
# "vertx:vertx-sql-client:vertx-sql-client-4.0:javaagent:test"
58-
# "vertx:vertx-sql-client:vertx-sql-client-4.0:javaagent:testStableSemconv"
59-
# "vertx:vertx-sql-client:vertx-sql-client-5.0:javaagent:test"
60-
# "vertx:vertx-sql-client:vertx-sql-client-5.0:javaagent:testStableSemconv"
61-
# "aws-sdk:aws-sdk-1.11:javaagent:testStableSemconv"
62-
# "aws-sdk:aws-sdk-2.2:javaagent:test"
63-
# "aws-sdk:aws-sdk-2.2:javaagent:testStableSemconv"
64-
# "aws-sdk:aws-sdk-2.2:javaagent:testBedrockRuntime"
65-
# "hikaricp-3.0:javaagent:test"
66-
# "hikaricp-3.0:javaagent:testStableSemconv"
67-
# "tomcat:tomcat-jdbc:javaagent:test"
68-
# "tomcat:tomcat-jdbc:javaagent:testStableSemconv"
69-
# "oracle-ucp-11.2:javaagent:test"
70-
# "oracle-ucp-11.2:javaagent:testStableSemconv"
71-
# "oshi:javaagent:test"
72-
# "oshi:javaagent:testExperimental"
73-
# "vibur-dbcp-11.0:javaagent:test"
74-
# "vibur-dbcp-11.0:javaagent:testStableSemconv"
27+
"apache-httpclient:apache-httpclient-5.0:javaagent:test"
28+
"apache-dubbo-2.7:javaagent:testDubbo"
29+
"c3p0-0.9:javaagent:test"
30+
"c3p0-0.9:javaagent:testStableSemconv"
31+
"clickhouse-client-0.5:javaagent:test"
32+
"clickhouse-client-0.5:javaagent:testStableSemconv"
33+
"aws-sdk:aws-sdk-1.11:javaagent:test"
34+
"google-http-client-1.19:javaagent:test"
35+
"http-url-connection:javaagent:test"
36+
"java-http-client:javaagent:test"
37+
"jetty-httpclient:jetty-httpclient-9.2:javaagent:test"
38+
"jetty-httpclient:jetty-httpclient-12.0:javaagent:test"
39+
"jodd-http-4.2:javaagent:test"
40+
"netty:netty-3.8:javaagent:test"
41+
"netty:netty-4.0:javaagent:test"
42+
"netty:netty-4.1:javaagent:test"
43+
"okhttp:okhttp-2.2:javaagent:test"
44+
"okhttp:okhttp-3.0:javaagent:test"
45+
"pekko:pekko-http-1.0:javaagent:test"
46+
"play:play-ws:play-ws-1.0:javaagent:test"
47+
"play:play-ws:play-ws-2.0:javaagent:test"
48+
"play:play-ws:play-ws-2.1:javaagent:test"
49+
"reactor:reactor-netty:reactor-netty-0.9:javaagent:test"
50+
"reactor:reactor-netty:reactor-netty-1.0:javaagent:test"
51+
"spring:spring-webflux:spring-webflux-5.0:javaagent:test"
52+
"vertx:vertx-http-client:vertx-http-client-3.0:javaagent:test"
53+
"vertx:vertx-http-client:vertx-http-client-4.0:javaagent:test"
54+
"vertx:vertx-http-client:vertx-http-client-5.0:javaagent:test"
55+
"vertx:vertx-redis-client-4.0:javaagent:test"
56+
"vertx:vertx-redis-client-4.0:javaagent:testStableSemconv"
57+
"vertx:vertx-sql-client:vertx-sql-client-4.0:javaagent:test"
58+
"vertx:vertx-sql-client:vertx-sql-client-4.0:javaagent:testStableSemconv"
59+
"vertx:vertx-sql-client:vertx-sql-client-5.0:javaagent:test"
60+
"vertx:vertx-sql-client:vertx-sql-client-5.0:javaagent:testStableSemconv"
61+
"aws-sdk:aws-sdk-1.11:javaagent:testStableSemconv"
62+
"aws-sdk:aws-sdk-2.2:javaagent:test"
63+
"aws-sdk:aws-sdk-2.2:javaagent:testStableSemconv"
64+
"aws-sdk:aws-sdk-2.2:javaagent:testBedrockRuntime"
65+
"hikaricp-3.0:javaagent:test"
66+
"hikaricp-3.0:javaagent:testStableSemconv"
67+
"tomcat:tomcat-jdbc:javaagent:test"
68+
"tomcat:tomcat-jdbc:javaagent:testStableSemconv"
69+
"oracle-ucp-11.2:javaagent:test"
70+
"oracle-ucp-11.2:javaagent:testStableSemconv"
71+
"oshi:javaagent:test"
72+
"oshi:javaagent:testExperimental"
73+
"vibur-dbcp-11.0:javaagent:test"
74+
"vibur-dbcp-11.0:javaagent:testStableSemconv"
7575
)
7676

7777
readonly TELEMETRY_DIR_NAME=".telemetry"

‎instrumentation-docs/readme.md‎

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,6 @@ tasks {
2323
}
2424
```
2525

26-
2726
In order to collect spans, add the `collectSpans` property (along with `collectMetadata`):
2827

2928
```kotlin

‎instrumentation-docs/src/main/java/io/opentelemetry/instrumentation/docs/DocGeneratorApplication.java‎

Lines changed: 20 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -83,8 +83,6 @@ private static void printStats(List<InstrumentationModule> modules) {
8383
getPercentage("configurations", withConfigurations, modules.size()));
8484

8585
logger.info(stats);
86-
87-
logger.info(modulesWithDescriptions(modules));
8886
}
8987

9088
private static String getClassificationStats(List<InstrumentationModule> modules) {
@@ -110,19 +108,18 @@ private static String getPercentage(String label, long numerator, long denominat
110108
+ "%)";
111109
}
112110

113-
@SuppressWarnings("unused") // helper method used for project tracking
111+
@SuppressWarnings("unused") // temporary helper method used for project tracking
114112
private static String listAllModules(List<InstrumentationModule> modules) {
115-
// Create a checklist of all modules sorted by name
116113
return modules.stream()
117114
.map(InstrumentationModule::getInstrumentationName)
118115
.sorted()
119116
.map(name -> "- [ ] " + name)
120117
.collect(Collectors.joining("\n"));
121118
}
122119

123-
@SuppressWarnings("unused") // helper method used for project tracking
120+
@SuppressWarnings("unused") // temporary helper method used for project tracking
124121
private static String modulesWithDescriptions(List<InstrumentationModule> modules) {
125-
// Create a checklist of all modules sorted by name, checked if description is set
122+
// checklist of all modules sorted by name, with a check if description is set
126123
return modules.stream()
127124
.sorted(Comparator.comparing(InstrumentationModule::getInstrumentationName))
128125
.map(
@@ -137,5 +134,22 @@ private static String modulesWithDescriptions(List<InstrumentationModule> module
137134
.collect(Collectors.joining("\n"));
138135
}
139136

137+
@SuppressWarnings("unused") // temporary helper method used for project tracking
138+
private static String modulesWithConfigs(List<InstrumentationModule> modules) {
139+
// checklist of all modules sorted by name, with a check if config is set
140+
return modules.stream()
141+
.sorted(Comparator.comparing(InstrumentationModule::getInstrumentationName))
142+
.map(
143+
module -> {
144+
boolean hasDescription =
145+
module.getMetadata() != null
146+
&& module.getMetadata().getConfigurations() != null
147+
&& !module.getMetadata().getConfigurations().isEmpty();
148+
String checkbox = hasDescription ? "- [x] " : "- [ ] ";
149+
return checkbox + module.getInstrumentationName();
150+
})
151+
.collect(Collectors.joining("\n"));
152+
}
153+
140154
private DocGeneratorApplication() {}
141155
}

‎instrumentation/apache-dbcp-2.0/metadata.yaml‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
description: >
2-
Provides OpenTelemetry auto-instrumentation for Apache DBCP.
2+
This instrumentation provides database connection pools metrics for Apache DBCP.
33
4-
This auto-instrumentation uses `MBeanRegistration` methods for lifecycle detection, therefore it
4+
The instrumentation uses `MBeanRegistration` methods for lifecycle detection, therefore it
55
only activates if the `BasicDataSource` is registered to an `MBeanServer`. If using Spring Boot,
66
this happens automatically as all Spring beans that support JMX registration are automatically
77
registered by default.

0 commit comments

Comments
 (0)