Skip to content

Commit

Permalink
add deprecation note about timeout option
Browse files Browse the repository at this point in the history
  • Loading branch information
clarkb7 committed Nov 8, 2023
1 parent 55ac098 commit a57acc0
Show file tree
Hide file tree
Showing 2 changed files with 17 additions and 10 deletions.
14 changes: 9 additions & 5 deletions win32_event_log/assets/configuration/spec.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -280,11 +280,6 @@ files:
of the current user will be used.
value:
type: string
- name: timeout
description: The number of seconds to wait for new event signals.
value:
type: integer
example: 5
- name: payload_size
description: |
The number of events to request at a time.
Expand All @@ -309,6 +304,15 @@ files:
value:
type: boolean
example: false
- name: timeout
description: |
The number of seconds to wait for new event signals.
Note: This is only used when `legacy_mode_v2` is set to `true`.
Starting in Agent version 7.50.0 this option is no longer applicable and can be removed.
value:
type: integer
example: 5
- name: legacy_mode
description: |
Whether or not to use a mode of operation that is now unmaintained and will be removed in a future version.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -230,11 +230,6 @@ instances:
#
# domain: <DOMAIN>

## @param timeout - integer - optional - default: 5
## The number of seconds to wait for new event signals.
#
# timeout: 5

## @param payload_size - integer - optional - default: 10
## The number of events to request at a time.
##
Expand All @@ -257,6 +252,14 @@ instances:
#
# legacy_mode_v2: false

## @param timeout - integer - optional - default: 5
## The number of seconds to wait for new event signals.
##
## Note: This is only used when `legacy_mode_v2` is set to `true`.
## Starting in Agent version 7.50.0 this option is no longer applicable and can be removed.
#
# timeout: 5

## @param legacy_mode - boolean - optional - default: true
## Whether or not to use a mode of operation that is now unmaintained and will be removed in a future version.
##
Expand Down

0 comments on commit a57acc0

Please sign in to comment.