Skip to content

Commit

Permalink
Update content/docs/2.3/scalers/azure-event-hub.md
Browse files Browse the repository at this point in the history
Co-authored-by: Tom Kerkhove <kerkhove.tom@gmail.com>
  • Loading branch information
christle and tomkerkhove authored May 5, 2021
1 parent 6b39836 commit f03cffb
Showing 1 changed file with 5 additions and 5 deletions.
10 changes: 5 additions & 5 deletions content/docs/2.3/scalers/azure-event-hub.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,11 +30,11 @@ triggers:
- `consumerGroup` - Consumer group of Azure Event Hub consumer. (default: `$default`)
- `unprocessedEventThreshold` - : Average target value to trigger scaling actions. (default: 64)
- `blobContainer` - Container name to store checkpoint. This is needed for every `checkpointStrategy` except of `AzureFunction`. With Azure Functions the `blobContainer` is autogenerated and cannot be overridden.
- `checkpointStrategy` - configure the checkpoint behaviour of different Event Hub SDK's. (default: `""`)
- `""`: if no checkpointStrategy is specified, the Event Hub scaler is in backward compatibility mode and able to scale older implementations of C#, Python or Java Event Hub SDK's. (see "Legacy checkpointing"). if this behaviour should be used, `blobContainer` is also required.
- `azureFunction`: suitable for Azure Functions. This is automatically the default setting, if `blobcontainer` is empty.
- `blobMetadata`: For all implementations which stores checkpoint informations on blob metadata like current C#, Python, Java and JavaScript Event Hub SDK's.
- `goSdk` For all implementations which use the Golang SDK checkpointing like Dapr.io
- `checkpointStrategy` - configure the checkpoint behaviour of different Event Hub SDKs. (default: `""`)
- `azureFunction`: Suitable for Azure Functions & Azure WebJobs SDK. This is the default setting, when `blobcontainer` is not specified.
- `blobMetadata`: For all implementations that store checkpoint informations on blob metadata such as current C#, Python, Java and JavaScript Event Hub SDKs.
- `goSdk` For all implementations using the [Golang SDK](https://github.com/Azure/azure-event-hubs-go)'s checkpointing, for example Dapr
- When no checkpoint strategy is specified, the Event Hub scaler will use backwards compatibility and able to scale older implementations of C#, Python or Java Event Hub SDKs. (see "Legacy checkpointing"). If this behaviour should be used, `blobContainer` is also required.

> 💡 **Legacy Checkpointing:** C# applications, which use the `Microsoft.Azure.EventHubs` package, Java applications which use the `azure-eventhubs-eph` package or Python applications which use the `azure-eventhub` below `v5` are supported if no `checkpointStrategy` is specified. These legacy implementations are based on the `EventProcessorHost` client, which stores checkpoint information as blob container content
>
Expand Down

0 comments on commit f03cffb

Please sign in to comment.