EventLog Configuration APIs

These APIs allow an admin user to add, edit or delete EventLogs and to perfrom EventLog Configuration.

APIs for EventLogFile

This API allows an admin user to add, edit or delete EventLogs in Applications Manager.

The parameters involved in executing this API request are:

Field Description
logFileName LogFile property of the Events
category The Type of LogFile for Windows or WindowsAzure - EventLogs, AzureTraceLogs, AzureDiagnosticLogs
ruletype RULETYPE ID column from the AM_RULETYPE table for the logfile.

Add

Syntax

XML - http://[ APM Host ]:[ APM Port ]/AppManager/xml/logfile?apikey=[ API Key ]&logFileName=[ Log File Name ]&category= [ EventLogs Catagory ]
JSON - http://[ APM Host ]:[ APM Port ]/AppManager/json/logfile?apikey=[ API Key ]&logFileName=[ Log File Name ]&category= [ EventLogs Catagory ]

Example

http://app-windows:59090/AppManager/xml/logfile?apikey=f87f10d80b6addd2b247c0b0b67b0f9a&logFileName=adminlogfile&category=EventLogs

Edit

Syntax

XML - http://[ APM Host ]:[ APM Port ]/AppManager/xml/logfile?apikey=[ API Key ]&logFileName=[ Log File Name ]&ruletype= [ Rule Type]
JSON - http://[ APM Host ]:[ APM Port ]/AppManager/json/logfile?apikey=[ API Key ]&logFileName=[ Log File Name ]&ruletype= [ Rule Type ]

Example

http://app-windows:59090/AppManager/xmlAppManager/xml/logfile?apikey=f87f10d80b6addd2b247c0b0b67b0f9a&logFileName=newadminname&ruletype=10000

Delete

Syntax

XML - http://[ APM Host ]:[ APM Port ]/AppManager/xml/logfile?apikey=[ API Key ]&ruletype=[ Type ]&TO_DELETE=[ TRUE ]
JSON - http://[ APM Host ]:[ APM Port ]/AppManager/json/logfile?apikey=[ API Key ]&ruletype=[ Type ]&TO_DELETE=[ TRUE ]

Example

http://app-windows:59090/AppManager/xml/logfile?apikey=f87f10d80b6addd2b247c0b0b67b0f9a&ruletype=10000&TO_DELETE=true

APIs for EventLog Configuration

This API allows an admin user to perform EventLog Configuration in Applications Manager. The parameters involved in executing this API request are:

Field Description
rulename Enter the Rule Name of your choice.
eventid Enter the Event ID associated with the Event Log File
source Source of the Event Log File
category EventLogs category
eventtype Values accepted are
  • 0 - Event of Any Type
  • 1 - Error
  • 2 - Warning
  • 3 - Information Respectively
severity 1,4 for Critical and Warning respectively
ruletype RULETYPE ID column from the AM_RULETYPE table for the logfile for Map to Application or Security events etc.
status Status of the EventLog. Values accepted are 1 and 0 for Enable and Disable Respectively
resourceids Resourceids of Windows monitors (Supports comma separated values).
logCategoryName EventLogs category name for Windows
ruleid Rule ID
servertypes Supported Windows Monitor Server types
haid Monitor Group id
TimeFrame Option to set alarm severity to 'Critical' or 'Warning' based on a given time window. Values accepted are:
  • 1 - used to mention current log rule is time frame based one.
  • 24 - used to mention current log rule is 24 hours based one

Syntax

XML - http://[ APM Host ]:[ APM Port ]/AppManager/xml/logfile?apikey=[ API Key ]&logFileName=[ Log File Name ]&ruletype= [ Rule Type ]&..
JSON - http://[ APM Host ]:[ APM Port ]/AppManager/json/logfile?apikey=[ API Key ]&logFileName=[ Log File Name ]&ruletype= [ Rule Type ]&..

Add

Apply to All monitors:

http://app-windows:59090/AppManager/xml/logrule?apikey=f87f10d80b6addd2b247c0b0b67b0f9a&rulename=addedinrestapi&eventid=121&source=&category=&username=&eventtype=0&message=&severity=1&ruletype=1&status=1&resourceids=&logCategoryName=EventLogs&applyto=allmonitor&TimeFrame=1

Apply to Specific Monitor types:

