Contact Free trial Login

Payload Formats and Logging

logo cloud disabled logo hybrid active logo server active logo rtf disabled

To send message payload data to external analytics software, Runtime Manager agent must first serialize and convert the data to text.

Because some payload formats can’t be converted to plain text, Runtime Manager agent converts only those formats that are considered to work. When the payload format can’t be converted, the agent passes only the fully qualified name of the payload class type, not the payload message content.

Runtime Manager agent version 1.6.2 and earlier attempts to convert all payload formats, which results in failures for some formats.

Default Conversion Behavior

The following table lists the payload formats and specifies whether Runtime Manager agent converts them to the String type and passes the payload message. If the Converted to String column shows FALSE, Runtime Manager agent passes only the payload class type.

Extension Kind of document MIME Type Converted to String

.epub

Electronic publication (EPUB)

application/epub+zip

FALSE

.jar

Java Archive (JAR)

application/java-archive

FALSE

.js

JavaScript (ECMAScript)

application/javascript

TRUE

.json

JSON format

application/json

TRUE

.doc

Microsoft Word

application/msword

FALSE

.arc

Archive document (multiple files embedded)

application/octet-stream

FALSE

.bin

Any kind of binary data

application/octet-stream

FALSE

.ogx

OGG

application/ogg

FALSE

.pdf

Adobe Portable Document Format (PDF)

application/pdf

FALSE

.rtf

Rich Text Format (RTF)

application/rtf

TRUE

.azw

Amazon Kindle eBook format

application/vnd.amazon.ebook

FALSE

.mpkg

Apple Installer Package

application/vnd.apple.installer+xml

FALSE

.xul

XUL

application/vnd.mozilla.xul+xml

TRUE

.xls

Microsoft Excel

application/vnd.ms-excel

FALSE

.ppt

Microsoft PowerPoint

application/vnd.ms-powerpoint

FALSE

.odp

OpenDocuemnt presentation document

application/vnd.oasis.opendocument.presentation

FALSE

.ods

OpenDocuemnt spreadsheet document

application/vnd.oasis.opendocument.spreadsheet

FALSE

.odt

OpenDocument text document

application/vnd.oasis.opendocument.text

FALSE

.vsd

Microsoft Visio

application/vnd.visio

FALSE

.7z

7-zip archive

application/x-7z-compressed

FALSE

.abw

AbiWord document

application/x-abiword

FALSE

.bz

BZip archive

application/x-bzip

FALSE

.bz2

BZip2 archive

application/x-bzip2

FALSE

.csh

C-Shell script

application/x-csh

TRUE

.rar

RAR archive

application/x-rar-compressed

FALSE

.sh

Bourne shell script

application/x-sh

TRUE

.swf

Small web format (SWF) or Adobe Flash document

application/x-shockwave-flash

FALSE

.tar

Tape Archive (TAR)

application/x-tar

FALSE

.xhtml

XHTML

application/xhtml+xml

TRUE

.xml

XML

application/xm

l TRUE

.zip

ZIP archive

application/zip

FALSE

.aac

AAC audio file

audio/aac

FALSE

.mid .midi

Musical Instrument Digital Interface (MIDI)

audio/midi

FALSE

.oga

OGG audio

audio/ogg

FALSE

.weba

WEBM audio

audio/webm

FALSE

.wav

Waveform Audio Format

audio/x-wav

FALSE

.ttf

TrueType Font

font/ttf

FALSE

.woff

Web Open Font Format (WOFF)

font/woff

FALSE

.woff2

Web Open Font Format (WOFF)

font/woff2

FALSE

.gif

Graphics Interchange Format (GIF)

image/gif

FALSE

.jpeg .jpg

JPEG images

image/jpeg

FALSE

.svg

Scalable Vector Graphics (SVG)

image/svg+xml

TRUE

.tif

.tiff Tagged Image File Format (TIFF)

image/tiff

FALSE

.webp

WEBP image

image/webp

FALSE

.ico

Icon format

image/x-icon

FALSE

.ics

iCalendar format

text/calendar

TRUE

.css

Cascading Style Sheets (CSS)

text/css

TRUE

.csv

Comma-separated values (CSV)

text/csv

TRUE

.htm

.html HyperText Markup Language (HTML)

text/html

TRUE

.txt

Plain Text

text/plain

TRUE

.3gp

3GPP audio/video container

video/3gpp audio/3gpp if it doesn’t contain video

FALSE

.3g2

3GPP2 audio/video container

video/3gpp2 audio/3gpp2 if it doesn’t contain video

FALSE

.mpeg

MPEG Video

video/mpeg

FALSE

.ogv

OGG video

video/ogg

FALSE

.webm

WEBM video

video/webm

FALSE

.avi

AVI: Audio Video Interleave

video/x-msvideo

FALSE

Multipart

"multipart/mixed, multipart/alternative, multipart/digest multipart/parallel"

FALSE

Customize Conversion Behavior

You can override the default behavior and configure the agent to forward all payload formats or none by adding properties to the conf/mule-agent.yml file.

For example, you might want to exclude some formats from the external logs if your organization is concerned about the security of sharing certain types of data.

Exclude Payloads

To exclude all payloads for a specific application:

    mule.agent.tracking.service:
        globalTrackingLevel: DEBUG
        enabled: true
        trackedApplications:
            - appName: someApp
              trackingLevel: DEBUG
              payloadExcluded: true

To exclude all payloads for all apps:

    mule.agent.tracking.service:
        globalTrackingLevel: DEBUG
        enabled: true
        globalPayloadExclusion: true

Include Payloads

You might want to convert and forward payload formats that Runtime Manager agent considers not convertible.

If you force conversion for all payload formats, the payload sent might be the payload class type, not the payload message content.

To include all payloads for a specific application:

    mule.agent.tracking.service:
        globalTrackingLevel: DEBUG
        enabled: true
        trackedApplications:
            - appName: someApp
              trackingLevel: DEBUG
              forcePayloadInclusion: true

To include all payloads for all apps:

    mule.agent.tracking.service:
        globalTrackingLevel: DEBUG
        enabled: true
        forceGlobalPayloadInclusion: true

Was this article helpful?

💙 Thanks for your feedback!

Edit on GitHub