convoy

package module
v0.5.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Mar 25, 2022 License: MPL-2.0 Imports: 6 Imported by: 22

README

Convoy

golangci-lint Build and run all tests

convoy image

Convoy is a fast & secure webhooks service. It receives event data from a HTTP API and sends these event data to the configured endpoints. To get started download the openapi spec into Postman or Insomnia.

Convoy includes the following features:

  • Security: Convoy signs the payload of events, so applications ensure the events have not been tampered with. You can configure your desired hash function to use as well as the name of the header E.g. X-Stripe-Signature to enable backward comptabile migrations from custom built systems to Convoy.

  • URL per Events: Convoy is able to receive one event and fan-out the event to multiple endpoints based on the configuration by the endpoint owner. On subscription, the endpoint owner configures what events should go to each endpoint. Overlaps are allowed.

  • Retries: Convoy current supports two retry mechanism: Constant time retries and exponential backoff. You can configure which retry mechanism works best for your application.

  • Management UI: Visibility and easy debugging are one of highly coverted features of a webhook delivery system. Convoy provides a UI to view your delivery attempt logs, filter by application, event status, date & time and perform flexible batch retries during downtimes.

  • Other features(Coming soon): Application Portal; enable you embed Convoy dashboard directly into your dashboard, Rate Limiting, Replay Attacks prevention, Multiple Ingest sources.

Installation, Getting Started

Follow the instructions on our quick start guide to start publishing events with Convoy.

There are several ways of installing Convoy.

Binaries

Convoy binaries can be downloaded with your package manager of choice. You can head over to Downloads Page to proceed.

Docker images

Docker images are available on Github Container Registry.

You can launch a Convoy Container with the following

$ docker run \
	-p 5005:5005 \
	--name convoy-server \
	-v `pwd`/convoy.json:/convoy.json \
	ghcr.io/frain-dev/convoy:v0.4.9

You can view a sample configuration here - convoy.json.

Building from source

To build Convoy from source code, you need:

git clone https://github.com/frain-dev/convoy.git && cd convoy
go build -o convoy ./convoy

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

View Source 
const (
	RATE_LIMIT          = 5000
	RATE_LIMIT_DURATION = "1m"
	HTTP_TIMEOUT        = "30s"
)
View Source 
const (
	StreamGroup           = "taskq"
	EventDeliveryIDLength = 12
)
View Source 
const (
	MaxNumWorkers = 1000
	// Maximum number of goroutines fetching messages
	MaxNumFetcher = 10
	// Number of messages reserved by a fetcher in the queue in one request.
	ReservationSize = 1000
	//Size of the internal buffer
	BufferSize = 100000
)

Variables

View Source 
var DefaultLevels = []log.Level{
	log.ErrorLevel,
	log.PanicLevel,
	log.FatalLevel,
	log.WarnLevel,
}

Functions

func GetVersion added in v0.4.10 

func GetVersion() string

func ReadVersion added in v0.4.10 

func ReadVersion() ([]byte, error)

Types

type HttpMethod 

type HttpMethod string
const (
	HttpPost HttpMethod = "POST"
)

type Plugin 

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

type SentryHook 

type SentryHook struct {
	LogLevels []log.Level
}

func NewSentryHook 

func NewSentryHook(levels []log.Level) *SentryHook

func (*SentryHook) Fire 

func (s *SentryHook) Fire(entry *log.Entry) error

func (*SentryHook) Levels 

func (s *SentryHook) Levels() []log.Level

type TaskName 

type TaskName string
const (
	EventProcessor      TaskName = "EventProcessor"
	DeadLetterProcessor TaskName = "DeadLetterProcessor"
)

func (TaskName) SetPrefix 

func (t TaskName) SetPrefix(prefix string) TaskName

Source Files

View all Source files

Directories

Path Synopsis
realm/file
realm/native
realm/noop
realm_chain
memory
redis
algo
badger
mongo
noop
redis
Package mocks is a generated GoMock package.
 Package mocks is a generated GoMock package.
memqueue
redis
models
task

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.