whatap 1.0.2 → 1.0.3-canary.0

package/README.md

@@ -1,62 +1,106 @@
 
-[![WhaTap Logo](https://login.whatap.io/static/whatap_logo.png)](http://www.whatap.io/)
+# 🚀 WhaTap Node.js Agent
 
-# Whatap for Node.js
+> **Comprehensive Node.js Application Performance Monitoring (APM) Solution**
 
-Whatap allows for application performance monitoring.
+WhaTap Node.js Agent provides real-time monitoring, tracing, and performance analysis capabilities as a professional APM agent.
 
-Works on Linux(32bit, 64bit), MacOSx(32bit, 64bit), Windows(32bit, 64bit).
+## 📋 Supported Environment
+- **Platform**: macOS (64bit), Linux (64bit)
+- **Node.js Version**: 17.0.0 or higher
+- **Database**: MySQL, PostgreSQL, MSSQL, Oracle, MariaDB, MongoDB, Redis
+- **Framework**: Express, Fastify, Socket.IO, WebSocket, GraphQL
 
-*Node.js 지원 버젼: 16.4.0 이상
+You can install WhaTap using npm with the following command:
 
-![step01](http://apm.whatap.io/images/icon_step01.png)
+```bash
+$ npm install whatap
+```
 
-#### Npm install
 
-npm 에서 다음과 같은 명령어를 통해 whatap을 설치 할 수 있습니다.
 
-    $ npm install whatap
+## 📝 Configuration
 
+Copy the `whatap.conf` file from `node_modules/whatap` to your project root directory and configure it as follows:
 
+```ini
+# Essential Settings
+license=XXXXXXXXXXXXXX-XXXXXXXXXXXXXX-XXXXXXXXXXXXXX
+whatap.server.host=XXX.XXX.XXX.XXX
 
-![step02](http://apm.whatap.io/images/icon_step02.png)
+# Application Identification Settings
+app_name=MyNodeApp              # Application name
+app_process_name=node           # Process name
+```
 
-#### License Key
 
-node\_modules/whatap에 있는 whatap.conf파일을 루트 디렉토리로 복사 후
-라이센스 키를 발급받은 후 추가 해 주세요.
 
-whatap.conf 파일은 다음과 같은 내용을 포함합니다.
+## 🚀 Usage
 
-    license=XXXXXXXXXXXXXX-XXXXXXXXXXXXXX-XXXXXXXXXXXXXX
-    whatap.server.host=XXX.XXX.XXX.XXX
+### Agent Initialization
 
+To activate WhaTap monitoring in your Node.js application, add the WhaTap agent initialization code to your application's **top-level entry point file**.
 
+> **⚠️ Important**: The WhaTap agent must be loaded before all other modules.
 
-![step03](http://apm.whatap.io/images/icon_step03.png)
+### Method 1: Using require('whatap') in Code
 
-#### Usage
+```javascript
+// app.js (or server.js)
+var WhatapAgent = require('whatap').NodeAgent;
 
-루트 디렉토리에 위치한 Node.js 애플리케이션에서 Whatap 모니터링 기능을 활성화하려면, 
-애플리케이션의 진입점 파일에 Whatap 에이전트를 초기화하는 코드를 추가해야 합니다.
+// Import other modules after
+const express = require('express');
+const app = express();
 
-Node.js 애플리케이션에 Whatap 모니터링을 적용하는 방법은 모듈 시스템의 종류(CommonJS 또는 ECMAScript Modules, ESM)에 따라 약간 다릅니다. 아래에서는 두 가지 모듈 시스템에 대해 Whatap 에이전트를 초기화하고 사용하는 방법을 설명합니다.
+// Application logic...
+```
 
+Run with:
+```bash
+node app.js
+```
 
-#### CommonJS 모듈 시스템 사용 시
-Whatap 에이전트를 CommonJS 방식으로 가져오고 초기화하려면, 다음 코드를 애플리케이션의 진입점 파일에 추가하세요:
-    
-    var WhatapAgent = require('whatap').NodeAgent;
+### Method 2: Using -r flag (without code modification)
 
-#### ECMAScript 모듈(ESM) 시스템 사용 시
-ESM 방식으로 Whatap 에이전트를 가져오고 사용하려면, 다음과 같이 코드를 작성하세요:
+If you prefer not to modify your application code, you can use the `-r` flag:
 
-    import WhatapAgent from 'whatap';
-    WhatapAgent.NodeAgent;
+```bash
+node -r whatap app.js
+```
 
-![step04](http://apm.whatap.io/images/icon_step04.png)
+### ECMAScript Module (ESM) System
 
-#### Restart
+```javascript
+// app.js (or server.js)
+import WhatapAgent from 'whatap';
+WhatapAgent.NodeAgent;
+
+// Import other modules after
+import express from 'express';
+const app = express();
+
+// Application logic...
+```
+
+## ✅ Run Application
+
+Once the agent configuration is complete, restart your application to begin monitoring:
+
+```bash
+# Direct Node.js execution
+node app.js
+
+# Using npm scripts
+npm start
+```
+
+### Monitoring Dashboard
+
+Once your application is running, you can view the following information in the WhaTap console:
+
+- 🔍 **Real-time Transactions**: HTTP requests, database query tracking
+- 📊 **Performance Metrics**: CPU, memory, GC information
+- 🚨 **Error Monitoring**: Application error and exception tracking
+- 📈 **Statistical Analysis**: Response time and throughput statistics
 
-어플리케이션 서버가 실행되면 애플리케이션의 모니터링 정보를 수집하기
-시작합니다.

package/build.txt

@@ -0,0 +1,4 @@
+app = 'NodeJS'
+name = 'whatap_nodejs'
+version = 'dev1.0.5'
+build_date = '20250923'

package/lib/conf/config-default.js

@@ -216,7 +216,9 @@ var ConfigDefault = {
 
     "_trace_mtrace_poid_key": str("mtrace_poid_key", "x-wtap-po"),
     "_trace_mtrace_caller_key": str("mtrace_caller_key","x-wtap-mst"),
+    "_trace_mtrace_callee_key": str("mtrace_callee_key","x-wtap-tx"),
     "_trace_mtrace_spec_key1": str("mtrace_spec_key", "x-wtap-sp1"),
+    "_trace_mtrace_ip": str("mtrace_ip", "x-wtap-ip"),
 
     // add apdex 2020.11.13
     "apdex_time_t": num('apdex_time_t', 1200),
@@ -276,16 +278,7 @@ var ConfigDefault = {
     "prisma_read_func_name": str("prisma_read_func_name", "read"),
     "prisma_database_url_name": str("prisma_database_url_name", "DATABASE_URL"),
 
-    "metering_tagcount_enabled": bool("metering_tagcount_enabled", false),
-    "profile_redis_param_enabled": bool("profile_redis_param_enabled", false),
-    "profile_mongodb_param_enabled": bool("profile_mongodb_param_enabled", false),
-
-    "trace_mtrace_traceparent_key": str("trace_mtrace_traceparent_key", "traceparent"),
-    "txtext_txname_enabled": bool("txtext_txname_enabled", true),
-    "ignore_env_variable_set": str("ignore_env_variable_set", ""),
-    "profile_httpc_start_step_enabled": bool("profile_httpc_start_step_enabled", false),
-    "perfx_nodejs_gc_enabled": bool("perfx_nodejs_gc_enabled", true)
-
+    "metering_tagcount_enabled": bool("metering_tagcount_enabled", false)
 };
 
 ConfigDefault._hook_method_ignore_prefix = ConfigDefault.hook_method_ignore_prefixes.split(',');