MEMPHIS PROTOCOL ADAPTER

Memphis protocol adapter is developed in accordance with #849. It consists of 2 adapters:

• syslog-adapter
• rest-gateway

SYSLOG ADAPTER

syslog-adapter is based on

• syslogsidecar
• sputnik

syslog-adapter consists of:

• syslog server - common part for all syslogsidecar based processes
• memphis specific plugins

Syslog server

Supported RFCs:

• RFC3164
• RFC5424

RFC3164 message consists of following symbolic parts:

• priority
• facility
• severity
• timestamp
• hostname
• tag
• content

RFC5424

RFC5424 message consists of following symbolic parts:

• priority
• facility
• severity
• timestamp
• hostname
• version
• app_name
• proc_id
• msg_id
• structured_data
• message

Non-RFC parts

syslogsidecar adds rfc of produced message:

• Part name: "rfc"
• Values: "RFC3164"|"RFC5424"

Badly formatted messages

syslogsidecar creates only one part for badly formatted message - former syslog message:

• Part name: "data"

Filtering messages by severity level

Valid severity levels are:

• 0 (emerg)
• 1 (alert)
• 2 (crit)
• 3 (err)
• 4 (warning)
• 5 (notice)
• 6 (info)
• 7 (debug)

syslog server filters messages by severity level according to value in configuration, e.g. for:

{
  "SEVERITYLEVEL": 4,
}

all messages with severity above 4 will be discarded.

syslog server configuration

Configuration of syslog server part of syslogsidecar is saved in the file syslogreceiver.json:

{
    "SEVERITYLEVEL": 4,
    "ADDRTCP": "127.0.0.1:5141",
    "ADDRUDP": "127.0.0.1:5141",
    "UDSPATH": "",
    "ADDRTCPTLS": "127.0.0.1:5143",
    "CLIENT_CERT_PATH": "",
    "CLIENT_KEY_PATH ": "",
    "ROOT_CA_PATH": ""
}

Memphis Plugins

Connector

Configuration file: connector.json

{
    "MEMPHIS_ADDR": "localhost:6666",
    "MEMPHIS_CLIENT":"MEMPHIS HTTP LOGGER",
    "USER_PASS_BASED_AUTH": true,
    "ROOT_USER": "root",
    "ROOT_PASSWORD": "memphis",
    "CONNECTION_TOKEN": "memphis",
    "CLIENT_CERT_PATH": "",
    "CLIENT_KEY_PATH ": "",
    "ROOT_CA_PATH": "",
    "CLOUD_ENV": false,
    "DEBUG": true,
    "DEV_ENV": true
}

Part of configuration is placed within docker-compose.yml:

    environment:
          - MEMPHIS_ADDR=memphis:6666

Connector creates shared nats.Conn for:

• periodic validation of connectivity with memphis
• loggers

Producer

Configuration file: syslogproducer.json

{
    "MEMPHIS_HOST": "127.0.0.1",
    "MEMPHIS_USER": "root",
    "MEMPHIS_PSWRD": "memphis",
    "PRODUCER": "syslog-adapter",
    "STATION": "syslog",
    "RETENTIONTYPE":"MaxMessageAgeSeconds",
    "RETENTIONVALUE":600
}

Part of configuration is placed within docker-compose.yml:

    environment:
          - MEMPHIS_HOST=memphis

"syslog" station is the default station. The rest used stations are defined according to advanced producer configuration in syslogconf.json file:

[
    {
        "Selector": "data",
        "Target": "syslog-wrongmessages"
    },
    {
        "Selector": "emerg,alert,crit,err",
        "Target": "syslog-failures"
    },
    {
        "Selector": "local0,local1,local2,local3,local4,local5,local6,local7",
        "Target": "syslog-applcations"
    }
]

syslog messages are produced to memphis as MsgHeaders with empty payload:

err := mpr.producer.Produce("", memphis.MsgHeaders(hdrs))

REST GATEWAY

Description of rest gateway see memphis-rest-gateway

Configuration of the protocol-adapter process

• Configuration folder
• Syslog advanced configuration