we4tech / uampnotif

A simplified notification dispatching system. Can call any HTTP API with dynamic payload, headers and configurable response status.

Welcome to UampNotif Project

[WIP] More details coming [WIP] A simplified notification dispatching system.

Build

make build-mac

Usages

Usage of ./uampnotif:
  -d string
    	(Required) Locate receivers directory
  -n string
    	(Required) Locate notification.yml file 

Terms

WIP: Confusing. Needs more simplification

• Receiver: A unit of notification recipient
• Notification: A configuration to glue together all notification receivers.

Example configuration

##
# Default settings for all receivers.
#
default_settings:
  retries: 3
  # Do you prefer uampnotif to call all notifcfg concurrently?
  async: true
  # What do you want us to do in case of a failure to notify one of the
  # downstream systems?
  #
  #   Accepted values:
  #    - ignore: Do nothing
  #    - fatal: Exit with 1 if on_error_receivers is set, notify before exiting.
  #    - no_error_receivers: Mute notifying the on_error_receivers
  #
  on_error: ignore
  # TODO: Future feature
  # Do you prefer to notify a list of notifcfg if error arises?
  on_error_receivers:
    - id: slack
      params:
        callback_url: https://httpbin.org/post

##
# A list of notifcfg to be invoked whenever uampnotif is launched.
#
receivers:
  ##
  # id: Must match with corresponding integration id:
  #
  - id: newrelic
    ##
    # You can use go-template with .Env for all param value.
    #
    params:
      callback_url: https://httpbin.org/post
      api_key: '{{.FindEnv "NEWRELIC_API_KEY"}}'

  - id: rollbar
    params:
      access_token: hello-access-token
      environment: staging
      rollbar_username: hello-rollbar-user
      comment: Exception from Rollbar

  - id: slack
    params:
      callback_url: https://httpbin.org/post

  - id: sox-auditor
    params:
      repo_name: test/repo
      secret: hello-world-secret
    ##
    # Override global settings. You can only add the one you may prefer.
    # Uampnotif merges the settings below with the globally exposed settings.
    #
    settings:
      on_error: fatal

Individual receiver spec

name: Test
id: test
request:
  valid_http_codes:
    - 201
    - 200
  params:
    - name: app_id
      label: App ID
    - name: api_key
      label: API Key
    - name: hostname
      label: Hostname
  method: POST
  url_tmpl: '{{.FindEnv "NOTIF_SERVER_URL"}}/v2/applications/{{.FindParam "app_id"}}/deployments.json'
  headers:
    - name: Content-Type
      value_tmpl: application/json
    - name: X-Api-Key
      value_tmpl: '{{.FindParam "api_key"}}'
  body_tmpl: |
    { "deployment": { "revision": "{{.FindEnv "COMMIT_HASH"}}" } }

uampnotif's Issues

Generate auto release tag

Acceptance criteria

• Should generate a release tag based on VERSION file
• Should publish binary for Mac
• Should publish binary Linux

Fix issue with dispatcher

Acceptance criteria

• Should print out all received events before the process exit
• Should add verbose logging for all event transition

Update README with usages

Acceptance criteria

• Should explain the example usages
• Should explain the flags
• Should explain receiver-spec
• Should explain notification config

Add CI pipeline

Acceptance criteria

• Should run test suite
• Should compile
• Should run golanglint

Rename notifier and integrations to friendlier names

Acceptance criteria

1. Should rename notifiers to receivers
2. Should rename notifiers.yml to notification.yml

Provide a repository for known receivers

Acceptance criteria

• TODO: Should explore different receivers

Implement dispatcher to act on notifications.yml config.

As a Dispatcher
I want to call all listed *Notifier* based on preferred retrial and parallelism rules
So that the third party notifier can receive the event.

Acceptance criteria

• Should follow the retrial preference
• Should follow the notifier precedence
• Should follow the parallelism preference
• Should pass the events through the channel