Skip to content

(GH-1061) Add dsc-lib-telemetry crate #1663

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
Mikey Lombardi (He/Him) (michaeltlombardi) wants to merge 4 commits into
base: main
Choose a base branch
from
Open

(GH-1061) Add dsc-lib-telemetry crate #1663

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
f02dc0e
(GH-1061) Init telemetry crate
michaeltlombardi Jul 8, 2026
b760d70
(GH-1061) Encapsulate tracing initialization in telemetry crate
michaeltlombardi Aug 10, 2026
3b6b7c2
(MAINT) Drop Erroneous modifications to build data
michaeltlombardi Aug 10, 2026
c61176d
(MAINT) Address PR comments
michaeltlombardi Aug 10, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 11 additions & 0 deletions Cargo.lock
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

114 changes: 60 additions & 54 deletions Cargo.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,29 +5,30 @@ resolver = "2"
members = [
"dsc",
"dsc-bicep-ext",
"lib/dsc-lib",
"lib/dsc-lib-jsonschema",
"grammars/tree-sitter-dscexpression",
"grammars/tree-sitter-ssh-server-config",
"lib/dsc-lib-jsonschema-macros",
"resources/dscecho",
"lib/dsc-lib-jsonschema",
"lib/dsc-lib-osinfo",
"resources/osinfo",
"lib/dsc-lib-pal",
"resources/process",
"resources/registry",
"lib/dsc-lib-registry",
"resources/runcommandonset",
"lib/dsc-lib-security_context",
"lib/dsc-lib-telemetry",
"lib/dsc-lib",
"resources/dism_dsc",
"resources/dscecho",
"resources/osinfo",
"resources/process",
"resources/registry",
"resources/runcommandonset",
"resources/sshdconfig",
"resources/WindowsUpdate",
"resources/windows_service",
"resources/windows_firewall",
"resources/windows_service",
"resources/WindowsUpdate",
"tools/dsctest",
"tools/test_group_resource",
"grammars/tree-sitter-dscexpression",
"grammars/tree-sitter-ssh-server-config",
"y2j",
"xtask"
"xtask",
"y2j"
]

