New Relic: add error for agent not being found (#1457)

* add error for agent not being found * Create usenewrelic-agent-error-msg.md * change error message * run prettier Co-authored-by: Laurin Quast <laurinquast@googlemail.com>
n1ru4l · Aug 15, 2022 · ff8b447 · ff8b447 · vercel · Aug 15, 2022
1 parent 0c1b170
commit ff8b447
Show file tree

Hide file tree

Showing 2 changed files with 14 additions and 0 deletions.
diff --git a/.changeset/usenewrelic-agent-error-msg.md b/.changeset/usenewrelic-agent-error-msg.md
@@ -0,0 +1,9 @@
+---
+'@envelop/newrelic': patch
+---
+
+New Relic: add error for agent not being found
+Adds an error message when initializing the new relic plugin
+
+- This error message will occur when the new relic agent is not found when initializing the plugin. Signalling information to a developer that new relic may not be
+- installed correctly or may be disabled where this plugin is being instantiated.
diff --git a/packages/plugins/newrelic/src/index.ts b/packages/plugins/newrelic/src/index.ts
@@ -63,6 +63,11 @@ export const useNewRelic = (rawOptions?: UseNewRelicOptions): Plugin => {
   const instrumentationApi$ = import('newrelic')
     .then(m => m.default || m)
     .then(({ shim }) => {
+      if (!shim?.agent) {
+        throw new Error(
+          'Agent unavailable. Please check your New Relic Agent configuration and ensure New Relic is enabled.'
+        );
+      }
       shim.agent.metrics
         .getOrCreateMetric(`Supportability/ExternalModules/${AttributeName.COMPONENT_NAME}`)
         .incrementCallCount();