io.opencensus.trace.propagation.TextFormat Java Examples

TracingAsyncClientHttpRequestInterceptor(
    @Nullable TextFormat propagator,
    @Nullable HttpExtractor<HttpRequest, ClientHttpResponse> extractor) {

  tracer = Tracing.getTracer();

  if (propagator == null) {
    propagator = Tracing.getPropagationComponent().getTraceContextFormat();
  }

  if (extractor == null) {
    extractor = (HttpExtractor<HttpRequest, ClientHttpResponse>) new HttpClientExtractor();
  }

  handler =
      new HttpClientHandler<HttpRequest, ClientHttpResponse, HttpRequest>(
          Tracing.getTracer(), extractor, propagator, setter);
}
 

/**
 * Creates a {@link HttpServerHandler} with given parameters.
 *
 * @param tracer the Open Census tracing component.
 * @param extractor the {@code HttpExtractor} used to extract information from the
 *     request/response.
 * @param textFormat the {@code TextFormat} used in HTTP propagation.
 * @param getter the getter used when extracting information from the {@code carrier}.
 * @param publicEndpoint set to true for publicly accessible HTTP(S) server. If true then incoming
 *     tracecontext will be added as a link instead of as a parent.
 * @since 0.19
 */
public HttpServerHandler(
    Tracer tracer,
    HttpExtractor<Q, P> extractor,
    TextFormat textFormat,
    TextFormat.Getter<C> getter,
    Boolean publicEndpoint) {
  super(extractor);
  checkNotNull(tracer, "tracer");
  checkNotNull(textFormat, "textFormat");
  checkNotNull(getter, "getter");
  checkNotNull(publicEndpoint, "publicEndpoint");
  this.tracer = tracer;
  this.textFormat = textFormat;
  this.getter = getter;
  this.publicEndpoint = publicEndpoint;
  this.statsRecorder = Stats.getStatsRecorder();
  this.tagger = Tags.getTagger();
}
 

/**
 * Creates a {@link HttpClientHandler} with given parameters.
 *
 * @param tracer the Open Census tracing component.
 * @param extractor the {@code HttpExtractor} used to extract information from the
 *     request/response.
 * @param textFormat the {@code TextFormat} used in HTTP propagation.
 * @param setter the setter used when injecting information to the {@code carrier}.
 * @since 0.19
 */
public HttpClientHandler(
    Tracer tracer,
    HttpExtractor<Q, P> extractor,
    TextFormat textFormat,
    TextFormat.Setter<C> setter) {
  super(extractor);
  checkNotNull(setter, "setter");
  checkNotNull(textFormat, "textFormat");
  checkNotNull(tracer, "tracer");
  this.setter = setter;
  this.textFormat = textFormat;
  this.tracer = tracer;
  this.statsRecorder = Stats.getStatsRecorder();
  this.tagger = Tags.getTagger();
}
 

@Bean
public TracingAsyncClientHttpRequestInterceptor asyncTracingClientHttpRequestInterceptor() {
  TextFormat propagator;

  if (propagation != null && propagation == Propagation.TRACE_PROPAGATION_B3) {
    propagator = Tracing.getPropagationComponent().getB3Format();
  } else {
    propagator = Tracing.getPropagationComponent().getTraceContextFormat();
  }
  return (TracingAsyncClientHttpRequestInterceptor)
      TracingAsyncClientHttpRequestInterceptor.create(propagator, extractor);
}
 

private static HttpClientHandler<Request, Response, Request> buildHandler(
    @Nullable HttpExtractor<Request, Response> extractor, @Nullable TextFormat propagator) {
  if (extractor == null) {
    extractor = new OcJettyHttpClientExtractor();
  }

  if (propagator == null) {
    propagator = Tracing.getPropagationComponent().getTraceContextFormat();
  }

  return new HttpClientHandler<Request, Response, Request>(
      Tracing.getTracer(), extractor, propagator, setter);
}
 

static HttpServerHandler<HttpServletRequest, HttpServletResponse, HttpServletRequest>
    buildHttpServerHandlerWithOptions(
        HttpExtractor<HttpServletRequest, HttpServletResponse> extractor,
        TextFormat propagator,
        Boolean publicEndpoint) {
  return new HttpServerHandler<HttpServletRequest, HttpServletResponse, HttpServletRequest>(
      Tracing.getTracer(), extractor, propagator, getter, publicEndpoint);
}
 

@Override
public TextFormat getB3Format() {
  return b3Format;
}
 

@Override
public TextFormat getTraceContextFormat() {
  return traceContextFormat;
}
 

TextFormatBenchmarkBase(TextFormat textFormat) {
  this.textFormat = textFormat;
}
 

private static String encodeSpanContextText(TextFormat format, SpanContext context) {
  StringBuilder builder = new StringBuilder();
  format.inject(context, builder, textSetter);
  return builder.toString();
}
 

