nemo-monitoring-module
v0.0.1
Published
All nessesary monitoring, service discovery, tracing, ... features in the NEMO project
Downloads
1
Readme
NEMO Monitoring Module
The NEMO monitoring-module contains all the nessesary tools for monitoring a microservice inside the NEMO environment.
Install
Go into the ./ root of your service and do:
mkdir modules
cd modules
git clone [email protected]:NEMO_BRiDGE/nemo-monitoring-module.git
npm install
Update
cd modules/nemo-monitoring-module
git pull origin master
How-To
Include
The init function expects the service name but defaults to environment variable NEMO_SVC_NAME if not set.
It also expects the environment variable NODE_ENV but defaults to 'development' if not set.
var nemoMonitor = require('./modules/nemo-monitoring-module')('myService');Tools
Currently there is only one tool integrated in monitoring.
Trace by Rising Stack
Trace keeps track of the communication flow inside of nemo and between the microservices. It can be configured in more detail using the trace specific config file in nemo-monitoring-module/src/trace.config.js. E.g. for the following settings:
- apiKey: 'the api key for the current envidonment' // setting the key for the current environment at trace server
- ignoreHeaders: {'user-agent': ['007']} // to exclude internal e.g. monitoring calls from the logs
- collectorApiUrl: 'http://www.example.de/' // endpoint of the trace-server
- other parameter: collectInterval, collectorLanguage, collectorApiSampleEndpoint, collectorApiServiceEndpoint, collectorApiApmMetricsEndpoint, collectorApiRpmMetricsEndpoint collectorApiEdgeMetricsEndpoint, collectorApiIncomingEdgeMetricsEndpoint, collectorApiExternalEdgeMetricsEndpoint