Skip to content

core: let channel tracing log service config changes #4675

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.

Sign up for GitHub

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

Merged
merged 2 commits into from
Jul 25, 2018
Merged

core: let channel tracing log service config changes #4675

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
caf03a5
core: let channel tracing log service config changes
dapengzhang0 Jul 24, 2018
7325812
fix negation
dapengzhang0 Jul 25, 2018
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
26 changes: 19 additions & 7 deletions core/src/main/java/io/grpc/internal/ManagedChannelImpl.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -211,7 +211,10 @@ void handleUncaughtThrowable(Throwable t) {
@CheckForNull
private final ChannelTracer channelTracer;
private final Channelz channelz;
private Boolean zeroBackends; // a flag for doing channel tracing when flipped
@CheckForNull
private Boolean haveBackends; // a flag for doing channel tracing when flipped
@Nullable
private Map<String, Object> lastServiceConfig; // used for channel tracing when value changed

// One instance per channel.
private final ChannelBufferMeter channelBufferUsed = new ChannelBufferMeter();
Expand Down Expand Up @@ -1250,13 +1253,24 @@ public void onAddresses(final List<EquivalentAddressGroup> servers, final Attrib
new Object[]{getLogId(), servers, config});
}

if (channelTracer != null && (zeroBackends == null || zeroBackends)) {
if (channelTracer != null && (haveBackends == null || !haveBackends)) {
channelTracer.reportEvent(new ChannelTrace.Event.Builder()
.setDescription("Address resolved: " + servers)
.setSeverity(ChannelTrace.Event.Severity.CT_INFO)
.setTimestampNanos(timeProvider.currentTimeNanos())
.build());
zeroBackends = false;
haveBackends = true;
}
final Map<String, Object> serviceConfig =
config.get(GrpcAttributes.NAME_RESOLVER_SERVICE_CONFIG);
if (channelTracer != null && serviceConfig != null
&& !serviceConfig.equals(lastServiceConfig)) {
channelTracer.reportEvent(new ChannelTrace.Event.Builder()
.setDescription("Service config changed")
.setSeverity(ChannelTrace.Event.Severity.CT_INFO)
.setTimestampNanos(timeProvider.currentTimeNanos())
.build());
lastServiceConfig = serviceConfig;
}

final class NamesResolved implements Runnable {
Expand All @@ -1269,8 +1283,6 @@ public void run() {

nameResolverBackoffPolicy = null;

Map<String, Object> serviceConfig =
config.get(GrpcAttributes.NAME_RESOLVER_SERVICE_CONFIG);
if (serviceConfig != null) {
try {
serviceConfigInterceptor.handleUpdate(serviceConfig);
Expand All @@ -1297,13 +1309,13 @@ public void onError(final Status error) {
checkArgument(!error.isOk(), "the error status must not be OK");
logger.log(Level.WARNING, "[{0}] Failed to resolve name. status={1}",
new Object[] {getLogId(), error});
if (channelTracer != null && (zeroBackends == null || !zeroBackends)) {
if (channelTracer != null && (haveBackends == null || haveBackends)) {
channelTracer.reportEvent(new ChannelTrace.Event.Builder()
.setDescription("Failed to resolve name")
.setSeverity(ChannelTrace.Event.Severity.CT_WARNING)
.setTimestampNanos(timeProvider.currentTimeNanos())
.build());
zeroBackends = true;
haveBackends = false;
}
channelExecutor
.executeLater(
Expand Down
56 changes: 56 additions & 0 deletions core/src/test/java/io/grpc/internal/ManagedChannelImplTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2216,6 +2216,62 @@ public void channelTracing_nameResolvedEvent_zeorAndNonzeroBackends() throws Exc
assertThat(getStats(channel).channelTrace.events).hasSize(prevSize + 1);
}

@Test
public void channelTracing_serviceConfigChange() throws Exception {
timer.forwardNanos(1234);
channelBuilder.maxTraceEvents(10);
List<EquivalentAddressGroup> servers = new ArrayList<EquivalentAddressGroup>();
servers.add(new EquivalentAddressGroup(socketAddress));
FakeNameResolverFactory nameResolverFactory =
new FakeNameResolverFactory.Builder(expectedUri).setServers(servers).build();
channelBuilder.nameResolverFactory(nameResolverFactory);
createChannel();

int prevSize = getStats(channel).channelTrace.events.size();
Attributes attributes =
Attributes.newBuilder()
.set(GrpcAttributes.NAME_RESOLVER_SERVICE_CONFIG, new HashMap<String, Object>())
.build();
nameResolverFactory.resolvers.get(0).listener.onAddresses(
Collections.singletonList(new EquivalentAddressGroup(
Arrays.asList(new SocketAddress() {}, new SocketAddress() {}))),
attributes);
assertThat(getStats(channel).channelTrace.events).hasSize(prevSize + 1);
assertThat(getStats(channel).channelTrace.events.get(prevSize))
.isEqualTo(new ChannelTrace.Event.Builder()
.setDescription("Service config changed")
.setSeverity(ChannelTrace.Event.Severity.CT_INFO)
.setTimestampNanos(timer.getTicker().read())
.build());

prevSize = getStats(channel).channelTrace.events.size();
nameResolverFactory.resolvers.get(0).listener.onAddresses(
Collections.singletonList(new EquivalentAddressGroup(
Arrays.asList(new SocketAddress() {}, new SocketAddress() {}))),
attributes);
assertThat(getStats(channel).channelTrace.events).hasSize(prevSize);

prevSize = getStats(channel).channelTrace.events.size();
Map<String, Object> serviceConfig = new HashMap<String, Object>();
serviceConfig.put("methodConfig", new HashMap<String, Object>());
attributes =
Attributes.newBuilder()
.set(GrpcAttributes.NAME_RESOLVER_SERVICE_CONFIG, serviceConfig)
.build();
timer.forwardNanos(1234);
nameResolverFactory.resolvers.get(0).listener.onAddresses(
Collections.singletonList(new EquivalentAddressGroup(
Arrays.asList(new SocketAddress() {}, new SocketAddress() {}))),
attributes);
assertThat(getStats(channel).channelTrace.events).hasSize(prevSize + 1);
assertThat(getStats(channel).channelTrace.events.get(prevSize))
.isEqualTo(new ChannelTrace.Event.Builder()
.setDescription("Service config changed")
.setSeverity(ChannelTrace.Event.Severity.CT_INFO)
.setTimestampNanos(timer.getTicker().read())
.build());
}

@Test
public void channelTracing_stateChangeEvent() throws Exception {
channelBuilder.maxTraceEvents(10);
Expand Down