CfnInstrumentationConfigProps Struct
Properties for defining a CfnInstrumentationConfig.
Example
ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_applicationsignals as applicationsignals } from 'aws-cdk-lib';
const cfnInstrumentationConfigProps: applicationsignals.CfnInstrumentationConfigProps = {
captureConfiguration: {
codeCapture: {
captureLimits: {
maxCollectionDepth: 123,
maxCollectionWidth: 123,
maxFieldsPerObject: 123,
maxHits: 123,
maxObjectDepth: 123,
maxStackFrames: 123,
maxStackTraceSize: 123,
maxStringLength: 123,
},
// the properties below are optional
captureArguments: ['captureArguments'],
captureLocals: ['captureLocals'],
captureReturn: false,
captureStackTrace: false,
},
},
environment: 'environment',
instrumentationType: 'instrumentationType',
location: {
codeLocation: {
filePath: 'filePath',
language: 'language',
// the properties below are optional
className: 'className',
codeUnit: 'codeUnit',
lineNumber: 123,
methodName: 'methodName',
},
},
service: 'service',
signalType: 'signalType',
// the properties below are optional
attributeFilters: [{
attributeFiltersKey: 'attributeFilters',
}],
description: 'description',
expiresAt: 'expiresAt',
tags: [{
key: 'key',
value: 'value',
}],
};
Properties
attributeFiltersoptionalIResolvable | IResolvable | { [key: string]: string }[]attribute_filtersoptionaltyping.Union[IResolvable, typing.List[typing.Union[IResolvable, typing.Mapping[str, str]]]]attributeFiltersoptionalIResolvableAttributeFiltersoptionalIResolvableAttributeFiltersoptionalinterface{}#Client-side filters that target specific instances.
Each object is AND-matched on keys, multiple objects are OR-matched.
captureConfigurationIResolvable | CfnInstrumentationConfig.CaptureConfigurationPropertycapture_configurationtyping.Union[IResolvable, CaptureConfigurationProperty]captureConfigurationIResolvableCaptureConfigurationIResolvableCaptureConfigurationinterface{}required#Specifies what to capture when the instrumentation point is hit.
descriptionoptionalstringdescriptionoptionalstrdescriptionoptionalStringDescriptionoptionalstringDescriptionoptional*string#An optional short description that explains the purpose of this instrumentation.
The environment that the service is running in.
expiresAtoptionalstringexpires_atoptionalstrexpiresAtoptionalStringExpiresAtoptionalstringExpiresAtoptional*string#The timestamp after which this configuration is no longer served.
For BREAKPOINT only; defaults to 24 hours.
instrumentationTypestringinstrumentation_typestrinstrumentationTypeStringInstrumentationTypestringInstrumentationType*stringrequired#Type of instrumentation: BREAKPOINT (temporary, expires after 24 hours) or PROBE (permanent, persists until deleted).
locationIResolvable | CfnInstrumentationConfig.LocationPropertylocationtyping.Union[IResolvable, LocationProperty]locationIResolvableLocationIResolvableLocationinterface{}required#The location where instrumentation should be applied.
The name of the service to instrument.
This should match the service.name resource attribute reported by the application.
The telemetry signal type to emit for this instrumentation.
The supported value is SNAPSHOT.