Merge pull request #12 from newrelic/bm-dev

Blue Medora Delivery

Author: matiasburni

.gitignore

@@ -0,0 +1,40 @@
+# Compiled Object files, Static and Dynamic libs (Shared Objects)
+*.o
+*.a
+*.so
+
+# Folders
+_obj
+_test
+bin
+
+# Architecture specific extensions/prefixes
+*.[568vq]
+[568vq].out
+
+*.cgo1.go
+*.cgo2.c
+_cgo_defun.c
+_cgo_gotypes.go
+_cgo_export.*
+
+_testmain.go
+
+*.exe
+*.test
+*.prof
+*.DS_STORE
+
+/integrations/*/bin/
+coverage.xml
+target/
+# Vim swap
+[._]*.s[a-w][a-z]
+[._]s[a-w][a-z]
+
+# Vim session
+Session.vim
+
+# VSCode
+.vscode
+debug

CHANGELOG.md

@@ -5,16 +5,6 @@ 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/).
 
-## Unreleased
-### Added
-- X
-
-### Changed
-- X
-
-### Removed
-- X
-
-## 0.1.0 - 2018-08-13
+## 0.1.0 - 2018-09-20
 ### Added
 - Initial version: Includes Metrics and Inventory data

LICENSE

@@ -0,0 +1,13 @@
+Copyright 2018, Blue Medora Inc.
+
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in 
+the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the 
+Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE 
+WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS 
+OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR 
+OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Makefile

@@ -46,15 +46,15 @@ validate-all: deps
 
 compile: deps
 	@echo "=== $(INTEGRATION) === [ compile ]: Building $(BINARY_NAME)..."
-	@go build -o bin/$(BINARY_NAME) $(GO_FILE)
+	@go build -o bin/$(BINARY_NAME) $(GO_FILES)
 
 compile-only: deps-only
 	@echo "=== $(INTEGRATION) === [ compile ]: Building $(BINARY_NAME)..."
-	@go build -o bin/$(BINARY_NAME) $(GO_FILE)
+	@go build -o bin/$(BINARY_NAME) $(GO_FILES)
 
 test: deps
 	@echo "=== $(INTEGRATION) === [ test ]: Running unit tests..."
-	@gocov test $(GO_FILES)... | gocov-xml > coverage.xml
+	@gocov test -race $(GO_FILES)... | gocov-xml > coverage.xml
 
 # Include thematic Makefiles
 include Makefile-*.mk

Makefile-docker.mk

@@ -0,0 +1,14 @@
+DOCKER_IMAGE := golang:1.9
+INTEGRATION_DIR := nri-$(INTEGRATION)
+
+docker-fmt:
+	@echo "=== $(INTEGRATION) === [ docker-fmt ]: Running gofmt in Docker..."
+	@echo "Using Docker image $(DOCKER_IMAGE)"
+	@docker run -it --rm -v $(PWD):/go/src/github.com/newrelic/$(INTEGRATION_DIR) -w /go/src/github.com/newrelic/$(INTEGRATION_DIR) $(DOCKER_IMAGE) "gofmt" "-s" "-w" "."
+
+docker-make:
+	@echo "=== $(INTEGRATION) === [ docker-fmt ]: Running make in Docker..."
+	@echo "Using Docker image $(DOCKER_IMAGE)"
+	@docker run -it --rm -v $(PWD):/go/src/github.com/newrelic/$(INTEGRATION_DIR) -w /go/src/github.com/newrelic/$(INTEGRATION_DIR) $(DOCKER_IMAGE) "make"
+
+.PHONY: docker-fmt docker-make

README.md

@@ -1,31 +1,75 @@
 # New Relic Infrastructure Integration for Microsoft SQL Server
 
-Reports status and metrics for nri-mssql service
+The New Relic Infrastructure Integration for MS SQL Server captures critical performance metrics and inventory reported by a SQL Server Instance. Data on the SQL Server Instance and Databases is collected.
+
+Inventory and metric data is collected via SQL queries to the Instance.
 
 ## Requirements
 
-Document if the Integration has some special requirement. Ex: Installing an
-extra module, permissions to execute a binary, etc.
+No additional requirements to monitor.
 
 ## Configuration
 
-Document if the Integration needs some configuration for running. Ex: Set
-up permissions, add a special user, etc.
+A user with the necessary permissions to collect all the metrics and inventory can be configured as follows
+
+```
+USE master;
+CREATE LOGIN newrelic WITH PASSWORD = 'tmppassword';
+CREATE USER newrelic FOR LOGIN newrelic;
+GRANT CONNECT SQL TO newrelic;
+GRANT VIEW SERVER STATE TO newrelic;
+
+-- Goes through each user database and adds public permissions
+DECLARE @name NVARCHAR(max)
+DECLARE db_cursor CURSOR FOR
+SELECT NAME
+FROM master.dbo.sysdatabases
+WHERE NAME NOT IN ('master','msdb','tempdb','model')
+OPEN db_cursor
+FETCH NEXT FROM db_cursor INTO @name WHILE @@FETCH_STATUS = 0
+BEGIN
+	EXECUTE('USE "' + @name + '"; CREATE USER newrelic FOR LOGIN newrelic;' );
+	FETCH next FROM db_cursor INTO @name
+END
+CLOSE db_cursor
+DEALLOCATE db_cursor
+```
 
 ## Installation
 
-Describe the installation process for the Integration.
+- download an archive file for the `MSSQL` Integration
+- extract `mssql-definition.yml` and `/bin` directory into `/var/db/newrelic-infra/newrelic-integrations`
+- add execute permissions for the binary file `nr-mssql` (if required)
+- extract `mssql-config.yml.sample` into `/etc/newrelic-infra/integrations.d`
 
 ## Usage
 
-Document mandatory and optional arguments for running the Integration, and how to execute it.
+This is the description about how to run the MSSQL Integration with New Relic Infrastructure agent, so it is required to have the agent installed (see [agent installation](https://docs.newrelic.com/docs/infrastructure/new-relic-infrastructure/installation/install-infrastructure-linux)).
+
+In order to use the MSSQL Integration it is required to configure `mssql-config.yml.sample` file. Firstly, rename the file to `mssql-config.yml`. Then, depending on your needs, specify all instances that you want to monitor. Once this is done, restart the Infrastructure agent.
+
+You can view your data in Insights by creating your own custom NRQL queries. To do so use the **MssqlDatabaseSample**, **MssqlInstanceSample** event type.
 
 ## Compatibility
 
-* Supported OS:
-* nri-mssql versions:
-* Edition:
+* Supported OS: No Limitations
+* MS SQL Server versions: SQL Server 2008 R2+
 
 ## Integration Development usage
 
-Describe the development workflow for this Integration.
+Assuming that you have source code you can build and run the MSSQL Integration locally.
+
+* Go to directory of the MSSQL Integration and build it
+```bash
+$ make
+```
+* The command above will execute tests for the MSSQL Integration and build an executable file called `nr-mssql` in `bin` directory.
+```bash
+$ ./bin/nr-mssql
+```
+* If you want to know more about usage of `./nr-mssql` check
+```bash
+$ ./bin/nr-mssql -help
+```
+
+For managing external dependencies [govendor tool](https://github.com/kardianos/govendor) is used. It is required to lock all external dependencies to specific version (if possible) into vendor directory.

bin/nr-mssql

@@ -0,0 +1,18 @@
+integration_name: com.newrelic.mssql
+
+instances:
+  - name: mssql-server
+    command: all_data
+    arguments:
+      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. Use do not supply port if this is specified>
+      port: <Microsoft SQL Server port to connect to. Only needed when instance not 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>
+      timeout: <Timeout in seconds for a single SQL Query Execution. Set 0 for no timeout>
+    labels:
+      env: production
+      role: mssql

coverage.xml

@@ -6,29 +6,14 @@
 # refer to the Integrations SDK documentation:
 # https://docs.newrelic.com/docs/integrations/integrations-sdk/file-specifications
 
-name: com.newrelic.nri-mssql
-description: Reports status and metrics for nri-mssql service
+name: com.newrelic.mssql
+description: Reports status and metrics for MSSQL service
 protocol_version: 1
 os: linux
 
 commands:
   all_data:
     command:
-      - ./bin/nr-nri-mssql
-    interval: 15
-  metrics:
-    command:
-      - ./bin/nr-nri-mssql
-      - --metrics
-    interval: 15
-  inventory:
-    command:
-      - ./bin/nr-nri-mssql
-      - --inventory
-    prefix: config/nr-nri-mssql
-    interval: 15
-  events:
-    command:
-    - ./bin/nr-nri-mssql
-    - --events
+      - ./bin/nr-mssql
+    prefix: config/mssql
     interval: 15