ai-perf-sdk 1.0.7 → 1.0.9
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +44 -0
- package/package.json +2 -2
- package/src/config.js +1 -1
package/README.md
ADDED
|
@@ -0,0 +1,44 @@
|
|
|
1
|
+
# ai-perf-sdk
|
|
2
|
+
|
|
3
|
+
A lightweight, plug-and-play performance monitoring SDK for Node.js.
|
|
4
|
+
|
|
5
|
+
## Installation
|
|
6
|
+
|
|
7
|
+
```bash
|
|
8
|
+
npm install ai-perf-sdk
|
|
9
|
+
```
|
|
10
|
+
|
|
11
|
+
## Usage
|
|
12
|
+
|
|
13
|
+
Initialize the SDK at the very top of your application entry point:
|
|
14
|
+
|
|
15
|
+
```javascript
|
|
16
|
+
const { initPerformanceSDK } = require('ai-perf-sdk');
|
|
17
|
+
|
|
18
|
+
initPerformanceSDK({
|
|
19
|
+
endpoint: 'https://your-telemetry-endpoint.com/api/telemetry', // Required
|
|
20
|
+
serviceName: 'my-microservice',
|
|
21
|
+
environment: 'production',
|
|
22
|
+
batchSize: 10,
|
|
23
|
+
flushInterval: 5000
|
|
24
|
+
});
|
|
25
|
+
```
|
|
26
|
+
|
|
27
|
+
## Configuration Options
|
|
28
|
+
|
|
29
|
+
| Option | Type | Default | Description |
|
|
30
|
+
| --- | --- | --- | --- |
|
|
31
|
+
| `endpoint` | String | (Required) | The URL where telemetry data will be sent. |
|
|
32
|
+
| `serviceName` | String | `unknown-service` | The name of your service for identification. |
|
|
33
|
+
| `environment` | String | `production` | The environment name (e.g., development, staging). |
|
|
34
|
+
| `batchSize` | Number | `10` | Number of items to queue before sending a batch. |
|
|
35
|
+
| `flushInterval` | Number | `5000` | Time in ms between automatic flushes. |
|
|
36
|
+
|
|
37
|
+
## How it works
|
|
38
|
+
|
|
39
|
+
The SDK automatically instruments the `http` and `https` modules to capture:
|
|
40
|
+
- HTTP Request Latency
|
|
41
|
+
- Response Status Codes
|
|
42
|
+
- Outbound and Inbound request metrics
|
|
43
|
+
|
|
44
|
+
All data is batched and sent asynchronously to your specified endpoint.
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "ai-perf-sdk",
|
|
3
|
-
"version": "1.0.
|
|
3
|
+
"version": "1.0.9",
|
|
4
4
|
"description": "Plug-and-play custom performance monitoring SDK",
|
|
5
5
|
"license": "MIT",
|
|
6
6
|
"author": "Akash",
|
|
@@ -9,4 +9,4 @@
|
|
|
9
9
|
"dependencies": {
|
|
10
10
|
"node-fetch": "^2.7.0"
|
|
11
11
|
}
|
|
12
|
-
}
|
|
12
|
+
}
|
package/src/config.js
CHANGED