||
Skip to end of metadata
Go to start of metadata

Output Cassandra event adapter is used to dump output events in a Cassandra database.

Configuring output Cassandra event adapter

You can configure the output Cassandra event adapter either using the management console or using a configuration file.

Configure using the management console

Follow the steps below to configure output Cassandra event adapter using the management console. This deploys the event adapter in the <PRODUCT_HOME>/repository/deployment/server/outputeventadaptors/ directory.

  1. Cassandra is not enabled by default in WSO2 products. Therefore, before using Cassandra, start the product in Cassandra-enabled mode using the following command:
    ./wso2server.sh -Ddisable.cassandra.server.startup=false
  2. Log in to product's management console, and click Configure. 
  3. Click Output Event Adaptors in the Event Processor Configs menu, and then click Add Output Event Adaptor.
  4. Enter the details as shown in the below example. 

    create output Cassandra event adapter

  5. Click Add Event Adaptor.  

Configure using a configuration file

Follow the steps below to configure output Cassandra event adapter using a configuration file.

  1. Create an XML file with the following output Cassandra event adapter configurations. Output event adapter implementation must start with <outputEventAdaptor> as the root element.

    <outputEventAdaptor name="outputCassandraAdaptor" statistics="disable" trace="disable" type="cassandra" xmlns="http://wso2.org/carbon/eventadaptormanager">
      <property name="index.all.columns">false</property>
      <property name="user.name">cassandra</property>
      <property name="port">9160</property>
      <property name="password">cassandra</property>
      <property name="cluster.name">Test Cluster</property>
      <property name="hostname">localhost</property>
    </outputEventAdaptor> 
  2. Add the XML file to the <PRODUCT_HOME>/repository/deployment/server/outputeventadaptors/ directory. Since hot deployment is supported in the product, you can simply add/remove output event adapter configuration files to deploy/undeploy output event adapters to/from the server.

After an adapter is successfully added, it gets added to the list of adapters displayed under Event Processor Configs in the Configure menu of the product's management console. Click Edit 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.

Configuring output Cassandra event adapter message properties

The configured output event adapters are used in event formatters. With output event adapter message properties, event formatters are able to extract data from event streams and format the output events. Message properties specific to output event adapters of the cassandra type can be configured as follows. 
  1. Log into the BAM Management Console. For detailed instructions, see Running the Product.
  2. In the Main tab, click Event Streams to open the Available Event Streams page.
  3. Click the Outflows link of the event stream to which the relevant output event adapter is connected. As a result, Event Out-Flows (<Output_Event_Adapter_Name>) opens.
  4. Click on the relevant event builder name to open the Event Formatter Details page.
    output Cassandra event adapter message propertiesThe message properties of a cassandra output event adapter are described below. Change the property values as required.

    PropertyDescription
    Column Family NameName of the Cassandra family to which, you want to input data.
    Keyspace NameName of the Cassandra keyspace to which, you want to input data.
    Output Event TypeThe incoming event type to be mapped. The Output Cassandra event adapter supports only map type mappings.
  • No labels