brave.http.HttpTracingCustomizer Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of brave-instrumentation-http Show documentation

There is a newer version: 6.0.3

Show newest version

/*
 * Copyright 2013-2020 The OpenZipkin 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 brave.http;

import brave.Tracing;
import brave.TracingCustomizer;

/**
 * This allows configuration plugins to collaborate on building an instance of {@link HttpTracing}.
 *
 * For example, a customizer can setup {@link HttpTracing.Builder#clientRequestParser(HttpRequestParser)
 * http parsers} without a reference to the {@link HttpTracing.Builder#Builder(Tracing) tracing
 * component}.
 *
 * 
This also allows one object to customize both {@link Tracing}, via {@link TracingCustomizer},
 * and the http layer {@link HttpTracing}, by implementing both customizer interfaces.
 *
 * 
Integration examples
 *
 * In practice, a dependency injection tool applies a collection of these instances prior to
 * {@link HttpTracing.Builder#build() building the tracing instance}. For example, an injected
 * {@code List} parameter to a provider of {@link HttpTracing}.
 *
 * 
Here are some examples, in alphabetical order:
 * 

 *   Dagger Set Multibindings
 *   Guice Set Multibinder
 *   Spring Autowired Collections
 * 
 *
 * @see TracingCustomizer
 * @since 5.7
 */
public interface HttpTracingCustomizer {
  /** Use to avoid comparing against null references */
  HttpTracingCustomizer NOOP = new HttpTracingCustomizer() {
    @Override public void customize(HttpTracing.Builder builder) {
    }

    @Override public String toString() {
      return "NoopHttpTracingCustomizer{}";
    }
  };

  void customize(HttpTracing.Builder builder);
}