How-To: Trigger your application with input bindings

Use Dapr input bindings to trigger event driven applications

Using bindings, your code can be triggered with incoming events from different resources which can be anything: a queue, messaging pipeline, cloud-service, filesystem etc.

This is ideal for event-driven processing, data pipelines or just generally reacting to events and doing further processing.

Dapr bindings allow you to:

  • Receive events without including specific SDKs or libraries
  • Replace bindings without changing your code
  • Focus on business logic and not the event resource implementation

For more info on bindings, read this overview.

For a quickstart sample showing bindings, visit this link.

1. Create a binding

An input binding represents an event resource that Dapr uses to read events from and push to your application.

For the purpose of this HowTo, we’ll use a Kafka binding. You can find a list of the different binding specs here.

Create the following YAML file, named binding.yaml, and save this to a components sub-folder in your application directory. (Use the --components-path flag with dapr run to point to your custom components dir)

Note: When running in Kubernetes, apply this file to your cluster using kubectl apply -f binding.yaml

  1. apiVersion: dapr.io/v1alpha1
  2. kind: Component
  3. metadata:
  4.   name: myevent
  5.   namespace: default
  6. spec:
  7.   type: bindings.kafka
  8.   version: v1
  9.   metadata:
  10.   - name: topics
  11.     value: topic1
  12.   - name: brokers
  13.     value: localhost:9092
  14.   - name: consumerGroup
  15.     value: group1

Here, you create a new binding component with the name of myevent.

Inside the metadata section, configure the Kafka related properties such as the topics to listen on, the brokers and more.

2. Listen for incoming events

Now configure your application to receive incoming events. If using HTTP, you need to listen on a POST endpoint with the name of the binding as specified in metadata.name in the file. In this example, this is myevent.

The following example shows how you would listen for the event in Node.js, but this is applicable to any programming language

  1. const express = require('express')
  2. const bodyParser = require('body-parser')
  3. const app = express()
  4. app.use(bodyParser.json())
  6. const port = 3000
  8. app.post('/myevent', (req, res) => {
  9.     console.log(req.body)
  10.     res.status(200).send()
  11. })
  13. app.listen(port, () => console.log(`Kafka consumer app listening on port ${port}!`))

ACK-ing an event

In order to tell Dapr that you successfully processed an event in your application, return a 200 OK response from your HTTP handler.

  1. res.status(200).send()

Rejecting an event

In order to tell Dapr that the event wasn’t processed correctly in your application and schedule it for redelivery, return any response different from 200 OK. For example, a 500 Error.

  1. res.status(500).send()

Event delivery Guarantees

Event delivery guarantees are controlled by the binding implementation. Depending on the binding implementation, the event delivery can be exactly once or at least once.

References

Last modified September 17, 2021 : Merge pull request #1757 from georgestevens99/1440SecretKeyRefExplanation (620a5f8)