Skip to content

Manifest Models, ConfigurationContent Extensions #13

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

Merged
merged 10 commits into from
Apr 25, 2025
Merged

Manifest Models, ConfigurationContent Extensions #13

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
2ccde69
chore: suppress CA1308
Apr 23, 2025
3643ce1
feat: add EdgeHubConstants
Apr 23, 2025
abbc623
feat: add ModuleStatus and RestartPolicy enums
Apr 23, 2025
3238cee
refactor: rename DeviceTwinPropertyNames to PropertyNames and extend …
Apr 23, 2025
30186a9
chore: remove unused record EdgeAgentDesiredProperties
Apr 23, 2025
08cc7bd
refactor: replace hardcoded values in AzureIoTHubService with Propert…
Apr 23, 2025
a76ef82
feat: add Manifest models
Apr 23, 2025
44901e3
feat: add ConfigurationContent extensions
Apr 23, 2025
a0943e5
feat: add EdgeHubRouteConverter for supporting short-hand routes or o…
Apr 25, 2025
3694505
chore: update template parameters in source-generated logging in sele…
Apr 25, 2025
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
1 change: 1 addition & 0 deletions .editorconfig
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -581,6 +581,7 @@ dotnet_diagnostic.SA1402.severity = none #
dotnet_diagnostic.SA1615.severity = none #

dotnet_diagnostic.CA1002.severity = none #
dotnet_diagnostic.CA1308.severity = none # Normalize strings to uppercase https://learn.microsoft.com/en-us/dotnet/fundamentals/code-analysis/quality-rules/ca1308
dotnet_diagnostic.CA2007.severity = none # Consider calling ConfigureAwait on the awaited task

