Skip to content

Commit 59432d2

Browse files
committed
Further readme updates
1 parent 1eb13ca commit 59432d2

File tree

1 file changed

+4
-4
lines changed

1 file changed

+4
-4
lines changed

README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -106,7 +106,7 @@ It also adds the `node-hc` command to another directory tied to your Node.js SDK
106106
<a name="config"></a>
107107
### Configuring Node Application Metrics
108108

109-
Node Application Metrics can be configured in two ways, by using the configuration file described below or via a call to configure(Object).
109+
Node Application Metrics can be configured in two ways, by using the configuration file described below or via a call to configure(options).
110110

111111
Node Application Metrics comes with a configuration file inside the [module installation directory](#install) (`.../node_modules/appmetrics/appmetrics.properties`). This can be used to configure connection options, logging and data source options.
112112

@@ -165,7 +165,7 @@ monitoring.on('cpu', function (cpu) {
165165

166166
## Health Center Eclipse IDE client
167167
### Connecting to the client
168-
Connecting to the Health Center client requires the additional installation of a MQTT broker. The Node Application Metrics agent sends data to the MQTT broker specified in the `appmetrics.properties` file or set via a call to configure(Obect). Installation and configuration documentation for the Health Center client is available from the [Health Center documentation in IBM Knowledge Center][2].
168+
Connecting to the Health Center client requires the additional installation of a MQTT broker. The Node Application Metrics agent sends data to the MQTT broker specified in the `appmetrics.properties` file or set via a call to configure(options). Installation and configuration documentation for the Health Center client is available from the [Health Center documentation in IBM Knowledge Center][2].
169169

170170
Note that both the API and the Health Center client can be used at the same time and will receive the same data. Use of the API requires a local install and application modification (see *[Modifying your application to use the local installation](#run-local)*).
171171

@@ -175,12 +175,12 @@ Further information regarding the use of the Health Center client with Node Appl
175175
## API Documentation
176176
### appmetrics.configure(options)
177177
Sets various properties on the appmetrics monitoring agent. If the agent has already been started, this function does nothing.
178-
* `options'(Object) key value pairs of properties and values to be set on the monitoring agent.
178+
* `options`(Object) key value pairs of properties and values to be set on the monitoring agent.
179179

180180
Property name | Property value | Effect
181181
:--------------------|:-------------------------|:-----------------------------
182182
`applicationID` | `string` | Specifies a unique identifier for the mqtt connection
183-
`mqtt` | `[off|on]` | Specifies whether the monitoring agent sends data to the mqtt broker
183+
`mqtt` | `[off|on]` | Specifies whether the monitoring agent sends data to the mqtt broker. The default value is on
184184
`mqttHost` | `host name` | Specifies the host name of the mqtt broker
185185
`mqttPort` | `port number` | Specifies the port number of the mqtt broker
186186
`profiling` | `[off|on]` | Specifies whether method profiling data will be captured. The default value is off

0 commit comments

Comments
 (0)