Skip to content

feat: add flag for ignoring bad connections #2452

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.

Sign up for GitHub

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

Merged
hessjcg merged 5 commits into from
Jun 23, 2025
Merged

feat: add flag for ignoring bad connections #2452

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
d7ef453
feat: add flag for ignoring bad connections
kenkania May 27, 2025
8131e9d
rename
kenkania Jun 17, 2025
7adc839
add unit test
kenkania Jun 17, 2025
8d34204
comments
kenkania Jun 17, 2025
6124da6
docs: Update the generated command line documentation.
hessjcg Jun 23, 2025
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
4 changes: 4 additions & 0 deletions cmd/root.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -527,6 +527,10 @@ CPU may be throttled and a background refresh cannot run reliably
against all specified instances. If an instance is unreachable, the Proxy exits with a failure
status code.`)

localFlags.BoolVar(&c.conf.SkipFailedInstanceConfig, "skip-failed-instance-config", false,
`If set, the Proxy will skip any instances that are invalid/unreachable (
only applicable to Unix sockets)`)

// Global and per instance flags
localFlags.StringVarP(&c.conf.Addr, "address", "a", "127.0.0.1",
"(*) Address to bind Cloud SQL instance listeners.")
Expand Down
2 changes: 2 additions & 0 deletions docs/cmd/cloud-sql-proxy.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -277,6 +277,8 @@ cloud-sql-proxy INSTANCE_CONNECTION_NAME... [flags]
--run-connection-test Runs a connection test
against all specified instances. If an instance is unreachable, the Proxy exits with a failure
status code.
--skip-failed-instance-config If set, the Proxy will skip any instances that are invalid/unreachable (
only applicable to Unix sockets)
--sqladmin-api-endpoint string API endpoint for all Cloud SQL Admin API requests. (default: https://sqladmin.googleapis.com)
-l, --structured-logs Enable structured logging with LogEntry format
--telemetry-prefix string Prefix for Cloud Monitoring metrics.
Expand Down
10 changes: 10 additions & 0 deletions internal/proxy/proxy.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -267,6 +267,11 @@ type Config struct {
// RunConnectionTest determines whether the Proxy should attempt a connection
// to all specified instances to verify the network path is valid.
RunConnectionTest bool

// SkipFailedInstanceConfig determines whether the Proxy should skip failed
// connections to Cloud SQL instances instead of exiting on startup.
// This only applies to Unix sockets.
SkipFailedInstanceConfig bool
}

// dialOptions interprets appropriate dial options for a particular instance
Expand Down Expand Up @@ -546,6 +551,11 @@ func NewClient(ctx context.Context, d cloudsql.Dialer, l cloudsql.Logger, conf *
for _, inst := range conf.Instances {
m, err := c.newSocketMount(ctx, conf, pc, inst)
if err != nil {
if conf.SkipFailedInstanceConfig {
l.Errorf("[%v] Unable to mount socket: %v (skipped due to skip-failed-instance-config flag)", inst.Name, err)
continue
}

for _, m := range mnts {
mErr := m.Close()
if mErr != nil {
Expand Down
14 changes: 14 additions & 0 deletions internal/proxy/proxy_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -309,6 +309,20 @@ func TestClientInitialization(t *testing.T) {
filepath.Join(testUnixSocketPathPg),
},
},
{
desc: "with Unix socket and two instances, one invalid but skipped",
in: &proxy.Config{
UnixSocket: testDir,
Instances: []proxy.InstanceConnConfig{
{Name: pg},
{Name: "proj:region:fakeserver"},
},
SkipFailedInstanceConfig: true,
},
wantUnixAddrs: []string{
filepath.Join(testDir, pg, ".s.PGSQL.5432"),
},
},
{
desc: "with TCP port for non functional instance",
in: &proxy.Config{
Expand Down
52 changes: 26 additions & 26 deletions migration-guide.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -144,29 +144,29 @@ The following table lists in alphabetical order v1 flags and their v2 version.
- ❌: Not supported in V2
- 🤔: Unplanned, but has open feature request

| v1 | v2 | Notes |
| --------------------------- | --------------------- | ------------------------------------------------------------------------------------ |
| check_region | ❌ | |
| credential_file | credentials-file | |
| dir | unix-socket | |
| enable_iam_login | auto-iam-authn | |
| fd_rlimit | 🤔 | [Feature Request](https://github.com/GoogleCloudPlatform/cloudsql-proxy/issues/1258) |
| fuse | fuse | |
| fuse_tmp | fuse-temp-dir | |
| health_check_port | http-port | Use --http-address=0.0.0.0 when using a health check in Kubernetes |
| host | sqladmin-api-endpoint | |
| instances_metadata | 🤔 | [Feature Request](https://github.com/GoogleCloudPlatform/cloudsql-proxy/issues/1259) |
| ip_address_types | private-ip | Defaults to public. To connect to a private IP, you must add the --private-ip flag |
| log_debug_stdout | ❌ | v2 logs to stdout, errors to stderr by default |
| max_connections | max-connections | |
| projects | ❌ | v2 prefers explicit connection configuration to avoid user error |
| quiet | quiet | quiet disables all logging except errors |
| quota_project | quota-project | |
| refresh_config_throttle | ❌ | |
| skip_failed_instance_config | ❌ | This flag was only necessary with Unix sockets. Use TCP sockets to avoid failed startup. |
| structured_logs | structured-logs | |
| term_timeout | max-sigterm-delay | |
| token | token | |
| use_http_health_check | health-check | |
| verbose | ❌ | |
| version | version | |
| v1 | v2 | Notes |
| --------------------------- | --------------------------- | ------------------------------------------------------------------------------------ |
| check_region | ❌ | |
| credential_file | credentials-file | |
| dir | unix-socket | |
| enable_iam_login | auto-iam-authn | |
| fd_rlimit | 🤔 | [Feature Request](https://github.com/GoogleCloudPlatform/cloudsql-proxy/issues/1258) |
| fuse | fuse | |
| fuse_tmp | fuse-temp-dir | |
| health_check_port | http-port | Use --http-address=0.0.0.0 when using a health check in Kubernetes |
| host | sqladmin-api-endpoint | |
| instances_metadata | 🤔 | [Feature Request](https://github.com/GoogleCloudPlatform/cloudsql-proxy/issues/1259) |
| ip_address_types | private-ip | Defaults to public. To connect to a private IP, you must add the --private-ip flag |
| log_debug_stdout | ❌ | v2 logs to stdout, errors to stderr by default |
| max_connections | max-connections | |
| projects | ❌ | v2 prefers explicit connection configuration to avoid user error |
| quiet | quiet | quiet disables all logging except errors |
| quota_project | quota-project | |
| refresh_config_throttle | ❌ | |
| skip_failed_instance_config | skip-failed-instance-config | |
| structured_logs | structured-logs | |
| term_timeout | max-sigterm-delay | |
| token | token | |
| use_http_health_check | health-check | |
| verbose | ❌ | |
| version | version | |
Loading