# jsonmesg

Provides the entire message object as a JSON representation.

This property belongs to the Message Properties group.

Name:

  jsonmesg

Category:

  Message Properties

Type:

  JSON

Introduced:

  8.3.0

## Description

The whole message object as JSON representation. Note that the JSON string will not include an LF and it will contain all other message properties specified here as respective JSON containers. It also includes all message variables in the “$!” subtree (this may be null if none are present).

This property is primarily meant as an interface to other systems and tools that want access to the full property set (namely external plugins). Note that it contains the same data items potentially multiple times. For example, parts of the syslog tag will by contained in the rawmsg, syslogtag, and programname properties. As such, this property has some additional overhead. Thus, it is suggested to be used only when there is actual need for it.

## Usage

    template(name="example" type="list") {
        property(name="jsonmesg")
    }

### Notes

Use this property when consumers require the complete structured message in a single JSON object.

## See also

See rsyslog Properties for the category overview.

Support: rsyslog Assistant | GitHub Discussions | GitHub Issues: rsyslog source project

Contributing: Source & docs: rsyslog source project

© 2008–2025 Rainer Gerhards and others. Licensed under the Apache License 2.0.