Real-time anomaly detection application, from multiple sources.

docker build . -t fox
docker run --rm -d -p 127.0.0.1:8082:8080 fox
open http://127.0.0.1:8082/

Note: Can run make too.

This will load the default config file at config/default.json. If you have an ENV environment variable, this will be used instead.

docker run --rm -d -p 127.0.0.1:8082:8080 --env ENVIRONMENT=production fox

Loads config/production.json.

Read customisation.md to learn how to create your own components: data intervals, detections and notifications.

Use config environment variable to pass a path to configuration JSON file, for example:

Example

{
     "server": {
          "port": 8080,
          "host": "0.0.0.0"
     },
     "logs": {
          "level": "debug",
          "json": true
     },
     "baseUrl": "http://192.168.1.1:8080/#/",
	 "schedulerNotifications": {
		  "name": "SESNotification",
		  ...
	 }
}

Datasources may have their own configuration defined in dataSources section. Their parameters will be passed to a datasource constructor right after application is loaded. Read about parameters needed for each datasource in datasource documentation.

For example NewRelic datasource requires accountId and apiKey as configuration parameters:

{
    "dataSources": {
        "NewRelicInsights": {
            "accountId": 100000,
            "apiKey": "MySecretKey"
        }
    }
}

Notifications like datasources may have their own configuration but defined in notifications section. Read about individual notification settings in their own documentation.

Example SESNotification requires AWS credentials and some email attributes:

{
    "notifications": {
        "SESNotification": {
            "accessKeyId": "MYSECRETACCESSKEYIDFROMAWS",
            "secretAccessKey": "0000000000SECRET/ACCESSKEY00000000000000000",
            "to": ["[email protected]"],
            "from": "'Fox' <[email protected]>"
        }
    }
}

Metrics are defined in configuration file in metric section. Every metric must contain these params:

Read particular data source or detection configuration to see the list of parameters you have to pass into them

Example:

{
	"metrics": {
		"MetricCodeName": {
			"description": "Speed The Collapse",
			"dataSource": "NewRelicInsights",
			"dataSourceQueries": [
				"ALL(the, way) FROM WHERE we came BUILD a MANSION in a day"
			],
			"detection": "SimpleDetection.isNeighbourHouseCollapsed",
			"detectionParams": {
				"emaInterval": 6
			},
			"notification": "SESNotification",
			"notificationConfig": {
				"intervalSeconds": 600,
				"count": 5
			},
			"updateInterval": 900000,
			"style": {
				"width": "50%"
			}
		}
	}
}

1. Install dependencies

yarn

2. Start SPA

yarn start

3. Start Api

node server.js

Read contributing.md to learn more about contributing to this project.