convoy

package module

v0.9.0 Latest Latest Go to latest Published: Mar 28, 2023 License: MPL-2.0 Imports: 4 Imported by: 22

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/frain-dev/convoy

Links

Open Source Insights

README ¶

Convoy is an open source high-performance webhooks gateway used to securely ingest, persist, debug, deliver and manage millions of events reliably with rich features such as retries, rate limiting, static ips, circuit breaking, rolling secrets and more. To get started import the openapi spec into Postman or Insomnia.

Convoy provides several key features:

Webhooks Gateway: As a webhooks gateway, Convoy lives at the edge of your network to stream webhooks from your micoservices, and send them out to your users as well as receive webhooks from your providers and route them to the required services. With this your internal systems are never exposed to the public internet.
Scalability: Convoy acts as a dedicated message queue for webhooks, and was designed to be horizontally scalable. It includes several components like the api server, workers, scheduler, and socket server which can be scaled independently to fit the need.
Security: Convoy ships with several security features for webhooks, such as payload signing to ensure message integrity, bearer token authentication for authenticated webhook endpoints, and static ips for network environments with strict firewall rules.
Fan Out: Convoy is able to route an events to multiple endpoints based on the event type or payload structure.
Rate Limiting: While Convoy is able to ingest events at a massive rate, it throttles the delivery of these events to the endpoints at a configurable rate per endpoint.
Retries & Batch Retries: Convoy supports two retry algorithms; constant time and exponential backoff with jitter. Where automatic retries are not sufficient, convoy provides batch retries for endpoints are consecutively failed to process retried events.
Customer-Facing Dashboards: Convoy allows you to generate customer facing webhooks dashboard to embed into your applications using an iframe. On this dashboard, users can debug webhooks, retry events, add endpoints, and configure each endpoint's subscription.
Endpoint Failure Notifications: When endpoints consecutively fails to process events, convoy disables the endpoint and sends out a notification. Two types of notifications are supported: Email and Slack Notifications.

Installation, Getting Started

To do this make sure you have Docker 20+ installed.

# Get the code
$ git clone https://github.com/frain-dev/convoy.git

# Go to the Convoy folder
$ cd convoy

# Start Services
docker compose -f configs/local/docker-compose.yml up

Convoy Cloud

Get started with our free Cloud version -- Sign up for Convoy Cloud account

Contributing

Thank you for your interest in contributing! Please refer to CONTRIBUTING.md for guidance. For contributions to the Convoy dashboard, please refer to the web/ui directory.

License

Mozilla Public License v2.0

Documentation ¶

Index ¶

Constants
Variables
func GetVersion() string
func ReadVersion() ([]byte, error)
type CacheKey
- func (c CacheKey) Get(suffix string) CacheKey
- func (c CacheKey) String() string
type HttpMethod
type Plugin
type QueueName
type TaskName
- func (t TaskName) SetPrefix(prefix string) TaskName

Constants ¶

View Source

const (
	RATE_LIMIT          = 5000
	RATE_LIMIT_DURATION = "1m"
	HTTP_TIMEOUT        = "30s"
)

View Source

const (
	EventProcessor           TaskName = "EventProcessor"
	DeadLetterProcessor      TaskName = "DeadLetterProcessor"
	CreateEventProcessor     TaskName = "CreateEventProcessor"
	NotificationProcessor    TaskName = "NotificationProcessor"
	IndexDocument            TaskName = "index document"
	DailyAnalytics           TaskName = "daily analytics"
	StreamCliEventsProcessor TaskName = "StreamCliEventsProcessor"
	MonitorTwitterSources    TaskName = "monitor twitter sources"
	RetentionPolicies        TaskName = "retention_policies"
	EmailProcessor           TaskName = "EmailProcessor"
	ExpireSecretsProcessor   TaskName = "ExpireSecretsProcessor"

	EndpointsCacheKey          CacheKey = "endpoints"
	OrganisationsCacheKey      CacheKey = "organisations"
	OrganisationMemberCacheKey CacheKey = "organisation_members"
	ProjectsCacheKey           CacheKey = "projects"
	TokenCacheKey              CacheKey = "tokens"
	SourceCacheKey             CacheKey = "sources"
)

View Source

const (
	DefaultOnPremDir = "/var/convoy/export"
	TmpExportDir     = "/tmp/convoy/export"
)

Exports dir

View Source

const (
	Concurrency = 100
)

View Source

const (
	EventDeliveryIDLength = 12
)

Variables ¶

View Source

var ErrUnsupportedDatebase = fmt.Errorf("unsupported database for search detected, remove search configuration or use a supported database (postgres)")

View Source

var MigrationFiles embed.FS

Functions ¶

func GetVersion ¶ added in v0.4.10

func GetVersion() string

func ReadVersion ¶ added in v0.4.10

func ReadVersion() ([]byte, error)

Types ¶

type CacheKey ¶ added in v0.5.3

type CacheKey string

func (CacheKey) Get ¶ added in v0.5.3

func (c CacheKey) Get(suffix string) CacheKey

func (CacheKey) String ¶ added in v0.5.3

func (c CacheKey) String() string

type HttpMethod ¶

type HttpMethod string

const (
	HttpPost HttpMethod = "POST"
	HttpGet  HttpMethod = "GET"
)

type Plugin ¶

type Plugin interface {
	Apply(http.ResponseWriter, *http.Request) error
	Name() string
	IsEnabled() bool
}

type QueueName ¶ added in v0.6.0

type QueueName string

const (
	EventQueue       QueueName = "EventQueue"
	CreateEventQueue QueueName = "CreateEventQueue"
	SearchIndexQueue QueueName = "SearchIndexQueue"
	StreamQueue      QueueName = "StreamQueue"
	ScheduleQueue    QueueName = "ScheduleQueue"
	DefaultQueue     QueueName = "DefaultQueue"
)

queues

type TaskName ¶

type TaskName string

func (TaskName) SetPrefix ¶

func (t TaskName) SetPrefix(prefix string) TaskName

Source Files ¶

View all Source files

Directories ¶

Path	Synopsis
analytics
api
models
policies
testdb
auth
realm/file
realm/jwt
realm/native
realm/noop
realm_chain
cache
memory
noop
redis
cmd
config
algo
database
postgres
sqlite3
datastore
object-store
docs Package docs GENERATED BY SWAG; DO NOT EDIT This file was generated by swaggo/swag at 2023-03-27 13:59:19.768988367 +0100 WAT m=+5.797785299	Package docs GENERATED BY SWAG; DO NOT EDIT This file was generated by swaggo/swag at 2023-03-27 13:59:19.768988367 +0100 WAT m=+5.797785299
internal
email
notifications
pkg/apm
pkg/crc
pkg/exporter
pkg/fflag
pkg/fflag/flipt
pkg/metrics
pkg/middleware
pkg/migrator
pkg/pubsub
pkg/pubsub/google
pkg/pubsub/sqs
pkg/rdb
pkg/searcher
pkg/searcher/noop
pkg/searcher/typesense
pkg/server
pkg/smtp
pkg/socket
limiter
noop
redis
mocks Package mocks is a generated GoMock package.	Package mocks is a generated GoMock package.
net
pkg
compare
flatten
httpheader
log
signature
verifier
plugins
queue
redis
retrystrategies
services
tracer
util
v3gen
worker
task

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL