Skip to content

[feature/10.0] Move binding logic to descriptors #8126

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

Merged
merged 6 commits into from
Apr 21, 2025
Merged
Show file tree
Hide file tree
Changes from 5 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
Expand Up @@ -186,7 +186,7 @@ await TestHostHelper.CreateCollectionRulesHost(_outputHelper, rootOptions =>
Assert.Throws<OptionsValidationException>(() => host.Services.GetRequiredService<IOptionsMonitor<CollectionRuleOptions>>().Get(DefaultRuleName));
}, serviceCollection =>
{
serviceCollection.RegisterCollectionRuleAction<PassThroughActionFactory, PassThroughOptions>(nameof(PassThroughAction));
serviceCollection.RegisterCollectionRuleAction<PassThroughActionFactory, PassThroughOptions, PassThroughActionDescriptor>();
});
}

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,15 +14,15 @@ internal static class ActionsServiceCollectionExtensions
public static IServiceCollection RegisterTestAction(this IServiceCollection services, CallbackActionService callback)
{
services.AddSingleton(callback);
services.RegisterCollectionRuleAction<CallbackActionFactory, BaseRecordOptions>(CallbackAction.ActionName);
services.RegisterCollectionRuleAction<CallbackActionFactory, BaseRecordOptions, CallbackActionDescriptor>();

return services;
}

public static IServiceCollection RegisterDelayedTestAction(this IServiceCollection services, CallbackActionService callback)
{
services.AddSingleton(callback);
services.RegisterCollectionRuleAction<DelayedCallbackActionFactory, BaseRecordOptions>(DelayedCallbackAction.ActionName);
services.RegisterCollectionRuleAction<DelayedCallbackActionFactory, BaseRecordOptions, DelayedCallbackActionDescriptor>();

return services;
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,9 @@

using Microsoft.Diagnostics.Monitoring.WebApi;
using Microsoft.Diagnostics.Tools.Monitor.CollectionRules.Actions;
using Microsoft.Diagnostics.Tools.Monitor.CollectionRules.Configuration;
using Microsoft.Diagnostics.Tools.Monitor.CollectionRules.Options.Actions;
using Microsoft.Extensions.Configuration;
using System;
using System.Collections.Generic;
using System.Threading;
Expand Down Expand Up @@ -73,6 +75,20 @@ public ICollectionRuleAction Create(IProcessInfo processInfo, BaseRecordOptions
}
}

internal sealed class CallbackActionDescriptor : ICollectionRuleActionDescriptor
{
public string ActionName => CallbackAction.ActionName;
public Type OptionsType => typeof(BaseRecordOptions);
public Type FactoryType => typeof(CallbackActionFactory);

public void BindOptions(IConfigurationSection settingsSection, out object settings)
{
BaseRecordOptions options = new();
settingsSection.Bind(options);
settings = options;
}
}

internal sealed class DelayedCallbackAction : ICollectionRuleAction
{
public const string ActionName = nameof(DelayedCallbackAction);
Expand Down Expand Up @@ -111,6 +127,20 @@ public Task<CollectionRuleActionResult> WaitForCompletionAsync(CancellationToken
}
}

internal sealed class DelayedCallbackActionDescriptor : ICollectionRuleActionDescriptor
{
public string ActionName => DelayedCallbackAction.ActionName;
public Type OptionsType => typeof(BaseRecordOptions);
public Type FactoryType => typeof(DelayedCallbackActionFactory);

public void BindOptions(IConfigurationSection settingsSection, out object settings)
{
BaseRecordOptions options = new();
settingsSection.Bind(options);
settings = options;
}
}

internal sealed class CallbackActionService
{
public TimeProvider TimeProvider { get; }
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,10 @@

using Microsoft.Diagnostics.Monitoring.WebApi;
using Microsoft.Diagnostics.Tools.Monitor.CollectionRules.Actions;
using Microsoft.Diagnostics.Tools.Monitor.CollectionRules.Configuration;
using Microsoft.Diagnostics.Tools.Monitor.CollectionRules.Options.Actions;
using Microsoft.Extensions.Configuration;
using System;
using System.Collections.Generic;
using System.Threading;
using System.Threading.Tasks;
Expand Down Expand Up @@ -53,6 +56,20 @@ public Task<CollectionRuleActionResult> WaitForCompletionAsync(CancellationToken
}
}

