Skip to content

Commit

Permalink
[bug_fix] [exporter/pulsar] Change configuration option (#36579)
Browse files Browse the repository at this point in the history
#### Description
I updated the name of the item `map_connections_per_broker` in the
config and description in readme. Changed from
`map_connections_per_broker` to `max_connections_per_broker`. From the
description of the item in readme, I think this should be a typo.

---------

Co-authored-by: Alex Boten <[email protected]>
  • Loading branch information
liuby01 and codeboten authored Dec 3, 2024
1 parent ebdeab1 commit 2ee18d0
Show file tree
Hide file tree
Showing 3 changed files with 29 additions and 2 deletions.
27 changes: 27 additions & 0 deletions .chloggen/bug_fix-pulsarexporter-change_configuration_option.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
# Use this changelog template to create an entry for release notes.

# One of 'breaking', 'deprecation', 'new_component', 'enhancement', 'bug_fix'
change_type: bug_fix

# The name of the component, or a single word describing the area of concern, (e.g. filelogreceiver)
component: exporter/pulsarexporter

# A brief description of the change. Surround your text with quotes ("") if it needs to start with a backtick (`).
note: Change configuration option `map_connections_per_broker`, rename to `max_connections_per_broker`.

# Mandatory: One or more tracking issues related to the change. You can use the PR number here if no issue exists.
issues: [36579]

# (Optional) One or more lines of additional information to render under the primary note.
# These lines will be padded with 2 spaces and then inserted directly into the document.
# Use pipe (|) for multiline entries.
subtext:

# If your change doesn't affect end users or the exported elements of any package,
# you should instead start your pull request title with [chore] or use the "Skip Changelog" label.
# Optional: The change log or logs in which this entry should be included.
# e.g. '[user]' or '[user, api]'
# Include 'user' if the change is relevant to end users.
# Include 'api' if there is a change to a library API.
# Default: '[user]'
change_logs: [user]
2 changes: 1 addition & 1 deletion exporter/pulsarexporter/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,7 @@ The following settings can be optionally configured:
- `timeout`: send pulsar message timeout (default: 5s)
- `operation_timeout`: sets producer-create, subscribe and unsubscribe operations timeout (default: 30 seconds)
- `connection_timeout`: timeout for the establishment of a TCP connection (default: 5 seconds)
- `map_connections_per_broker`: max number of connections to a single broker that will kept in the pool. (default: 1 connection)
- `max_connections_per_broker`: max number of connections to a single broker that will kept in the pool. (default: 1 connection)
- `retry_on_failure`
- `enabled` (default = true)
- `initial_interval` (default = 5s): Time to wait after the first failure before retrying; ignored if `enabled` is `false`
Expand Down
2 changes: 1 addition & 1 deletion exporter/pulsarexporter/config.go
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ type Config struct {
Authentication Authentication `mapstructure:"auth"`
OperationTimeout time.Duration `mapstructure:"operation_timeout"`
ConnectionTimeout time.Duration `mapstructure:"connection_timeout"`
MaxConnectionsPerBroker int `mapstructure:"map_connections_per_broker"`
MaxConnectionsPerBroker int `mapstructure:"max_connections_per_broker"`
}

type Authentication struct {
Expand Down

0 comments on commit 2ee18d0

Please sign in to comment.