Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/vardius/pubsub

gRPC message-oriented middleware on top of message-bus, event ingestion and delivery system.
https://github.com/vardius/pubsub

broker bus docker docker-image grpc grpc-go message-broker message-bus message-queue pubsub queue

Last synced: 3 months ago
JSON representation

gRPC message-oriented middleware on top of message-bus, event ingestion and delivery system.

Host: GitHub
URL: https://github.com/vardius/pubsub
Owner: vardius
License: mit
Created: 2019-06-19T00:04:52.000Z (over 5 years ago)
Default Branch: master
Last Pushed: 2023-02-25T05:45:16.000Z (almost 2 years ago)
Last Synced: 2024-10-14T06:09:02.332Z (3 months ago)
Topics: broker, bus, docker, docker-image, grpc, grpc-go, message-broker, message-bus, message-queue, pubsub, queue
Language: Go
Homepage: https://hub.docker.com/r/vardius/pubsub
Size: 104 KB
Stars: 48
Watchers: 1
Forks: 10
Open Issues: 2
Metadata Files:
- Readme: README.md
- Contributing: .github/CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE.md
- Code of conduct: .github/CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

        # 📬 pubsub

[![Build Status](https://travis-ci.org/vardius/pubsub.svg?branch=master)](https://travis-ci.org/vardius/pubsub)

[![Go Report Card](https://goreportcard.com/badge/github.com/vardius/pubsub)](https://goreportcard.com/report/github.com/vardius/pubsub)

[![codecov](https://codecov.io/gh/vardius/pubsub/branch/master/graph/badge.svg)](https://codecov.io/gh/vardius/pubsub)

[![FOSSA Status](https://app.fossa.io/api/projects/git%2Bgithub.com%2Fvardius%2Fpubsub.svg?type=shield)](https://app.fossa.io/projects/git%2Bgithub.com%2Fvardius%2Fpubsub?ref=badge_shield)

[![](https://godoc.org/github.com/vardius/pubsub?status.svg)](https://pkg.go.dev/github.com/vardius/pubsub)

[![Docker Pulls](https://img.shields.io/docker/pulls/vardius/pubsub.svg)](https://hub.docker.com/r/vardius/pubsub/)

[![license](https://img.shields.io/github/license/mashape/apistatus.svg)](https://github.com/vardius/pubsub/blob/master/LICENSE.md)



pubsub - gRPC message-oriented middleware on top of [message-bus](https://github.com/vardius/message-bus), event ingestion and delivery system.

  Table of Contents

- [About](#about)

- [How to use](#how-to-use)

  - [Docker](#docker)

    - [How to use this image](#how-to-use-this-image)

    - [Environment Variables](#environment-variables)

    - [Makefile](#makefile)

  - [Client](https://github.com/vardius/pubsub/tree/master/proto#client)

    - [Use in your Go project](https://github.com/vardius/pubsub/tree/master/proto#use-in-your-go-project)

      - [Publish](https://github.com/vardius/pubsub/tree/master/proto#publish)

      - [Subscribe](https://github.com/vardius/pubsub/tree/master/proto#subscribe)

  - [Protocol Buffers](https://github.com/vardius/pubsub/tree/master/proto#protocol-buffers)

  - [Generating client and server code](https://github.com/vardius/pubsub/tree/master/proto#generating-client-and-server-code)

# 📖 ABOUT

[pubsub](https://github.com/vardius/pubsub) allows you to publish even that is delivered to all subscribed clients. 

See also [pushpull](https://github.com/vardius/pushpull).

Contributors:

- [Rafał Lorenz](http://rafallorenz.com)

Want to contribute ? Feel free to send pull requests!

Have problems, bugs, feature ideas?

We are using the github [issue tracker](https://github.com/vardius/pubsub/issues) to manage them.

# 🚏 HOW TO USE

## 🐳 [Docker Hub](https://hub.docker.com/r/vardius/pubsub)

Pull image from the command line:

```bash

$ docker pull vardius/pubsub:latest

```

Use as base image in DockerFile:

```Dockerfile

FROM vardius/pubsub:latest

```

## [Github Package Registry](https://github.com/vardius/pubsub/packages/108226)

Pull image from the command line:

```bash

$ docker pull docker.pkg.github.com/vardius/pubsub/pubsub:latest

```

Use as base image in DockerFile:

```Dockerfile

FROM docker.pkg.github.com/vardius/pubsub/pubsub:latest

```

### How to use this image

Starting a pubsub instance:

```bash

docker run --name my-pubsub -e QUEUE_BUFFER_SIZE=100 -d vardius/pubsub:tag

```

### Environment Variables

#### `HOST` (string)

This is optional variable, sets gRPC server host value. **Default `0.0.0.0`**

#### `PORT` (int)

This is optional variable, sets gRPC server port value. **Default `9090`**

#### `QUEUE_BUFFER_SIZE` (int)

This is optional variable, sets buffered channel length per subscriber. **Default 0**, which evaluates to `runtime.NumCPU()`.

#### `KEEPALIVE_MIN_TIME`

This is optional variable, if a client pings more than once every **5 minutes (default)**, terminate the connection.

ParseDuration parses a duration string. A duration string is a possibly signed sequence of decimal numbers, each with optional fraction and a unit suffix, such as `300ms`, `-1.5h` or `2h45m`. Valid time units are `ns`, `us` (or `µs`), `ms`, `s`, `m`, `h`

#### `KEEPALIVE_TIME` (nanoseconds)

This is optional variable, ping the client if it is idle for **2 hours (default)** to ensure the connection is still active.

ParseDuration parses a duration string. A duration string is a possibly signed sequence of decimal numbers, each with optional fraction and a unit suffix, such as `300ms`, `-1.5h` or `2h45m`. Valid time units are `ns`, `us` (or `µs`), `ms`, `s`, `m`, `h`

#### `KEEPALIVE_TIMEOUT` (nanoseconds)

This is optional variable, wait **20 second (default)** for the ping ack before assuming the connection is dead.

ParseDuration parses a duration string. A duration string is a possibly signed sequence of decimal numbers, each with optional fraction and a unit suffix, such as `300ms`, `-1.5h` or `2h45m`. Valid time units are `ns`, `us` (or `µs`), `ms`, `s`, `m`, `h`

#### `LOG_VERBOSE_LEVEL` (int)

This is optional variable, Verbose level. `-1` = Disabled, `0` = Critical, `1` = Error, `2` = Warning, `3` = Info, `4` = Debug. **Default 3 (Info)**.

### Makefile

```sh

➜  pubsub git:(master) make help

version                        Show version

docker-build                   Build given container. Example: `make docker-build`

docker-run                     Run container on given port. Example: `make docker-run PORT=9090`

docker-stop                    Stop docker container. Example: `make docker-stop`

docker-rm                      Stop and then remove docker container. Example: `make docker-rm`

docker-publish                 Docker publish. Example: `make docker-publish REGISTRY=https://your-registry.com`

docker-tag                     Tag current container. Example: `make docker-tag REGISTRY=https://your-registry.com`

docker-release                 Docker release - build, tag and push the container. Example: `make docker-release REGISTRY=https://your-registry.com`

```

## Client

See [proto package](https://github.com/vardius/pubsub/blob/master/proto) for details.

## 📜 [License](LICENSE.md)

This package is released under the MIT license. See the complete license in the package

[![FOSSA Status](https://app.fossa.io/api/projects/git%2Bgithub.com%2Fvardius%2Fpubsub.svg?type=large)](https://app.fossa.io/projects/git%2Bgithub.com%2Fvardius%2Fpubsub?ref=badge_large)