# This value is modified by the `Set-DefaultWorkspaceMember` helper.
Expand All @@ -36,29 +37,30 @@ members = [
default-members = [
"dsc",
"dsc-bicep-ext",
"lib/dsc-lib",
"lib/dsc-lib-jsonschema",
"grammars/tree-sitter-dscexpression",
"grammars/tree-sitter-ssh-server-config",
"lib/dsc-lib-jsonschema-macros",
"resources/dscecho",
"lib/dsc-lib-jsonschema",
"lib/dsc-lib-osinfo",
"resources/osinfo",
"lib/dsc-lib-pal",
"resources/process",
"resources/registry",
"lib/dsc-lib-registry",
"resources/runcommandonset",
"lib/dsc-lib-security_context",
"lib/dsc-lib-telemetry",
"lib/dsc-lib",
"resources/dism_dsc",
"resources/dscecho",
"resources/osinfo",
"resources/process",
"resources/registry",
"resources/runcommandonset",
"resources/sshdconfig",
"resources/WindowsUpdate",
"resources/windows_service",
"resources/windows_firewall",
"resources/windows_service",
"resources/WindowsUpdate",
"tools/dsctest",
"tools/test_group_resource",
"grammars/tree-sitter-dscexpression",
"grammars/tree-sitter-ssh-server-config",
"y2j",
"xtask"
"xtask",
"y2j"
]

[workspace.metadata.groups]
Expand All @@ -68,69 +70,72 @@ default-members = [
Windows = [
"dsc",
"dsc-bicep-ext",
"lib/dsc-lib",
"lib/dsc-lib-jsonschema",
"grammars/tree-sitter-dscexpression",
"grammars/tree-sitter-ssh-server-config",
"lib/dsc-lib-jsonschema-macros",
"resources/dscecho",
"lib/dsc-lib-jsonschema",
"lib/dsc-lib-osinfo",
"resources/osinfo",
"lib/dsc-lib-pal",
"lib/dsc-lib-registry",
"lib/dsc-lib-security_context",
"lib/dsc-lib-telemetry",
"lib/dsc-lib",
"resources/dism_dsc",
"resources/dscecho",
"resources/osinfo",
"resources/process",
"resources/registry",
"lib/dsc-lib-registry",
"resources/runcommandonset",
"lib/dsc-lib-security_context",
"resources/sshdconfig",
"resources/WindowsUpdate",
"resources/windows_service",
"resources/windows_firewall",
"resources/windows_service",
"resources/WindowsUpdate",
"tools/dsctest",
"tools/test_group_resource",
"grammars/tree-sitter-dscexpression",
"grammars/tree-sitter-ssh-server-config",
"y2j",
"xtask",
"resources/dism_dsc"
"y2j"
]
macOS = [
"dsc",
"dsc-bicep-ext",
"lib/dsc-lib",
"lib/dsc-lib-jsonschema",
"grammars/tree-sitter-dscexpression",
"grammars/tree-sitter-ssh-server-config",
"lib/dsc-lib-jsonschema-macros",
"resources/dscecho",
"lib/dsc-lib-jsonschema",
"lib/dsc-lib-osinfo",
"lib/dsc-lib-security_context",
"lib/dsc-lib-telemetry",
"lib/dsc-lib",
"resources/dscecho",
"resources/osinfo",
"resources/process",
"resources/runcommandonset",
"lib/dsc-lib-security_context",
"resources/sshdconfig",
"tools/dsctest",
"tools/test_group_resource",
"grammars/tree-sitter-dscexpression",
"grammars/tree-sitter-ssh-server-config",
"xtask",
"y2j",
"xtask"
]
Linux = [
"dsc",
"dsc-bicep-ext",
"lib/dsc-lib",
"lib/dsc-lib-jsonschema",
"grammars/tree-sitter-dscexpression",
"grammars/tree-sitter-ssh-server-config",
"lib/dsc-lib-jsonschema-macros",
"resources/dscecho",
"lib/dsc-lib-jsonschema",
"lib/dsc-lib-osinfo",
"lib/dsc-lib-security_context",
"lib/dsc-lib-telemetry",
"lib/dsc-lib",
"resources/dscecho",
"resources/osinfo",
"resources/process",
"resources/runcommandonset",
"lib/dsc-lib-security_context",
"resources/sshdconfig",
"tools/dsctest",
"tools/test_group_resource",
"grammars/tree-sitter-dscexpression",
"grammars/tree-sitter-ssh-server-config",
"y2j",
"xtask"
"xtask",
"y2j"
]

[profile.release]
Expand Down Expand Up @@ -299,7 +304,8 @@ dsc-lib = { path = "lib/dsc-lib" }
dsc-lib-jsonschema = { path = "lib/dsc-lib-jsonschema" }
dsc-lib-jsonschema-macros = { path = "lib/dsc-lib-jsonschema-macros" }
dsc-lib-osinfo = { path = "lib/dsc-lib-osinfo" }
dsc-lib-registry = { path = "lib/dsc-lib-registry" }
dsc-lib-security_context = { path = "lib/dsc-lib-security_context" }
dsc-lib-telemetry = { path = "lib/dsc-lib-telemetry" }
tree-sitter-dscexpression = { path = "grammars/tree-sitter-dscexpression" }
dsc-lib-registry = { path = "lib/dsc-lib-registry" }
tree-sitter-ssh-server-config = { path = "grammars/tree-sitter-ssh-server-config" }
1 change: 1 addition & 0 deletions dsc/Cargo.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,3 +37,4 @@ tracing-subscriber = { workspace = true }
tracing-indicatif = { workspace = true }
# workspace crate dependencies
dsc-lib = { workspace = true }
dsc-lib-telemetry = { workspace = true }
63 changes: 12 additions & 51 deletions dsc/src/util.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,6 +46,7 @@ use dsc_lib::{
parse_input_to_json,
},
};
use dsc_lib_telemetry::{StderrFormat, basic::{BasicTracingOptions}};
use path_absolutize::Absolutize;
use rust_i18n::t;
use schemars::{Schema, schema_for};
Expand All @@ -62,8 +63,6 @@ use syntect::{
util::{as_24_bit_terminal_escaped, LinesWithEndings}
};
use tracing::{Level, debug, error, info, warn, trace};
use tracing_subscriber::{filter::EnvFilter, layer::SubscriberExt, Layer};
use tracing_indicatif::IndicatifLayer;

pub const EXIT_SUCCESS: i32 = 0;
pub const EXIT_INVALID_ARGS: i32 = 1;
Expand Down Expand Up @@ -327,22 +326,10 @@ pub fn write_object(json: &str, format: Option<&OutputFormat>, include_separator

#[allow(clippy::too_many_lines)]
pub fn enable_tracing(trace_level_arg: Option<&TraceLevel>, trace_format_arg: Option<&TraceFormat>) {

let mut policy_is_used = false;
let mut tracing_setting = TracingSetting::default();

let default_filter = EnvFilter::try_from_default_env()
.or_else(|_| EnvFilter::try_new("warn"))
.unwrap_or_default()
.add_directive(Level::WARN.into());
let default_indicatif_layer = IndicatifLayer::new();
let default_layer = tracing_subscriber::fmt::Layer::default().with_writer(default_indicatif_layer.get_stderr_writer());
let default_fmt = default_layer
.with_ansi(true)
.with_level(true)
.boxed();
let default_subscriber = tracing_subscriber::Registry::default().with(default_fmt).with(default_filter).with(default_indicatif_layer);
let default_guard = tracing::subscriber::set_default(default_subscriber);
let default_guard = dsc_lib_telemetry::basic::BasicTracingOptions::init_default_guard();

// read setting/policy from files
if let Ok(v) = get_setting("tracing") {
Expand Down Expand Up @@ -399,44 +386,18 @@ pub fn enable_tracing(trace_level_arg: Option<&TraceLevel>, trace_format_arg: Op
TraceLevel::Debug => Level::DEBUG,
TraceLevel::Trace => Level::TRACE,
};

// enable tracing
let filter = EnvFilter::try_from_default_env()
.or_else(|_| EnvFilter::try_new("warn"))
.unwrap_or_default()
.add_directive(tracing_level.into());
let indicatif_layer = IndicatifLayer::new();
let layer = tracing_subscriber::fmt::Layer::default().with_writer(indicatif_layer.get_stderr_writer());
let with_source = tracing_level == Level::DEBUG || tracing_level == Level::TRACE;
let fmt = match tracing_setting.format {
TraceFormat::Default => {
layer
.with_ansi(true)
.with_level(true)
.with_target(with_source)
.with_line_number(with_source)
.boxed()
},
TraceFormat::Plaintext => {
layer
.with_ansi(false)
.with_level(true)
.with_target(with_source)
.with_line_number(with_source)
.boxed()
},
TraceFormat::Json | TraceFormat::PassThrough => {
layer
.with_ansi(false)
.with_level(true)
.with_target(with_source)
.with_line_number(with_source)
.json()
.boxed()
},
// convert to 'dsc-lib-telemetry' crate type
let stderr_format = match tracing_setting.format {
TraceFormat::Default => StderrFormat::Default,
TraceFormat::Plaintext => StderrFormat::Plaintext,
TraceFormat::Json | TraceFormat::PassThrough => StderrFormat::Json,
};

let subscriber = tracing_subscriber::Registry::default().with(fmt).with(filter).with(indicatif_layer);
// enable tracing
let subscriber = BasicTracingOptions {
tracing_level,
stderr_format
}.init_subscriber();

drop(default_guard);
if tracing::subscriber::set_global_default(subscriber).is_err() {
Expand Down
5 changes: 5 additions & 0 deletions lib/dsc-lib-telemetry/.project.data.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
{
"Name": "dsc-lib-telemetry",
"Kind": "Library",
"IsRust": true
}
13 changes: 13 additions & 0 deletions lib/dsc-lib-telemetry/Cargo.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
[package]
name = "dsc-lib-telemetry"
version = "0.0.0"
edition = "2024"

[lib]
doctest = false # Disable doc tests by default for compilation speed

[dependencies]
thiserror = { workspace = true }
tracing = { workspace = true }
tracing-indicatif = { workspace = true }
tracing-subscriber = { workspace = true }
Loading
Loading