View a markdown version of this page

AWS::ApplicationSignals::InstrumentationConfig CaptureLimitsConfig - AWS CloudFormation

This is the new CloudFormation Template Reference Guide. Please update your bookmarks and links. For help getting started with CloudFormation, see the AWS CloudFormation User Guide.

AWS::ApplicationSignals::InstrumentationConfig CaptureLimitsConfig

Guardrails that prevent instrumentation from impacting application performance by limiting how much data is captured.

Syntax

To declare this entity in your CloudFormation template, use the following syntax:

JSON

{ "MaxCollectionDepth" : Integer, "MaxCollectionWidth" : Integer, "MaxFieldsPerObject" : Integer, "MaxHits" : Integer, "MaxObjectDepth" : Integer, "MaxStackFrames" : Integer, "MaxStackTraceSize" : Integer, "MaxStringLength" : Integer }

YAML

MaxCollectionDepth: Integer MaxCollectionWidth: Integer MaxFieldsPerObject: Integer MaxHits: Integer MaxObjectDepth: Integer MaxStackFrames: Integer MaxStackTraceSize: Integer MaxStringLength: Integer

Properties

MaxCollectionDepth

The maximum nesting depth to traverse inside collections. Defaults to 3.

Required: No

Type: Integer

Minimum: 1

Maximum: 5

Update requires: Replacement

MaxCollectionWidth

The maximum number of items to capture from any collection to prevent large payloads. Defaults to 10.

Required: No

Type: Integer

Minimum: 1

Maximum: 20

Update requires: Replacement

MaxFieldsPerObject

The maximum number of fields to capture for any object. Defaults to 10.

Required: No

Type: Integer

Minimum: 1

Maximum: 20

Update requires: Replacement

MaxHits

The maximum number of times the instrumentation point can be hit before it is automatically disabled. Defaults to 100.

Required: No

Type: Integer

Minimum: 1

Maximum: 1000

Update requires: Replacement

MaxObjectDepth

The maximum depth for nested object traversal when capturing structured data. Defaults to 3.

Required: No

Type: Integer

Minimum: 1

Maximum: 5

Update requires: Replacement

MaxStackFrames

The maximum number of stack frames to capture in stack traces. Defaults to 2.

Required: No

Type: Integer

Minimum: 1

Maximum: 20

Update requires: Replacement

MaxStackTraceSize

The maximum total size, in bytes, of a captured stack trace. Defaults to 1000.

Required: No

Type: Integer

Minimum: 1

Maximum: 1000

Update requires: Replacement

MaxStringLength

The maximum length of captured string values in characters. Strings longer than this are truncated. Defaults to 128.

Required: No

Type: Integer

Minimum: 1

Maximum: 255

Update requires: Replacement