io.grpc.census.InternalCensusTracingAccessor Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of grpc-census Show documentation
gRPC: Census
There is a newer version: 1.69.0
/*
 * Copyright 2019 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 io.grpc.ClientInterceptor;
import io.grpc.Internal;
import io.grpc.ServerStreamTracer;
import io.opencensus.trace.Tracing;

/**
 * Accessor for getting {@link ClientInterceptor} or {@link ServerStreamTracer.Factory} with
 * default Census tracing implementation.
 */
@Internal
public final class InternalCensusTracingAccessor {

  // Prevent instantiation.
  private InternalCensusTracingAccessor() {
  }

  /**
   * Returns a {@link ClientInterceptor} with default tracing implementation.
   */
  public static ClientInterceptor getClientInterceptor() {
    return getClientInterceptor(true);
  }

  /**
   * Returns the client interceptor that facilitates Census-based stats reporting.
   *
   * @param addMessageEvents add message events to Spans
   * @return a {@link ClientInterceptor} with default tracing implementation.
   */
  public static ClientInterceptor getClientInterceptor(
      boolean addMessageEvents) {
    CensusTracingModule censusTracing =
        new CensusTracingModule(
            Tracing.getTracer(),
            Tracing.getPropagationComponent().getBinaryFormat(),
            addMessageEvents);
    return censusTracing.getClientInterceptor();
  }

  /**
   * Returns a {@link ServerStreamTracer.Factory} with default stats implementation.
   */
  public static ServerStreamTracer.Factory getServerStreamTracerFactory() {
    return getServerStreamTracerFactory(true);
  }

  /**
   * Returns a {@link ServerStreamTracer.Factory} with default stats implementation.
   */
  public static ServerStreamTracer.Factory getServerStreamTracerFactory(
      boolean addMessageEvents) {
    CensusTracingModule censusTracing =
        new CensusTracingModule(
            Tracing.getTracer(),
            Tracing.getPropagationComponent().getBinaryFormat(),
            addMessageEvents);
    return censusTracing.getServerTracerFactory();
  }
}