dotnet_diagnostic.MA0004.severity = none # Use Task.ConfigureAwait(false) as the current SynchronizationContext is not needed
Expand Down
32 changes: 16 additions & 16 deletions ...dules/opcpublishernodemanagermodule/OpcPublisherNodeManagerModuleServiceLoggerMessages.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ public sealed partial class OpcPublisherNodeManagerModuleService
[LoggerMessage(
EventId = Atc.Azure.IoTEdge.LoggingEventIdConstants.ModuleStarted,
Level = LogLevel.Trace,
Message = "{callerMethodName}({callerLineNumber}) - Successfully started module '{moduleName}'.")]
Message = "{CallerMethodName}({CallerLineNumber}) - Successfully started module '{ModuleName}'.")]
private partial void LogModuleStarted(
string moduleName,
[CallerMemberName] string callerMethodName = "",
Expand All @@ -19,7 +19,7 @@ private partial void LogModuleStarted(
[LoggerMessage(
EventId = Atc.Azure.IoTEdge.LoggingEventIdConstants.ModuleStopping,
Level = LogLevel.Trace,
Message = "{callerMethodName}({callerLineNumber}) - Stopping module '{moduleName}'.")]
Message = "{CallerMethodName}({CallerLineNumber}) - Stopping module '{ModuleName}'.")]
private partial void LogModuleStopping(
string moduleName,
[CallerMemberName] string callerMethodName = "",
Expand All @@ -28,7 +28,7 @@ private partial void LogModuleStopping(
[LoggerMessage(
EventId = Atc.Azure.IoTEdge.LoggingEventIdConstants.ModuleStopped,
Level = LogLevel.Trace,
Message = "{callerMethodName}({callerLineNumber}) - Successfully stopped module '{moduleName}'.")]
Message = "{CallerMethodName}({CallerLineNumber}) - Successfully stopped module '{ModuleName}'.")]
private partial void LogModuleStopped(
string moduleName,
[CallerMemberName] string callerMethodName = "",
Expand All @@ -37,7 +37,7 @@ private partial void LogModuleStopped(
[LoggerMessage(
EventId = Atc.Azure.IoTEdge.LoggingEventIdConstants.ModuleClientStarted,
Level = LogLevel.Trace,
Message = "{callerMethodName}({callerLineNumber}) - Successfully started moduleClient for module '{moduleName}'.")]
Message = "{CallerMethodName}({CallerLineNumber}) - Successfully started moduleClient for module '{ModuleName}'.")]
private partial void LogModuleClientStarted(
string moduleName,
[CallerMemberName] string callerMethodName = "",
Expand All @@ -46,7 +46,7 @@ private partial void LogModuleClientStarted(
[LoggerMessage(
EventId = Atc.Azure.IoTEdge.LoggingEventIdConstants.ModuleClientStopped,
Level = LogLevel.Trace,
Message = "{callerMethodName}({callerLineNumber}) - Successfully stopped moduleClient for module '{moduleName}'.")]
Message = "{CallerMethodName}({CallerLineNumber}) - Successfully stopped moduleClient for module '{ModuleName}'.")]
private partial void LogModuleClientStopped(
string moduleName,
[CallerMemberName] string callerMethodName = "",
Expand All @@ -55,7 +55,7 @@ private partial void LogModuleClientStopped(
[LoggerMessage(
EventId = Atc.Azure.IoTEdge.LoggingEventIdConstants.ConnectionStatusChange,
Level = LogLevel.Trace,
Message = "{callerMethodName}({callerLineNumber}) - Connection changed - status: '{status}', reason: '{reason}'.")]
Message = "{CallerMethodName}({CallerLineNumber}) - Connection changed - status: '{Status}', reason: '{Reason}'.")]
private partial void LogConnectionStatusChange(
ConnectionStatus status,
ConnectionStatusChangeReason reason,
Expand All @@ -65,7 +65,7 @@ private partial void LogConnectionStatusChange(
[LoggerMessage(
EventId = Atc.Azure.IoTEdge.LoggingEventIdConstants.MethodCalled,
Level = LogLevel.Trace,
Message = "{callerMethodName}({callerLineNumber}) - Method '{methodName}' was called on module '{moduleName}'.")]
Message = "{CallerMethodName}({CallerLineNumber}) - Method '{MethodName}' was called on module '{ModuleName}'.")]
private partial void LogMethodCalled(
string methodName,
string moduleName,
Expand All @@ -75,7 +75,7 @@ private partial void LogMethodCalled(
[LoggerMessage(
EventId = Atc.Azure.IoTEdge.LoggingEventIdConstants.MethodCallCompleted,
Level = LogLevel.Trace,
Message = "{callerMethodName}({callerLineNumber}) - Method '{methodName}' completed on module '{moduleName}'.")]
Message = "{CallerMethodName}({CallerLineNumber}) - Method '{MethodName}' completed on module '{ModuleName}'.")]
private partial void LogMethodCallCompleted(
string methodName,
string moduleName,
Expand All @@ -85,7 +85,7 @@ private partial void LogMethodCallCompleted(
[LoggerMessage(
EventId = Atc.Azure.IoTEdge.LoggingEventIdConstants.MethodRequestEmpty,
Level = LogLevel.Error,
Message = "{callerMethodName}({callerLineNumber}) - No data in request when method '{methodName}' was called on module '{moduleName}'.")]
Message = "{CallerMethodName}({CallerLineNumber}) - No data in request when method '{MethodName}' was called on module '{ModuleName}'.")]
private partial void LogMethodRequestEmpty(
string methodName,
string moduleName,
Expand All @@ -95,7 +95,7 @@ private partial void LogMethodRequestEmpty(
[LoggerMessage(
EventId = Atc.Azure.IoTEdge.LoggingEventIdConstants.MethodRequestDeserializationError,
Level = LogLevel.Error,
Message = "{callerMethodName}({callerLineNumber}) - Could not deserialize request when method '{methodName}' was called on module '{moduleName}': '{errorMessage}'.")]
Message = "{CallerMethodName}({CallerLineNumber}) - Could not deserialize request when method '{MethodName}' was called on module '{ModuleName}': '{ErrorMessage}'.")]
private partial void LogMethodRequestDeserializationError(
string methodName,
string moduleName,
Expand All @@ -106,7 +106,7 @@ private partial void LogMethodRequestDeserializationError(
[LoggerMessage(
EventId = Atc.Azure.IoTEdge.LoggingEventIdConstants.MethodRequestUriParsingError,
Level = LogLevel.Error,
Message = "{callerMethodName}({callerLineNumber}) - Could not parse url '{url}' from request when method '{methodName}' was called on module '{moduleName}': '{errorMessage}'.")]
Message = "{CallerMethodName}({CallerLineNumber}) - Could not parse url '{Url}' from request when method '{MethodName}' was called on module '{ModuleName}': '{ErrorMessage}'.")]
private partial void LogMethodRequestUriParsingError(
string url,
string methodName,
Expand All @@ -118,7 +118,7 @@ private partial void LogMethodRequestUriParsingError(
[LoggerMessage(
EventId = Atc.Azure.IoTEdge.LoggingEventIdConstants.MethodRequestUriFormatExceptionError,
Level = LogLevel.Error,
Message = "{callerMethodName}({callerLineNumber}) - Exception while parsing endpointUrl '{endpointUrl}': '{errorMessage}'")]
Message = "{CallerMethodName}({CallerLineNumber}) - Exception while parsing endpointUrl '{EndpointUrl}': '{ErrorMessage}'")]
private partial void LogMethodRequestUriFormatExceptionError(
string endpointUrl,
string errorMessage,
Expand All @@ -128,7 +128,7 @@ private partial void LogMethodRequestUriFormatExceptionError(
[LoggerMessage(
EventId = Atc.Azure.IoTEdge.LoggingEventIdConstants.MethodRequestError,
Level = LogLevel.Error,
Message = "{callerMethodName}({callerLineNumber}) - Could not process request when method '{methodName}' was called on module '{moduleName}': '{errorMessage}'.")]
Message = "{CallerMethodName}({CallerLineNumber}) - Could not process request when method '{MethodName}' was called on module '{ModuleName}': '{ErrorMessage}'.")]
private partial void LogMethodRequestError(
string methodName,
string moduleName,
Expand All @@ -139,7 +139,7 @@ private partial void LogMethodRequestError(
[LoggerMessage(
EventId = LoggingEventIdConstants.ConfigurationFileMissing,
Level = LogLevel.Error,
Message = "{callerMethodName}({callerLineNumber}) - The node configuration file '{publisherNodeConfigurationFilename}' does not exist.")]
Message = "{CallerMethodName}({CallerLineNumber}) - The node configuration file '{PublisherNodeConfigurationFilename}' does not exist.")]
private partial void LogConfigurationFileNotFound(
string publisherNodeConfigurationFilename,
[CallerMemberName] string callerMethodName = "",
Expand All @@ -148,7 +148,7 @@ private partial void LogConfigurationFileNotFound(
[LoggerMessage(
EventId = LoggingEventIdConstants.ConfigurationFileLoadError,
Level = LogLevel.Error,
Message = "{callerMethodName}({callerLineNumber}) - Loading of the node configuration file failed. Check the file exist and have correct syntax: '{errorMessage}'.")]
Message = "{CallerMethodName}({CallerLineNumber}) - Loading of the node configuration file failed. Check the file exist and have correct syntax: '{ErrorMessage}'.")]
private partial void LogConfigurationFileLoadError(
string errorMessage,
[CallerMemberName] string callerMethodName = "",
Expand All @@ -157,7 +157,7 @@ private partial void LogConfigurationFileLoadError(
[LoggerMessage(
EventId = LoggingEventIdConstants.ConfigurationFileWriteError,
Level = LogLevel.Error,
Message = "{callerMethodName}({callerLineNumber}) - Writing to the node configuration file failed. Check the file exist and have correct syntax: '{errorMessage}'.")]
Message = "{CallerMethodName}({CallerLineNumber}) - Writing to the node configuration file failed. Check the file exist and have correct syntax: '{ErrorMessage}'.")]
private partial void LogConfigurationFileWriteError(
string errorMessage,
[CallerMemberName] string callerMethodName = "",
Expand Down
8 changes: 4 additions & 4 deletions sample/src/IoTEdgeModules/modules/simulationmodule/Jobs/PulsJobLoggerMessages.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ public sealed partial class PulsJob
[LoggerMessage(
EventId = LoggingEventIdConstants.JobStarted,
Level = LogLevel.Information,
Message = "{callerMethodName}({callerLineNumber}) - '{jobName}' started.")]
Message = "{CallerMethodName}({CallerLineNumber}) - '{JobName}' started.")]
private partial void LogJobStarted(
string jobName,
[CallerMemberName] string callerMethodName = "",
Expand All @@ -20,7 +20,7 @@ private partial void LogJobStarted(
[LoggerMessage(
EventId = LoggingEventIdConstants.JobEnded,
Level = LogLevel.Information,
Message = "{callerMethodName}({callerLineNumber}) - '{jobName}' ended.")]
Message = "{CallerMethodName}({CallerLineNumber}) - '{JobName}' ended.")]
private partial void LogJobEnded(
string jobName,
[CallerMemberName] string callerMethodName = "",
Expand All @@ -29,7 +29,7 @@ private partial void LogJobEnded(
[LoggerMessage(
EventId = Atc.Azure.IoTEdge.LoggingEventIdConstants.FailedToAcquireModuleClient,
Level = LogLevel.Error,
Message = "{callerMethodName}({callerLineNumber}) - Failed to acquire ModuleClient for the job '{jobName}'.")]
Message = "{CallerMethodName}({CallerLineNumber}) - Failed to acquire ModuleClient for the job '{JobName}'.")]
private partial void LogFailedToAcquireModuleClient(
string jobName,
[CallerMemberName] string callerMethodName = "",
Expand All @@ -38,7 +38,7 @@ private partial void LogFailedToAcquireModuleClient(
[LoggerMessage(
EventId = LoggingEventIdConstants.UnhandledExceptionInJob,
Level = LogLevel.Error,
Message = "{callerMethodName}({callerLineNumber}) - Unhandled exception occurred in job '{jobName}' - '{errorMessage}'.")]
Message = "{CallerMethodName}({CallerLineNumber}) - Unhandled exception occurred in job '{JobName}' - '{ErrorMessage}'.")]
private partial void LogUnhandledExceptionInJob(
string jobName,
string? errorMessage,
Expand Down
24 changes: 12 additions & 12 deletions sample/src/IoTEdgeModules/modules/simulationmodule/SimulationModuleServiceLoggerMessages.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ public sealed partial class SimulationModuleService
[LoggerMessage(
EventId = Atc.Azure.IoTEdge.LoggingEventIdConstants.ModuleStarted,
Level = LogLevel.Trace,
Message = "{callerMethodName}({callerLineNumber}) - Successfully started module '{moduleName}'.")]
Message = "{CallerMethodName}({CallerLineNumber}) - Successfully started module '{ModuleName}'.")]
private partial void LogModuleStarted(
string moduleName,
[CallerMemberName] string callerMethodName = "",
Expand All @@ -19,7 +19,7 @@ private partial void LogModuleStarted(
[LoggerMessage(
EventId = Atc.Azure.IoTEdge.LoggingEventIdConstants.ModuleStopping,
Level = LogLevel.Trace,
Message = "{callerMethodName}({callerLineNumber}) - Stopping module '{moduleName}'.")]
Message = "{CallerMethodName}({CallerLineNumber}) - Stopping module '{ModuleName}'.")]
private partial void LogModuleStopping(
string moduleName,
[CallerMemberName] string callerMethodName = "",
Expand All @@ -28,7 +28,7 @@ private partial void LogModuleStopping(
[LoggerMessage(
EventId = Atc.Azure.IoTEdge.LoggingEventIdConstants.ModuleStopped,
Level = LogLevel.Trace,
Message = "{callerMethodName}({callerLineNumber}) - Successfully stopped module '{moduleName}'.")]
Message = "{CallerMethodName}({CallerLineNumber}) - Successfully stopped module '{ModuleName}'.")]
private partial void LogModuleStopped(
string moduleName,
[CallerMemberName] string callerMethodName = "",
Expand All @@ -37,7 +37,7 @@ private partial void LogModuleStopped(
[LoggerMessage(
EventId = Atc.Azure.IoTEdge.LoggingEventIdConstants.ModuleClientStarted,
Level = LogLevel.Trace,
Message = "{callerMethodName}({callerLineNumber}) - Successfully started moduleClient for module '{moduleName}'.")]
Message = "{CallerMethodName}({CallerLineNumber}) - Successfully started moduleClient for module '{ModuleName}'.")]
private partial void LogModuleClientStarted(
string moduleName,
[CallerMemberName] string callerMethodName = "",
Expand All @@ -46,7 +46,7 @@ private partial void LogModuleClientStarted(
[LoggerMessage(
EventId = Atc.Azure.IoTEdge.LoggingEventIdConstants.ModuleClientStopped,
Level = LogLevel.Trace,
Message = "{callerMethodName}({callerLineNumber}) - Successfully stopped moduleClient for module '{moduleName}'.")]
Message = "{CallerMethodName}({CallerLineNumber}) - Successfully stopped moduleClient for module '{ModuleName}'.")]
private partial void LogModuleClientStopped(
string moduleName,
[CallerMemberName] string callerMethodName = "",
Expand All @@ -55,7 +55,7 @@ private partial void LogModuleClientStopped(
[LoggerMessage(
EventId = Atc.Azure.IoTEdge.LoggingEventIdConstants.ConnectionStatusChange,
Level = LogLevel.Trace,
Message = "{callerMethodName}({callerLineNumber}) - Connection changed - status: '{status}', reason: '{reason}'.")]
Message = "{CallerMethodName}({CallerLineNumber}) - Connection changed - status: '{Status}', reason: '{Reason}'.")]
private partial void LogConnectionStatusChange(
ConnectionStatus status,
ConnectionStatusChangeReason reason,
Expand All @@ -65,7 +65,7 @@ private partial void LogConnectionStatusChange(
[LoggerMessage(
EventId = Atc.Azure.IoTEdge.LoggingEventIdConstants.MethodCalled,
Level = LogLevel.Trace,
Message = "{callerMethodName}({callerLineNumber}) - Method '{methodName}' was called on module '{moduleName}'.")]
Message = "{CallerMethodName}({CallerLineNumber}) - Method '{MethodName}' was called on module '{ModuleName}'.")]
private partial void LogMethodCalled(
string methodName,
string moduleName,
Expand All @@ -75,7 +75,7 @@ private partial void LogMethodCalled(
[LoggerMessage(
EventId = Atc.Azure.IoTEdge.LoggingEventIdConstants.MethodCallCompleted,
Level = LogLevel.Trace,
Message = "{callerMethodName}({callerLineNumber}) - Method '{methodName}' completed on module '{moduleName}'.")]
Message = "{CallerMethodName}({CallerLineNumber}) - Method '{MethodName}' completed on module '{ModuleName}'.")]
private partial void LogMethodCallCompleted(
string methodName,
string moduleName,
Expand All @@ -85,7 +85,7 @@ private partial void LogMethodCallCompleted(
[LoggerMessage(
EventId = Atc.Azure.IoTEdge.LoggingEventIdConstants.MethodRequestEmpty,
Level = LogLevel.Error,
Message = "{callerMethodName}({callerLineNumber}) - No data in request when method '{methodName}' was called on module '{moduleName}'.")]
Message = "{CallerMethodName}({CallerLineNumber}) - No data in request when method '{MethodName}' was called on module '{ModuleName}'.")]
private partial void LogMethodRequestEmpty(
string methodName,
string moduleName,
Expand All @@ -95,7 +95,7 @@ private partial void LogMethodRequestEmpty(
[LoggerMessage(
EventId = Atc.Azure.IoTEdge.LoggingEventIdConstants.MethodRequestDeserializationError,
Level = LogLevel.Error,
Message = "{callerMethodName}({callerLineNumber}) - Could not deserialize request when method '{methodName}' was called on module '{moduleName}': '{errorMessage}'.")]
Message = "{CallerMethodName}({CallerLineNumber}) - Could not deserialize request when method '{MethodName}' was called on module '{ModuleName}': '{ErrorMessage}'.")]
private partial void LogMethodRequestDeserializationError(
string methodName,
string moduleName,
Expand All @@ -106,7 +106,7 @@ private partial void LogMethodRequestDeserializationError(
[LoggerMessage(
EventId = Atc.Azure.IoTEdge.LoggingEventIdConstants.MethodRequestUriParsingError,
Level = LogLevel.Error,
Message = "{callerMethodName}({callerLineNumber}) - Could not parse url '{url}' from request when method '{methodName}' was called on module '{moduleName}': '{errorMessage}'.")]
Message = "{CallerMethodName}({CallerLineNumber}) - Could not parse url '{url}' from request when method '{MethodName}' was called on module '{ModuleName}': '{ErrorMessage}'.")]
private partial void LogMethodRequestUriParsingError(
string url,
string methodName,
Expand All @@ -118,7 +118,7 @@ private partial void LogMethodRequestUriParsingError(
[LoggerMessage(
EventId = Atc.Azure.IoTEdge.LoggingEventIdConstants.MethodRequestError,
Level = LogLevel.Error,
Message = "{callerMethodName}({callerLineNumber}) - Could not process request when method '{methodName}' was called on module '{moduleName}': '{errorMessage}'.")]
Message = "{CallerMethodName}({CallerLineNumber}) - Could not process request when method '{MethodName}' was called on module '{ModuleName}': '{ErrorMessage}'.")]
private partial void LogMethodRequestError(
string methodName,
string moduleName,
Expand Down
Loading