@apminsight/next 1.0.0

package/README.md

@@ -0,0 +1,102 @@
+# APM Insight Next.js instrumentation
+
+This is the official Next.js framework instrumentation for the APM Insight Node.js agent.
+
+The [Site24x7 Node.js agent][1] uses the APM Insight Next.js package to monitor the application key metrics and Next.js-specific metrics in the back-end. If you want to monitor the front-end metrics such as web vitals, AJAX calls, and pageviews, you need to inject the [RUM script][2] into the header or footer of the index page or a common page of your application. These metrics can help improve your application's performance and identify bottlenecks in the application.
+
+**Note:**
+* The minimum supported Next.js version is 12.0.9.
+* The APM Insight Next.js package does not provide any instrumentation for actions that occur during the build or in client-side code.
+
+Before you can use Next.js module, you need to install the [Site24x7 Node.js agent.][3]
+
+## Table of contents:
+* Installation
+* Configuration
+* Set configuration values
+* Performance Metrics
+ 
+## Installation
+This package is not bundled with the agent and must be installed separately. However, the package depends on the agent, so you will get all the agent's capabilities while loading this package.
+* Run the following command in your Next.js project to install the APM Insight Node.js (APM) agent and APM Insight middleware for Next.js.
+```
+   npm install apminsight @apminsight/next
+```
+
+* When the command is completed successfully, the dependencies will be listed in your package.json file.
+```
+   "dependencies": {
+   "@apminsight/next": "^1.0.0",
+   "apminsight": "^3.1.2",
+   "next": "latest",
+    },
+```
+## Configuration
+**Method 1:**
+Next, modify your dev and start npm scripts by updating the scripts section of the package.json file. Allow your application to run with the Node’s -r option, which will preload @apminsight/next middleware.
+```
+NODE_OPTIONS='-r @apminsight/next' next start
+```
+The scripts section should look like the following:
+```
+"scripts": {
+"dev": "NODE_OPTIONS='-r @apminsight/next' next",
+"build": "next build",
+"start": "NODE_OPTIONS='-r @apminsight/next' next start"
+},
+```
+**Method 2:**
+If you have no control over how your program is executed, you can load the @apminsight/next module before any other module. However, we recommend you avoid using this method at all costs. We discovered that bundling when running the next build causes issues and makes your bundle unnecessarily large.
+
+```
+require('@apminsight/next')
+/* ... the rest of your program ... */
+```
+
+**Method 3:**
+For Custom Next.js servers:
+If you're using Next as a custom server, you're probably not running your application using the Next CLI. In that case, we recommend executing the Next.js instrumentation as shown below.
+
+```
+node -r @apminsight/next your-start-file.js
+```
+
+## Set configuration values
+If you want to configure in the file, follow the steps below:
+* Create a new file named apminsightnode.json and place it in the directory where you run the application.
+* Add the below code snippet in the file. 
+
+```
+	{"licenseKey" : "<license-key>",
+	"appName" : "<application-name>",
+	"port" : <application-port> }
+```	
+    
+If you are using proxy:
+    
+```  
+    {"licenseKey" : "<license-key>",
+	"appName" : "<application-name>",
+	"port" : <application-port>,
+	"proxyServerHost" : "<proxy-server>",
+	"proxyServerPort" : <proxy-port>,
+	"proxyAuthUser" : "<proxy-user-name>",
+	"proxyAuthPassword" : "<proxy-password>"}
+```	
+**Note:** You can also configure the values as [environment variables][4].
+
+## Performance metrics
+To view the metrics in the client:
+* Log in to your [Site24x7][5] web client
+* Navigate to APM > your Node.js application.
+* Select the time frame for which you need the metrics. For which you can see your application’s server-side data flowing into the application monitor.
+
+
+
+
+[1]: https://www.site24x7.com/help/apm/nodejs-agent.html
+[2]: https://www.site24x7.com/help/apm/rum/add-rum-monitor.html
+[3]: https://www.site24x7.com/help/apm/nodejs-agent/Install-Node.js-Agent.html
+[4]: https://www.site24x7.com/help/apm/nodejs-agent/Install-Node.js-Agent.html#environment-variables
+[5]: https://www.site24x7.com/
+

package/index.js

@@ -0,0 +1,6 @@
+var apminsight = require("apminsight")();
+var dotenv = require("dotenv");  //No I18N
+dotenv.config();
+
+apminsight.instrumentWebFramework('./render', require('./lib/render'));
+apminsight.instrumentWebFramework('./context', require('./lib/context'));

package/lib/context.js

