rulego-components

rulego-components is a rule engine extension component library for RuleGo.

Features

The component library is divided into the following submodules:

• endpoint: Receiver endpoint, responsible for listening and receiving data, and then handing it over to the RuleGo rule engine for processing. For example: MQTT endpoint (subscribe to MQTT Broker data), HTTP endpoint (HTTP server)
• filter: Filter the messages.
  • x/luaFilter Use lua script to filter the messages.
• transform: Transform the messages.
  • x/luaTransform Use lua script to transform the messages.
• action: Perform some actions.
• stats: Perform statistics and analysis on the data.
• external: External integration, integrate with third-party systems, such as: calling kafka, database, third-party api, etc.
  • x/kafkaProducer kafka producer.
  • x/redisClient redis client.

Installation

Use the go get command to install rulego-components:

go get github.com/rulego/rulego-components

Usage

Use the blank identifier to import the extension component, and the extension component will automatically register to RuleGo

_ "github.com/rulego/rulego-components/external/redis"

Then use the type specified by the component in the rule chain JSON file to call the extension component

{
  "ruleChain": {
    "id": "rule01",
    "name": "Test rule chain"
  },
  "metadata": {
    "nodes": [
      {
        "id": "s1",
        "type": "x/redisClient",
        "name": "Name",
        "debugMode": true,
        "configuration": {
          "field1": "Configuration parameters defined by the component",
          "....": "..."
        }
      }
    ],
    "connections": [
      {
        "fromId": "s1",
        "toId": "Connect to the next component ID",
        "type": "The connection relationship with the component"
      }
    ]
  }
}

Contributing

The core feature of RuleGo is componentization, where all business logic is composed of components, and they can be flexibly configured and reused. Currently, RuleGo has built-in some common components, such as message type Switch, JavaScript Switch, JavaScript Filter, JavaScript Transformer, HTTP Push, MQTT Push, Send Email, Log Record and so on.
However, we know that these components are far from meeting the needs of all users, so we hope to have more developers contribute to RuleGo's extension components, making RuleGo's ecosystem more rich and powerful.

If you are interested in RuleGo and want to contribute to its extension components, you can follow these steps:

• Read RuleGo's documentation , and learn about its architecture, features and usage.
• Fork RuleGo's repository , and clone it to your local machine.
• Refer to RuleGo's examples , and write your own extension component, implementing the corresponding interfaces and methods.
• Test your extension component locally, and make sure it works properly and correctly.
• Submit your code and create a pull request, we will review and merge your contribution as soon as possible.
• Give a star to the RuleGo project on GitHub/Gitee, and let more people know about it.

We welcome and appreciate any form of contribution, whether it is code, documentation, suggestion or feedback. We believe that with your support, RuleGo will become a better rule engine and event processing framework. Thank you!

If the component code you submit has no third-party dependencies or is a general-purpose component, please submit it to the built-in components under github.com/rulego/rulego , otherwise submit it to this repository: rulego-components .

License

RuleGo is licensed under the Apache 2.0 License - see the [LICENSE] file for details.