New Relic: add error for agent not being found

.changeset/usenewrelic-agent-error-msg.md

@@ -0,0 +1,8 @@
+---
+"@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.

packages/plugins/newrelic/src/index.ts

@@ -63,6 +63,9 @@ 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();
@@ -125,50 +128,50 @@ export const useNewRelic = (rawOptions?: UseNewRelicOptions): Plugin => {
 
       const onResolverCalled: OnResolverCalledHook | undefined = options.trackResolvers
         ? async ({ args: resolversArgs, info }) => {
-            const logger = await logger$;
-            const { returnType, path, parentType } = info;
-            const formattedPath = flattenPath(path, delimiter);
-            const currentSegment = instrumentationApi.getActiveSegment();
-
-            if (!currentSegment) {
-              logger.trace('No active segment found at resolver call. Not recording resolver (%s).', formattedPath);
-              return () => {};
-            }
+          const logger = await logger$;
+          const { returnType, path, parentType } = info;
+          const formattedPath = flattenPath(path, delimiter);
+          const currentSegment = instrumentationApi.getActiveSegment();
+
+          if (!currentSegment) {
+            logger.trace('No active segment found at resolver call. Not recording resolver (%s).', formattedPath);
+            return () => { };
+          }
 
-            const resolverSegment = instrumentationApi.createSegment(
-              `resolver${delimiter}${formattedPath}`,
-              null,
-              operationSegment
-            );
+          const resolverSegment = instrumentationApi.createSegment(
+            `resolver${delimiter}${formattedPath}`,
+            null,
+            operationSegment
+          );
 
-            if (!resolverSegment) {
-              logger.trace('Resolver segment was not created (%s).', formattedPath);
-              return () => {};
-            }
+          if (!resolverSegment) {
+            logger.trace('Resolver segment was not created (%s).', formattedPath);
+            return () => { };
+          }
 
-            resolverSegment.start();
+          resolverSegment.start();
 
-            resolverSegment.addAttribute(AttributeName.RESOLVER_FIELD_PATH, formattedPath);
-            resolverSegment.addAttribute(AttributeName.RESOLVER_TYPE_NAME, parentType.toString());
-            resolverSegment.addAttribute(AttributeName.RESOLVER_RESULT_TYPE, returnType.toString());
+          resolverSegment.addAttribute(AttributeName.RESOLVER_FIELD_PATH, formattedPath);
+          resolverSegment.addAttribute(AttributeName.RESOLVER_TYPE_NAME, parentType.toString());
+          resolverSegment.addAttribute(AttributeName.RESOLVER_RESULT_TYPE, returnType.toString());
 
-            if (options.includeResolverArgs) {
-              const rawArgs = resolversArgs || {};
-              const resolverArgsToTrack = options.isResolverArgsRegex
-                ? filterPropertiesByRegex(rawArgs, options.includeResolverArgs as RegExp)
-                : rawArgs;
+          if (options.includeResolverArgs) {
+            const rawArgs = resolversArgs || {};
+            const resolverArgsToTrack = options.isResolverArgsRegex
+              ? filterPropertiesByRegex(rawArgs, options.includeResolverArgs as RegExp)
+              : rawArgs;
 
-              resolverSegment.addAttribute(AttributeName.RESOLVER_ARGS, JSON.stringify(resolverArgsToTrack));
-            }
+            resolverSegment.addAttribute(AttributeName.RESOLVER_ARGS, JSON.stringify(resolverArgsToTrack));
+          }
 
-            return ({ result }) => {
-              if (options.includeRawResult) {
-                resolverSegment.addAttribute(AttributeName.RESOLVER_RESULT, JSON.stringify(result));
-              }
+          return ({ result }) => {
+            if (options.includeRawResult) {
+              resolverSegment.addAttribute(AttributeName.RESOLVER_RESULT, JSON.stringify(result));
+            }
 
-              resolverSegment.end();
-            };
-          }
+            resolverSegment.end();
+          };
+        }
         : undefined;
 
       return {