-
Notifications
You must be signed in to change notification settings - Fork 3.9k
census: expose client interceptors #12050
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
base: master
Are you sure you want to change the base?
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,113 @@ | ||
/* | ||
* Copyright 2025 The gRPC Authors | ||
* | ||
* Licensed under the Apache License, Version 2.0 (the "License"); | ||
* you may not use this file except in compliance with the License. | ||
* You may obtain a copy of the License at | ||
* | ||
* http://www.apache.org/licenses/LICENSE-2.0 | ||
* | ||
* Unless required by applicable law or agreed to in writing, software | ||
* distributed under the License is distributed on an "AS IS" BASIS, | ||
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
* See the License for the specific language governing permissions and | ||
* limitations under the License. | ||
*/ | ||
|
||
package io.grpc.census; | ||
|
||
import com.google.common.base.Stopwatch; | ||
import com.google.common.base.Supplier; | ||
import io.grpc.ClientInterceptor; | ||
import io.grpc.ServerBuilder; | ||
import io.grpc.ServerStreamTracer; | ||
import io.opencensus.trace.Tracing; | ||
|
||
/** | ||
* The entrypoint for OpenCensus instrumentation functionality in gRPC. | ||
* | ||
* <p>GrpcCensus uses {@link io.opencensus.api.OpenCensus} APIs for instrumentation. | ||
* | ||
*/ | ||
public final class GrpcCensus { | ||
ejona86 marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
private GrpcCensus() {} | ||
|
||
private static final Supplier<Stopwatch> STOPWATCH_SUPPLIER = new Supplier<Stopwatch>() { | ||
@Override | ||
public Stopwatch get() { | ||
return Stopwatch.createUnstarted(); | ||
} | ||
}; | ||
|
||
/** | ||
* Returns a {@link ClientInterceptor} with default stats implementation. | ||
*/ | ||
public static ClientInterceptor newClientStatsInterceptor() { | ||
CensusStatsModule censusStats = | ||
new CensusStatsModule( | ||
STOPWATCH_SUPPLIER, | ||
true, | ||
true, | ||
true, | ||
false, | ||
true); | ||
return censusStats.getClientInterceptor(); | ||
} | ||
|
||
/** | ||
* Returns a {@link ClientInterceptor} with default tracing implementation. | ||
*/ | ||
public static ClientInterceptor newClientTracingInterceptor() { | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Seeing all the statics is making me see why to more closely mirror GrpcOpenTelemetry. This could be fine as-is, because we don't care about it too much, but there do seem to be advantages in the GrpcOpenTelemetry API in clarity and letting us add options when needed. If we had only There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. +1 |
||
CensusTracingModule censusTracing = | ||
new CensusTracingModule( | ||
Tracing.getTracer(), | ||
Tracing.getPropagationComponent().getBinaryFormat()); | ||
return censusTracing.getClientInterceptor(); | ||
} | ||
|
||
/** | ||
* Returns a {@link ServerStreamTracer.Factory} with default stats implementation. | ||
*/ | ||
private static ServerStreamTracer.Factory newServerStatsStreamTracerFactory() { | ||
CensusStatsModule censusStats = | ||
new CensusStatsModule( | ||
STOPWATCH_SUPPLIER, | ||
true, | ||
true, | ||
true, | ||
false, | ||
true); | ||
return censusStats.getServerTracerFactory(); | ||
} | ||
|
||
/** | ||
* Returns a {@link ServerStreamTracer.Factory} with default tracing implementation. | ||
*/ | ||
private static ServerStreamTracer.Factory newServerTracingStreamTracerFactory() { | ||
CensusTracingModule censusTracing = | ||
new CensusTracingModule( | ||
Tracing.getTracer(), | ||
Tracing.getPropagationComponent().getBinaryFormat()); | ||
return censusTracing.getServerTracerFactory(); | ||
} | ||
|
||
/** | ||
* Configures the given {@link ServerBuilder} with serverStreamTracerFactory for stats. | ||
* | ||
* @param serverBuilder the server builder to configure | ||
*/ | ||
public static void configureServerBuilderWithStatsTracer(ServerBuilder<?> serverBuilder) { | ||
serverBuilder.addStreamTracerFactory(newServerStatsStreamTracerFactory()); | ||
} | ||
|
||
/** | ||
* Configures the given {@link ServerBuilder} with serverStreamTracerFactory for tracing. | ||
* | ||
* @param serverBuilder the server builder to configure | ||
*/ | ||
public static void configureServerBuilderWithTracingTracer(ServerBuilder<?> serverBuilder) { | ||
serverBuilder.addStreamTracerFactory(newServerTracingStreamTracerFactory()); | ||
} | ||
|
||
} |
Uh oh!
There was an error while loading. Please reload this page.