Message Structure

Client JSON Message Schema

{
    "host": "{string}",
    "pname": "{string}",
    "time": "{date-rfc3339}",
    "native": {
        "*": "{*}"
    }
}

Required Fields

host

The host field of a message must contain the host name of the originator of the message being sent. This is a string type.

pname The pname field of a message must contain the process name of the originator of the message being sent. This is a string type.

time The time field of a message must contain an RFC3339 formatted time stamp representing when this message was generated. This is a string type.

Optional Fields

native The native field of a message is an optional component that may be utilized to extend the currently specified profile without having to provide a definition. Domain specific data should be placed here if there is no profile schema that correctly describes the domain.

The content of the native field may be indexed by Meniscus but this is not guaranteed.

Worker JSON Message Schema

{
    "host": "{string}",
    "pname": "{string}",
    "time": "{date-rfc3339}",
    "profile": "{uri}",
    "meniscus": {
        "correlation": {
            "host_id": "{number}",
            "ep_id": "{number}",
            "job_id": "{uuid4}"
        }
    },
    "native": {
        "*": "{*}"
    }
}

Required Fields

host

The host field of a message must contain the host name of the originator of the message being sent. This is a string type.

pname

The pname field of a message must contain the process name of the originator of the message being sent. This is a string type.

time

The time field of a message must contain an RFC3339 formatted time stamp representing when this message was generated. This is a string type.

profile

The profile field of a message must contain a valid URI. This URI must be equal to one of the available Meniscus profiles such as the default Meniscus CEE profile, http://projectmeniscus.org/cee/profiles/base.

meniscus

The meniscus field of the message may contain a dictionary of meta-data to be made available to downstream Meniscus workers.

meniscus.correlation

The correlation field of the meniscus field must contain a dictionary of message:system correlation data to be made available to downstream Meniscus workers.

meniscus.correlation.host_id

The host_id field of the correlation field must contain a number representing the related host configuration's ID.

Optional Fields

native

The native field of a message is an optional component that may be utilized to extend the currently specified profile without having to provide a definition. Domain specific data should be placed here if there is no profile schema that correctly describes the domain.

The content of the native field may be indexed by Meniscus but this is not guaranteed.

meniscus.correlation.ep_id

The ep_id field of the correlation structure must contain a number representing the related event producer configuration's ID.

meniscus.correlation.job_id

The job_id field of the correlation structure must contain a UUID representing the asynchronous job context ID of the message's processing.

Examples

Client Publication to Meniscus

{
    "host": "web-n01.dev.projectmeniscus.org",
    "pname": "webapp-1.0.2r1",
    "time": "2013-03-20T23:01:23.425602-05:00",
    "native": {
        "test": "value",
        "extended": {
            "customer": "12345"
        }
    }
}