Skip to content
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.

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

Trace Tag Replacer: functionality to scrub sensitive data from spans #111

Merged
merged 27 commits into from
Feb 23, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
27 commits
Select commit Hold shift + click to select a range
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
2 changes: 2 additions & 0 deletions .github/CODEOWNERS
Validating CODEOWNERS rules …
Original file line number Diff line number Diff line change
Expand Up @@ -11,3 +11,5 @@ NOTICE @Datadog/libdatadog
rustfmt.toml @Datadog/libdatadog
README.md @Datadog/libdatadog
trace-normalization @Datadog/serverless
trace-obfuscation @Datadog/serverless
trace-protobuf @Datadog/serverless
130 changes: 125 additions & 5 deletions Cargo.lock

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

1 change: 1 addition & 0 deletions Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@ members = [
"tools",
"tools/cc_utils",
"trace-normalization",
"trace-obfuscation",
"spawn_worker",
"tests/spawn_from_lib"
]
Expand Down
2 changes: 1 addition & 1 deletion LICENSE-3rdparty.yml
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
root_name: "datadog-profiling, ddcommon, datadog-profiling-ffi, ddcommon-ffi, ddtelemetry, ddtelemetry-ffi, tools, cc_utils, datadog-trace-normalization, spawn_worker"
root_name: "datadog-profiling, ddcommon, datadog-profiling-ffi, ddcommon-ffi, ddtelemetry, ddtelemetry-ffi, tools, cc_utils, datadog-trace-normalization, datadog-trace-protobuf, datadog-trace-obfuscation, spawn_worker"
third_party_libraries:
- package_name: aho-corasick
package_version: 0.7.20
Expand Down
4 changes: 3 additions & 1 deletion tools/docker/Dockerfile.build
Original file line number Diff line number Diff line change
Expand Up @@ -78,12 +78,14 @@ COPY "ddtelemetry-ffi/Cargo.toml" "ddtelemetry-ffi/"
COPY "profiling/Cargo.toml" "profiling/"
COPY "profiling-ffi/Cargo.toml" "profiling-ffi/"
COPY "trace-normalization/Cargo.toml" "trace-normalization/"
COPY "trace-obfuscation/Cargo.toml" "trace-obfuscation/"
COPY "trace-protobuf/Cargo.toml" "trace-protobuf/"
COPY "tools/Cargo.toml" "tools/"
COPY "tools/cc_utils/Cargo.toml" "tools/cc_utils/"
COPY "spawn_worker/Cargo.toml" "spawn_worker/"
COPY "tests/spawn_from_lib/Cargo.toml" "tests/spawn_from_lib/"
RUN find -name "Cargo.toml" | sed -e s#Cargo.toml#src/lib.rs#g | xargs -n 1 sh -c 'mkdir -p $(dirname $1); touch $1; echo $1' create_stubs
RUN echo ddtelemetry/benches/ipc.rs tools/src/bin/dedup_headers.rs ddtelemetry/examples/tm-worker-test.rs | xargs -n 1 sh -c 'mkdir -p $(dirname $1); touch $1; echo $1' create_stubs
RUN echo trace-obfuscation/benches/replace_trace_tags_bench.rs ddtelemetry/benches/ipc.rs tools/src/bin/dedup_headers.rs ddtelemetry/examples/tm-worker-test.rs | xargs -n 1 sh -c 'mkdir -p $(dirname $1); touch $1; echo $1' create_stubs

# cache dependencies
RUN cargo fetch --locked
Expand Down
2 changes: 1 addition & 1 deletion trace-normalization/Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,8 @@ authors = ["David Lee <david.lee@datadoghq.com>"]
edition = "2021"

[dependencies]
prost = "0.11.6"
anyhow = "1.0"
datadog-trace-protobuf = { path = "../trace-protobuf" }

[dev-dependencies]
rand = "0.8.5"
Expand Down
4 changes: 0 additions & 4 deletions trace-normalization/src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -5,10 +5,6 @@

