Azure Event Hubs Endpoint

Use the Azure Event Hubs endpoint when LoadStrike needs produce or consume flows with stable partition and correlation behavior.

What this page helps you do

What this page helps you do

Use the Azure Event Hubs endpoint when LoadStrike needs produce or consume flows with stable partition and correlation behavior.

Who this is for

Teams defining the transport-specific source or destination side of a correlated transaction.

Prerequisites

  • A stable tracking field shared between the producer side and the consumer or completion side

By the end

A transport definition that matches the transaction you need to measure.

Use this page when

Use this page when Azure Event Hubs Endpoint is the source or destination side of the transaction and you need the documented endpoint fields before wiring the scenario.

Visual guide

Transaction diagram showing source action, handoff, downstream processing, and completion.
The settings on this page only make sense when the workflow is treated as one transaction from source action to downstream completion.

Guide

Connection Settings

Use ConnectionString to tell LoadStrike how to connect to the Event Hubs namespace, and EventHubName to point it at the correct hub. Those two values are the base of both produce and consume configurations.

Consumer Groups

Use dedicated consumer groups when the test needs predictable isolation from other consumers. That makes it easier to reason about what the LoadStrike run is actually reading.

Partition Routing And Tracking

Use PartitionId when you must pin consume-side reads or explicit produce-side writes to one partition. Use PartitionKey for produce mode when the same tenant, order, or correlation key should always hash to the same partition. TrackingField still defines the business ID that LoadStrike uses for correlation. If PartitionId and PartitionKey are both set, PartitionId wins.

Endpoint definition samples

Use these samples to see how Azure Event Hubs Endpoint is represented as a source or destination endpoint before you attach it to a correlated scenario.

If you run these examples locally, add a valid runner key before execution starts. Set it with WithRunnerKey("...") or the config key LoadStrike:RunnerKey.

Event Hubs Endpoint

using LoadStrike;

var tracking = new CrossPlatformTrackingConfiguration
{
    Source = new AzureEventHubsEndpointDefinition
    {
        Name = "eh-in",
        Mode = TrafficEndpointMode.Produce,
        TrackingField = TrackingFieldSelector.Parse("json:$.trackingId"),
        ConnectionString = "<connection-string>",
        EventHubName = "orders",
        PartitionKey = "customer-a",
        PartitionCount = 8,
        MessagePayload = new { trackingId = "trk-1001", amount = 49.95m }
    },
    Destination = new AzureEventHubsEndpointDefinition
    {
        Name = "eh-out",
        Mode = TrafficEndpointMode.Consume,
        TrackingField = TrackingFieldSelector.Parse("json:$.trackingId"),
        ConnectionString = "<connection-string>",
        EventHubName = "orders"
    }
};

var scenario = CrossPlatformScenarioConfigurator
    .Configure(LoadStrikeScenario.Empty("orders-http-to-event-hubs"), tracking)
    .WithLoadSimulations(LoadStrikeSimulation.Inject(10, TimeSpan.FromSeconds(1), TimeSpan.FromSeconds(20)));

LoadStrikeRunner.RegisterScenarios(scenario)
    .WithRunnerKey("rkl_your_local_runner_key")
    .Run();

Azure Event Hubs endpoint fields and parameters

Name

Required endpoint identifier. It appears in correlation tables, sink exports, and troubleshooting messages, so choose a stable descriptive name.

Mode

Choose Produce when LoadStrike should create traffic, or Consume when it should listen for downstream traffic. Run mode validation checks that the selected mode matches the source or destination role.

TrackingField

Selector that extracts the correlation id from a header or JSON body. It is normally required, but can be omitted when UseLoadStrikeTraceIdHeader is true so LoadStrike uses header:loadstrike-trace-id for generated source traffic. Selector prefixes such as header: and json: are parsed case-insensitively, but the header name or JSON path segments after the prefix must match exact casing. The extracted value is matched case-sensitively by default unless TrackingFieldValueCaseSensitive is turned off on the tracking configuration.

GatherByField

Optional destination-only selector used for grouped correlation reports. It follows the same selector-casing rules as TrackingField. Group values are grouped case-sensitively by default unless GatherByFieldValueCaseSensitive is turned off on the tracking configuration.

AutoGenerateTrackingIdWhenMissing

Defaults to true. When the source payload does not already contain the tracked id, LoadStrike can inject one so the generated traffic still produces a correlation key.

UseLoadStrikeTraceIdHeader

Defaults to false. When true and TrackingField is omitted, produced source messages receive a loadstrike-trace-id header with a GUID value. Consume-mode source endpoints and CorrelateExistingTraffic runs do not inject this header; they only observe it if the existing traffic already contains it.

PollInterval

Controls how often a consumer-style endpoint polls for new messages. The value must stay greater than zero whenever you set it explicitly.

MessageHeaders

Optional headers that are written with produced traffic and also influence tracking extraction when the selector targets headers. Header names are preserved exactly as you set them, and header selectors later match using that same exact casing.

MessagePayload

Optional object or body value sent by producer-style endpoints. This is the payload your scenario is actually placing on the wire.

MessagePayloadType

Optional type hint used when JSON selectors need typed parsing. Leave it unset when dynamic JSON parsing is enough.

JsonSettings / JsonConvertSettings

Optional serializer settings for System.Text.Json or Newtonsoft.Json. Use them only when the payload shape or naming strategy requires custom parsing behavior.

ContentType

Optional explicit content type for custom payload handling. This is most helpful for delegate-style transports or non-default HTTP body shapes.

ConnectionString

Required Event Hubs namespace connection string.

EventHubName

Required Event Hub name.

ConsumerGroup

Consumer group used for consume mode. It defaults to $Default.

StartFromEarliest

Enable this when the consumer should start at the earliest retained events instead of only new ones.

PartitionId

Optional partition targeting field for consume-side reads when the test must stay on one partition.

PartitionKey

Optional produce-side routing key. When PartitionId is not set, the runtime hashes this key into a partition so the same business key consistently lands on the same Event Hubs partition across SDKs.

PartitionCount

Optional produce-side partition count used with PartitionKey. When you set PartitionKey and leave PartitionCount unset, LoadStrike falls back to 4. PartitionId still wins whenever both are set.

{ "trackingId": "trk-1" }