internal sealed class PassThroughActionDescriptor : ICollectionRuleActionDescriptor
{
public string ActionName => nameof(PassThroughAction);
public Type OptionsType => typeof(PassThroughOptions);
public Type FactoryType => typeof(PassThroughActionFactory);

public void BindOptions(IConfigurationSection settingsSection, out object settings)
{
PassThroughOptions options = new();
settingsSection.Bind(options);
settings = options;
}
}

internal sealed record class PassThroughOptions : BaseRecordOptions
{
[ActionOptionsDependencyProperty]
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -135,7 +135,7 @@ await TestHostHelper.CreateCollectionRulesHost(_outputHelper, rootOptions =>
Assert.Equal("Output a1input3 trail", a2output3);
}, serviceCollection =>
{
serviceCollection.RegisterCollectionRuleAction<PassThroughActionFactory, PassThroughOptions>(nameof(PassThroughAction));
serviceCollection.RegisterCollectionRuleAction<PassThroughActionFactory, PassThroughOptions, PassThroughActionDescriptor>();
});
}

Expand Down Expand Up @@ -174,7 +174,7 @@ await TestHostHelper.CreateCollectionRulesHost(_outputHelper, rootOptions =>

}, serviceCollection =>
{
serviceCollection.RegisterCollectionRuleAction<PassThroughActionFactory, PassThroughOptions>(nameof(PassThroughAction));
serviceCollection.RegisterCollectionRuleAction<PassThroughActionFactory, PassThroughOptions, PassThroughActionDescriptor>();
});
}

Expand Down Expand Up @@ -211,7 +211,7 @@ await TestHostHelper.CreateCollectionRulesHost(_outputHelper, rootOptions =>
}, serviceCollection =>
{
serviceCollection.AddSingleton<TimeProvider, MockTimeProvider>();
serviceCollection.RegisterCollectionRuleAction<PassThroughActionFactory, PassThroughOptions>(nameof(PassThroughAction));
serviceCollection.RegisterCollectionRuleAction<PassThroughActionFactory, PassThroughOptions, PassThroughActionDescriptor>();
});
}

Expand Down Expand Up @@ -254,7 +254,7 @@ await TestHostHelper.CreateCollectionRulesHost(_outputHelper, rootOptions =>

}, serviceCollection =>
{
serviceCollection.RegisterCollectionRuleAction<PassThroughActionFactory, PassThroughOptions>(nameof(PassThroughAction));
serviceCollection.RegisterCollectionRuleAction<PassThroughActionFactory, PassThroughOptions, PassThroughActionDescriptor>();
}, loggingBuilder =>
{
loggingBuilder.AddProvider(new TestLoggerProvider(record));
Expand Down Expand Up @@ -290,7 +290,7 @@ await TestHostHelper.CreateCollectionRulesHost(_outputHelper, rootOptions =>

}, serviceCollection =>
{
serviceCollection.RegisterCollectionRuleAction<PassThroughActionFactory, PassThroughOptions>(nameof(PassThroughAction));
serviceCollection.RegisterCollectionRuleAction<PassThroughActionFactory, PassThroughOptions, PassThroughActionDescriptor>();
});
}

Expand Down Expand Up @@ -352,7 +352,7 @@ await TestHostHelper.CreateCollectionRulesHost(_outputHelper, rootOptions =>
Assert.Equal("Output a1input3 trail", a2output3);
}, serviceCollection =>
{
serviceCollection.RegisterCollectionRuleAction<PassThroughActionFactory, PassThroughOptions>(nameof(PassThroughAction));
serviceCollection.RegisterCollectionRuleAction<PassThroughActionFactory, PassThroughOptions, PassThroughActionDescriptor>();
});
}
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,9 @@
// The .NET Foundation licenses this file to you under the MIT license.

using Microsoft.Diagnostics.Monitoring.WebApi;
using Microsoft.Diagnostics.Tools.Monitor.CollectionRules.Configuration;
using Microsoft.Diagnostics.Tools.Monitor.CollectionRules.Triggers;
using Microsoft.Extensions.Configuration;
using System;
using System.Threading;
using System.Threading.Tasks;
Expand Down Expand Up @@ -59,6 +61,19 @@ private void NotifyHandler(object sender, EventArgs args)
}
}

internal sealed class ManualTriggerDescriptor : ICollectionRuleTriggerDescriptor
{
public string TriggerName => ManualTrigger.TriggerName;
public Type FactoryType => typeof(ManualTriggerFactory);
public Type OptionsType => null;

public bool TryBindOptions(IConfigurationSection settingsSection, out object settings)
{
settings = null;
return false;
}
}

internal sealed class ManualTriggerService
{
public event EventHandler NotifyStarted;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ internal static class TriggersServiceCollectionExtensions
public static IServiceCollection RegisterManualTrigger(this IServiceCollection services, ManualTriggerService service)
{
services.AddSingleton(service);
return services.RegisterCollectionRuleTrigger<ManualTriggerFactory>(ManualTrigger.TriggerName);
return services.RegisterCollectionRuleTrigger<ManualTriggerFactory, ManualTriggerDescriptor>();
}
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,9 @@

using Microsoft.Diagnostics.Monitoring.WebApi;
using Microsoft.Diagnostics.Monitoring.WebApi.Models;
using Microsoft.Diagnostics.Tools.Monitor.CollectionRules.Configuration;
using Microsoft.Diagnostics.Tools.Monitor.CollectionRules.Options.Actions;
using Microsoft.Extensions.Configuration;
using Microsoft.Extensions.DependencyInjection;
using System;
using System.ComponentModel.DataAnnotations;
Expand Down Expand Up @@ -66,4 +68,18 @@ protected override EgressOperation CreateArtifactOperation(CollectionRuleMetadat
}
}
}

internal sealed class CollectDumpActionDescriptor : ICollectionRuleActionDescriptor
{
public string ActionName => KnownCollectionRuleActions.CollectDump;
public Type FactoryType => typeof(CollectDumpActionFactory);
public Type OptionsType => typeof(CollectDumpOptions);

public void BindOptions(IConfigurationSection settingsSection, out object settings)
{
CollectDumpOptions options = new();
settingsSection.Bind(options);
settings = options;
}
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,9 @@

using Microsoft.Diagnostics.Monitoring.WebApi;
using Microsoft.Diagnostics.Tools.Monitor.CollectionRules.Options.Actions;
using Microsoft.Diagnostics.Tools.Monitor.CollectionRules.Configuration;
using Microsoft.Extensions.DependencyInjection;
using Microsoft.Extensions.Configuration;
using System;
using System.ComponentModel.DataAnnotations;
using Utils = Microsoft.Diagnostics.Monitoring.WebApi.Utilities;
Expand Down Expand Up @@ -55,4 +57,18 @@ protected override EgressOperation CreateArtifactOperation(CollectionRuleMetadat
return egressOperation;
}
}

internal sealed class CollectExceptionsActionDescriptor : ICollectionRuleActionDescriptor
{
public string ActionName => KnownCollectionRuleActions.CollectExceptions;
public Type FactoryType => typeof(CollectExceptionsActionFactory);
public Type OptionsType => typeof(CollectExceptionsOptions);

public void BindOptions(IConfigurationSection settingsSection, out object settings)
{
CollectExceptionsOptions options = new();
settingsSection.Bind(options);
settings = options;
}
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -3,10 +3,12 @@

using Microsoft.Diagnostics.Monitoring.WebApi;
using Microsoft.Diagnostics.Tools.Monitor.CollectionRules.Options.Actions;
using Microsoft.Extensions.Configuration;
using Microsoft.Extensions.DependencyInjection;
using System;
using System.ComponentModel.DataAnnotations;
using Utils = Microsoft.Diagnostics.Monitoring.WebApi.Utilities;
using Microsoft.Diagnostics.Tools.Monitor.CollectionRules.Configuration;

namespace Microsoft.Diagnostics.Tools.Monitor.CollectionRules.Actions
{
Expand Down Expand Up @@ -59,4 +61,18 @@ protected override EgressOperation CreateArtifactOperation(CollectionRuleMetadat
}
}
}

