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

Fix memory leak in SQL helper when database is not available #26607

Merged
merged 4 commits into from
Jul 1, 2021
Merged
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
1 change: 1 addition & 0 deletions CHANGELOG.next.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -500,6 +500,7 @@ https://github.com/elastic/beats/compare/v7.0.0-alpha2...master[Check the HEAD d
- Fix metric grouping for windows/perfmon module {issue}23489[23489] {pull}23505[23505]
- Major refactor of system/cpu and system/core metrics. {pull}25771[25771]
- Fix GCP Project ID being ingested as `cloud.account.id` in `gcp.billing` module {issue}26357[26357] {pull}26412[26412]
- Fix memory leak in SQL module when database is not available. {issue}25840[25840] {pull}26607[26607]
- Fix aws metric tags with resourcegroupstaggingapi paginator. {issue}26385[26385] {pull}26443[26443]

*Packetbeat*
Expand Down
3 changes: 3 additions & 0 deletions metricbeat/helper/sql/sql.go
Original file line number Diff line number Diff line change
Expand Up @@ -52,6 +52,9 @@ func NewDBClient(driver, uri string, l *logp.Logger) (*DbClient, error) {
}
err = dbx.Ping()
if err != nil {
if closeErr := dbx.Close(); closeErr != nil {
return nil, errors.Wrapf(err, "failed to close with %s, after connection test failed", closeErr)
}
return nil, errors.Wrap(err, "testing connection")
}

Expand Down
59 changes: 59 additions & 0 deletions metricbeat/helper/sql/sql_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -18,11 +18,18 @@
package sql

import (
"context"
"database/sql"
"database/sql/driver"
"fmt"
"math"
"testing"
"time"

"github.com/stretchr/testify/require"

"github.com/elastic/beats/v7/libbeat/common"
"github.com/elastic/beats/v7/libbeat/tests/resources"
)

type kv struct {
Expand Down Expand Up @@ -186,3 +193,55 @@ func TestToDotKeys(t *testing.T) {
t.Fail()
}
}

func TestNewDBClient(t *testing.T) {
t.Run("create and close", func(t *testing.T) {
goroutines := resources.NewGoroutinesChecker()
defer goroutines.Check(t)

client, err := NewDBClient("dummy", "localhost", nil)
require.NoError(t, err)

err = client.Close()
require.NoError(t, err)
})

t.Run("unavailable", func(t *testing.T) {
goroutines := resources.NewGoroutinesChecker()
defer goroutines.Check(t)

_, err := NewDBClient("dummy", "unavailable", nil)
require.Error(t, err)
})
}

func init() {
sql.Register("dummy", dummyDriver{})
}

type dummyDriver struct{}

func (dummyDriver) Open(name string) (driver.Conn, error) {
if name == "error" {
return nil, fmt.Errorf("error")
}

return &dummyConnection{name: name}, nil
}

type dummyConnection struct {
name string
}

// Ensure that this dummy connection implements the pinger interface, used by the helper.
var _ driver.Pinger = &dummyConnection{}

func (*dummyConnection) Prepare(query string) (driver.Stmt, error) { return nil, nil }
func (*dummyConnection) Close() error { return nil }
func (*dummyConnection) Begin() (driver.Tx, error) { return nil, nil }
func (c *dummyConnection) Ping(context.Context) error {
if c.name == "unavailable" {
return fmt.Errorf("database unavailable")
}
return nil
}