Database instance attribute (#22)

* Added instance as an attribute on the DB samples

* Added host and instance to all samples

Author: cpheps

CHANGELOG.md

@@ -5,6 +5,11 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](http://keepachangelog.com/)
 and this project adheres to [Semantic Versioning](http://semver.org/).
 
+## 0.1.5 - 2018-11-15
+### Added
+- Instance as an attribute to WaitGroup and Instance samples
+- Host as an attribute to all samples
+
 ## 0.1.4 - 2018-11-14
 ### Changed
 - Made sub query for Instance errors more generic

mssql-config.yml.sample

@@ -7,8 +7,13 @@ instances:
       hostname: <Host name or IP address of the SQl Server>
       username: <Microsoft SQL Server connection user name>
       password: <Microsoft SQL Server connection password>
-      instance: <The Microsoft SQL Server instance to connect to. Do not supply port if this is specified>
+
+      # Both port and instance can be omitted to use a default port of 1433
       port: <Microsoft SQL Server port to connect to. Only needed when instance not specified>
+
+      # Only use instance instead of port if SQL Browser is enabled
+      instance: <The Microsoft SQL Server instance to connect to. Do not supply port if this is specified>
+
       enable_ssl: <true or false. Indicates if SSL encryption should be used>
       trust_server_certificate: <true or false. If true server certificate is not verified for SSL. If false certificate will be verified against supplied certificate>
       certificate_location: <Location of the SSL Certificate. Do not specify if trust_server_certificate is set to true>

src/connection/sql_connection.go

@@ -16,6 +16,7 @@ import (
 // SQLConnection represents a wrapper around a SQL Server connection
 type SQLConnection struct {
 	Connection *sqlx.DB
+	Host       string
 }
 
 // NewConnection creates a new SQLConnection from args
@@ -26,6 +27,7 @@ func NewConnection(args *args.ArgumentList) (*SQLConnection, error) {
 	}
 	return &SQLConnection{
 		Connection: db,
+		Host:       args.Hostname,
 	}, nil
 }
 

src/database/sql_database.go

@@ -94,12 +94,14 @@ func (l DBMetricSetLookup) getDatabaseName(model interface{}) string {
 }
 
 // CreateDBEntitySetLookup creates a look up of Database entity name to a metric.Set
-func CreateDBEntitySetLookup(dbEntities []*integration.Entity) DBMetricSetLookup {
+func CreateDBEntitySetLookup(dbEntities []*integration.Entity, instanceName, hostname string) DBMetricSetLookup {
 	entitySetLookup := make(DBMetricSetLookup)
 	for _, dbEntity := range dbEntities {
 		set := dbEntity.NewMetricSet("MssqlDatabaseSample",
 			metric.Attribute{Key: "displayName", Value: dbEntity.Metadata.Name},
 			metric.Attribute{Key: "entityName", Value: dbEntity.Metadata.Namespace + ":" + dbEntity.Metadata.Name},
+			metric.Attribute{Key: "instance", Value: instanceName},
+			metric.Attribute{Key: "host", Value: hostname},
 		)
 
 		entitySetLookup[dbEntity.Metadata.Name] = set

src/database/sql_database_test.go

@@ -161,14 +161,18 @@ func Test_createDBEntitySetLookUp(t *testing.T) {
 		"master": masterEntity.NewMetricSet("MssqlDatabaseSample",
 			metric.Attribute{Key: "displayName", Value: "master"},
 			metric.Attribute{Key: "entityName", Value: "database:master"},
+			metric.Attribute{Key: "instance", Value: "MSSQL"},
+			metric.Attribute{Key: "host", Value: "myHost"},
 		),
 		"tempdb": tempdbEntity.NewMetricSet("MssqlDatabaseSample",
 			metric.Attribute{Key: "displayName", Value: "tempdb"},
 			metric.Attribute{Key: "entityName", Value: "database:tempdb"},
+			metric.Attribute{Key: "instance", Value: "MSSQL"},
+			metric.Attribute{Key: "host", Value: "myHost"},
 		),
 	}
 
-	out := CreateDBEntitySetLookup(entities)
+	out := CreateDBEntitySetLookup(entities, "MSSQL", "myHost")
 	if !reflect.DeepEqual(out, expected) {
 		t.Errorf("Expected %+v got %+v", expected, out)
 	}

src/metrics/metrics.go

@@ -17,6 +17,7 @@ func PopulateInstanceMetrics(instanceEntity *integration.Entity, connection *con
 	metricSet := instanceEntity.NewMetricSet("MssqlInstanceSample",
 		metric.Attribute{Key: "displayName", Value: instanceEntity.Metadata.Name},
 		metric.Attribute{Key: "entityName", Value: instanceEntity.Metadata.Namespace + ":" + instanceEntity.Metadata.Name},
+		metric.Attribute{Key: "host", Value: connection.Host},
 	)
 
 	for _, queryDef := range instanceDefinitions {
@@ -56,6 +57,8 @@ func populateWaitTimeMetrics(instanceEntity *integration.Entity, connection *con
 			metric.Attribute{Key: "displayName", Value: instanceEntity.Metadata.Name},
 			metric.Attribute{Key: "entityName", Value: instanceEntity.Metadata.Namespace + ":" + instanceEntity.Metadata.Name},
 			metric.Attribute{Key: "waitType", Value: *model.WaitType},
+			metric.Attribute{Key: "host", Value: connection.Host},
+			metric.Attribute{Key: "instance", Value: instanceEntity.Metadata.Name},
 		)
 
 		metrics := []struct {
@@ -81,15 +84,15 @@ func populateWaitTimeMetrics(instanceEntity *integration.Entity, connection *con
 }
 
 // PopulateDatabaseMetrics collects per-database metrics
-func PopulateDatabaseMetrics(i *integration.Integration, connection *connection.SQLConnection) error {
+func PopulateDatabaseMetrics(i *integration.Integration, instanceName string, connection *connection.SQLConnection) error {
 	// create database entities
 	dbEntities, err := database.CreateDatabaseEntities(i, connection)
 	if err != nil {
 		return err
 	}
 
 	// create database entities lookup for fast metric set
-	dbSetLookup := database.CreateDBEntitySetLookup(dbEntities)
+	dbSetLookup := database.CreateDBEntitySetLookup(dbEntities, instanceName, connection.Host)
 
 	modelChan := make(chan interface{}, 10)
 	var wg sync.WaitGroup

src/metrics/metrics_test.go

@@ -72,7 +72,7 @@ func Test_populateDatabaseMetrics(t *testing.T) {
 
 	mock.ExpectClose()
 
-	PopulateDatabaseMetrics(i, conn)
+	PopulateDatabaseMetrics(i, "MSSQL", conn)
 
 	actual, _ := i.MarshalJSON()
 	expectedFile := filepath.Join("..", "testdata", "databaseMetrics.json.golden")

src/mssql.go

@@ -14,7 +14,7 @@ import (
 
 const (
 	integrationName    = "com.newrelic.mssql"
-	integrationVersion = "0.1.4"
+	integrationVersion = "0.1.5"
 )
 
 func main() {
@@ -56,7 +56,7 @@ func main() {
 
 	// Metric collection
 	if args.HasMetrics() {
-		if err := metrics.PopulateDatabaseMetrics(i, con); err != nil {
+		if err := metrics.PopulateDatabaseMetrics(i, instanceEntity.Metadata.Name, con); err != nil {
 			log.Error("Error collecting metrics for databases: %s", err.Error())
 		}
 

src/testdata/databaseMetrics.json.golden

@@ -1 +1 @@
-{"name":"test","protocol_version":"2","integration_version":"1.0.0","data":[{"entity":{"name":"test","type":"instance"},"metrics":[],"inventory":{},"events":[]},{"entity":{"name":"master","type":"database"},"metrics":[{"displayName":"master","entityName":"database:master","event_type":"MssqlDatabaseSample","log.transactionGrowth":0}],"inventory":{},"events":[]},{"entity":{"name":"otherdb","type":"database"},"metrics":[{"displayName":"otherdb","entityName":"database:otherdb","event_type":"MssqlDatabaseSample","log.transactionGrowth":1}],"inventory":{},"events":[]}]}
+{"name":"test","protocol_version":"2","integration_version":"1.0.0","data":[{"entity":{"name":"test","type":"instance"},"metrics":[],"inventory":{},"events":[]},{"entity":{"name":"master","type":"database"},"metrics":[{"displayName":"master","entityName":"database:master","event_type":"MssqlDatabaseSample","host":"","instance":"MSSQL","log.transactionGrowth":0}],"inventory":{},"events":[]},{"entity":{"name":"otherdb","type":"database"},"metrics":[{"displayName":"otherdb","entityName":"database:otherdb","event_type":"MssqlDatabaseSample","host":"","instance":"MSSQL","log.transactionGrowth":1}],"inventory":{},"events":[]}]}

src/testdata/empty.json.golden

@@ -1 +1 @@
-{"name":"test","protocol_version":"2","integration_version":"1.0.0","data":[{"entity":{"name":"test","type":"instance"},"metrics":[{"displayName":"test","entityName":"instance:test","event_type":"MssqlInstanceSample"}],"inventory":{},"events":[]}]}
+{"name":"test","protocol_version":"2","integration_version":"1.0.0","data":[{"entity":{"name":"test","type":"instance"},"metrics":[{"displayName":"test","entityName":"instance:test","event_type":"MssqlInstanceSample","host":""}],"inventory":{},"events":[]}]}