WSO2 Data Analytics Server is succeeded by WSO2 Stream Processor. To view the latest documentation for WSO2 SP, see WSO2 Stream Processor Documentation.

All docs This doc
||
Skip to end of metadata
Go to start of metadata

Events can be notified or published to external systems from WSO2 servers using event publishers. Event publishers enable you to manage event publishing and notifications. They allow publishing events via multiple transports in JSON, XML, Map, text, and WSO2Event formats to various endpoints and data stores.

Configuring global properties

Global properties can be set for individual output event adapter types in the <DAS_HOME>/repository/conf/output-event-adapters.xml file. A global property set for an output event adapter type in this file applies to all the publishers 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 output event adapter type.

Custom properties cannot be added as global properties.

When the output event adapter type is RDBMS, it is allowed to change the queries used to perform the standard database operations. This enables you to use RDBMS database types that use different queries. Customised values can be defined for the following used in standard queries.

Attribute/activityCurrent query
stringVARCHAR(255)
doubleDOUBLE
integerINT
longBIGINT
floatFLOAT
createTableCREATE TABLE $TABLE_NAME ($COLUMN_TYPES)
insertDataToTableINSERT INTO $TABLE_NAME ($COLUMNS) VALUES ($VALUES)
isTableExistSELECT * FROM $TABLE_NAME limit 1
updateTableRowUPDATE $TABLE_NAME SET $COLUMN_VALUES WHERE $CONDITION
comma,
questionMark?
equal=
andAND
selectAllColumnsDataTypeInTableSELECT COLUMN_NAME, DATA_TYPE FROM INFORMATION_SCHEMA.COLUMNS WHERE TABLE_NAME = '$TABLE_NAME'
selectFromTableSELECT $COLUMNS FROM $TABLE_NAME
oracle.stringvarchar2(255)
oracle.longCLOB
oracle.doubleBINARY_DOUBLE
oracle.isTableExistSELECT * FROM $TABLE_NAME WHERE ROWNUM = 1
oracle.selectAllColumnsDataTypeInTableSELECT COLUMN_NAME, DATA_TYPE FROM USER_TAB_COLS WHERE TABLE_NAME = '$TABLE_NAME'
mssql.stringvarchar2(255)
mssql.isTableExistSELECT TOP 1 * FROM $TABLE_NAME
mssql.selectAllColumnsDataTypeInTableSELECT COLUMN_NAME, DATA_TYPE FROM INFORMATION_SCHEMA.COLUMNS WHERE TABLE_NAME = '$TABLE_NAME'
h2.integervarchar2(255)
h2.longREAL
h2.selectAllColumnsDataTypeInTableSHOW COLUMNS FROM $TABLE_NAME

The following properties are available for the http output 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
defaultMaxConnectionsPerHostThe maximum number of connections allowed per host configuration.Integer50
maxTotalConnectionsThe maximum number of connections allowed overall.Integer1000

The following properties are available for the jms output 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 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.Integer10000

The following properties are available for the mqtt output 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 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.Integer10000
connectionKeepAliveIntervalThe time interval in milliseconds at which a check should be carried out to identify inactive threads.Integer60

The following properties are available for the kafka output 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 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.Integer10000

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

Property KeyDescriptionData TypeDefault Value
mail.smtp.fromThe email address used by the publisher to publish events.Stringabcd@gmail.com
mail.smtp.userThe username used by the publisher to publish events via email.Stringabcd
mail.smtp.passwordThe password used by the publish events via email.Stringxxxx
mail.smtp.hostThe host of the email server.Stringsmtp.gmail.com
mail.smtp.portThe port of the email server.Integer587
mail.smtp.starttls.enableThis property specifies whether STARTTLS encryption is enabled or not. STARTTLS is an extension which enables a plain text connection to be upgraded to an encrypted (SSL or TLS) connection.Booleantrue
mail.smtp.authThis property specifies whether SMTP authentication is enabled or not.Booleantrue
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 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.Integer10000

The following properties are available for the UI output event adapter type.

Property KeyDescriptionData TypeDefault Value
eventQueueSizeThe maximum number of events allowed in the adapter queue when the rate at which a UI publisher receives events to be published higher than the rate at which the relevant UI is accepting the events. When the number of events received by the publisher exceeds the value specified for this property, the publisher stops accepting events until the events that are already in the queue get published. Therefore, if you want to reduce system latency, a higher queue size should be specified.Integer30
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 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.Integer10000

The following properties are available for the websocket-local output 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 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.Integer10000

The following properties are available for the websocket output 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 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.Integer10000

The following properties are available for the soap output 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 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.Integer10000
axis2ClientConnectionTimeoutThe number of milliseconds allowed to elapse before the Axis2 client connection times out.Integer10000
reuseHTTPClientIf this property is set to true, it is allowed to reuse the connection to the HTTP client for subsequent requests.Booleantrue
autoReleaseConnectionIf this property is set to true, inactive connections are automatically killed.Booleantrue
maxConnectionsPerHostThe maximum number of connections allowed per host configuration.Integer50

Event publisher configuration

An event publisher configuration has four main sections as follows. 

event publisher configuration in the UI

Event publisher configurations are stored in file system as hot deployable artifacts in the <PRODUCT _HOME>/repository/deployment/server/eventpublishers/ directory as shown in the example below .

