Skip to content

Commit 41ef5b2

Browse files
alexlianidesalianides
alexlianides
and
alianides
authored
updated logging for responses to include status (#10)
Co-authored-by: alianides <[email protected]>
1 parent 1a80c5d commit 41ef5b2

6 files changed

+31
-31
lines changed

‎src/MessageHandlers/LinkResponseHandler.cs

+7-7
Original file line numberDiff line numberDiff line change
@@ -22,23 +22,23 @@ private void InboxToOutbox(MessageFormats.HostServices.Link.LinkRequest? linkReq
2222

2323
private void SendFileToApp(MessageFormats.HostServices.Link.LinkResponse? message) {
2424

25-
_logger.LogInformation("Processing {messageType} for potential additional file transfer.(trackingId: '{trackingId}' / correlationId: '{correlationId}')", message.GetType().Name, message.ResponseHeader.TrackingId, message.ResponseHeader.CorrelationId);
25+
_logger.LogInformation("Processing {messageType} for potential additional file transfer.(trackingId: '{trackingId}' / correlationId: '{correlationId}' / status: '{status}')", message.GetType().Name, message.ResponseHeader.TrackingId, message.ResponseHeader.CorrelationId, message.ResponseHeader.Status);
2626

2727
string? sourcePayloadAppId = message.LinkRequest.RequestHeader.Metadata.FirstOrDefault((_item) => _item.Key == "SOURCE_PAYLOAD_APP_ID").Value;
2828

2929
// If the LinkRequest was sent by platform-mts itself, does not contain the required SOURCE_PAYLOAD_APP_ID metadata field, or was successful in it's file transfer? drop the LinkResponse
3030
if (message.LinkRequest.RequestHeader.AppId == $"platform-{MessageFormats.Common.PlatformServices.Mts}".ToLower() || string.IsNullOrWhiteSpace(sourcePayloadAppId) || message.ResponseHeader.Status != MessageFormats.Common.StatusCodes.Successful) return;
3131

32-
_logger.LogInformation("Detected '{messageType}' associated with LinkRequest for payload-app file. (trackingId: '{trackingId}' / correlationId: '{correlationId}')", message.GetType().Name, message.ResponseHeader.TrackingId, message.ResponseHeader.CorrelationId);
32+
_logger.LogInformation("Detected '{messageType}' associated with LinkRequest for payload-app file. (trackingId: '{trackingId}' / correlationId: '{correlationId}' / status: '{status}')", message.GetType().Name, message.ResponseHeader.TrackingId, message.ResponseHeader.CorrelationId, message.ResponseHeader.Status);
3333

3434
InboxToOutbox(message.LinkRequest);
3535

3636
var filePath = Path.Combine(Core.GetXFerDirectories().Result.inbox_directory, message.LinkRequest.FileName);
3737

3838
if (!string.IsNullOrWhiteSpace(message.LinkRequest.Subdirectory)) filePath = Path.Combine(Core.GetXFerDirectories().Result.inbox_directory, message.LinkRequest.Subdirectory, message.LinkRequest.FileName);
3939

40-
_logger.LogInformation("{methodRequest}: Found SOURCE_PAYLOAD_APP_ID metadata {sourcePayloadAppID} and found file at '{filePath}'. Sending LinkRequest to '{destinationAppId}'. (TrackingId: {trackingId}, CorrelationId: {correlationId})",
41-
nameof(SendFileToApp), sourcePayloadAppId, filePath, sourcePayloadAppId, message.ResponseHeader.TrackingId, message.ResponseHeader.CorrelationId);
40+
_logger.LogInformation("{methodRequest}: Found SOURCE_PAYLOAD_APP_ID metadata {sourcePayloadAppID} and found file at '{filePath}'. Sending LinkRequest to '{destinationAppId}'. (trackingId: {trackingId} / correlationId: {correlationId} / status: '{status}')",
41+
nameof(SendFileToApp), sourcePayloadAppId, filePath, sourcePayloadAppId, message.ResponseHeader.TrackingId, message.ResponseHeader.CorrelationId, message.ResponseHeader.Status);
4242

4343

4444
// Modify the original LinkRequest to transfer the file to SOURCE_PAYLOAD_APP_ID
@@ -54,7 +54,7 @@ private void LinkResponseHandler(MessageFormats.HostServices.Link.LinkResponse?
5454
if (message == null) return;
5555

5656
using (var scope = _serviceProvider.CreateScope()) {
57-
_logger.LogInformation("Processing message type '{messageType}' from '{sourceApp}' (trackingId: '{trackingId}' / correlationId: '{correlationId}')", message.GetType().Name, fullMessage.SourceAppId, message.ResponseHeader.TrackingId, message.ResponseHeader.CorrelationId);
57+
_logger.LogInformation("Processing message type '{messageType}' from '{sourceApp}' (trackingId: '{trackingId}' / correlationId: '{correlationId}' / status: '{status}')", message.GetType().Name, fullMessage.SourceAppId, message.ResponseHeader.TrackingId, message.ResponseHeader.CorrelationId, message.ResponseHeader.Status);
5858

5959
// Deployment Scenario: No Plugins
6060
// No plugins are loaded. Process LinkResponse to see if the file requires an additional transfer
@@ -76,15 +76,15 @@ private void LinkResponseHandler(MessageFormats.HostServices.Link.LinkResponse?
7676
}
7777

7878
// Deployment Plugin Scenario:
79-
_logger.LogDebug("Passing message '{messageType}' to plugins (trackingId: '{trackingId}' / correlationId: '{correlationId}')", message.GetType().Name, message.ResponseHeader.TrackingId, message.ResponseHeader.CorrelationId);
79+
_logger.LogDebug("Passing message '{messageType}' to plugins (trackingId: '{trackingId}' / correlationId: '{correlationId}' / status: '{status}')", message.GetType().Name, message.ResponseHeader.TrackingId, message.ResponseHeader.CorrelationId, message.ResponseHeader.Status);
8080

8181

8282
MessageFormats.HostServices.Link.LinkResponse? pluginResult =
8383
_pluginLoader.CallPlugins<MessageFormats.HostServices.Link.LinkResponse?, Plugins.PluginBase>(
8484
orig_request: message,
8585
pluginDelegate: _pluginDelegates.LinkResponse);
8686

87-
_logger.LogDebug("Plugins finished processing '{messageType}' (trackingId: '{trackingId}' / correlationId: '{correlationId}')", message.GetType().Name, message.ResponseHeader.TrackingId, message.ResponseHeader.CorrelationId);
87+
_logger.LogDebug("Plugins finished processing '{messageType}' (trackingId: '{trackingId}' / correlationId: '{correlationId}' / status: '{status}')", message.GetType().Name, message.ResponseHeader.TrackingId, message.ResponseHeader.CorrelationId, message.ResponseHeader.Status);
8888
};
8989
}
9090
}

‎src/MessageHandlers/PositionUpdateResponseHandler.cs

+5-5
Original file line numberDiff line numberDiff line change
@@ -6,24 +6,24 @@ public partial class MessageHandler<T> {
66
private void PositionUpdateResponseHandler(MessageFormats.HostServices.Position.PositionUpdateResponse? message, MessageFormats.Common.DirectToApp fullMessage) {
77
if (message == null) return;
88
using (var scope = _serviceProvider.CreateScope()) {
9-
_logger.LogInformation("Processing message type '{messageType}' from '{sourceApp}' (trackingId: '{trackingId}' / correlationId: '{correlationId}')", message.GetType().Name, fullMessage.SourceAppId, message.ResponseHeader.TrackingId, message.ResponseHeader.CorrelationId);
9+
_logger.LogInformation("Processing message type '{messageType}' from '{sourceApp}' (trackingId: '{trackingId}' / correlationId: '{correlationId}' / status: '{status}')", message.GetType().Name, fullMessage.SourceAppId, message.ResponseHeader.TrackingId, message.ResponseHeader.CorrelationId, message.ResponseHeader.Status);
1010

11-
_logger.LogDebug("Passing message '{messageType}' to plugins (trackingId: '{trackingId}' / correlationId: '{correlationId}')", message.GetType().Name, message.ResponseHeader.TrackingId, message.ResponseHeader.CorrelationId);
11+
_logger.LogDebug("Passing message '{messageType}' to plugins (trackingId: '{trackingId}' / correlationId: '{correlationId}' / status: '{status}')", message.GetType().Name, message.ResponseHeader.TrackingId, message.ResponseHeader.CorrelationId, message.ResponseHeader.Status);
1212

1313

1414
MessageFormats.HostServices.Position.PositionUpdateResponse? pluginResult =
1515
_pluginLoader.CallPlugins<MessageFormats.HostServices.Position.PositionUpdateResponse?, Plugins.PluginBase>(
1616
orig_request: message,
1717
pluginDelegate: _pluginDelegates.PositionUpdateResponse);
1818

19-
_logger.LogDebug("Plugins finished processing '{messageType}' (trackingId: '{trackingId}' / correlationId: '{correlationId}')", message.GetType().Name, message.ResponseHeader.TrackingId, message.ResponseHeader.CorrelationId);
19+
_logger.LogDebug("Plugins finished processing '{messageType}' (trackingId: '{trackingId}' / correlationId: '{correlationId}')", message.GetType().Name, message.ResponseHeader.TrackingId, message.ResponseHeader.CorrelationId, message.ResponseHeader.Status);
2020

2121
if (pluginResult == null) {
22-
_logger.LogInformation("Plugins nullified '{messageType}'. Dropping Message (trackingId: '{trackingId}' / correlationId: '{correlationId}')", message.GetType().Name, message.ResponseHeader.TrackingId, message.ResponseHeader.CorrelationId);
22+
_logger.LogInformation("Plugins nullified '{messageType}'. Dropping Message (trackingId: '{trackingId}' / correlationId: '{correlationId}' / status: '{status}')", message.GetType().Name, message.ResponseHeader.TrackingId, message.ResponseHeader.CorrelationId, message.ResponseHeader.Status);
2323
return;
2424
}
2525

26-
_logger.LogInformation("Sending message '{messageType}' to local event handler (trackingId: '{trackingId}' / correlationId: '{correlationId}')", message.GetType().Name, message.ResponseHeader.TrackingId, message.ResponseHeader.CorrelationId);
26+
_logger.LogInformation("Sending message '{messageType}' to local event handler (trackingId: '{trackingId}' / correlationId: '{correlationId}' / status: '{status}')", message.GetType().Name, message.ResponseHeader.TrackingId, message.ResponseHeader.CorrelationId, message.ResponseHeader.Status);
2727
_messageRouter.CallEventHandlers<MessageFormats.HostServices.Position.PositionUpdateResponse>(pluginResult, fullMessage.SourceAppId, _messageRouter.PositionUpdateResponseReceivedEvent);
2828
};
2929
}

‎src/MessageHandlers/SensorDataHandler.cs

+5-5
Original file line numberDiff line numberDiff line change
@@ -6,23 +6,23 @@ public partial class MessageHandler<T> {
66
private void SensorDataHandler(MessageFormats.HostServices.Sensor.SensorData? message, MessageFormats.Common.DirectToApp fullMessage) {
77
if (message == null) return;
88
using (var scope = _serviceProvider.CreateScope()) {
9-
_logger.LogInformation("Processing message type '{messageType}' from '{sourceApp}' (trackingId: '{trackingId}' / correlationId: '{correlationId}')", message.GetType().Name, fullMessage.SourceAppId, message.ResponseHeader.TrackingId, message.ResponseHeader.CorrelationId);
9+
_logger.LogInformation("Processing message type '{messageType}' from '{sourceApp}' (trackingId: '{trackingId}' / correlationId: '{correlationId}' / status: '{status}')", message.GetType().Name, fullMessage.SourceAppId, message.ResponseHeader.TrackingId, message.ResponseHeader.CorrelationId, message.ResponseHeader.Status);
1010

11-
_logger.LogDebug("Passing message '{messageType}' to plugins (trackingId: '{trackingId}' / correlationId: '{correlationId}')", message.GetType().Name, message.ResponseHeader.TrackingId, message.ResponseHeader.CorrelationId);
11+
_logger.LogDebug("Passing message '{messageType}' to plugins (trackingId: '{trackingId}' / correlationId: '{correlationId}' / status: '{status}')", message.GetType().Name, message.ResponseHeader.TrackingId, message.ResponseHeader.CorrelationId, message.ResponseHeader.Status);
1212

1313
MessageFormats.HostServices.Sensor.SensorData? pluginResult =
1414
_pluginLoader.CallPlugins<MessageFormats.HostServices.Sensor.SensorData?, Plugins.PluginBase>(
1515
orig_request: message,
1616
pluginDelegate: _pluginDelegates.SensorData);
1717

18-
_logger.LogDebug("Plugins finished processing '{messageType}' (trackingId: '{trackingId}' / correlationId: '{correlationId}')", message.GetType().Name, message.ResponseHeader.TrackingId, message.ResponseHeader.CorrelationId);
18+
_logger.LogDebug("Plugins finished processing '{messageType}' (trackingId: '{trackingId}' / correlationId: '{correlationId}' / status: '{status}')", message.GetType().Name, message.ResponseHeader.TrackingId, message.ResponseHeader.CorrelationId, message.ResponseHeader.Status);
1919

2020
if (pluginResult == null) {
21-
_logger.LogInformation("Plugins nullified '{messageType}'. Dropping Message (trackingId: '{trackingId}' / correlationId: '{correlationId}')", message.GetType().Name, message.ResponseHeader.TrackingId, message.ResponseHeader.CorrelationId);
21+
_logger.LogInformation("Plugins nullified '{messageType}'. Dropping Message (trackingId: '{trackingId}' / correlationId: '{correlationId}' / status: '{status}')", message.GetType().Name, message.ResponseHeader.TrackingId, message.ResponseHeader.CorrelationId, message.ResponseHeader.Status);
2222
return;
2323
}
2424

25-
_logger.LogInformation("Routing message type '{messageType}' to '{appId}' (trackingId: '{trackingId}' / correlationId: '{correlationId}')", message.GetType().Name, $"hostsvc-{nameof(MessageFormats.Common.HostServices.Sensor)}", message.ResponseHeader.TrackingId, message.ResponseHeader.CorrelationId);
25+
_logger.LogInformation("Routing message type '{messageType}' to '{appId}' (trackingId: '{trackingId}' / correlationId: '{correlationId}' / status: '{status}')", message.GetType().Name, $"hostsvc-{nameof(MessageFormats.Common.HostServices.Sensor)}", message.ResponseHeader.TrackingId, message.ResponseHeader.CorrelationId, message.ResponseHeader.Status);
2626
_client.DirectToApp(appId: $"hostsvc-{nameof(MessageFormats.Common.HostServices.Sensor)}", message: pluginResult);
2727
};
2828
}

‎src/MessageHandlers/SensorsAvailableResponseHandler.cs

+4-4
Original file line numberDiff line numberDiff line change
@@ -6,20 +6,20 @@ public partial class MessageHandler<T> {
66
private void SensorsAvailableResponseHandler(MessageFormats.HostServices.Sensor.SensorsAvailableResponse? message, MessageFormats.Common.DirectToApp fullMessage) {
77
if (message == null) return;
88
using (var scope = _serviceProvider.CreateScope()) {
9-
_logger.LogInformation("Processing message type '{messageType}' from '{sourceApp}' (trackingId: '{trackingId}' / correlationId: '{correlationId}')", message.GetType().Name, fullMessage.SourceAppId, message.ResponseHeader.TrackingId, message.ResponseHeader.CorrelationId);
9+
_logger.LogInformation("Processing message type '{messageType}' from '{sourceApp}' (trackingId: '{trackingId}' / correlationId: '{correlationId}' / status: '{status}')", message.GetType().Name, fullMessage.SourceAppId, message.ResponseHeader.TrackingId, message.ResponseHeader.CorrelationId, message.ResponseHeader.Status);
1010

1111
MessageFormats.HostServices.Sensor.SensorsAvailableResponse? pluginResult =
1212
_pluginLoader.CallPlugins<MessageFormats.HostServices.Sensor.SensorsAvailableResponse?, Plugins.PluginBase>(
1313
orig_request: message,
1414
pluginDelegate: _pluginDelegates.SensorsAvailableResponse);
1515

16-
_logger.LogDebug("Plugins finished processing '{messageType}' (trackingId: '{trackingId}' / correlationId: '{correlationId}')", message.GetType().Name, message.ResponseHeader.TrackingId, message.ResponseHeader.CorrelationId);
16+
_logger.LogDebug("Plugins finished processing '{messageType}' (trackingId: '{trackingId}' / correlationId: '{correlationId}' / status: '{status}')", message.GetType().Name, message.ResponseHeader.TrackingId, message.ResponseHeader.CorrelationId, message.ResponseHeader.Status);
1717

1818
if (pluginResult == null) {
19-
_logger.LogInformation("Plugins nullified '{messageType}'. Dropping Message (trackingId: '{trackingId}' / correlationId: '{correlationId}')", message.GetType().Name, message.ResponseHeader.TrackingId, message.ResponseHeader.CorrelationId);
19+
_logger.LogInformation("Plugins nullified '{messageType}'. Dropping Message (trackingId: '{trackingId}' / correlationId: '{correlationId}' / status: '{status}')", message.GetType().Name, message.ResponseHeader.TrackingId, message.ResponseHeader.CorrelationId, message.ResponseHeader.Status);
2020
return;
2121
} else {
22-
_logger.LogInformation("Sending message '{messageType}' to '{appId}' (trackingId: '{trackingId}' / correlationId: '{correlationId}')", message.GetType().Name, MessageFormats.Common.HostServices.Sensor, message.ResponseHeader.TrackingId, message.ResponseHeader.CorrelationId);
22+
_logger.LogInformation("Sending message '{messageType}' to '{appId}' (trackingId: '{trackingId}' / correlationId: '{correlationId}' / status: '{status}')", message.GetType().Name, MessageFormats.Common.HostServices.Sensor, message.ResponseHeader.TrackingId, message.ResponseHeader.CorrelationId, message.ResponseHeader.Status);
2323
_client.DirectToApp(appId: $"hostsvc-{MessageFormats.Common.HostServices.Sensor}", message: pluginResult);
2424
}
2525
};

0 commit comments

Comments
 (0)