#![deny(clippy::all)]

pub mod pb {
include!("./pb/pb.rs");
}

pub mod normalizer;

pub mod normalize_utils;
4 changes: 2 additions & 2 deletions trace-normalization/src/normalizer.rs
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
// Datadog, Inc.

use crate::normalize_utils;
use crate::pb;
use datadog_trace_protobuf::pb;
use std::time::SystemTime;

const MAX_TYPE_LEN: usize = 100;
Expand Down Expand Up @@ -177,7 +177,7 @@ mod tests {
use crate::normalize_utils;
use crate::normalizer;
use crate::normalizer::DEFAULT_SPAN_NAME;
use crate::pb;
use datadog_trace_protobuf::pb;
use rand::Rng;
use std::collections::HashMap;
use std::time::SystemTime;
Expand Down
18 changes: 18 additions & 0 deletions trace-obfuscation/Cargo.toml
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
[package]
name = "datadog-trace-obfuscation"
version = "2.0.0"
authors = ["David Lee <david.lee@datadoghq.com>"]
edition = "2021"

[dependencies]
anyhow = "1.0"
regex = "1"
datadog-trace-protobuf = { path = "../trace-protobuf" }

[dev-dependencies]
duplicate = "0.4.1"
criterion = "0.4"

[[bench]]
name = "replace_trace_tags_bench"
harness = false
59 changes: 59 additions & 0 deletions trace-obfuscation/benches/replace_trace_tags_bench.rs
Original file line number Diff line number Diff line change
@@ -0,0 +1,59 @@
// Unless explicitly stated otherwise all files in this repository are licensed
// under the Apache License Version 2.0. This product includes software
// developed at Datadog (https://www.datadoghq.com/). Copyright 2023-Present
// Datadog, Inc.

use std::collections::HashMap;

use criterion::{black_box, criterion_group, criterion_main, Criterion};
use datadog_trace_obfuscation::replacer;
use datadog_trace_protobuf::pb;

fn criterion_benchmark(c: &mut Criterion) {
let rules: &[replacer::ReplaceRule] = &replacer::parse_rules_from_string(&[
["http.url", "(token/)([^/]*)", "${1}?"],
["http.url", "guid", "[REDACTED]"],
["*", "(token/)([^/]*)", "${1}?"],
["*", "this", "that"],
["custom.tag", "(/foo/bar/).*", "${1}extra"],
["resource.name", "prod", "stage"],
])
.unwrap();

let span_1 = pb::Span {
duration: 10000000,
error: 0,
resource: "GET /some/raclette".to_string(),
service: "django".to_string(),
name: "django.controller".to_string(),
span_id: 123,
start: 1448466874000000000,
trace_id: 424242,
meta: HashMap::from([
("resource.name".to_string(), "this is prod".to_string()),
(
"http.url".to_string(),
"some/[REDACTED]/token/abcdef/abc".to_string(),
),
(
"other.url".to_string(),
"some/guid/token/abcdef/abc".to_string(),
),
("custom.tag".to_string(), "/foo/bar/foo".to_string()),
]),
metrics: HashMap::from([("cheese_weight".to_string(), 100000.0)]),
parent_id: 1111,
r#type: "http".to_string(),
meta_struct: HashMap::new(),
};

let mut trace = [span_1];
c.bench_function("replace_trace_tags_bench", |b| {
b.iter(|| {
replacer::replace_trace_tags(black_box(&mut trace), black_box(rules));
})
});
}

criterion_group!(benches, criterion_benchmark);
criterion_main!(benches);
8 changes: 8 additions & 0 deletions trace-obfuscation/src/lib.rs
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
// Unless explicitly stated otherwise all files in this repository are licensed
// under the Apache License Version 2.0. This product includes software
// developed at Datadog (https://www.datadoghq.com/). Copyright 2023-Present
// Datadog, Inc.

#![deny(clippy::all)]
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

is this clippy setting still required?


pub mod replacer;
Loading