Skip to content

Improve format specifiers in logs #1097

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 4 commits into from
Aug 7, 2020
Merged

Improve format specifiers in logs #1097

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
1dc6b53
Remove C99 %hhu format specifier
muneebahmed10 Aug 5, 2020
d9cd620
Add unsigned long to %lu format specifiers
muneebahmed10 Aug 5, 2020
76a7302
Log stringified status codes instead of integers
muneebahmed10 Aug 5, 2020
8f3c930
Change init log
muneebahmed10 Aug 7, 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
37 changes: 19 additions & 18 deletions demos/mqtt/mqtt_demo_basic_tls/mqtt_demo_basic_tls.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -533,9 +533,9 @@ static int handlePublishResend( MQTTContext_t * pMqttContext )
if( mqttStatus != MQTTSuccess )
{
LogError( ( "Sending duplicate PUBLISH for packet id %u "
" failed with status %u.",
" failed with status %s.",
outgoingPublishPackets[ index ].packetId,
mqttStatus ) );
MQTT_Status_strerror( mqttStatus ) ) );
returnStatus = EXIT_FAILURE;
break;
}
Expand Down Expand Up @@ -716,7 +716,7 @@ static int establishMqttSession( MQTTContext_t * pMqttContext,
if( mqttStatus != MQTTSuccess )
{
returnStatus = EXIT_FAILURE;
LogError( ( "MQTT init failed with status %u.", mqttStatus ) );
LogError( ( "MQTT init failed: Status=%s.", MQTT_Status_strerror( mqttStatus ) ) );
}
else
{
Expand Down Expand Up @@ -754,7 +754,8 @@ static int establishMqttSession( MQTTContext_t * pMqttContext,
if( mqttStatus != MQTTSuccess )
{
returnStatus = EXIT_FAILURE;
LogError( ( "Connection with MQTT broker failed with status %u.", mqttStatus ) );
LogError( ( "Connection with MQTT broker failed with status %s.",
MQTT_Status_strerror( mqttStatus ) ) );
}
else
{
Expand All @@ -779,8 +780,8 @@ static int disconnectMqttSession( MQTTContext_t * pMqttContext )

if( mqttStatus != MQTTSuccess )
{
LogError( ( "Sending MQTT DISCONNECT failed with status=%u.",
mqttStatus ) );
LogError( ( "Sending MQTT DISCONNECT failed with status=%s.",
MQTT_Status_strerror( mqttStatus ) ) );
returnStatus = EXIT_FAILURE;
}

Expand Down Expand Up @@ -816,8 +817,8 @@ static int subscribeToTopic( MQTTContext_t * pMqttContext )

if( mqttStatus != MQTTSuccess )
{
LogError( ( "Failed to send SUBSCRIBE packet to broker with error = %u.",
mqttStatus ) );
LogError( ( "Failed to send SUBSCRIBE packet to broker with error = %s.",
MQTT_Status_strerror( mqttStatus ) ) );
returnStatus = EXIT_FAILURE;
}
else
Expand Down Expand Up @@ -860,8 +861,8 @@ static int unsubscribeFromTopic( MQTTContext_t * pMqttContext )

if( mqttStatus != MQTTSuccess )
{
LogError( ( "Failed to send UNSUBSCRIBE packet to broker with error = %u.",
mqttStatus ) );
LogError( ( "Failed to send UNSUBSCRIBE packet to broker with error = %s.",
MQTT_Status_strerror( mqttStatus ) ) );
returnStatus = EXIT_FAILURE;
}
else
Expand Down Expand Up @@ -913,8 +914,8 @@ static int publishToTopic( MQTTContext_t * pMqttContext )

if( mqttStatus != MQTTSuccess )
{
LogError( ( "Failed to send PUBLISH packet to broker with error = %u.",
mqttStatus ) );
LogError( ( "Failed to send PUBLISH packet to broker with error = %s.",
MQTT_Status_strerror( mqttStatus ) ) );
cleanupOutgoingPublishAt( publishIndex );
returnStatus = EXIT_FAILURE;
}
Expand Down Expand Up @@ -1010,8 +1011,8 @@ static int subscribePublishLoop( NetworkContext_t * pNetworkContext )
if( mqttStatus != MQTTSuccess )
{
returnStatus = EXIT_FAILURE;
LogError( ( "MQTT_ProcessLoop returned with status = %u.",
mqttStatus ) );
LogError( ( "MQTT_ProcessLoop returned with status = %s.",
MQTT_Status_strerror( mqttStatus ) ) );
}
}

Expand All @@ -1036,8 +1037,8 @@ static int subscribePublishLoop( NetworkContext_t * pNetworkContext )

if( mqttStatus != MQTTSuccess )
{
LogWarn( ( "MQTT_ProcessLoop returned with status = %u.",
mqttStatus ) );
LogWarn( ( "MQTT_ProcessLoop returned with status = %s.",
MQTT_Status_strerror( mqttStatus ) ) );
}

LogInfo( ( "Delay before continuing to next iteration.\n\n" ) );
Expand All @@ -1064,8 +1065,8 @@ static int subscribePublishLoop( NetworkContext_t * pNetworkContext )
if( mqttStatus != MQTTSuccess )
{
returnStatus = EXIT_FAILURE;
LogError( ( "MQTT_ProcessLoop returned with status = %u.",
mqttStatus ) );
LogError( ( "MQTT_ProcessLoop returned with status = %s.",
MQTT_Status_strerror( mqttStatus ) ) );
}
}

Expand Down
2 changes: 1 addition & 1 deletion demos/mqtt/mqtt_demo_lightweight/mqtt_demo_lightweight.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -532,7 +532,7 @@ static void mqttPublishToTopic( NetworkContext_t * pNetworkContext,
pFixedBuffer,
&headerSize );
LogDebug( ( "Serialized PUBLISH header size is %lu.",
headerSize ) );
( unsigned long ) headerSize ) );
assert( result == MQTTSuccess );
/* Send Publish header to the broker. */
status = Plaintext_Send( pNetworkContext, ( void * ) pFixedBuffer->pBuffer, headerSize );
Expand Down
37 changes: 19 additions & 18 deletions demos/mqtt/mqtt_demo_mutual_auth/mqtt_demo_mutual_auth.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -580,9 +580,9 @@ static int handlePublishResend( MQTTContext_t * pMqttContext )
if( mqttStatus != MQTTSuccess )
{
LogError( ( "Sending duplicate PUBLISH for packet id %u "
" failed with status %u.",
" failed with status %s.",
outgoingPublishPackets[ index ].packetId,
mqttStatus ) );
MQTT_Status_strerror( mqttStatus ) ) );
returnStatus = EXIT_FAILURE;
break;
}
Expand Down Expand Up @@ -745,7 +745,7 @@ static int establishMqttSession( MQTTContext_t * pMqttContext,
if( mqttStatus != MQTTSuccess )
{
returnStatus = EXIT_FAILURE;
LogError( ( "MQTT init failed with status %u.", mqttStatus ) );
LogError( ( "MQTT init failed: Status=%s.", MQTT_Status_strerror( mqttStatus ) ) );
}
else
{
Expand Down Expand Up @@ -783,7 +783,8 @@ static int establishMqttSession( MQTTContext_t * pMqttContext,
if( mqttStatus != MQTTSuccess )
{
returnStatus = EXIT_FAILURE;
LogError( ( "Connection with MQTT broker failed with status %u.", mqttStatus ) );
LogError( ( "Connection with MQTT broker failed with status %s.",
MQTT_Status_strerror( mqttStatus ) ) );
}
else
{
Expand All @@ -808,8 +809,8 @@ static int disconnectMqttSession( MQTTContext_t * pMqttContext )

if( mqttStatus != MQTTSuccess )
{
LogError( ( "Sending MQTT DISCONNECT failed with status=%u.",
mqttStatus ) );
LogError( ( "Sending MQTT DISCONNECT failed with status=%s.",
MQTT_Status_strerror( mqttStatus ) ) );
returnStatus = EXIT_FAILURE;
}

Expand Down Expand Up @@ -845,8 +846,8 @@ static int subscribeToTopic( MQTTContext_t * pMqttContext )

if( mqttStatus != MQTTSuccess )
{
LogError( ( "Failed to send SUBSCRIBE packet to broker with error = %u.",
mqttStatus ) );
LogError( ( "Failed to send SUBSCRIBE packet to broker with error = %s.",
MQTT_Status_strerror( mqttStatus ) ) );
returnStatus = EXIT_FAILURE;
}
else
Expand Down Expand Up @@ -889,8 +890,8 @@ static int unsubscribeFromTopic( MQTTContext_t * pMqttContext )

if( mqttStatus != MQTTSuccess )
{
LogError( ( "Failed to send UNSUBSCRIBE packet to broker with error = %u.",
mqttStatus ) );
LogError( ( "Failed to send UNSUBSCRIBE packet to broker with error = %s.",
MQTT_Status_strerror( mqttStatus ) ) );
returnStatus = EXIT_FAILURE;
}
else
Expand Down Expand Up @@ -942,8 +943,8 @@ static int publishToTopic( MQTTContext_t * pMqttContext )

if( mqttStatus != MQTTSuccess )
{
LogError( ( "Failed to send PUBLISH packet to broker with error = %u.",
mqttStatus ) );
LogError( ( "Failed to send PUBLISH packet to broker with error = %s.",
MQTT_Status_strerror( mqttStatus ) ) );
cleanupOutgoingPublishAt( publishIndex );
returnStatus = EXIT_FAILURE;
}
Expand Down Expand Up @@ -1039,8 +1040,8 @@ static int subscribePublishLoop( NetworkContext_t * pNetworkContext )
if( mqttStatus != MQTTSuccess )
{
returnStatus = EXIT_FAILURE;
LogError( ( "MQTT_ProcessLoop returned with status = %u.",
mqttStatus ) );
LogError( ( "MQTT_ProcessLoop returned with status = %s.",
MQTT_Status_strerror( mqttStatus ) ) );
}
}

Expand All @@ -1065,8 +1066,8 @@ static int subscribePublishLoop( NetworkContext_t * pNetworkContext )

if( mqttStatus != MQTTSuccess )
{
LogWarn( ( "MQTT_ProcessLoop returned with status = %u.",
mqttStatus ) );
LogWarn( ( "MQTT_ProcessLoop returned with status = %s.",
MQTT_Status_strerror( mqttStatus ) ) );
}

LogInfo( ( "Delay before continuing to next iteration.\n\n" ) );
Expand All @@ -1093,8 +1094,8 @@ static int subscribePublishLoop( NetworkContext_t * pNetworkContext )
if( mqttStatus != MQTTSuccess )
{
returnStatus = EXIT_FAILURE;
LogError( ( "MQTT_ProcessLoop returned with status = %u.",
mqttStatus ) );
LogError( ( "MQTT_ProcessLoop returned with status = %s.",
MQTT_Status_strerror( mqttStatus ) ) );
}
}

Expand Down
41 changes: 20 additions & 21 deletions demos/mqtt/mqtt_demo_plaintext/mqtt_demo_plaintext.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -452,7 +452,7 @@ static int establishMqttSession( MQTTContext_t * pMqttContext,
if( mqttStatus != MQTTSuccess )
{
returnStatus = EXIT_FAILURE;
LogError( ( "MQTT init failed with status %u.", mqttStatus ) );
LogError( ( "MQTT init failed: Status=%s.", MQTT_Status_strerror( mqttStatus ) ) );
}
else
{
Expand Down Expand Up @@ -490,7 +490,8 @@ static int establishMqttSession( MQTTContext_t * pMqttContext,
if( mqttStatus != MQTTSuccess )
{
returnStatus = EXIT_FAILURE;
LogError( ( "Connection with MQTT broker failed with status %u.", mqttStatus ) );
LogError( ( "Connection with MQTT broker failed with status %s.",
MQTT_Status_strerror( mqttStatus ) ) );
}
else
{
Expand All @@ -515,8 +516,8 @@ static int disconnectMqttSession( MQTTContext_t * pMqttContext )

if( mqttStatus != MQTTSuccess )
{
LogError( ( "Sending MQTT DISCONNECT failed with status=%u.",
mqttStatus ) );
LogError( ( "Sending MQTT DISCONNECT failed with status=%s.",
MQTT_Status_strerror( mqttStatus ) ) );
returnStatus = EXIT_FAILURE;
}

Expand Down Expand Up @@ -552,8 +553,8 @@ static int subscribeToTopic( MQTTContext_t * pMqttContext )

if( mqttStatus != MQTTSuccess )
{
LogError( ( "Failed to send SUBSCRIBE packet to broker with error = %u.",
mqttStatus ) );
LogError( ( "Failed to send SUBSCRIBE packet to broker with error = %s.",
MQTT_Status_strerror( mqttStatus ) ) );
returnStatus = EXIT_FAILURE;
}
else
Expand Down Expand Up @@ -596,8 +597,8 @@ static int unsubscribeFromTopic( MQTTContext_t * pMqttContext )

if( mqttStatus != MQTTSuccess )
{
LogError( ( "Failed to send UNSUBSCRIBE packet to broker with error = %u.",
mqttStatus ) );
LogError( ( "Failed to send UNSUBSCRIBE packet to broker with error = %s.",
MQTT_Status_strerror( mqttStatus ) ) );
returnStatus = EXIT_FAILURE;
}
else
Expand All @@ -615,7 +616,7 @@ static int unsubscribeFromTopic( MQTTContext_t * pMqttContext )
static int publishToTopic( MQTTContext_t * pMqttContext )
{
int returnStatus = EXIT_SUCCESS;
MQTTStatus_t mqttSuccess = MQTTSuccess;
MQTTStatus_t mqttStatus = MQTTSuccess;
MQTTPublishInfo_t publishInfo;

assert( pMqttContext != NULL );
Expand All @@ -632,14 +633,12 @@ static int publishToTopic( MQTTContext_t * pMqttContext )

/* Send PUBLISH packet. Packet Id is not used for a QoS0 publish.
* Hence 0 is passed as packet id. */
mqttSuccess = MQTT_Publish( pMqttContext,
&publishInfo,
0U );
mqttStatus = MQTT_Publish( pMqttContext, &publishInfo, 0U );

if( returnStatus != MQTTSuccess )
if( mqttStatus != MQTTSuccess )
{
LogError( ( "Failed to send PUBLISH packet to broker with error = %u.",
mqttSuccess ) );
LogError( ( "Failed to send PUBLISH packet to broker with error = %s.",
MQTT_Status_strerror( mqttStatus ) ) );
returnStatus = EXIT_FAILURE;
}
else
Expand Down Expand Up @@ -708,8 +707,8 @@ static int subscribePublishLoop( NetworkContext_t * pNetworkContext )
if( mqttStatus != MQTTSuccess )
{
returnStatus = EXIT_FAILURE;
LogError( ( "MQTT_ProcessLoop returned with status = %u.",
mqttStatus ) );
LogError( ( "MQTT_ProcessLoop returned with status = %s.",
MQTT_Status_strerror( mqttStatus ) ) );
}
}

Expand All @@ -734,8 +733,8 @@ static int subscribePublishLoop( NetworkContext_t * pNetworkContext )

if( mqttStatus != MQTTSuccess )
{
LogWarn( ( "MQTT_ProcessLoop returned with status = %u.",
mqttStatus ) );
LogWarn( ( "MQTT_ProcessLoop returned with status = %s.",
MQTT_Status_strerror( mqttStatus ) ) );
}

LogInfo( ( "Delay before continuing to next iteration.\n\n" ) );
Expand All @@ -762,8 +761,8 @@ static int subscribePublishLoop( NetworkContext_t * pNetworkContext )
if( mqttStatus != MQTTSuccess )
{
returnStatus = EXIT_FAILURE;
LogError( ( "MQTT_ProcessLoop returned with status = %u.",
mqttStatus ) );
LogError( ( "MQTT_ProcessLoop returned with status = %s.",
MQTT_Status_strerror( mqttStatus ) ) );
}
}

Expand Down
Loading