zipkin2.reporter.Reporter Maven / Gradle / Ivy
/*
* Copyright 2016-2024 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 zipkin2.reporter;
import zipkin2.Span;
/**
* Spans are created in instrumentation, transported out-of-band, and eventually persisted.
* Reporters sends spans (or encoded spans) recorded by instrumentation out of process.
*
* Type of span to report, usually {@link Span}, but extracted for reporting other java
* types like HTrace spans to zipkin, and to allow future Zipkin model types to be reported (ex.
* zipkin2.Span).
*/
public interface Reporter {
Reporter NOOP = new Reporter() {
@Override public void report(Span span) {
}
@Override public String toString() {
return "NoopReporter{}";
}
};
Reporter CONSOLE = new Reporter() {
@Override public void report(Span span) {
System.out.println(span.toString());
}
@Override public String toString() {
return "ConsoleReporter{}";
}
};
/**
* Schedules the span to be sent onto the transport.
*
* @param span Span, should not be null.
*/
void report(S span);
}