update comments

gophr-pm · Sep 30, 2016 · f5d811e · f5d811e
1 parent ca92789
commit f5d811e
Show file tree

Hide file tree

Showing 4 changed files with 6 additions and 3 deletions.
diff --git a/common/newrelic/create_txn.go b/common/newrelic/create_txn.go
@@ -8,7 +8,8 @@ import (
 	newrelic "github.com/newrelic/go-agent"
 )
 
-// CreateNewRelicTxn lol
+// CreateNewRelicTxn starts a transaction that will log activity
+// to new relic.
 func CreateNewRelicTxn(
 	newRelicApp newrelic.Application,
 	conf *config.Config,

diff --git a/common/newrelic/generate_app.go b/common/newrelic/generate_app.go
@@ -8,7 +8,8 @@ import (
 	newrelic "github.com/newrelic/go-agent"
 )
 
-// CreateNewRelicApp lol
+// CreateNewRelicApp return a newrelic object that can create
+// transactions to monitor endpoints.
 func CreateNewRelicApp(conf *config.Config) (newrelic.Application, error) {
 	var app newrelic.Application
 	if !conf.IsDev {

diff --git a/common/newrelic/report_error.go b/common/newrelic/report_error.go
@@ -6,7 +6,7 @@ import (
 	newrelic "github.com/newrelic/go-agent"
 )
 
-// ReportNewRelicError report
+// ReportNewRelicError reports errors to newrelic.
 func ReportNewRelicError(txn newrelic.Transaction, err error, isDev bool) {
 	if !isDev {
 		log.Println("Reporting error to newrelic: ", err)

diff --git a/router/main.go b/router/main.go
@@ -18,6 +18,7 @@ func main() {
 		log.Fatalln("Failed to read credentials secret:", err)
 	}
 
+	// Create new relic app for monitoring.
 	newRelicApp, err := nr.CreateNewRelicApp(conf)
 	if err != nil {
 		log.Fatalln(err)