Error: Insufficient information provided for naming the alarms and/or monitoring section: Please provide alarmFriendlyName, humanReadableName, or namedConstruct as a fallback

[bestickley]

I got the error: Error: Insufficient information provided for naming the alarms and/or monitoring section: Please provide alarmFriendlyName, humanReadableName, or namedConstruct as a fallback when deploying this Nextjs construct and I'm not sure why. Can anyone help me understand how I can resolve the issue?

[mobob]

I just came across this lib, and first try i hit this too. It probably depends on what service you're using, but fwiw i'm using app sync, and just had to add in an alarmFriendlyName to the constructor to resolve the synth issue:

    monitoring
      .addLargeHeader('Backend Monitoring')
      .monitorAppSyncApi({ api: appSyncApp, alarmFriendlyName: 'fsta-backend' });

[cayman-amzn]

Hey there! Apologies on the very late reply

The error Insufficient information error is thrown here:

cdk-monitoring-constructs/lib/dashboard/MonitoringNamingStrategy.ts

Lines 87 to 90 in 2357fe0

	throw new Error(
	"Insufficient information provided for naming the alarms and/or monitoring section: " +
	"Please provide alarmFriendlyName, humanReadableName, or namedConstruct as a fallback"
	);

...via:

cdk-monitoring-constructs/lib/dashboard/MonitoringNamingStrategy.ts

Lines 54 to 56 in 2357fe0

	resolveAlarmFriendlyName(): string {
	return this.input.alarmFriendlyName ?? this.getFallbackAlarmFriendlyName();
	}

From what I remember, there are requirements on what values we can use since they can end up in CloudFormation parameters- providing the alarmFriendlyName like @mobob mentions helps us generate a string withing the Cfn requirements. Hope this helps!

CC @echeung-amzn to correct me if I'm wrong :P

[echeung-amzn]

That's right. Like @mobob mentioned as well, it can depend on what service you're using and whether the props you're passing in end up being sufficient enough to form a decently recognizable/unique name or not.

@bestickley I'm not familiar with the NextJS construct, does the error happen to spit out more context on what it's failing around? Are you using monitorScope?

[bestickley]

@echeung-amzn and @cayman-amzn, thank you. I'm guessing it's an issue with the name as you suggested. I'll test this out when I can find time. See here as example for how I'm using construct.