Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Events are received by WSO2 CEP/DAS server using event receivers, which manage the event retrieval process. Event receiver configurations are stored in the file system as deployable artifacts. WSO2 CEPDAS CEP/DAS receives events via multiple transports in JSON, XML, Map, Text, and WSO2Event formats, and converts them into streams of canonical WSO2Events to be processed by the server. 

Table of Contents
maxLevel3

Configuring global properties

Global properties can be set for individual input event adapter types in the <DAS_HOME>/repository/conf/input-event-adapters.xml file. A global property set for an input event adapter type in this file applies to all the receivers with that adapter type. If a property available for an adapter type by default is removed, the default value of the property applies. Click the relevant tab to view the properties available by default for a specific input event adapter type.

Info

Custom properties cannot be added as global properties.

Localtabgroup
Localtab
titleHTTP

The following properties are available for the http input event adapter type.

Property KeyDescriptionData TypeDefault Value
minThreadThe minimum number of threads (including idle threads) that should be available in the thread pool at a given time.Integer8
maxThreadThe maximum number of threads (including idle threads) that should be available in the thread pool at a given time.Integer100
keepAliveTimeInMillisThe maximum number of milliseconds that idle threads should be kept alive when the total number of threads in the pool exceeds the number of cores in the machine.Integer20000
jobQueueSizeThe size of the queue that is used to hold events before they are forwarded to the event stream.Integer10000
Localtab
titleFile-tail

The following properties are available for the file-tail input event adapter type.

Property KeyDescriptionData TypeDefault Value
events.duplicated.in.clusterIf this property is set to true, events received by file-tail receivers are re-created in every node in the cluster.Booleanfalse
Localtab
titleEmail

The following properties are available for the email input event adapter type.

Property KeyDescriptionData TypeDefault Value
moveToFolderNameThe name of the folder in which the events received should be saved. If a folder with the given name does not already exist in the email server, it will be automatically created when events are received by email-receivers.StringreadMails
Localtab
titleJMS

The following properties are available for the jms input event adapter type.

Property KeyDescriptionData TypeDefault Value
keepAliveTimeInMillisThe maximum number of milliseconds that idle threads should be kept alive when the total number of threads in the pool exceeds the number of cores in the machine.Integer20000
jobQueueSizeThe size of the queue that is used to hold events before they are forwarded to the event stream.Integer10000

Event receiver types
Anchor
Event Receiver Types
Event Receiver Types

WSO2 CEP/DAS has the capability of receiving events from event receivers via various transport protocols. Following are the event receivers that come with WSO2 CEP/DAS by default. You can write extensions to support other transport.

Child pages (Children Display)

Info

In addition to the above, the SQS extension allows you to receive events via SQS.

For instructions to download and install an extension, see Downloading and Installing Extensions from the Store.


Event receiver configuration

An event receiver configuration has four main sections as shown in the example below

...

The above sections of an event receiver configuration are described below.

Section
Description
FromAn input event adapter (transport) configuration via which the event receiver receives events.
Adapter propertiesSpecific properties of the selected input event adapter. For information on configuring adapter properties of various transport types, see Event Receiver Types.
ToThe event stream from which the event receiver will fetch the events for processing.
Mapping configurationThe format of the message that is received. You can configure custom mappings on the selected format via advanced settings. For information on configuring custom mappings, see Input Mapping Types.

Creating event receivers

You can create event receivers either using the management console or  or using a configuration file as explained below.

Anchor
Creating receivers using the management console
Creating receivers using the management console
Creating receivers using the management console 

...

  1. Log in to the management console, and click Main.
  2. Click Receivers in the Event menu, and then click Add Event Receiver.
  3. Enter a name for Event Receiver Name. (Do not use spaces between the words in the name of the event receiver.)

  4. Select the input transport from which you want to receive events for the  Input Event Adapter Type, and enter the Adapter Properties accordingly. For instructions on the adapter properties of input transport types, see Event Receiver Types .

  5. Select the Event Stream, to which you want to map the received events.

  6. Select the Message Format which you want to apply on the receiving events. WSO2 servers allow users to configure events in XML, JSON, Text, Map, and WSO2Event event formats.

  7. Click Advanced to define custom input mappings based on the message format you selected, if you are sending events that do not adhere to the default event formats /wiki/spaces/TESB/pages/32604416For more information on custom input mapping types, see Input Mapping Types.
  8. Click Add Event Receiver, to create the event receiver in the system. When you click  OK  in the pop-up message on successful addition of the event receiver, you view it in the  Available Event Receivers  list as shown below.
    available event receivers list

...

  1. Create an XML file with the following event receiver configurations. An event receiver implementation must start with  <eventReceiver> as the root element.

    Note

    In the following configuration, specify the respective adapter properties based on the transport type of the receiver within the <from> element. For the respective adapter properties of the event receiver configuration based on the transport type, see Event Receiver Types .

    Code Block
    languagexml
    <eventReceiver name="EVENT-RECEIVER-NAME" statistics="disable" trace="disable" xmlns="http://wso2.org/carbon/eventreceiver">
        <from eventAdapterType="EVENT-ADAPTER-TYPE">
           .................................
        </from>
        <mapping customMapping="disable" type="xml"/>
        <to streamName="Test Stream" version="1.0.0"/>
    </eventReceiver>

    The properties of the above configuration are described below.

    Adapter propertyDescription
    name
    Name of the event receiver
    statistics
    Whether monitoring event statistics is enabled for the receiver
    trace
    Whether tracing events is enabled for the receiver
    xmlns
    XML namespace for event receivers
    eventAdapterType
    Type of the event adapter.
    customMapping
    Whether a custom mapping is enabled on the receiver.
    type
    Type of the enabled custom mapping.
    streamName
    Name of the event stream to which the receiver is mapped.
  2.   Add the XML file to the <PRODUCT_HOME>/repository/deployment/server/eventreceivers/directory directory. Since hot deployment is supported in the product, you can simply add/remove event receiver configuration files to deploy/undeploy event receivers to/from the server.

...

After a receiver is successfully added, it gets added to the list of receivers displayed under under Event in the  in the  Main   menu of the product's management console. Click Edit  Edit to change its configuration and redeploy it. This opens an XML-based editor allowing you to edit the event receiverr configurations event receiver configurations from the UI. Do your modifications and click Update. You can also delete it, enable/disable statistics or enable/disable tracing on it using the provided options in the UI as described below.

...