Setup tracing with a typed configuration.

2026-11-03 16:10:20 +00:00 · 2022-11-24 10:16:59 +00:00
parent f776575c81
commit 5762dc3037
6 changed files with 126 additions and 10 deletions
@@ -0,0 +1,61 @@
+//
+// Copyright 2022 New Vector Ltd
+//
+// 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.
+//
+
+import MatrixRustSDK
+
+// This exposes the full Rust side tracing subscriber filter for more flexibility.
+// We can filter by level, crate and even file. See more details here:
+// https://docs.rs/tracing-subscriber/0.2.7/tracing_subscriber/filter/struct.EnvFilter.html#examples
+struct TracingConfiguration {
+    static var release = TracingConfiguration(common: .info)
+    static var debug = TracingConfiguration()
+    static var full = TracingConfiguration(common: .info,
+                                           crates: [
+                                               .hyper: .warn,
+                                               .sled: .warn,
+                                               .matrix_sdk_sled: .warn,
+                                               .matrix_sdk_http_client: .trace,
+                                               .matrix_sdk_ffi_uniffi_api: .warn,
+                                               .matrix_sdk_ffi: .warn,
+                                               .matrix_sdk_sliding_sync: .warn,
+                                               .matrix_sdk_base_sliding_sync: .warn
+                                           ])
+    
+    enum Target: String {
+        case hyper, sled, matrix_sdk_sled, matrix_sdk_ffi
+        case matrix_sdk_http_client = "matrix_sdk::http_client"
+        case matrix_sdk_ffi_uniffi_api = "matrix_sdk_ffi::uniffi_api"
+        case matrix_sdk_sliding_sync = "matrix_sdk::sliding_sync"
+        case matrix_sdk_base_sliding_sync = "matrix_sdk_base::sliding_sync"
+    }
+    
+    enum LogLevel: String { case warn, trace, info }
+    
+    var common = LogLevel.warn
+    var crates: [Target: LogLevel] = [
+        .hyper: .warn,
+        .sled: .warn,
+        .matrix_sdk_sled: .warn
+    ]
+    
+    var filter: String {
+        "\(common),\(crates.map { "\($0.key)=\($0.value)" }.joined(separator: ","))"
+    }
+}
+
+func setupTracing(configuration: TracingConfiguration) {
+    setupTracing(filter: configuration.filter)
+}