@@ -0,0 +1,11 @@
+var moduleInfo = {
+    functions: [
+        {
+            functionName: "getModuleContext",
+            component: "NEXTJS",  //No I18N
+            completeTrackerName : "Nextjs/Middleware"
+        },
+    ],
+};
+
+module.exports = moduleInfo;

package/lib/render.js

@@ -0,0 +1,19 @@
+var moduleInfo = {
+    functions: [
+        {
+            functionName: "renderToHTML",
+            component: "NEXTJS",  //No I18N
+            extractInfo: getPath,
+            completeTrackerName : "Nextjs/Pre-render-HTML",
+
+        },
+    ],
+};
+
+function getPath(invoker, params, returnObj, tracker){
+    var info = {};
+    info.reqPath = params[2];
+    tracker.updateInfo(info);
+}
+
+module.exports = moduleInfo;

package/license.txt

@@ -0,0 +1,135 @@
+PLEASE  READ  THE  FOLLOWING  LICENSE  AGREEMENT  CAREFULLY. BY DOWNLOADING THIS
+SOFTWARE YOU AGREE TO BE BOUND BY THE TERMS OF THIS LICENSE AGREEMENT. 
+
+This  License  Agreement  details the  policy for license of Site24x7 APM Insight
+Next.js package ("Licensed Software") on the following topics: 
+ 
+* Free License
+* Technical Support
+
+
+1. FREE LICENSE:
+ZOHO  grants you a non-exclusive, non-transferable, worldwide license to use the
+Licensed  Software  for  no cost in perpetuity. You are forbidden from using the
+Licensed  Software  for  any other use or otherwise offering it for resale under
+the  terms  of  this Section 1. ZOHO retains all rights not specifically granted
+to you herein. 
+
+2. THIRD PARTY PRODUCTS:
+The  Licensed  Software  may  contain software which originated with third party
+vendors  and  without limiting the general applicability of the other provisions
+of  this  Agreement,  you  agree  that (a) the title to any third party software
+incorporated  in  the  Licensed Software shall remain with the third party which
+supplied  the  same;  and  (b)  you  will  not  distribute  any such third party
+software  available with the Licensed Software, unless the license terms of such
+third party software provide otherwise. 
+
+3. RESTRICTIONS ON USE:
+In addition to all other terms and conditions of this Agreement, you shall not:
+
+i.  remove  any  copyright,  trademark  or  other  proprietary  notices from the
+Licensed Software or its copies; 
+ii.  make  any  copies  except  for  one back-up or archival copy, for temporary
+emergency purpose; 
+iii.  rent,  lease,  license,  sublicense or distribute the Licensed Software or
+any portions of it on a standalone basis or as part of your application; 
+   iv. modify or enhance the Licensed Software; 
+   v. reverse engineer, decompile or disassemble the Licensed Software;
+vi. allow any third parties to access, use or support the Licensed Software. 
+
+4. TECHNICAL SUPPORT:
+You  may  submit technical support queries through our discussion forums. Though
+ZOHO  will  respond  to such queries within a reasonable time in most cases, you
+are not entitled to claim technical support as a matter of right. 
+
+5. OWNERSHIP AND INTELLECTUAL PROPERTY:
+ZOHO  owns  all  right, title and interest in and to the Licensed Software. ZOHO
+expressly  reserves  all  rights  not granted to you herein, notwithstanding the
+right  to  discontinue  or  not  to  release  any  Software and to alter prices,
+features,  specifications,  capabilities,  functions,  licensing  terms, release
+dates,  general  availability  or  characteristics of the Licensed Software. The
+Software is only licensed and not sold to you by ZOHO. 
+
+6. AUDIT:
+ZOHO  has  the  right to audit your Use of the Licensed Software by providing at
+least  seven  (7)  days prior written notice of its intention to conduct such an
+audit at your facilities during normal business hours. 
+
+7. CONFIDENTIALITY:
+The  Licensed  Software  contains  proprietary  information  of  ZOHO  that  are
+protected  by  the  laws  of  the United States and you hereby agree to take all
+reasonable  efforts  to  maintain  the confidentiality of the Licensed Software.
+You  agree  to reasonably communicate the terms and conditions of this Agreement
+to  those  persons  employed  by  you  who  come into contact with or access the
+Licensed  Software,  and  to  use  reasonable efforts to ensure their compliance
+with  such  terms  and  conditions,  including but not limited to, not knowingly
+permitting  such  persons  to  use  any  portion  of the Licensed Software for a
+purpose that is not allowed under this Agreement. 
+
+8. WARRANTY DISCLAIMER:
+ZOHO  does  not warrant that the Licensed Software will be error-free. Except as
+provided  herein, the Licensed Software is furnished "as is" without warranty of
+any  kind,  including  the  warranties  of  merchantability  and  fitness  for a
+particular  purpose  and  without  warranty as to the performance or results you
+may  obtain  by  using  the  Licensed  Software.  You are solely responsible for
+determining  the  appropriateness  of using the Licensed Software and assume all
+risks  associated  with the use of it, including but not limited to the risks of
+program  errors,  damage  to  or  loss  of  data,  programs  or  equipment,  and
+unavailability or interruption of operations. 
+Because  some  jurisdictions  do  not  allow  for the exclusion or limitation of
+implied warranties, the above exclusions or limitations may not apply to you. 
+
+9. LIMITATION OF LIABILITY:
+In  no  event  will  ZOHO  be  liable to you or any third party for any special,
+incidental,  indirect,  punitive  or  exemplary  or  consequential  damages,  or
+damages  for  loss  of business, loss of profits, business interruption, or loss
+of  business  information arising out of the use or inability to use the program
+or  for  any  claim  by  any  other  party  even if ZOHO has been advised of the
+possibility  of  such  damages.  ZOHO's  entire  liability  with  respect to its
+obligations  under  this  agreement  or  otherwise  with respect to the Licensed
+Software  shall not exceed the amount of the named developer license fee paid by
+you for the Licensed Software. 
+Because  some  jurisdictions  do  not  allow  the  exclusion  or  limitation  of
+liability  for  incidental  or  consequential  damages,  the above exclusions or
+limitations may not apply to you. 
+
+10. INDEMNIFICATION:
+ZOHO  agrees  to  indemnify  and defend you from and against any and all claims,
+actions  or  proceedings,  arising  out  of any claim that the Licensed Software
+infringes  or violates any valid U.S. patent, copyright or trade secret right of
+any  third  party;  so long as you provide; (i) prompt written notice to ZOHO of
+such  claim;  (ii) cooperate with ZOHO in the defense and/or settlement thereof,
+at  ZOHO's expense; and, (iii) allow ZOHO to control the defense and all related
+settlement  negotiations.  The  above is ZOHO's sole obligation to you and shall
+be  your  sole  and exclusive remedy pursuant to this Agreement for intellectual
+property infringement. 
+ZOHO  shall  have  no  indemnity  obligation  for  claims of infringement to the
+extent  resulting  or  alleged to result from (i) any combination, operation, or
+use  of  the  Licensed  Software  with any programs or equipment not supplied by
+ZOHO;  (ii)  any  modification  of  the  Licensed Software by a party other than
+ZOHO;  and  (iii) your failure, within a reasonable time frame, to implement any
+replacement or modification of Licensed Software provided by ZOHO. 
+
+11. TERMINATION:
+This  Agreement is effective until terminated by either party. You may terminate
+this  Agreement at any time by destroying or returning to ZOHO all copies of the
+Licensed  Software in your possession. ZOHO may terminate this Agreement for any
+reason,  including  but  not  limited to your breach of any of the terms of this
+Agreement.  Upon  termination, you shall destroy or return to ZOHO all copies of
+the  Licensed  Software  and  certify  in writing that all know copies have been
+destroyed.  All  provisions  relating  to  confidentiality,  proprietary rights,
+non-disclosure,  and  limitation  of  liability shall survive the termination of
+this Agreement. 
+
+12. GENERAL:
+This  Agreement  shall be construed, interpreted and governed by the laws of the
+State  of  California  exclusive  of  its  conflicts  of  law  provisions.  This
+Agreement  constitutes  the entire agreement between the parties, and supersedes
+all  prior communications, understandings or agreements between the parties. Any
+waiver  or  modification  of  this Agreement shall only be effective if it is in
+writing  and  signed  by  both  parties hereto. If any part of this Agreement is
+found  invalid  or  unenforceable,  the  remainder shall be interpreted so as to
+reasonable  effect  the  intention  of  the  parties.  You  shall not export the
+Licensed  Software  or  your application containing the Licensed Software except
+in  compliance  with  United  States  export regulations and applicable laws and
+regulations. 

package/package.json

@@ -0,0 +1,19 @@
+{
+  "name": "@apminsight/next",
+  "version": "1.0.0",
+  "description": "",
+  "main": "index.js",
+  "scripts": {
+    "test": "echo \"Error: no test specified\" && exit 1"
+  },
+  "keywords": [],
+  "author": {
+    "name" : "Zoho Corporation Pvt. Ltd.",
+    "email" : "apm-insight@zohocorp.com"
+  },
+  "license": "SEE LICENSE IN license.txt",
+  "dependencies": {
+    "apminsight": "^3.1.1",
+    "dotenv": "^16.3.1"
+  }
+}