Skip to content

Commit

Permalink
Clarify + simplify docs & UI descriptions
Browse files Browse the repository at this point in the history
  • Loading branch information
zmoog committed Feb 18, 2025
1 parent b934ef4 commit 5951569
Show file tree
Hide file tree
Showing 3 changed files with 44 additions and 43 deletions.
14 changes: 9 additions & 5 deletions packages/azure/_dev/build/docs/events.md
Original file line number Diff line number Diff line change
Expand Up @@ -517,7 +517,7 @@ _string_
_string_
(v2 only) Controls from what position in the event hub the input should start processing messages for all partitions.

Possible values are `earliest` and `latest`.
Possible values are `earliest` and `latest`.

* `earliest` starts processing messages from the last checkpoint, or the beginning of the event hub if no checkpoint is available.
* `latest` starts processing messages from the the latest event in the event hub and continues to process new events as they arrive.
Expand All @@ -526,17 +526,21 @@ Default is `earliest`.

`migrate_checkpoint` :
_boolean_
(v2 only) Whether to migrate the checkpoint information from the input v1 format to v2 format.
(v2 only) Flag to control if the input should perform the checkpoint information migration from v1 to v2 at startup. The checkpoint migration converts the checkpoint information from the v1 format to the v2 format.

Default is `false`, which means the input will not perform the checkpoint migration and will start processing messages from the beginning or the end of the event hub according to the `processor_start_position` setting.
Default is `false`, which means the input will not perform the checkpoint migration.

`partition_receive_timeout` :
_string_
(v2 only) Max time to wait before processing the messages received from the event hub. Default is `5s`.
(v2 only) Max time to wait before processing the messages received from the event hub.

The partition consumer waits up to a "receive count" or a "receive timeout", whichever comes first. Default is `5` seconds.

`partition_receive_count` :
_string_
(v2 only) Max number of events to wait for before processing the messages received from the event hub. Default is `100`.
(v2 only) Max number of messages from the event hub to wait for before processing them.

The partition consumer waits up to a "receive count" or a "receive timeout", whichever comes first. Default is `100` messages.

## Handling Malformed JSON in Azure Logs

Expand Down
59 changes: 26 additions & 33 deletions packages/azure/data_stream/events/manifest.yml
Original file line number Diff line number Diff line change
Expand Up @@ -95,22 +95,7 @@ streams:
is recommended for typical use cases.
Default is `v1`.
- name: migrate_checkpoint
type: bool
title: Migrate checkpoint information
multi: false
required: false
show_user: false
default: false
description: >-
(Processor v2 only) The "migrate checkpoint information" option
controls if the input should perform the checkpoint information
migration from v1 to v2 at startup.
Default is `false`, which means the input will not perform the
checkpoint migration.
- name: processor_update_interval
type: text
title: Processor update interval
Expand All @@ -131,9 +116,8 @@ streams:
show_user: false
default: earliest
description: >-
(Processor v2 only) The "processor start position" option controls
from what position in the event hub the input should start processing
messages for all partitions.
(Processor v2 only) Controls from what position in the event hub
the input should start processing messages for all partitions.
Possible values are `earliest` and `latest`.
Expand All @@ -145,6 +129,23 @@ streams:
Default is `earliest`.
- name: migrate_checkpoint
type: bool
title: Migrate checkpoint information
multi: false
required: false
show_user: false
default: false
description: >-
(Processor v2 only) Flag to control if the input should perform the
checkpoint information migration from v1 to v2 at startup.
The checkpoint migration converts the checkpoint information
from the v1 format to the v2 format.
Default is `false`, which means the input will not perform the
checkpoint migration.
- name: partition_receive_timeout
type: text
title: Partition receive timeout
Expand All @@ -156,12 +157,8 @@ streams:
(Processor v2 only) Max time to wait before processing the
messages received from the event hub.
The partition client waits up to "partition receive timeout" or
for at least "partition receive count events", then it returns
the events it has received.
The Partition receive timeout option controls the batching
of incoming messages together with Partition receive count.
The partition consumer waits up to a "receive count" or a
"receive timeout", whichever comes first.
Default is `5` seconds.
Expand All @@ -173,15 +170,11 @@ streams:
show_user: false
default: 100
description: >-
(Processor v2 only) Max number of events to wait for before processing
the messages received from the event hub.
(Processor v2 only) Max number of messages from the event hub
to wait for before processing them.
The "partition receive count" option controls the batching of
incoming messages together with Partition receive timeout.
The partition client waits up to "partition receive timeout" or
for at least "partition receive count" events, then it returns
the events it has received.
The partition consumer waits up to a "receive count" or a
"receive timeout", whichever comes first.
Default is `100` messages.
Expand Down
14 changes: 9 additions & 5 deletions packages/azure/docs/events.md
Original file line number Diff line number Diff line change
Expand Up @@ -517,7 +517,7 @@ _string_
_string_
(v2 only) Controls from what position in the event hub the input should start processing messages for all partitions.

Possible values are `earliest` and `latest`.
Possible values are `earliest` and `latest`.

* `earliest` starts processing messages from the last checkpoint, or the beginning of the event hub if no checkpoint is available.
* `latest` starts processing messages from the the latest event in the event hub and continues to process new events as they arrive.
Expand All @@ -526,17 +526,21 @@ Default is `earliest`.

`migrate_checkpoint` :
_boolean_
(v2 only) Whether to migrate the checkpoint information from the input v1 format to v2 format.
(v2 only) Flag to control if the input should perform the checkpoint information migration from v1 to v2 at startup. The checkpoint migration converts the checkpoint information from the v1 format to the v2 format.

Default is `false`, which means the input will not perform the checkpoint migration and will start processing messages from the beginning or the end of the event hub according to the `processor_start_position` setting.
Default is `false`, which means the input will not perform the checkpoint migration.

`partition_receive_timeout` :
_string_
(v2 only) Max time to wait before processing the messages received from the event hub. Default is `5s`.
(v2 only) Max time to wait before processing the messages received from the event hub.

The partition consumer waits up to a "receive count" or a "receive timeout", whichever comes first. Default is `5` seconds.

`partition_receive_count` :
_string_
(v2 only) Max number of events to wait for before processing the messages received from the event hub. Default is `100`.
(v2 only) Max number of messages from the event hub to wait for before processing them.

The partition consumer waits up to a "receive count" or a "receive timeout", whichever comes first. Default is `100` messages.

## Handling Malformed JSON in Azure Logs

Expand Down

0 comments on commit 5951569

Please sign in to comment.