smartlogic-notifier

README

smartlogic-notifier

Introduction

Entrypoint for concept publish notifications from the Smartlogic Semaphore system

Installation

Download the source code, dependencies and test dependencies:

    go get -u github.com/kardianos/govendor
    go get -u github.com/Financial-Times/smartlogic-notifier
    cd $GOPATH/src/github.com/Financial-Times/smartlogic-notifier
    govendor sync
    go build .

Running locally

1. Run the tests and install the binary:

    govendor sync
    govendor test -v -race
    go install
   

2. Run the binary (using the help flag to see the available optional arguments):

    $GOPATH/bin/smartlogic-notifier [--help]
   

Options:

--app-system-code="smartlogic-notifier"      System Code of the application ($APP_SYSTEM_CODE)
--app-name="Smartlogic Notifier"                   Application name ($APP_NAME)
--port="8080"                                                     Port to listen on ($APP_PORT)

Build and deployment

• Built by Docker Hub on merge to master: coco/smartlogic-notifier
• CI provided by CircleCI: smartlogic-notifier

Service endpoints

Endpoints are documented in Swagger

Based on the following google doc.

Healthchecks

Admin endpoints are:

/__gtg

/__health

/__build-info

Logging

• The application uses logrus; the log file is initialised in main.go.
• Logging requires an env app parameter, for all environments other than local logs are written to file.
• When running locally, logs are written to console. If you want to log locally to file, you need to pass in an env parameter that is != local.
• NOTE: /__build-info and /__gtg endpoints are not logged as they are called every second from varnish/vulcand and this information is not needed in logs/splunk.