internal sealed class CollectGCDumpActionDescriptor : ICollectionRuleActionDescriptor
{
public string ActionName => KnownCollectionRuleActions.CollectGCDump;
public Type FactoryType => typeof(CollectGCDumpActionFactory);
public Type OptionsType => typeof(CollectGCDumpOptions);

public void BindOptions(IConfigurationSection settingsSection, out object settings)
{
CollectGCDumpOptions options = new();
settingsSection.Bind(options);
settings = options;
}
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,8 @@
using Microsoft.Diagnostics.Monitoring.WebApi;
using Microsoft.Diagnostics.Monitoring.WebApi.Models;
using Microsoft.Diagnostics.Tools.Monitor.CollectionRules.Options.Actions;
using Microsoft.Diagnostics.Tools.Monitor.CollectionRules.Configuration;
using Microsoft.Extensions.Configuration;
using Microsoft.Extensions.DependencyInjection;
using Microsoft.Extensions.Options;
using System;
Expand Down Expand Up @@ -95,4 +97,18 @@ protected override EgressOperation CreateArtifactOperation(CollectionRuleMetadat
}
}
}

internal sealed class CollectLiveMetricsActionDescriptor : ICollectionRuleActionDescriptor
{
public string ActionName => KnownCollectionRuleActions.CollectLiveMetrics;
public Type FactoryType => typeof(CollectLiveMetricsActionFactory);
public Type OptionsType => typeof(CollectLiveMetricsOptions);

public void BindOptions(IConfigurationSection settingsSection, out object settings)
{
CollectLiveMetricsOptions options = new();
settingsSection.Bind(options);
settings = options;
}
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,10 @@
using Microsoft.Diagnostics.Monitoring.Options;
using Microsoft.Diagnostics.Monitoring.WebApi;
using Microsoft.Diagnostics.Tools.Monitor.CollectionRules.Options.Actions;
using Microsoft.Diagnostics.Tools.Monitor.CollectionRules.Configuration;
using Microsoft.Extensions.DependencyInjection;
using Microsoft.Extensions.Logging;
using Microsoft.Extensions.Configuration;
using System;
using System.Collections.Generic;
using System.ComponentModel.DataAnnotations;
Expand Down Expand Up @@ -83,4 +85,18 @@ protected override EgressOperation CreateArtifactOperation(CollectionRuleMetadat
}
}
}

internal sealed class CollectLogsActionDescriptor : ICollectionRuleActionDescriptor
{
public string ActionName => KnownCollectionRuleActions.CollectLogs;
public Type FactoryType => typeof(CollectLogsActionFactory);
public Type OptionsType => typeof(CollectLogsOptions);

public void BindOptions(IConfigurationSection settingsSection, out object settings)
{
CollectLogsOptions options = new();
settingsSection.Bind(options);
settings = options;
}
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,9 @@

using Microsoft.Diagnostics.Monitoring.WebApi;
using Microsoft.Diagnostics.Tools.Monitor.CollectionRules.Options.Actions;
using Microsoft.Diagnostics.Tools.Monitor.CollectionRules.Configuration;
using Microsoft.Extensions.DependencyInjection;
using Microsoft.Extensions.Configuration;
using System;
using System.ComponentModel.DataAnnotations;
using Utils = Microsoft.Diagnostics.Monitoring.WebApi.Utilities;
Expand Down Expand Up @@ -71,4 +73,18 @@ private static StackFormat MapCallStackFormat(CallStackFormat format) =>
_ => throw new InvalidOperationException()
};
}

internal sealed class CollectStacksActionDescriptor : ICollectionRuleActionDescriptor
{
public string ActionName => KnownCollectionRuleActions.CollectStacks;
public Type FactoryType => typeof(CollectStacksActionFactory);
public Type OptionsType => typeof(CollectStacksOptions);

public void BindOptions(IConfigurationSection settingsSection, out object settings)
{
CollectStacksOptions options = new();
settingsSection.Bind(options);
settings = options;
}
}
}
Loading