Skip to content

Event Files

When communicating with the agent through the event file mechanism, processes can output event files for consumption by the agent in JSON format.

Warning

For legacy reasons, the SAS Enterprise Session Monitor agent matches event files based on hostname and will disregard any files where the hostname element of the filename does not match the agent hostname exactly. This check may be removed in a future release.

new event

File name: new_12345_thishostname (where 12345 is the PID of the process to be monitored and thishostname is the agent recognised hostname)

File content (json) an array of

{
    "owner": "thisUser",
    "sasUuid": "234801532270870",
    "hostname" : "mysashost",
    "queue": "defaultQueue",
    "jobName": "Lev1_SASAppTest",
    "workFolder": "/data/saswork/SAS_workC02600003039_thishostname",
    "utilFolder": "/data/sasutil/tempUtil_12345_thishostname",
    "logFiles": [
      {
        "logFile": "/data/logs/someWorkspaceLog.log",
        "logPattern": "someWorkspaceLog.*.log.*",
        "logDirectory": "/data/logs/"
      }
    ],
    "esmType": "WS"
}

tag event

File name: tag_12345_thishostname_123 (where 12345 is the PID of the process to be monitored, thishostname is the agent recognised hostname and 123 is an identifier that ensures a unique filename for the eventfile, often an autoincremented counter)

File content (json)

[{
   "text": "flagText",
   "tooltip": "tooltipText with more detail",
   "color": "#FAAD39",
   "pid": 12345
}]

event event

File name:

File content (json) an array of

{
    hostname: "testhost"
    podId: "pod-this-is-a-test-123h73"
    containerId: "1235"
    sessionId: "12354"
    esmUser: "testuser"
    timeStamp: "2022-07-01T14:44:44,000"
    eventType: "testtype"
    eventContents : {
        color: "#3AA5FC"
        message: "I"
        tooltip: "This is a test"
    }
}

highlightStart event

File name: highlightStart_12345_thishostname (where 12345 is the PID of the process to be monitored and thishostname is the agent recognised hostname)

File content (json)

{
   "uuid": "234801532270870"
}

highlightEnd event

File name: highlightEnd_hostname_234801532270870 (where thishostname is the agent recognised hostname and 234801532270870 is the uuid

File content (json)

{
    "uuid":"234801532270870", 
    "text":"myJobName.sas", 
    "returnCode":0, 
    "flow":"1670:thisUser:some_daily_flow:some_daily_subflow:myJobName"
}

SAS Enterprise Session Monitor Agent Events directories

want to see it in SAS Enterprise Session Monitor. This value can be hardcoded or you can use the results of a named capture group from the processFilterRegex using the special variable format ${var}. | Yes | normal |

Last update: May 31, 2023
Created: May 31, 2023