Skip to content

Commit

Permalink
Merge pull request #4 from seabaylea/master
Browse files Browse the repository at this point in the history
Update docs for 1.0.1 release
  • Loading branch information
seabaylea committed Oct 20, 2015
2 parents fabf8a2 + ecf1cec commit cc38248
Show file tree
Hide file tree
Showing 2 changed files with 14 additions and 3 deletions.
15 changes: 13 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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: [
Expand All @@ -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);
Expand All @@ -50,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.

Expand Down Expand Up @@ -173,7 +181,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
Expand Down
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -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": {
Expand Down

0 comments on commit cc38248

Please sign in to comment.