1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77

//  Copyright 2017 Palantir Technologies, Inc.
//
//  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.

//! Span reporters.
use std::sync::Arc;

use Span;

/// A reporter consumes Zipkin spans and reports them.
///
/// For example, the reporter may log the span information to a file, or send
/// it over the network to a collection service.
pub trait Report {
    /// Reports a span.
    ///
    /// For backwards compatibility, the default implementation of this method
    /// delegates to the deprecated `report` method. It should be overridden by
    /// all implementations.
    #[allow(deprecated)]
    fn report2(&self, span: Span) {
        self.report(&span);
    }

    #[allow(missing_docs)]
    #[deprecated(since = "0.3.2", note = "use `report2` instead")]
    fn report(&self, _: &Span) {
        unimplemented!()
    }
}

impl<T> Report for Arc<T>
where
    T: ?Sized + Report,
{
    fn report2(&self, span: Span) {
        (**self).report2(span)
    }
}

impl<T> Report for Box<T>
where
    T: ?Sized + Report,
{
    fn report2(&self, span: Span) {
        (**self).report2(span)
    }
}

/// A `Report`er which does nothing.
pub struct NopReporter;

impl Report for NopReporter {
    fn report2(&self, _: Span) {}
}

/// A `Report`er which logs the `Span` at the `info` level.
///
/// The `Span` is simply logged in its `Debug` representation which is not
/// stable, so this reporter is only useful for testing.
pub struct LoggingReporter;

impl Report for LoggingReporter {
    fn report2(&self, span: Span) {
        info!("{:?}", span);
    }
}