def _encode_message(op, message):
"""
Gzip and base64 encode a message based on the operation.
The intent of this message is to make the logs human readable and include the
stdout/stderr from extension operations. Extension operations tend to generate
a lot of noise, which makes it difficult to parse the line-oriented waagent.log.
The compromise is to encode the stdout/stderr so we preserve the data and do
not destroy the line oriented nature.
The data can be recovered using the following command:
$ echo '<encoded data>' | base64 -d | pigz -zd
You may need to install the pigz command.
:param op: Operation, e.g. Enable or Install
:param message: Message to encode
:return: gzip'ed and base64 encoded message, or the original message
"""
if len(message) == 0:
return message
if op not in SHOULD_ENCODE_MESSAGE_OP:
return message
try:
return textutil.compress(message)
except Exception:
# If the message could not be encoded a dummy message ('<>') is returned.
# The original message was still sent via telemetry, so all is not lost.
return "<>"
def _encode_message(op, message):
"""
Gzip and base64 encode a message based on the operation.
The intent of this message is to make the logs human readable and include the
stdout/stderr from extension operations. Extension operations tend to generate
a lot of noise, which makes it difficult to parse the line-oriented waagent.log.
The compromise is to encode the stdout/stderr so we preserve the data and do
not destroy the line oriented nature.
The data can be recovered using the following command:
$ echo '<encoded data>' | base64 -d | pigz -zd
You may need to install the pigz command.
:param op: Operation, e.g. Enable or Install
:param message: Message to encode
:return: gzip'ed and base64 encoded message, or the original message
"""
if len(message) == 0:
return message
if op not in SHOULD_ENCODE_MESSAGE_OP:
return message
try:
return textutil.compress(message)
except Exception:
# If the message could not be encoded a dummy message ('<>') is returned.
# The original message was still sent via telemetry, so all is not lost.
return "<>"
def test_compress(self):
result = textutil.compress('[stdout]\nHello World\n\n[stderr]\n\n')
self.assertEqual(
'eJyLLi5JyS8tieXySM3JyVcIzy/KSeHiigaKphYVxXJxAQDAYQr2', result)
def test_compress(self):
result = textutil.compress('[stdout]\nHello World\n\n[stderr]\n\n')
self.assertEqual('eJyLLi5JyS8tieXySM3JyVcIzy/KSeHiigaKphYVxXJxAQDAYQr2', result)
