tracing-etw 0.2.3

ETW or Linux user_events output for tokio-tracing
Documentation 
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
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175

#[cfg(target_os = "windows")]
#[doc(hidden)]
pub mod etw;
#[cfg(target_os = "windows")]
#[doc(hidden)]
pub use etw::Provider;
#[cfg(target_os = "windows")]
pub(crate) use etw::ProviderGroupType;
#[cfg(target_os = "windows")]
pub(crate) use etw::_start__etw_kw;
#[cfg(target_os = "windows")]
pub(crate) use etw::_stop__etw_kw;

#[cfg(not(any(target_os = "windows", target_os = "linux")))]
#[doc(hidden)]
pub mod noop;
#[cfg(not(any(target_os = "windows", target_os = "linux")))]
#[doc(hidden)]
pub use noop::Provider;
#[cfg(not(any(target_os = "windows", target_os = "linux")))]
pub(crate) use noop::ProviderGroupType;

#[cfg(target_os = "linux")]
#[doc(hidden)]
pub mod user_events;
#[cfg(target_os = "linux")]
#[doc(hidden)]
pub use user_events::Provider;
#[cfg(target_os = "linux")]
pub(crate) use user_events::ProviderGroupType;
#[cfg(target_os = "linux")]
pub(crate) use user_events::_start__etw_kw;
#[cfg(target_os = "linux")]
pub(crate) use user_events::_stop__etw_kw;

#[cfg(target_os = "linux")]
pub(crate) use eventheader::Guid as native_guid;
#[cfg(not(target_os = "linux"))]
pub(crate) use tracelogging_dynamic::Guid as native_guid;

use crate::error::EtwError;

#[doc(hidden)]
#[derive(Copy, Clone, PartialEq, Eq)]
pub struct GuidWrapper(u128);

impl From<&native_guid> for GuidWrapper {
    fn from(value: &native_guid) -> Self {
        Self(value.to_u128())
    }
}

impl From<u128> for GuidWrapper {
    fn from(value: u128) -> Self {
        Self(value)
    }
}

impl From<&GuidWrapper> for GuidWrapper {
    fn from(value: &GuidWrapper) -> Self {
        Self(value.0)
    }
}

impl From<GuidWrapper> for native_guid {
    fn from(value: GuidWrapper) -> Self {
        native_guid::from_u128(&value.0)
    }
}

impl From<&GuidWrapper> for u128 {
    fn from(value: &GuidWrapper) -> Self {
        value.0
    }
}

impl AsRef<u128> for GuidWrapper {
    fn as_ref(&self) -> &u128 {
        &self.0
    }
}

impl GuidWrapper {
    pub fn from_name(name: &str) -> Self {
        Self(native_guid::from_name(name).to_u128())
    }

    pub fn to_u128(&self) -> u128 {
        self.0
    }
}

#[doc(hidden)]
mod private {
    #[doc(hidden)]
    pub trait Sealed {}
}

#[doc(hidden)]
pub trait OutputMode: private::Sealed {}

#[doc(hidden)]
pub struct NormalOutput;
impl private::Sealed for NormalOutput {}
impl OutputMode for NormalOutput {}

#[doc(hidden)]
pub struct CommonSchemaOutput;
impl private::Sealed for CommonSchemaOutput {}
impl OutputMode for CommonSchemaOutput {}

#[doc(hidden)]
pub trait ProviderTraits {
    fn new<G>(
        provider_name: &str,
        provider_id: &G,
        provider_group: &Option<ProviderGroupType>,
        _default_keyword: u64,
    ) -> std::pin::Pin<std::sync::Arc<Self>>
    where
        for<'a> &'a G: Into<GuidWrapper>;

    fn supports_enable_callback() -> bool;

    fn is_valid_provider(provider_name: &str) -> Result<(), EtwError>;

    fn is_valid_group(provider_name: &str, value: &ProviderGroupType) -> Result<(), EtwError>;

    fn enabled(&self, level: &tracing_core::Level, keyword: u64) -> bool;
}

#[doc(hidden)]
pub trait EventWriter<OutMode: OutputMode> {
    #[allow(clippy::too_many_arguments)]
    fn span_start<'a, 'b, R>(
        self: std::pin::Pin<&Self>,
        span: &'b tracing_subscriber::registry::SpanRef<'a, R>,
        timestamp: std::time::SystemTime,
        activity_id: &[u8; 16],
        related_activity_id: &[u8; 16],
        fields: &'b [crate::values::span_values::FieldValueIndex],
        level: &tracing_core::Level,
        keyword: u64,
        event_tag: u32,
    ) where
        R: tracing_subscriber::registry::LookupSpan<'a>;

    #[allow(clippy::too_many_arguments)]
    fn span_stop<'a, 'b, R>(
        self: std::pin::Pin<&Self>,
        span: &'b tracing_subscriber::registry::SpanRef<'a, R>,
        start_stop_times: (std::time::SystemTime, std::time::SystemTime),
        activity_id: &[u8; 16],
        related_activity_id: &[u8; 16],
        fields: &'b [crate::values::span_values::FieldValueIndex],
        level: &tracing_core::Level,
        keyword: u64,
        event_tag: u32,
    ) where
        R: tracing_subscriber::registry::LookupSpan<'a>;

    #[allow(clippy::too_many_arguments)]
    fn write_record(
        self: std::pin::Pin<&Self>,
        timestamp: std::time::SystemTime,
        current_span: u64,
        parent_span: u64,
        event_name: &str,
        level: &tracing_core::Level,
        keyword: u64,
        event_tag: u32,
        event: &tracing::Event<'_>,
        otel_context: Option<([u8; 32], [u8; 16])>, // (trace_id, span_id) when opentelemetry feature is enabled
    );
}