http://app-windows:59090/AppManager/xml/logrule?apikey=f87f10d80b6addd2b247c0b0b67b0f9a&logCategoryName=WindowsEventLogs&status=1&rulename=adminmontyperestapi&rulescope=1&haid=10045&severity=1&eventid=210&resourceids=&message=-1&applyto=monitortype&ruletype=1&username=-1&category=-1&source=-1&servertypes=Windows 2000&eventtype=0&displayname=addmontype&TimeFrame=1

Apply to selected monitors:

http://app-windows:59090/AppManager/xml/logrule?apikey=f87f10d80b6addd2b247c0b0b67b0f9a&rulename=admintestindi&eventid=121&alsource=&category=&username=&eventtype=0&message=&severity=1&ruletype=1&status=1&resourceids=10000097,10000100,20000076,20000065&logCategoryName=EventLogs&applyto=monitorlist&TimeFrame=1

Apply to monitors under a group:

http://app-windows:59090/AppManager/xml/logrule?apikey=f87f10d80b6addd2b247c0b0b67b0f9a&prerulestatus=&logCategoryName=WindowsEventLogs&status=1&rulename=adminhaid&rulescope=1&haid=10056&severity=1&eventid=210&message=-1&applyto=monitorgroup&ruletype=1&username=-1&category=-1&source=-1&servertypes=&savetype=new&eventtype=0&TimeFrame=1

Edit

Change Advanced Options:

http://app-windows:59090/AppManager/xml/logrule?apikey=f87f10d80b6addd2b247c0b0b67b0f9a&logCategoryName=EventLogs&status=1&rulename=newname&severity=1&eventid=121&resourceids=&message=testdesc1&applyto=monitorlist&category=testcatecategory1&username=testuser1&ruletype=1&source=testsource1&ruleid=10003&eventtype=1&displayname=newname&TimeFrame=1

Change Event Type:

http://app-windows:59090/AppManager/xml/logrule?apikey=f87f10d80b6addd2b247c0b0b67b0f9a&eventtype=3&ruleid=10004&TimeFrame=1

Change Severity:

http://app-windows:59090/AppManager/xml/logrule?apikey=f87f10d80b6addd2b247c0b0b67b0f9a&severity=4&ruleid=10004&TimeFrame=1

Change Applyto Option:

http://app-windows:59090/AppManager/xml/logrule?apikey=f87f10d80b6addd2b247c0b0b67b0f9a&severity=4&ruleid=10004&applyto=monitorlist&resourceids=10000094&TimeFrame=1
http://app-windows:59090/AppManager/xml/logrulet?apikey=f87f10d80b6addd2b247c0b0b67b0f9a&severity=4&ruleid=10005&applyto=monitorgroup&haid=10056&TimeFrame=1

Montype add/remove:

http://app-windows:59090/AppManager/xml/logrule?apikey=f87f10d80b6addd2b247c0b0b67b0f9a&type=monitortype&action=add&servertypes=Windows 2012&ruleid=10006&TimeFrame=1
http://app-windows:59090/AppManager/xml/logrule?apikey=f87f10d80b6addd2b247c0b0b67b0f9a&type=monitortype&action=remove&servertypes=Windows 2012&ruleid=10006&TimeFrame=1

To add/remove a monitor from a rule:

http://app-windows:59090/AppManager/xml/logrule?apikey=f87f10d80b6addd2b247c0b0b67b0f9a&action=add&resourceids=100001&ruleid=10007&type=monitorlist&TimeFrame=1
http://app-windows:59090/AppManager/xml/logrule?apikey=f87f10d80b6addd2b247c0b0b67b0f9a&action=remove&resourceids=10000097&ruleid=10007&type=monitorlist&TimeFrame=1

Change Status:

http://app-windows:59090/AppManager/xml/logrule?apikey=f87f10d80b6addd2b247c0b0b67b0f9a&action=changestatus&ruleids=10000003,10000002&status=disable&TimeFrame=1
http://app-windows:59090/AppManager/xml/logrule?apikey=f87f10d80b6addd2b247c0b0b67b0f9a&action=changestatus&ruleids=10000003,10000002&status=enable&TimeFrame=1

Delete

Delete Logrule:

http://app-windows:59090/AppManager/xml/logrule?apikey=f87f10d80b6addd2b247c0b0b67b0f9a&action=changestatus&ruleids=10000003,10000002&status=disable