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

Adds extension methods for TrackEvent and TrackMetric #348

Merged
merged 5 commits into from
Jan 16, 2024
Merged
Changes from 2 commits
Commits
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
Original file line number Diff line number Diff line change
@@ -0,0 +1,75 @@
// Copyright (c) Microsoft Corporation.
// Licensed under the MIT license.
//
using Microsoft.ApplicationInsights;
using Microsoft.ApplicationInsights.DataContracts;
using Microsoft.FeatureManagement.FeatureFilters;

namespace Microsoft.FeatureManagement.Telemetry.ApplicationInsights
{
/// <summary>
/// Provides extension methods for tracking events with TargetingContext.
Copy link
Contributor

@zhiyuanliang-ms zhiyuanliang-ms Jan 9, 2024

Choose a reason for hiding this comment

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

Suggested change
/// Provides extension methods for tracking events with TargetingContext.
/// Provides extension methods for tracking events with <see cref="TargetingContext"/>.

The same suggestion for other occurrences of the word "TargetingContext"

Copy link
Contributor

@zhiyuanliang-ms zhiyuanliang-ms Jan 9, 2024

Choose a reason for hiding this comment

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

As mentioned in #347 (comment)
I understand we will use TargetingContext instead of ITargetingContext here. But I am wondering why we use ITargetingContext for ContextualTargetingFilter. It seems like ContextualTargetingFilter is the only place we use ITargetingContext.

Copy link
Member

Choose a reason for hiding this comment

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

Contextual filters describe an interface that they handle. This allows a single app context type to satisfy multiple contextual feature filters.

Copy link
Contributor Author

@rossgrambo rossgrambo Jan 9, 2024

Choose a reason for hiding this comment

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

*Removing my comment in favor of Jimmy's ^

/// </summary>
public static class ApplicationInsightsTelemetryExtensions
rossgrambo marked this conversation as resolved.
Show resolved Hide resolved
{
/// <summary>
/// Extension method to track an event with <see cref="TargetingContext"/>.
/// </summary>
public static void TrackEvent(this TelemetryClient telemetryClient, string eventName, TargetingContext targetingContext, IDictionary<string, string> properties = null, IDictionary<string, double> metrics = null)
{
if (properties == null)
{
properties = new Dictionary<string, string>();
}

properties["TargetingId"] = targetingContext.UserId;

telemetryClient.TrackEvent(eventName, properties, metrics);
}

/// <summary>
/// Extension method to track an <see cref="EventTelemetry"/> with <see cref="TargetingContext"/>.
/// </summary>
public static void TrackEvent(this TelemetryClient telemetryClient, EventTelemetry telemetry, TargetingContext targetingContext)
{
if (telemetry == null)
rossgrambo marked this conversation as resolved.
Show resolved Hide resolved
{
telemetry = new EventTelemetry();
}

telemetry.Properties["TargetingId"] = targetingContext.UserId;
rossgrambo marked this conversation as resolved.
Show resolved Hide resolved

telemetryClient.TrackEvent(telemetry);
}

/// <summary>
/// Extension method to track a metric with <see cref="TargetingContext"/>.
/// </summary>
public static void TrackMetric(this TelemetryClient telemetryClient, string name, double value, TargetingContext targetingContext, IDictionary<string, string> properties = null)
rossgrambo marked this conversation as resolved.
Show resolved Hide resolved
{
if (properties == null)
{
properties = new Dictionary<string, string>();
}

properties["TargetingId"] = targetingContext.UserId;

telemetryClient.TrackMetric(name, value, properties);
}

/// <summary>
/// Extension method to track a <see cref="MetricTelemetry"/> with <see cref="TargetingContext"/>.
/// </summary>
public static void TrackMetric(this TelemetryClient telemetryClient, MetricTelemetry telemetry, TargetingContext targetingContext)
{
if (telemetry == null)
{
telemetry = new MetricTelemetry();
}

telemetry.Properties["TargetingId"] = targetingContext.UserId;

telemetryClient.TrackMetric(telemetry);
}
}
}