From 1fd649f1993072a7baa80fa5a6bac4fbcfcd4bca Mon Sep 17 00:00:00 2001 From: seabaylea Date: Tue, 20 Oct 2015 10:55:38 +0100 Subject: [PATCH 1/2] Update docs for 1.0.1 --- README.md | 14 ++++++++++++-- package.json | 2 +- 2 files changed, 13 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 7fd1dca..499f3e2 100644 --- a/README.md +++ b/README.md @@ -25,6 +25,11 @@ appmetrics.disable('mysql'); // disable MySQL monitoring ``` Additionally, the `monitor()` API call can be passed an optional [ElasticSearch Configuration][3] object to configure the ElasticSearch connection, including database location and security. + +The same configuration object can be used to pass configuration to the ELK connector. The following configurations can be applied: +* `index` (String) the name of the index to use for storing the monitoring data. The default is `appmetrics`. +* `applicationName` (String) the name to use for the applicationName field in the monitoring data. The default is the name of the applications main file, eg. `app.js`. + ```js var config = { hosts: [ @@ -34,7 +39,9 @@ var config = { ssl: { ca: fs.readFileSync('./cacert.pem'), rejectUnauthorized: true - } + }, + index: 'nodedata', + applicationName: 'HelloWorld' } var appmetrics = require('appmetrics-elk').monitor(config); @@ -173,7 +180,10 @@ You can also create your own charts using the "Visualize" tab. The Node Application Metrics to ELK Connector is licensed using an Apache v2.0 License. ### Version -1.0.0 +The current version is 1.0.1 + +1.0.1 Support for configurable indexes and addition of applicationName field +1.0.0 Initial release [1]:https://www.elastic.co/downloads/elasticsearch [2]:https://www.elastic.co/downloads/kibana diff --git a/package.json b/package.json index cc7de8d..ca46f97 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "appmetrics-elk", - "version": "1.0.0", + "version": "1.0.1", "description": "ELK Connector for Node Application Metrics", "main": "index.js", "dependencies": { From ecf1cecbf1f0d8903c214a87636c140aae72b316 Mon Sep 17 00:00:00 2001 From: seabaylea Date: Tue, 20 Oct 2015 11:01:59 +0100 Subject: [PATCH 2/2] Update docs for 1.0.1 release --- README.md | 1 + 1 file changed, 1 insertion(+) diff --git a/README.md b/README.md index 499f3e2..17ca039 100644 --- a/README.md +++ b/README.md @@ -57,6 +57,7 @@ The ELK Connector for Node Application Metrics uploads its data to the 'appmetri timestamp | The time when the monitoring event occurred hostName | The hostname for the machine the monitored process is running on pid | The process ID for the monitored process + applicationName | The JavaScript file used to launch the application, or a custom name Additional data is then included depending on the monitoring event.