Merge pull request #5 from ibm-cds-labs/sos

Sos

Author: glynnbird

.gitignore

@@ -1,3 +1,4 @@
 node_modules
 npm-debug.log
 start.sh
+.vscode

README.md

@@ -73,6 +73,12 @@ The value of QUEUE_NAME determines which queue/topic the data is written to. If
 5. rabbit_pubsub - mcpubsub
 6. kafka - mcqueue
 
+### ETCD_URL
+
+`ETCD_URL` determines which [Etcd](https://github.com/coreos/etcd) instance should be used for the Service Registry.
+
+The Service Registry allows the Metrics Collector Microservice to be utilised by the [Simple Search Service](https://github.com/ibm-cds-labs/simple-search-service) to log searches. This is achieved by using the [Simple Service Registry](https://github.com/mattcollins84/simple-service-registry) module.
+
 ### VCAP_SERVICES
 
 `VCAP_SERVICES` is created for you by the Bluemix Cloud Foundry service. It defines the credentials of the attached services that this app can connect to. 
@@ -244,6 +250,9 @@ CDS Labs Simple Logging Service started on port 8081 : Fri Nov 27 2015 15:57:31
 Created topic 'mcqueue'
 ```
 
+## Web output
+There is a realtime web output of each item logged at `/output`. Load this page and wait for events to be displayed at the front end. This page does not load any historical data.
+
 ## Conclusion
 
 The Simple Logging Service is a Bluemix app that collects web metrics. Instead of storing the metrics directly in a database, it writes the data to a choice of queues (Redis, RabbitMQ and Apache Kafka). You can run this app on many instances to share the data collection load and couple it with other microservices that consume and analyse the data. It could serve as the basis of a high-volume metrics collection service.

package.json

@@ -24,6 +24,8 @@
     "message-hub-rest": "^1.0.1",
     "node-redis": "^0.1.7",
     "rabbit.js": "^0.4.4",
+    "simple-service-registry": "^0.1.1",
+    "socket.io": "^1.4.8",
     "when": "~3.7.3"
   },
   "devDependencies": {