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.

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

Jump to bottom

Hash all instances of module ids in device telemetry #3442

Merged
merged 2 commits into from
Aug 24, 2020
Merged

Hash all instances of module ids in device telemetry #3442

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
f30f5d8
hash to from
lfitchett Aug 24, 2020
29193d6
add tests
lfitchett Aug 24, 2020
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
28 changes: 19 additions & 9 deletions edge-agent/src/Microsoft.Azure.Devices.Edge.Agent.Diagnostics/MetricsWorker.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,13 @@ public MetricsWorker(IMetricsScraper scraper, IMetricsStorage storage, IMetricsP
this.metricFilter = new MetricTransformer()
.AddAllowedTags(new KeyValuePair<string, string>(MetricsConstants.MsTelemetry, true.ToString()))
.AddTagsToRemove(MetricsConstants.MsTelemetry, MetricsConstants.IotHubLabel, MetricsConstants.DeviceIdLabel)
.AddTagsToModify(("id", this.ReplaceDeviceId), ("module_name", name => name.CreateSha256()));
.AddTagsToModify(
Copy link
Contributor

Choose a reason for hiding this comment

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

tests?

("id", this.ReplaceDeviceId),
("module_name", this.ReplaceModuleId),
("to", name => name.CreateSha256()),
("from", name => name.CreateSha256()),
("to_route_input", name => name.CreateSha256()),
("from_route_output", name => name.CreateSha256()));
}

public void Start(TimeSpan scrapingInterval, TimeSpan uploadInterval)
Expand Down Expand Up @@ -143,20 +149,24 @@ string ReplaceDeviceId(string id)
string[] parts = id.Split('/');
if (parts.Length == 2)
{
parts[0] = deviceIdReplacement;

if (!parts[1].StartsWith("$")) // Don't hash system modules
{
parts[1] = parts[1].CreateSha256(); // Hash moduleId
}

return $"{parts[0]}/{parts[1]}";
return $"{deviceIdReplacement}/{this.ReplaceModuleId(parts[1])}";
}

// Id is just 'deviceId'
return deviceIdReplacement;
}

string ReplaceModuleId(string id)
{
// Don't hash system modules
if (id.StartsWith("$"))
{
return id;
}

return id.CreateSha256();
}

public void Dispose()
{
this.scrape?.Dispose();
Expand Down
88 changes: 88 additions & 0 deletions edge-agent/test/Microsoft.Azure.Devices.Edge.Agent.Diagnostics.Test/MetricsWorkerTest.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -52,6 +52,94 @@ public async Task TestScraping()
Assert.Equal(testData.Select(d => (d.TimeGeneratedUtc, d.Name, d.Value)), storedValues.Select(d => (d.TimeGeneratedUtc, d.Name, d.Value)));
}

[Fact]
public async Task TestTagHashing()
{
/* Setup mocks */
Metric[] testData = new Metric[0];
var scraper = new Mock<IMetricsScraper>();
scraper.Setup(s => s.ScrapeEndpointsAsync(CancellationToken.None)).ReturnsAsync(() => testData);

var storage = new Mock<IMetricsStorage>();
IEnumerable<Metric> storedValues = Enumerable.Empty<Metric>();
storage.Setup(s => s.StoreMetricsAsync(It.IsAny<IEnumerable<Metric>>())).Callback((Action<IEnumerable<Metric>>)(data => storedValues = data)).Returns(Task.CompletedTask);

var uploader = new Mock<IMetricsPublisher>();

MetricsWorker worker = new MetricsWorker(scraper.Object, storage.Object, uploader.Object);

// test id hash
var tags = new Dictionary<string, string>
{
{ "ms_telemetry", true.ToString() },
{ "not_hashed", "1" },
{ "id", "my_device1/my_module_1" },
};
testData = new Metric[] { new Metric(DateTime.UtcNow, "test_metric", 0, tags) };
await worker.Scrape(CancellationToken.None);

Assert.Contains(new KeyValuePair<string, string>("not_hashed", "1"), storedValues.Single().Tags);
Assert.Contains(new KeyValuePair<string, string>("id", "device/Ut4Ug5Wg2qMCvwtG08RIi0k10DkoNMqQ7AmTUKy/pMs="), storedValues.Single().Tags);

// test id not hash edgeAgent
tags = new Dictionary<string, string>
{
{ "ms_telemetry", true.ToString() },
{ "not_hashed", "1" },
{ "id", "my_device1/$edgeAgent" },
};
testData = new Metric[] { new Metric(DateTime.UtcNow, "test_metric", 0, tags) };
await worker.Scrape(CancellationToken.None);

Assert.Contains(new KeyValuePair<string, string>("not_hashed", "1"), storedValues.Single().Tags);
Assert.Contains(new KeyValuePair<string, string>("id", "device/$edgeAgent"), storedValues.Single().Tags);

// test module_name hash
tags = new Dictionary<string, string>
{
{ "ms_telemetry", true.ToString() },
{ "not_hashed", "1" },
{ "module_name", "my_module" },
};
testData = new Metric[] { new Metric(DateTime.UtcNow, "test_metric", 0, tags) };
await worker.Scrape(CancellationToken.None);

Assert.Contains(new KeyValuePair<string, string>("not_hashed", "1"), storedValues.Single().Tags);
Assert.Contains(new KeyValuePair<string, string>("module_name", "rPbHx4uTZz/x2x8rSxfPxL4egT61y7B1dlsSgWpHh6s="), storedValues.Single().Tags);

// test module name not hash edgeAgent
tags = new Dictionary<string, string>
{
{ "ms_telemetry", true.ToString() },
{ "not_hashed", "1" },
{ "module_name", "$edgeAgent" },
};
testData = new Metric[] { new Metric(DateTime.UtcNow, "test_metric", 0, tags) };
await worker.Scrape(CancellationToken.None);

Assert.Contains(new KeyValuePair<string, string>("not_hashed", "1"), storedValues.Single().Tags);
Assert.Contains(new KeyValuePair<string, string>("module_name", "$edgeAgent"), storedValues.Single().Tags);

// test to from hash
tags = new Dictionary<string, string>
{
{ "ms_telemetry", true.ToString() },
{ "not_hashed", "1" },
{ "to", "my_module_1" },
{ "from", "my_module_2" },
{ "to_route_input", "my_module_1" },
{ "from_route_output", "my_module_2" },
};
testData = new Metric[] { new Metric(DateTime.UtcNow, "test_metric", 0, tags) };
await worker.Scrape(CancellationToken.None);

Assert.Contains(new KeyValuePair<string, string>("not_hashed", "1"), storedValues.Single().Tags);
Assert.Contains(new KeyValuePair<string, string>("to", "Ut4Ug5Wg2qMCvwtG08RIi0k10DkoNMqQ7AmTUKy/pMs="), storedValues.Single().Tags);
Assert.Contains(new KeyValuePair<string, string>("from", "t+TD1s4uqQrTHY7Xe/lJqasX1biQ9yK4ev5ZnScMcpk="), storedValues.Single().Tags);
Assert.Contains(new KeyValuePair<string, string>("to_route_input", "Ut4Ug5Wg2qMCvwtG08RIi0k10DkoNMqQ7AmTUKy/pMs="), storedValues.Single().Tags);
Assert.Contains(new KeyValuePair<string, string>("from_route_output", "t+TD1s4uqQrTHY7Xe/lJqasX1biQ9yK4ev5ZnScMcpk="), storedValues.Single().Tags);
}

[Fact]
public async Task TestBasicUploading()
{
Expand Down