feat #19: integrate sentry for event reporting

docs/CHANGELOG.md

@@ -12,8 +12,10 @@
 - docs: init documentation website with [`mkdocs`][mkdocs]
 - docs: add project badges, including go report card, codecov, github actions, FOSSA, etc.
 - test: add CI test with [github actions][github-actions]
+- test: integrate [sentry sdk][sentry sdk] for event reporting and analysis
 
 [jmespath]: https://jmespath.org/
 [mkdocs]: https://www.mkdocs.org/
 [github-actions]: https://github.com/httprunner/hrp/actions
 [boomer]: github.com/myzhan/boomer
+[sentry sdk]: https://github.com/getsentry/sentry-go

go.mod

@@ -3,6 +3,7 @@ module github.com/httprunner/hrp
 go 1.16
 
 require (
+	github.com/getsentry/sentry-go v0.11.0
 	github.com/go-ole/go-ole v1.2.6 // indirect
 	github.com/jinzhu/copier v0.3.2
 	github.com/jmespath/go-jmespath v0.4.0

hrp/cmd/boom.go

@@ -3,6 +3,7 @@ package cmd
 import (
 	"time"
 
+	"github.com/getsentry/sentry-go"
 	"github.com/spf13/cobra"
 
 	"github.com/httprunner/hrp"
@@ -18,6 +19,7 @@ var boomCmd = &cobra.Command{
   $ hrp boom examples/	# run testcases in specified folder`,
 	Args: cobra.MinimumNArgs(1),
 	Run: func(cmd *cobra.Command, args []string) {
+		sentry.CaptureMessage("start to run load test")
 		var paths []hrp.ITestCase
 		for _, arg := range args {
 			paths = append(paths, &hrp.TestCasePath{Path: arg})

hrp/cmd/har2case.go

@@ -1,6 +1,7 @@
 package cmd
 
 import (
+	"github.com/getsentry/sentry-go"
 	"github.com/rs/zerolog/log"
 	"github.com/spf13/cobra"
 
@@ -14,6 +15,7 @@ var har2caseCmd = &cobra.Command{
 	Long:  `Convert HAR to json/yaml testcase files`,
 	Args:  cobra.MinimumNArgs(1),
 	RunE: func(cmd *cobra.Command, args []string) error {
+		sentry.CaptureMessage("start to convert HAR to testcases")
 		var outputFiles []string
 		for _, arg := range args {
 			var outputPath string

hrp/cmd/run.go

@@ -1,6 +1,7 @@
 package cmd
 
 import (
+	"github.com/getsentry/sentry-go"
 	"github.com/spf13/cobra"
 
 	"github.com/httprunner/hrp"
@@ -16,6 +17,7 @@ var runCmd = &cobra.Command{
   $ hrp run examples/	# run testcases in specified folder`,
 	Args: cobra.MinimumNArgs(1),
 	RunE: func(cmd *cobra.Command, args []string) error {
+		sentry.CaptureMessage("start to run API tests")
 		var paths []hrp.ITestCase
 		for _, arg := range args {
 			paths = append(paths, &hrp.TestCasePath{Path: arg})

hrp/main.go

@@ -1,7 +1,15 @@
 package main
 
-import "github.com/httprunner/hrp/hrp/cmd"
+import (
+	"time"
+
+	"github.com/getsentry/sentry-go"
+	"github.com/httprunner/hrp/hrp/cmd"
+)
 
 func main() {
+	// Flush buffered events before the program terminates.
+	defer sentry.Flush(2 * time.Second)
+
 	cmd.Execute()
 }

log.go

@@ -4,10 +4,25 @@ import (
 	"os"
 	"strings"
 
+	"github.com/getsentry/sentry-go"
 	"github.com/rs/zerolog"
 	zlog "github.com/rs/zerolog/log"
 )
 
+func init() {
+	// init sentry sdk
+	err := sentry.Init(sentry.ClientOptions{
+		Dsn:     "https://[email protected]/6070292",
+		Release: VERSION,
+	})
+	if err != nil {
+		log.Fatal().Err(err).Msg("init sentry sdk failed!")
+	}
+	sentry.ConfigureScope(func(scope *sentry.Scope) {
+		scope.SetLevel(sentry.LevelError)
+	})
+}
+
 var log = zlog.Logger
 
 func SetLogLevel(level string) {