Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
@@ -0,0 +1,48 @@
# REQUIRED
# Kind can be one of:
# - breaking-change: a change to previously-documented behavior
# - deprecation: functionality that is being removed in a later release
# - bug-fix: fixes a problem in a previous version
# - enhancement: extends functionality but does not break or fix existing behavior
# - feature: new functionality
# - known-issue: problems that we are aware of in a given version
# - security: impacts on the security of a product or a user’s deployment.
# - upgrade: important information for someone upgrading from a prior version
# - other: does not fit into any of the other categories
kind: deprecation

# REQUIRED for all kinds
# Change summary; a 80ish characters long description of the change.
summary: change-azure-eventhub-processor-version

# REQUIRED for breaking-change, deprecation, known-issue
# Long description; in case the summary is not enough to describe the change
# this field accommodate a description without length limits.
description: This PR is to change Filebeat azure eventhub input to use processor V2 as default instead of V1. Since we've decided to retire processor v1, we plan to set processor v2 as the default option in the next release, and completely remove v1 in the following release.

# REQUIRED for breaking-change, deprecation, known-issue
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@zmoog What would be the impact and action here for this breaking change?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is this a breaking change? If we can continue to support the connection string with the same setting this should not be.

Are we forced to change the config format, making it incompatible with the existing configs?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not a breaking change! I think we should use deprecation instead. @zmoog wdyt?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Deprecation sounds good to me.

impact: Users of the Azure Event Hub input who were relying on processor v1 as the default behavior will now automatically use processor v2, which may have different behavior or performance characteristics.

# REQUIRED for breaking-change, deprecation, known-issue
action: |
Users who want to continue using processor v1 should explicitly set `processor_version: v1` in their configuration.
However, v1 will be completely removed in a future release, so users should plan to migrate to v2.
Users who were not explicitly specifying a processor version will now use v2 by default and should test their configuration accordingly.

# REQUIRED for all kinds
# Affected component; usually one of "elastic-agent", "fleet-server", "filebeat", "metricbeat", "auditbeat", "all", etc.
component: filebeat

# AUTOMATED
# OPTIONAL to manually add other PR URLs
# PR URL: A link the PR that added the changeset.
# If not present is automatically filled by the tooling finding the PR where this changelog fragment has been added.
# NOTE: the tooling supports backports, so it's able to fill the original PR number instead of the backport PR number.
# Please provide it if you are adding a fragment for a different PR.
# pr: https://github.com/owner/repo/1234

# AUTOMATED
# OPTIONAL to manually add other issue URLs
# Issue URL; optional; the GitHub issue related to this changeset (either closes or is part of).
# If not present is automatically filled by the tooling with the issue linked to the PR number.
# issue: https://github.com/owner/repo/1234
10 changes: 5 additions & 5 deletions x-pack/filebeat/input/azureeventhub/config.go
Original file line number Diff line number Diff line change
Expand Up @@ -77,8 +77,8 @@ type azureInputConfig struct {
// migration from v1 to v2 (processor v2 only). Default is false.
MigrateCheckpoint bool `config:"migrate_checkpoint"`
// ProcessorVersion controls the processor version to use.
// Possible values are v1 and v2 (processor v2 only). Default is v1.
ProcessorVersion string `config:"processor_version"`
// Possible values are v1 and v2 (processor v2 only). The default is v2.
ProcessorVersion string `config:"processor_version" default:"v2"`
// ProcessorUpdateInterval controls how often attempt to claim
// partitions (processor v2 only). The default value is 10 seconds.
ProcessorUpdateInterval time.Duration `config:"processor_update_interval"`
Expand All @@ -103,9 +103,9 @@ type azureInputConfig struct {

func defaultConfig() azureInputConfig {
return azureInputConfig{
// For this release, we continue to use
// the processor v1 as the default.
ProcessorVersion: processorV1,
// For this release, we use
// the processor v2 as the default.
ProcessorVersion: processorV2,
// Controls how often attempt to claim partitions.
ProcessorUpdateInterval: 10 * time.Second,
// For backward compatibility with v1,
Expand Down
1 change: 1 addition & 0 deletions x-pack/filebeat/input/azureeventhub/config_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,7 @@ func TestStorageContainerValidate(t *testing.T) {
func TestValidate(t *testing.T) {
t.Run("Sanitize storage account containers with underscores", func(t *testing.T) {
config := defaultConfig()
config.ProcessorVersion = "v1"
config.ConnectionString = "Endpoint=sb://test-ns.servicebus.windows.net/;SharedAccessKeyName=RootManageSharedAccessKey;SharedAccessKey=SECRET"
config.EventHubName = "event_hub_00"
config.SAName = "teststorageaccount"
Expand Down
2 changes: 1 addition & 1 deletion x-pack/filebeat/module/azure/activitylogs/manifest.yml
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ var:
- name: migrate_checkpoint
default: yes
- name: processor_version
default: "v1"
default: "v2"
- name: processor_update_interval
default: "10s"
- name: processor_start_position
Expand Down
2 changes: 1 addition & 1 deletion x-pack/filebeat/module/azure/auditlogs/manifest.yml
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ var:
- name: migrate_checkpoint
default: yes
- name: processor_version
default: "v1"
default: "v2"
- name: processor_update_interval
default: "10s"
- name: processor_start_position
Expand Down
2 changes: 1 addition & 1 deletion x-pack/filebeat/module/azure/platformlogs/manifest.yml
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ var:
- name: migrate_checkpoint
default: yes
- name: processor_version
default: "v1"
default: "v2"
- name: processor_update_interval
default: "10s"
- name: processor_start_position
Expand Down
2 changes: 1 addition & 1 deletion x-pack/filebeat/module/azure/signinlogs/manifest.yml
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ var:
- name: migrate_checkpoint
default: yes
- name: processor_version
default: "v1"
default: "v2"
- name: processor_update_interval
default: "10s"
- name: processor_start_position
Expand Down