Starter

Shadow SQS

SQS starter-backed shadow traffic support for publishing duplicated requests to SQS.

Artifact
helix-shadow-sqs-spring-boot-starter

Usage

build.gradle

Groovy DSL

dependencies {
    implementation helix.shadow.sqs.springboot.starter
}

build.gradle.kts

Kotlin DSL

dependencies {
    implementation(helix.shadow.sqs.springboot.starter)
}

Configuration

This starter uses the helix.shadow.sqs property namespace.

Helix Shadow Traffic configuration for publishing mirrored traffic to AWS SQS.

  • helix.shadow.sqs.enabled (Boolean): Enable or disable SQS shadow traffic.
  • helix.shadow.sqs.percentage (Integer): Percentage of traffic to shadow (0-100).
  • helix.shadow.sqs.inclusion-filters (Set): Optional set of inclusion filters. Only requests matching at least one filter will be shadowed.
  • helix.shadow.sqs.inclusion-filters[0].uri-pattern (String): Regex pattern matched against the request URI.
  • helix.shadow.sqs.inclusion-filters[0].method (String): HTTP method to match (e.g., GET, POST). Use ‘ALL’ to match any method.
  • helix.shadow.sqs.service-endpoint (String): Optional custom SQS service endpoint (e.g., for local testing or VPC endpoints).
  • helix.shadow.sqs.queue-url (String): SQS Queue URL used to publish shadow traffic messages.