Expose prometheus metrics over http (#815). (#919)

Expose prometheus metrics over http (#815).
src-d · Jul 4, 2019 · 8954e18 · 8954e18
2 parents b66dc53 + 4061625
commit 8954e18
Show file tree

Hide file tree

Showing 5 changed files with 211 additions and 26 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -141,8 +141,9 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - Added `json_unquote` function.
 - Added `commit_file_stats` function.
 - Added documentation about `commit_stats`.
-- Add metrics (engine, analyzer, regex, pilosa) based on go-kit interface. ([#744](https://github.com/src-d/go-mysql-server/pull/744))
 - `commit_files` is now squashable with `blobs`.
+- Add metrics (engine, analyzer, uast, pilosa) based on go-kit interface. ([#744](https://github.com/src-d/go-mysql-server/pull/744)).
+- Expose (if enabled) prometheus metrics over http (#815).
 
 ### Changed
 

diff --git a/cmd/gitbase/command/server.go b/cmd/gitbase/command/server.go
@@ -1,8 +1,10 @@
 package command
 
 import (
+	"context"
 	"fmt"
 	"net"
+	"net/http"
 	"net/url"
 	"os"
 	"path/filepath"
@@ -12,6 +14,10 @@ import (
 	"strings"
 	"time"
 
+	"github.com/go-kit/kit/metrics/prometheus"
+	promopts "github.com/prometheus/client_golang/prometheus"
+	"github.com/prometheus/client_golang/prometheus/promhttp"
+
 	"github.com/src-d/gitbase"
 	"github.com/src-d/gitbase/internal/function"
 	"github.com/src-d/gitbase/internal/rule"
@@ -54,29 +60,31 @@ type Server struct {
 	plainLibrary *plain.Library
 	sharedCache  cache.Object
 
-	Name          string         `long:"db" default:"gitbase" description:"Database name"`
-	Version       string         // Version of the application.
-	Directories   []string       `short:"d" long:"directories" description:"Path where standard git repositories are located, multiple directories can be defined."`
-	Format        string         `long:"format" default:"git" choice:"git" choice:"siva" description:"Library format"`
-	Bucket        int            `long:"bucket" default:"2" description:"Bucketing level to use with siva libraries"`
-	Bare          bool           `long:"bare" description:"Sets the library to use bare git repositories, used only with git format libraries"`
-	NonBare       bool           `long:"non-bare" description:"Sets the library to use non bare git repositories, used only with git format libraries"`
-	NonRooted     bool           `long:"non-rooted" description:"Disables treating siva files as rooted repositories"`
-	Host          string         `long:"host" default:"localhost" description:"Host where the server is going to listen"`
-	Port          int            `short:"p" long:"port" default:"3306" description:"Port where the server is going to listen"`
-	User          string         `short:"u" long:"user" default:"root" description:"User name used for connection"`
-	Password      string         `short:"P" long:"password" default:"" description:"Password used for connection"`
-	UserFile      string         `short:"U" long:"user-file" env:"GITBASE_USER_FILE" default:"" description:"JSON file with credentials list"`
-	ConnTimeout   int            `short:"t" long:"timeout" env:"GITBASE_CONNECTION_TIMEOUT" description:"Timeout in seconds used for connections"`
-	IndexDir      string         `short:"i" long:"index" default:"/var/lib/gitbase/index" description:"Directory where the gitbase indexes information will be persisted." env:"GITBASE_INDEX_DIR"`
-	CacheSize     cache.FileSize `long:"cache" default:"512" description:"Object cache size in megabytes" env:"GITBASE_CACHESIZE_MB"`
-	Parallelism   uint           `long:"parallelism" description:"Maximum number of parallel threads per table. By default, it's the number of CPU cores. 0 means default, 1 means disabled."`
-	DisableSquash bool           `long:"no-squash" description:"Disables the table squashing."`
-	TraceEnabled  bool           `long:"trace" env:"GITBASE_TRACE" description:"Enables jaeger tracing"`
-	ReadOnly      bool           `short:"r" long:"readonly" description:"Only allow read queries. This disables creating and deleting indexes as well. Cannot be used with --user-file." env:"GITBASE_READONLY"`
-	SkipGitErrors bool           // SkipGitErrors disables failing when Git errors are found.
-	Verbose       bool           `short:"v" description:"Activates the verbose mode"`
-	LogLevel      string         `long:"log-level" env:"GITBASE_LOG_LEVEL" choice:"info" choice:"debug" choice:"warning" choice:"error" choice:"fatal" default:"info" description:"logging level"`
+	Name           string         `long:"db" default:"gitbase" description:"Database name"`
+	Version        string         // Version of the application.
+	Directories    []string       `short:"d" long:"directories" description:"Path where standard git repositories are located, multiple directories can be defined."`
+	Format         string         `long:"format" default:"git" choice:"git" choice:"siva" description:"Library format"`
+	Bucket         int            `long:"bucket" default:"2" description:"Bucketing level to use with siva libraries"`
+	Bare           bool           `long:"bare" description:"Sets the library to use bare git repositories, used only with git format libraries"`
+	NonBare        bool           `long:"non-bare" description:"Sets the library to use non bare git repositories, used only with git format libraries"`
+	NonRooted      bool           `long:"non-rooted" description:"Disables treating siva files as rooted repositories"`
+	Host           string         `long:"host" default:"localhost" description:"Host where the server is going to listen"`
+	Port           int            `short:"p" long:"port" default:"3306" description:"Port where the server is going to listen"`
+	User           string         `short:"u" long:"user" default:"root" description:"User name used for connection"`
+	Password       string         `short:"P" long:"password" default:"" description:"Password used for connection"`
+	UserFile       string         `short:"U" long:"user-file" env:"GITBASE_USER_FILE" default:"" description:"JSON file with credentials list"`
+	ConnTimeout    int            `short:"t" long:"timeout" env:"GITBASE_CONNECTION_TIMEOUT" description:"Timeout in seconds used for connections"`
+	IndexDir       string         `short:"i" long:"index" default:"/var/lib/gitbase/index" description:"Directory where the gitbase indexes information will be persisted." env:"GITBASE_INDEX_DIR"`
+	CacheSize      cache.FileSize `long:"cache" default:"512" description:"Object cache size in megabytes" env:"GITBASE_CACHESIZE_MB"`
+	Parallelism    uint           `long:"parallelism" description:"Maximum number of parallel threads per table. By default, it's the number of CPU cores. 0 means default, 1 means disabled."`
+	DisableSquash  bool           `long:"no-squash" description:"Disables the table squashing."`
+	TraceEnabled   bool           `long:"trace" env:"GITBASE_TRACE" description:"Enables jaeger tracing"`
+	MetricsEnabled bool           `long:"metrics" env:"GITBASE_METRICS" description:"Enables prometheus metrics"`
+	MetricsPort    int            `long:"metrics-port" env:"GITBASE_METRICS_PORT" default:"2112" description:"Port where the server is going to expose prometheus metrics"`
+	ReadOnly       bool           `short:"r" long:"readonly" description:"Only allow read queries. This disables creating and deleting indexes as well. Cannot be used with --user-file." env:"GITBASE_READONLY"`
+	SkipGitErrors  bool           // SkipGitErrors disables failing when Git errors are found.
+	Verbose        bool           `short:"v" description:"Activates the verbose mode"`
+	LogLevel       string         `long:"log-level" env:"GITBASE_LOG_LEVEL" choice:"info" choice:"debug" choice:"warning" choice:"error" choice:"fatal" default:"info" description:"logging level"`
 }
 
 type jaegerLogrus struct {
@@ -212,6 +220,19 @@ func (c *Server) Execute(args []string) error {
 		return err
 	}
 
+	if c.MetricsEnabled {
+		metricsSrv := enableMetrics(c.Host, c.MetricsPort)
+		defer func() {
+			if err := metricsSrv.Shutdown(context.Background()); err != nil {
+				logrus.Errorln(err)
+			}
+		}()
+		go func() {
+			logrus.Infof("metrics server started and listening on %s", metricsSrv.Addr)
+			logrus.Errorln(metricsSrv.ListenAndServe())
+		}()
+	}
+
 	logrus.Infof("server started and listening on %s:%d", c.Host, c.Port)
 	return s.Start()
 }
@@ -506,3 +527,105 @@ func discoverBare(d directory) (bool, error) {
 
 	return bare, nil
 }
+
+func enableMetrics(host string, port int) *http.Server {
+	// Engine metrics
+	sqle.QueryCounter = prometheus.NewCounterFrom(promopts.CounterOpts{
+		Namespace: "go_mysql_server",
+		Subsystem: "engine",
+		Name:      "query_counter",
+	}, []string{
+		"query",
+	})
+	sqle.QueryErrorCounter = prometheus.NewCounterFrom(promopts.CounterOpts{
+		Namespace: "go_mysql_server",
+		Subsystem: "engine",
+		Name:      "query_error_counter",
+	}, []string{
+		"query",
+		"error",
+	})
+	sqle.QueryHistogram = prometheus.NewHistogramFrom(promopts.HistogramOpts{
+		Namespace: "go_mysql_server",
+		Subsystem: "engine",
+		Name:      "query_histogram",
+	}, []string{
+		"query",
+		"duration",
+	})
+
+	// Analyzer metrics
+	analyzer.ParallelQueryCounter = prometheus.NewCounterFrom(promopts.CounterOpts{
+		Namespace: "go_mysql_server",
+		Subsystem: "analyzer",
+		Name:      "parallel_query_counter",
+	}, []string{
+		"parallelism",
+	})
+
+	// Pilosa index driver metrics
+	pilosa.RowsGauge = prometheus.NewGaugeFrom(promopts.GaugeOpts{
+		Namespace: "go_mysql_server",
+		Subsystem: "index",
+		Name:      "indexed_rows_gauge",
+	}, []string{
+		"driver",
+	})
+	pilosa.TotalHistogram = prometheus.NewHistogramFrom(promopts.HistogramOpts{
+		Namespace: "go_mysql_server",
+		Subsystem: "index",
+		Name:      "index_created_total_histogram",
+	}, []string{
+		"driver",
+		"duration",
+	})
+	pilosa.MappingHistogram = prometheus.NewHistogramFrom(promopts.HistogramOpts{
+		Namespace: "go_mysql_server",
+		Subsystem: "index",
+		Name:      "index_created_mapping_histogram",
+	}, []string{
+		"driver",
+		"duration",
+	})
+	pilosa.BitmapHistogram = prometheus.NewHistogramFrom(promopts.HistogramOpts{
+		Namespace: "go_mysql_server",
+		Subsystem: "index",
+		Name:      "index_created_bitmap_histogram",
+	}, []string{
+		"driver",
+		"duration",
+	})
+
+	//Uast metrics
+	function.UastHitCacheCounter = prometheus.NewCounterFrom(promopts.CounterOpts{
+		Namespace: "gitbase",
+		Subsystem: "uast",
+		Name:      "hit_cache_counter",
+	}, []string{
+		"lang",
+		"xpath",
+	})
+	function.UastMissCacheCounter = prometheus.NewCounterFrom(promopts.CounterOpts{
+		Namespace: "gitbase",
+		Subsystem: "uast",
+		Name:      "miss_cache_counter",
+	}, []string{
+		"lang",
+		"xpath",
+	})
+	function.UastQueryHistogram = prometheus.NewHistogramFrom(promopts.HistogramOpts{
+		Namespace: "gitbase",
+		Subsystem: "uast",
+		Name:      "query_histogram",
+	}, []string{
+		"lang",
+		"xpath",
+		"duration",
+	})
+
+	// metrics http server
+	return &http.Server{
+		Addr:    net.JoinHostPort(host, strconv.Itoa(port)),
+		Handler: promhttp.Handler(),
+	}
+}
diff --git a/go.mod b/go.mod
@@ -6,12 +6,14 @@ require (
 	github.com/bblfsh/go-client/v4 v4.1.0
 	github.com/bblfsh/sdk/v3 v3.1.0
 	github.com/gliderlabs/ssh v0.2.0 // indirect
+	github.com/go-kit/kit v0.8.0
 	github.com/go-sql-driver/mysql v1.4.1
 	github.com/hashicorp/golang-lru v0.5.1
 	github.com/hhatto/gocloc v0.3.0
 	github.com/jessevdk/go-flags v1.4.0
 	github.com/miekg/dns v1.1.1 // indirect
 	github.com/opentracing/opentracing-go v1.1.0
+	github.com/prometheus/client_golang v1.0.0
 	github.com/sirupsen/logrus v1.3.0
 	github.com/src-d/enry/v2 v2.0.0
 	github.com/src-d/go-borges v0.0.0-20190628121335-da12a84d60fd