zipkin.reporter.ReporterMetrics Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of zipkin-reporter Show documentation
There is a newer version: 1.1.2
/**
 * Copyright 2016 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 zipkin.reporter;

/**
 * Instrumented applications report spans over a transport such as Kafka to Zipkin Collectors.
 *
 * Callbacks on this type are invoked by zipkin reporters to improve the visibility of the
 * system. A typical implementation will report metrics to a telemetry system for analysis and
 * reporting.
 *
 * 
Spans Reported vs Queryable Spans
 *
 * A span in the context of reporting is <= span in the context of query. Instrumentation should
 * report a span only once except, but certain types of spans cross the network. For example, RPC
 * spans are reported at the client and the server separately.
 *
 * 
Key Relationships
 *
 * The following relationships can be used to consider health of the tracing system.
 * 
 * 
 * Dropped spans = Alert when this increases as it could indicate a queue backup.
 * 
Successful Messages = {@link #incrementMessages() Accepted messages} -
 * {@link #incrementMessagesDropped() Dropped messages}. Alert when this is more than amount of
 * messages received from collectors.
 * 
 * 
 * 
 */
public interface ReporterMetrics {

  /**
   * Those who wish to partition metrics by transport can call this method to include the transport
   * type in the backend metric key.
   *
   * For example, an implementation may by default report {@link #incrementSpans(int) incremented
   * spans} to the key "zipkin.reporter.span.accepted". When {@code metrics.forTransport("kafka"} is
   * called, the counter would report to "zipkin.reporter.scribe.span.accepted"
   *
   * @param transportType ex "http", "scribe", "kafka"
   */
  ReporterMetrics forTransport(String transportType);

  /**
   * Increments count of message attempts, which contain 1 or more spans. Ex POST requests or Kafka
   * messages sent.
   */
  void incrementMessages();

  /**
   * Increments count of messages that could not be sent. Ex host unavailable, or peer disconnect.
   */
  void incrementMessagesDropped();

  /**
   * Increments the count of spans reported. When {@link AsyncReporter} is used, reported spans will
   * usually be a larger number than messages.
   */
  void incrementSpans(int quantity);

  /**
   * Increments the number of {@link Encoder#sizeInBytes(Object) encoded spans bytes} reported.
   *
   * @see MessageEncoder
   */
  void incrementSpanBytes(int quantity);

  /**
   * Increments the number of bytes containing encoded spans in a message.
   *
   * This is a function of span bytes per message and {@link MessageEncoder#overheadInBytes(int)
   * overhead}
   */
  void incrementMessageBytes(int quantity);

  /**
   * Increments the count of spans dropped for any reason. For example, failure queueing or
   * sending.
   */
  void incrementSpansDropped(int quantity);

  ReporterMetrics NOOP_METRICS = new ReporterMetrics() {

    @Override public ReporterMetrics forTransport(String transportType) {
      return this;
    }

    @Override public void incrementMessages() {
    }

    @Override public void incrementMessagesDropped() {
    }

    @Override public void incrementSpans(int quantity) {
    }

    @Override public void incrementSpanBytes(int quantity) {
    }

    @Override public void incrementMessageBytes(int quantity) {
    }

    @Override public void incrementSpansDropped(int quantity) {
    }

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