Git Product home page Git Product logo

adodge-bcg / ntt-data-notification-service Goto Github PK

View Code? Open in Web Editor NEW

This project forked from sierrasystems/ntt-data-notification-service

0.0 1.0 0.0 416 KB

A Service that pushes notifications and alerts to various channels

Home Page: http://ntt-data-notification-service.canadacentral.azurecontainer.io:8080/notification/

Java 76.03% Dockerfile 2.13% HTML 7.10% JavaScript 12.37% CSS 2.38%

ntt-data-notification-service's Introduction

Test Coverage Maintainability

Coverage Security Rating

ntt-data-notification-service

A Service that pushes notification to different channels.

Teams notification screenshot:

teams-message

Running Locally

docker-compose up --build ntt-data-notification-service

This should spin up the ntt-data-notification-service and the latest docker image of Splunk locally.

To modify the ports the app is running on, simply change the port mappings in the docker-compose file.

Optional: If not running the application through docker, you can set a property in application.properties if you would like to customize the port your app runs on:

server.port=${PORT:<PORT>}

Frontend

Once the application is running, the frontend page should be accessible at http://localhost:<PORT>/alert. If not altered, this should be port 6060 on your local machine.

ntt

In order to see the mocha frontend unit test results locally, navigate to http://localhost:<PORT>/alert/testrunner.html.

Splunk WebHook Setup

Once you have Splunk and the notification service running locally, you'll need to setup the actual webhook to send notifications to your favourite Teams/RocketChat channels. Follow the following steps to set this up:

  1. Navigate to your local Splunk instance at http://localhost:<LOCAL_SPLUNK_PORT>. Via docker this port is defaulted to 7000.

  2. To try out an example log, type the following as a search in Splunk:

index="_audit"
| eval message="Some message about something"
| table message source
  1. Click Save As and select Alert.

  2. Provide a title, set it to run on a cron schedule and provide a valid cron expression as per your frequency needs.

alertsettings1

  1. Add actions:
Webhook
Add to Triggered Alerts

settings2

  1. In order to generate the Webhook URL, navigate to the application frontend, type in at least one valid Teams/RocketChat URL and a valid token (present in the application.yml file) and copy the generated base64encoded URL.

  2. Paste this value into Splunk. If running the application via docker, this url will need to be modified. Replace

localhost:6060

with

172.20.0.6:8080
  1. Press Save.

  2. Click View Alert.

NOTE: Make sure to disable this alert once done testing if it is only for testing purposes.

ntt-data-notification-service's People

Contributors

adodge-bcg avatar alexjoybc avatar brendanbeach avatar sdevalapurkar avatar taygov avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.