<eventPublisher name="WebSocketEventPublisher" statistics="disable"
  trace="disable" xmlns="http://wso2.org/carbon/eventpublisher">
  <from streamName="testEventStream" version="1.0.0"/>
  <mapping customMapping="disable" type="text"/>
  <to eventAdapterType="websocket">
    <property name="websocket.server.url">ws://localhost:9099</property>
  </to>
</eventPublisher>

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

SectionDescription
FromThe event stream from which the event publisher will fetch the events for publishing.
ToAn output event adapter(transport) configuration that is used to send the events to.
Adapter properties

Output event adapters contain three types of adapter properties in their configuration as explained below.

  • Static Adapter Properties : You can add these properties via the management console. You cannot change them based on the event.
  • Dynamic Adapter Properties : You can add these properties via the management console. You can change them for each event by adding event attributes as follows: {{ attribute }} E.g.  http://localhost:8000/endpoint/{{endpointId}} 
  • Global Adapter Properties : These properties come from the <PRODUCT_HOME>/repository/conf/output-event-adapters.xml file. They are common for all adapters on its kind which was defined during the event publisher creation.
Mapping configurationThe format of the message that needs to be sent. You can configure custom mappings on the selected format via advanced settings.

Creating event publishers

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

Creating publishers using the management console 

Follow the steps below to create an event publisher using the management console of WOS2 CEP/DAS.

  • To create an event publisher via the management console, you must at least have one event stream defined.
  • Once and event publisher is created and saved, its XML configuration is saved in the <DAS_HOME>/repository/deployment/server/eventpublishers directory.
  1. Log in to the management console, and click Main.
  2. Click Publishers in the Event menu, and then click Add Event Publisher.
  3. Enter a name for Event Publisher Name. (Do not use spaces between the words in the name of the event publisher.)

  4. Select the Event Source with the published events.

  5. You view the Stream Attributes of the selected event source. You cannot edit the attributes of a created event stream in here. 
  6. Select the output transport to which you want to publish events for the Output Event Adapter Type, and enter the Adapter Properties accordingly. For instructions on the adapter properties of output transport types, see Event Publisher Types.

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

  8. Click Advanced to define custom output mappings based on the message format you selected, if you want to publish events that do not adhere to the default event formats. For more information on custom input mapping types, see Publishing Events in Various Event Formats.
  9. Click  Add Event Publisher ,   to create the event publisher in the system.  When you click  OK   in the pop-up message on successful addition of the event publisher, you view it in the  Available Event Publishers    list as shown below.  
    list of all existing event publishers

Creating publishers using a configuration file

Follow the steps below to create an event publisher using a configuration file.

  1. Create an XML file with the following event publisher configurations. An event publisher implementation should start with <eventPublisher> as the root element.

    In the following configuration, specify the respective adapter properties based on the transport type of the publisher within the <from> element. For the respective adapter properties of the event publisher configuration based on the transport type, see Publishing Events via Various Transports.

    <eventPublisher name="EVENT-PUBLISHER-NAME" statistics="disable"
      trace="disable" xmlns="http://wso2.org/carbon/eventpublisher">
      <from streamName="Test Stream" version="1.0.0"/>
      <mapping customMapping="disable" type="text"/>
      <to eventAdapterType="EVENT-ADAPTER-TYPE">
         .....................
      </to>
    </eventPublisher>

    The properties of the above configuration are described below.

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

    First define the stream to which the publisher is publishing data from to activate the publisher. When receiving WSO2Events, the outgoing stream definition that you select in the advanced input mappings must also be defined, to activate the event publisher. When you click Inactive Event Publishers in the Available Event Publishers screen, if an event publisher is in the inactive state due to some issue in the configurations, you view a short message specifying the reason why the event publisher is inactive as shown below. A similar message is also printed on the CLI.

    an inactive publisher

After a publisher is successfully added, it gets added to the list of publisher displayed under Event in the Main menu of the product's management console. ClickEdit to change its configuration and redeploy it. This opens an XML-based editor allowing you to edit the event adapter 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.

Enabling statistics for event publishers

Follow the steps below to enable monitoring statistics of events published by an existing event publisher.

For more information on monitoring event statistics of event publishers, see Event Statistics.

  1. Log in to the management console, and click Main.
  2. Click Publishers in the Event menu. You view the Available Event Publishers list.
  3. Click the Enable Statistics button of the corresponding event publisher to enable monitoring event statistics for it.

Enabling tracing for event publishers

Follow the steps below to enable tracing on events published by an existing event publisher.

For more information on monitoring event statistics of event publisher s, see Event Tracer.

  1. Log in to the management console, and click Main.
  2. Click Publishers  in the Event menu. You view the Available Event Publishers  list.
  3. Click the Enable Tracing button of the corresponding event publisher to enable event tracing for it. 

Deleting event publishers

Follow the steps below to delete an existing event publisher.

  1. Log in to the management console, and click Main.
  2. Click  Publishers  in the Event menu. You view the Available Event Publishers  list.
  3. Click the Delete button of the corresponding event publishe r to delete it.

Editing event publishers

Follow the steps below to edit an existing event publisher.

  1. Log in to the management console, and click Main.
  2. Click  Publishers  in the Event menu. You view the Available Event Publishers  list.
  3. Click the  Edit button of the corresponding event publishe r to edit it. This opens Edit Event Publishers  Configurations XML editor.  
  4. After editing, click Update, to save the configuration, or click Reset to reset the configuration to its original state.
  • No labels