@Test
public void cloudTraceFormatNotNull() {
  TextFormat cloudTraceFormat = HttpPropagationUtil.getCloudTraceFormat();
  assertThat(cloudTraceFormat).isNotNull();
  assertThat(cloudTraceFormat).isInstanceOf(CloudTraceFormat.class);
}
 

/**
 * Create a new {@code OcJettyHttpClient} with support for HTTPS, extractor and propagator.
 *
 * @param transport {@link HttpClientTransport} The transport implementation.
 * @param sslContextFactory {@link SslContextFactory} Used to configure SSL connectors.
 * @param extractor {@link HttpExtractor} to extract request and response specific attributes. If
 *     it is null then default extractor is used.
 * @param propagator {@link TextFormat} to propagate trace context to remote peer. If it is null
 *     then default propagator (TraceContextFormat) is used.
 * @since 0.20
 */
public OcJettyHttpClient(
    HttpClientTransport transport,
    SslContextFactory sslContextFactory,
    @Nullable HttpExtractor<Request, Response> extractor,
    @Nullable TextFormat propagator) {
  super(transport, sslContextFactory);
  handler = buildHandler(extractor, propagator);
}
 

/**
 * Construct instance with custom configuration.
 *
 * @param extractor the {@code HttpExtractor} used to extract information from the
 *     request/response.
 * @param propagationFormat the {@code TextFormat} used in HTTP propagation.
 * @param publicEndpoint set to true for publicly accessible HTTP(S) server. If true then incoming
 *     tracecontext will be added as a link instead of as a parent.
 */
public JaxrsContainerFilter(
    HttpExtractor<ExtendedContainerRequest, ContainerResponseContext> extractor,
    TextFormat propagationFormat,
    Boolean publicEndpoint) {
  this.handler =
      new HttpServerHandler<>(
          Tracing.getTracer(), extractor, propagationFormat, GETTER, publicEndpoint);
}
 

/**
 * Sets the {@link io.opencensus.trace.propagation.TextFormat.Setter} used in context propagation.
 *
 * <p>This API allows users of google-http-client to specify other text format setter, or disable
 * context propagation by setting it to {@code null}. It should be used along with {@link
 * #setPropagationTextFormat} for setting purpose.
 *
 * @param textFormatSetter the {@code TextFormat.Setter} for the text format.
 */
public static void setPropagationTextFormatSetter(@Nullable TextFormat.Setter textFormatSetter) {
  propagationTextFormatSetter = textFormatSetter;
}
 

/**
 * Sets the {@link TextFormat} used in context propagation.
 *
 * <p>This API allows users of google-http-client to specify other text format, or disable context
 * propagation by setting it to {@code null}. It should be used along with {@link
 * #setPropagationTextFormatSetter} for setting purpose.
 *
 * @param textFormat the text format.
 */
public static void setPropagationTextFormat(@Nullable TextFormat textFormat) {
  propagationTextFormat = textFormat;
}
 

/**
 * Construct new client filter with custom configuration.
 *
 * @param extractor the {@code HttpExtractor} used to extract information from the
 *     request/response.
 * @param propagationFormat the {@code TextFormat} used in HTTP propagation.
 */
public JaxrsClientFilter(
    HttpExtractor<ClientRequestContext, ClientResponseContext> extractor,
    TextFormat propagationFormat) {
  handler = new HttpClientHandler<>(Tracing.getTracer(), extractor, propagationFormat, SETTER);
}
 

/**
 * Returns the Stack Driver format implementation. The header specification for this format is
 * "X-Cloud-Trace-Context: &lt;TRACE_ID&gt;/&lt;SPAN_ID&gt;[;o=&lt;TRACE_TRUE&gt;]". See this <a
 * href="https://cloud.google.com/trace/docs/support">page</a> for more information.
 *
 * @since 0.11.0
 * @return the Stack Driver format.
 */
public static TextFormat getCloudTraceFormat() {
  return new CloudTraceFormat();
}
 

/**
 * Create an instance of {@code TracingAsyncClientHttpRequestInterceptor}.
 *
 * @param extractor {@link HttpExtractor} to extract request and response specific attributes. If
 *     it is null then default extractor is used.
 * @param propagator {@link TextFormat} to propagate trace context to remote peer. If it is null
 *     then default propagator (TraceContextFormat) is used.
 * @return {@code TracingAsyncClientHttpRequestInterceptor}
 * @since 0.23.0
 */
public static TracingAsyncClientHttpRequestInterceptor create(
    @Nullable TextFormat propagator,
    @Nullable HttpExtractor<HttpRequest, ClientHttpResponse> extractor) {
  return new TracingAsyncClientHttpRequestInterceptor(propagator, extractor);
}