Skip to content

Commit 59aaef7

Browse files
committed
code review suggestions
1 parent 5199c3b commit 59aaef7

File tree

3 files changed

+17
-15
lines changed

3 files changed

+17
-15
lines changed

instrumentation/jmx-metrics/library/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
Provides OpenTelemetry instrumentation for [Java Management Extensions (JMX)](https://docs.oracle.com/javase/tutorial/jmx/).
44

5-
This instrumentation collects JMX metrics and exports them as OpenTelemetry metrics.
5+
This instrumentation collects JMX-based metrics and exports them as OpenTelemetry metrics.
66

77
## Quickstart
88

instrumentation/netty/netty-4.1/library/README.md

Lines changed: 15 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -35,9 +35,8 @@ implementation("io.opentelemetry.instrumentation:opentelemetry-netty-4.1:OPENTEL
3535
import io.netty.bootstrap.Bootstrap;
3636
import io.netty.channel.Channel;
3737
import io.netty.channel.ChannelInitializer;
38-
import io.netty.channel.nio.NioEventLoopGroup;
38+
import io.netty.channel.EventLoopGroup;
3939
import io.netty.channel.socket.SocketChannel;
40-
import io.netty.channel.socket.nio.NioSocketChannel;
4140
import io.netty.handler.codec.http.HttpClientCodec;
4241
import io.opentelemetry.api.OpenTelemetry;
4342
import io.opentelemetry.context.Context;
@@ -48,16 +47,19 @@ OpenTelemetry openTelemetry = ...;
4847

4948
NettyClientTelemetry clientTelemetry = NettyClientTelemetry.create(openTelemetry);
5049

50+
EventLoopGroup eventLoopGroup = ...; // Use appropriate EventLoopGroup for your platform
51+
Class<? extends Channel> channelClass = ...; // Use appropriate Channel class for your platform
52+
5153
Bootstrap bootstrap = new Bootstrap();
52-
bootstrap.group(new NioEventLoopGroup())
53-
.channel(NioSocketChannel.class)
54+
bootstrap.group(eventLoopGroup)
55+
.channel(channelClass)
5456
.handler(new ChannelInitializer<SocketChannel>() {
5557
@Override
5658
protected void initChannel(SocketChannel ch) {
5759
ch.pipeline()
5860
.addLast(new HttpClientCodec())
59-
.addLast(clientTelemetry.createRequestHandler())
60-
.addLast(clientTelemetry.createResponseHandler());
61+
.addLast(clientTelemetry.createCombinedHandler())
62+
.addLast(new YourClientHandler()); // Your application handler
6163
}
6264
});
6365

@@ -71,9 +73,8 @@ NettyClientTelemetry.setChannelContext(channel, Context.current());
7173
import io.netty.bootstrap.ServerBootstrap;
7274
import io.netty.channel.ChannelInitializer;
7375
import io.netty.channel.EventLoopGroup;
74-
import io.netty.channel.nio.NioEventLoopGroup;
76+
import io.netty.channel.ServerChannel;
7577
import io.netty.channel.socket.SocketChannel;
76-
import io.netty.channel.socket.nio.NioServerSocketChannel;
7778
import io.netty.handler.codec.http.HttpServerCodec;
7879
import io.opentelemetry.api.OpenTelemetry;
7980
import io.opentelemetry.instrumentation.netty.v4_1.NettyServerTelemetry;
@@ -83,19 +84,20 @@ OpenTelemetry openTelemetry = ...;
8384

8485
NettyServerTelemetry serverTelemetry = NettyServerTelemetry.create(openTelemetry);
8586

86-
EventLoopGroup bossGroup = new NioEventLoopGroup();
87-
EventLoopGroup workerGroup = new NioEventLoopGroup();
87+
EventLoopGroup bossGroup = ...; // Use appropriate EventLoopGroup for your platform
88+
EventLoopGroup workerGroup = ...; // Use appropriate EventLoopGroup for your platform
89+
Class<? extends ServerChannel> serverChannelClass = ...; // Use appropriate ServerChannel class for your platform
8890

8991
ServerBootstrap bootstrap = new ServerBootstrap();
9092
bootstrap.group(bossGroup, workerGroup)
91-
.channel(NioServerSocketChannel.class)
93+
.channel(serverChannelClass)
9294
.childHandler(new ChannelInitializer<SocketChannel>() {
9395
@Override
9496
protected void initChannel(SocketChannel ch) {
9597
ch.pipeline()
9698
.addLast(new HttpServerCodec())
97-
.addLast(serverTelemetry.createRequestHandler())
98-
.addLast(serverTelemetry.createResponseHandler());
99+
.addLast(serverTelemetry.createCombinedHandler())
100+
.addLast(new YourServerHandler()); // Your application handler
99101
}
100102
});
101103

instrumentation/quartz-2.0/library/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# Library Instrumentation for Quartz version 2.0 and higher
22

33
Provides OpenTelemetry instrumentation for [Quartz Scheduler](https://www.quartz-scheduler.org/),
4-
enabling INTERNAL spans for each job execution.
4+
enabling job execution spans.
55

66
## Quickstart
77

0 commit comments

Comments
 (0)