Node.js Troubleshooting Framework Install

Once you’ve installed the Node agent, you should see data reporting within a few minutes. If you’re having trouble, these are the steps that our support teams take to troubleshoot, and we hope they will help you find and resolve the issue quickly.

  1. Confirm the app is receiving traffic, has been for at least 5 min, and continues to receive traffic during troubleshooting

  2. Run NrDiag to collect data then validate:

  3. Confirm Node.js and NPM version meets requirements.

  4. Verify host information meets requirements.

  5. Verify the existence of newrelic module in the package.json/package-lock.json

  6. Check top level npm ls dependencies for newrelic module.

  7. Check if the newrelic.js file is copied to the root directory of the application as described in step 3 of our install documentation.

  8. Ensure configuration is valid with a license key and app name.

  9. Check for the existence of agent logs in default path.

  10. Check that agent can connect to the New Relic collector.

  11. Verify agent isn’t an EOL version.

  12. Check for a “reporting to” line in the logs.

  13. Check for High Security Mode configuration mismatches

  14. If there are no logs in the root directory of the application, ensure that the log file path wasn’t changed and that logs are enabled in the agent configuration.

  15. Ensure your application is using a supported Node.js framework.

  16. Check New Relic ENV variables for the application to see if any configuration is being set via ENV variables.

  17. If NEW_RELIC_NO_CONFIG_FILE=true, make sure that you have set all the required ENV variable configuration equivalents. Ex: app_name, license_key, etc.

  18. Confirm the set application name is the expected one.

  19. Run npm install newrelic --loglevel=silly to check for and fix any errors shown.

  20. It is most common to see an issue with the optional Native Metrics Module (NMM) that comes bundled with the agent. It supplies metrics to the NodeVM page. Requirements and extra troubleshooting for this module can be found in our Node VM documentation.

  21. A common error message is with node-gyp needing python.

  22. Another common one is needing xcode on a Mac.

  23. Check you are using a package manager other than NPM (Ex: yarn). If you are, try and get the most verbose install logs you can find for that package manager (Ex: yarn install --verbose). Check for errors in the install logs.

  24. Check trace level agent logs for network issues.

  25. Ensure your network is not blocking the ranges listed in New Relic’s Network info

  26. If you are using a proxy, ensure proxy info is in the agent configuration.

  27. If using a containerized environment, make sure you installed the agent in the container itself.

  28. If you are using Lambda, review our Lambda documentation.

  29. If you are still unable to resolve the issue please reach out to New Relic Global Technical Support by going to support.newrelic.com. Please be sure to mention, in as much detail as possible, the steps you have tried already and details of what you expect to see and what you are seeing.