Skip to content

Commit

Permalink
[receiver/mysql] Change the type of Config.Password to be `configop…
Browse files Browse the repository at this point in the history
…aque.String` (#23868)

**Description:**
Split out from: #17353

**Link to tracking Issue:**
#17273
  • Loading branch information
mackjmr committed Jun 30, 2023
1 parent 4b93564 commit 35a2adb
Show file tree
Hide file tree
Showing 5 changed files with 29 additions and 5 deletions.
20 changes: 20 additions & 0 deletions .chloggen/mysql-use-configopaque.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
# Use this changelog template to create an entry for release notes.
# If your change doesn't affect end users, such as a test fix or a tooling change,
# you should instead start your pull request title with [chore] or use the "Skip Changelog" label.

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

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

# A brief description of the change. Surround your text with quotes ("") if it needs to start with a backtick (`).
note: Change the type of `Config.Password` to be `configopaque.String`

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

# (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:
2 changes: 1 addition & 1 deletion receiver/mysqlreceiver/client.go
Original file line number Diff line number Diff line change
Expand Up @@ -166,7 +166,7 @@ var _ client = (*mySQLClient)(nil)
func newMySQLClient(conf *Config) client {
driverConf := mysql.Config{
User: conf.Username,
Passwd: conf.Password,
Passwd: string(conf.Password),
Net: conf.Transport,
Addr: conf.Endpoint,
DBName: conf.Database,
Expand Down
9 changes: 5 additions & 4 deletions receiver/mysqlreceiver/config.go
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ import (
"time"

"go.opentelemetry.io/collector/config/confignet"
"go.opentelemetry.io/collector/config/configopaque"
"go.opentelemetry.io/collector/receiver/scraperhelper"

"github.com/open-telemetry/opentelemetry-collector-contrib/receiver/mysqlreceiver/internal/metadata"
Expand All @@ -20,10 +21,10 @@ const (

type Config struct {
scraperhelper.ScraperControllerSettings `mapstructure:",squash"`
Username string `mapstructure:"username,omitempty"`
Password string `mapstructure:"password,omitempty"`
Database string `mapstructure:"database,omitempty"`
AllowNativePasswords bool `mapstructure:"allow_native_passwords,omitempty"`
Username string `mapstructure:"username,omitempty"`
Password configopaque.String `mapstructure:"password,omitempty"`
Database string `mapstructure:"database,omitempty"`
AllowNativePasswords bool `mapstructure:"allow_native_passwords,omitempty"`
confignet.NetAddr `mapstructure:",squash"`
MetricsBuilderConfig metadata.MetricsBuilderConfig `mapstructure:",squash"`
StatementEvents StatementEventsConfig `mapstructure:"statement_events"`
Expand Down
1 change: 1 addition & 0 deletions receiver/mysqlreceiver/go.mod
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@ require (
github.com/testcontainers/testcontainers-go v0.21.0
go.opentelemetry.io/collector/component v0.80.1-0.20230629144634-c3f70bd1f8ea
go.opentelemetry.io/collector/config/confignet v0.80.1-0.20230629144634-c3f70bd1f8ea
go.opentelemetry.io/collector/config/configopaque v0.80.1-0.20230629144634-c3f70bd1f8ea
go.opentelemetry.io/collector/confmap v0.80.1-0.20230629144634-c3f70bd1f8ea
go.opentelemetry.io/collector/consumer v0.80.1-0.20230629144634-c3f70bd1f8ea
go.opentelemetry.io/collector/pdata v1.0.0-rcv0013.0.20230629144634-c3f70bd1f8ea
Expand Down
2 changes: 2 additions & 0 deletions receiver/mysqlreceiver/go.sum

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

0 comments on commit 35a2adb

Please sign in to comment.