Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[exporter/kafkaexporter] Skip Username and Password config validation for IAM #37417

Open
wants to merge 10 commits into
base: main
Choose a base branch
from
27 changes: 27 additions & 0 deletions .chloggen/main.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: enhancement

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

# A brief description of the change. Surround your text with quotes ("") if it needs to start with a backtick (`).
note: do not ask for user and password if auth mechanism is set to AWS IAM

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

# (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: []
13 changes: 7 additions & 6 deletions exporter/kafkaexporter/config.go
Original file line number Diff line number Diff line change
Expand Up @@ -135,12 +135,13 @@ func validateSASLConfig(c *kafka.SASLConfig) error {
return nil
}

if c.Username == "" {
return fmt.Errorf("auth.sasl.username is required")
}

if c.Password == "" {
return fmt.Errorf("auth.sasl.password is required")
if c.Mechanism != "AWS_MSK_IAM" && c.Mechanism != "AWS_MSK_IAM_OAUTHBEARER" {
if c.Username == "" {
return fmt.Errorf("auth.sasl.username is required")
}
if c.Password == "" {
return fmt.Errorf("auth.sasl.password is required")
}
}

switch c.Mechanism {
Expand Down
16 changes: 16 additions & 0 deletions exporter/kafkaexporter/config_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -294,6 +294,22 @@ func TestValidate_sasl_version(t *testing.T) {
assert.EqualError(t, err, "auth.sasl.version has to be either 0 or 1. configured value 42")
}

func TestValidate_sasl_iam(t *testing.T) {
config := &Config{
Producer: Producer{
Compression: "none",
},
Authentication: kafka.Authentication{
SASL: &kafka.SASLConfig{
Mechanism: "AWS_MSK_IAM",
},
},
}

err := config.Validate()
assert.Equal(t, err, nil)
}

func Test_saramaProducerCompressionCodec(t *testing.T) {
tests := map[string]struct {
compression string
Expand Down