The event
library provides functions for understanding an event and the environment in which it was raised. For historical reasons, some of these are Web-centric. The following functions are available:
event:env()-
returns information about the event's environment. The function takes an argument that determines what will be returned:caller -
return the URL of the Web page on which the event is firing (assumes an event in theweb
domain)ip -
return the IP number of the endpoint (client).referer -
return the URL of the referring page to the caller (assumes a web event).title -
return the page title of the calling page.- txn_id - return the transaction ID of this ruleset evaluation.
event:attr() -
returns a specific event attribute. The function takes the name of the attribute to be returned as its sole argument.event:attrs() -
returns all the event attributes as a map.event:channel()
- returns information about the event channel. The function takes an argument that determines what is returned:id
- returns the event channel identifier.