Understanding channels
Channels in EventCatalog describe how a messages transport between producers and consumers. You can use the channels resource to help your team understand how your messages are transported.
Example of channels (not limited to) can be topics, queues, buses.
Resources page
eventcatalog@5.0.0Every channel that is connected to something gets a Resources page. Open it from Quick Reference > Resources in the channel's sidebar, or go to /docs/channels/{channel-id}/{version}/resources.
The page lists everything the channel connects to, with a Relationship column that shows how each one is connected:
| Resource | Relationship |
|---|---|
| Services and agents that send messages to the channel or receive messages from it | Produces messages, Receives messages or Produces & receives |
| Events, commands and queries the channel transports | Transports |
| Decision records that apply to the channel | Governed by |
Use the Inbound filter to see what sends messages to the channel, and Outbound to see what receives messages from it. You can also filter by resource type, search, sort and paginate the table, and use each row's ... menu to open the resource. See the service Resources page for more on these controls.
Supported Channel Protocols
Here is a list of protocols that are supported by EventCatalog (with icons)
- amqp
- azure-event-hubs
- azure-service-bus
- azure-eventgrid
- eventbridge
- googlepubsub
- grpc
- http
- jms
- kafka
- kinesis
- mercure
- mqtt
- nats
- pulsar
- redis
- sns
- solace
- sqs
- tibco-ftl
- tibco-rv
- ws
- webrtc
- zmq
If you are using a protocol that is not on this list, please raise on issue on GitHub so we can get the icon supported.