Skip to content

Commit 6b3a121

Browse files
authored
Add performance statement
Added a short statement about overhead and also tidied supported platforms and moved to the bottom
1 parent e65dffa commit 6b3a121

File tree

1 file changed

+14
-20
lines changed

1 file changed

+14
-20
lines changed

README.md

Lines changed: 14 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -41,29 +41,13 @@ Node Application Metrics provides the following built-in data collection sources
4141
Riak | Riak methods called by the application
4242
Request tracking | A tree of application requests, events and optionally trace (disabled by default)
4343
Function trace | Tracing of application function calls that occur during a request (disabled by default)
44+
## Performance overhead
4445

45-
## Getting Started
46-
### Prerequisites
46+
Our testing has shown that the performance overhead in terms of processing is minimal, adding less than 0.5 % to the CPU usage of your application. The additional memory required is around 20 MB to gather information about your system and application.
4747

48-
The Node Application Metrics agent supports the following runtime environments:
48+
We gathered this information by monitoring the sample application [Acme Air][3]. We used MongoDB as our datastore and used JMeter to drive load though the program. We have performed this testing with Node.js version 6.10.3
4949

50-
* **Node.js v7** on:
51-
* 64-bit or 32-bit runtime on Windows (x64 or x86)
52-
* 64-bit or 32-bit runtime on Linux (x64, x86, PPC64LE)
53-
* 64-bit runtime on Mac OS X (x64)
54-
* **Node.js v6** on:
55-
* 64-bit or 32-bit runtime on Windows (x64 or x86)
56-
* 64-bit or 32-bit runtime on Linux (x64, x86, PPC64LE)
57-
* 64-bit runtime on Mac OS X (x64)
58-
* **Node.js v4** on:
59-
* 64-bit or 32-bit runtime on Windows (x64 or x86)
60-
* 64-bit or 32-bit runtime on Linux (x64, x86, PPC64LE)
61-
* 64-bit runtime on Mac OS X (x64)
62-
* **IBM SDK for Node.js 4** on:
63-
* 64-bit or 32-bit runtime on Windows (x64 or x86)
64-
* 64-bit or 32-bit runtime on Linux (x64, x86, PPC32, PPC64, PPC64LE, z31, z64)
65-
* 64-bit or 32-bit runtime on AIX (PPC32, PPC64)
66-
* 64-bit runtime on Mac OS X (x64)
50+
## Getting Started
6751

6852
### Installation
6953

@@ -448,6 +432,16 @@ Requests are a special type of event emitted by appmetrics. All the probes name
448432
* `duration` (Number) the time taken for the request to complete in ms.
449433
* `duration` (Number) the time taken for the overall request to complete in ms.
450434

435+
### Supported platforms
436+
437+
The Node Application Metrics agent supports the following runtime environments:
438+
439+
* **Node.js v4, v6 and v7** on:
440+
* 64-bit or 32-bit runtime on Windows (x64 or x86)
441+
* 64-bit or 32-bit runtime on Linux (x64, x86, PPC32, PPC64, PPC64LE, z31, z64)
442+
* 64-bit or 32-bit runtime on AIX (PPC64)
443+
* 64-bit runtime on Mac OS X (x64)
444+
451445
## Troubleshooting
452446
Find below some possible problem scenarios and corresponding diagnostic steps. Updates to troubleshooting information will be made available on the [appmetrics wiki][3]: [Troubleshooting](https://github.com/RuntimeTools/appmetrics/wiki/Troubleshooting). If these resources do not help you resolve the issue, you can open an issue on the Node Application Metrics [appmetrics issue tracker][5].
453447

0 commit comments

Comments
 (0)