Fixes #48

Author: haxorof

.github/workflows/ci.yml

@@ -24,9 +24,21 @@ jobs:
         uses: docker/build-push-action@v2.7.0
         with:
           load: true
-          tags: test
+          tags: dbhi/prometheus-sql:test
           context: .
 
+      - name: Start containers
+        run: docker-compose -f "docker-compose.yml" -f "docker-compose.test.yml" up -d
+        working-directory: ./examples/working_example
+
+      - name: Wait and Test Metrics Endpoint
+        run: sleep 30 && curl http://localhost:8080/metrics
+
+      - name: Stop containers
+        if: always()
+        run: docker-compose -f "docker-compose.yml" -f "docker-compose.test.yml" down
+        working-directory: ./examples/working_example
+
   build_pkgs:
     name: Build Packages
     needs: build_docker

config.go

@@ -49,6 +49,7 @@ type DataSource struct {
 // Query defines a SQL statement and parameters as well as configuration for the monitoring behavior
 type Query struct {
 	Name          string
+	Help          string
 	DataSourceRef string `yaml:"data-source"`
 	Driver        string
 	Connection    map[string]interface{}

examples/example-queries.yml

@@ -7,6 +7,8 @@
 
 # Name of the metric. Will be exposed as query_result_num_products
 - num_products:
+    # Help text seen for metrics exposed
+    help: Products belonging to category ID 5
     # Name of the driver to use.
     driver: postgresql
 
@@ -45,6 +47,8 @@
 
 # For faceted metrics provide the name of the metric-column in config, and return a resultset of multiple columns and rows
 - sales_by_country:
+    # Help text seen for metrics exposed
+    help: Number of sales by country
     # Name of the driver to use.
     driver: postgresql
 

examples/working_example/docker-compose.test.yml

@@ -0,0 +1,15 @@
+version: "2.4"
+services:
+    prometheus-sql:
+        image: dbhi/prometheus-sql:test
+        links:
+            - sqlagent:sqlagent
+        depends_on:
+            - sqlagent
+        ports:
+            - 8080:8080
+        command:
+            - -config
+            - /config.yml
+            - -service
+            - http://sqlagent:5000

examples/working_example/queries.yml

@@ -1,18 +1,21 @@
 # Use default data source
 - nr_companies_per_country:
+    help: Number of companies per country
     sql: >
         select country, count(1) as cnt from Companies group by country
     data-field: cnt
 
 # Missing database user, data source 'my-ds-missing-user' shall be used instead of the default 'my-ds'
 - error_missing_user:
+    help: Data source error
     data-source: my-ds-missing-user
     sql: >
         select * from dual
     interval: 30s
 
 # Missing table
 - error_missing_table:
+    help: Missing table
     sql: >
         select * from missing_table
     interval: 30s
@@ -22,6 +25,7 @@
 # - response_time_count with cnt as value
 # - response_time_sum with rt as value
 - response_time:
+    help: Sub metrics
     sql: >
         select count(*) as cnt, sum(response_time) as rt from Requests
     sub-metrics:

set.go

@@ -50,7 +50,7 @@ func (r *QueryResult) generateMetricUniqueKey(facets map[string]interface{}, suf
 	return fmt.Sprintf("%s%s", r.generateMetricName(suffix), string(jsonData))
 }
 
-func (r *QueryResult) createMetric(facets map[string]interface{}, suffix string) (string, metricStatus) {
+func (r *QueryResult) createMetric(facets map[string]interface{}, suffix string, help string) (string, metricStatus) {
 	metricName := r.generateMetricName(suffix)
 	resultKey := r.generateMetricUniqueKey(facets, suffix)
 
@@ -64,10 +64,14 @@ func (r *QueryResult) createMetric(facets map[string]interface{}, suffix string)
 		return resultKey, registered
 	}
 
+	if len(help) == 0 {
+		help = "Result of an SQL query"
+	}
+
 	fmt.Println("Creating", resultKey)
 	r.Result[resultKey] = prometheus.NewGauge(prometheus.GaugeOpts{
 		Name:        fmt.Sprintf("query_result_%s", metricName),
-		Help:        "Result of an SQL query",
+		Help:        help,
 		ConstLabels: labels,
 	})
 	return resultKey, unregistered
@@ -164,7 +168,7 @@ func (r *QueryResult) SetMetrics(recs records, valueOnError string) error {
 				return errors.New("Data field not found in result set")
 			}
 
-			key, status := r.createMetric(facet, suffix)
+			key, status := r.createMetric(facet, suffix, r.Query.Help)
 			err := setValueForResult(r.Result[key], dataVal)
 			if err != nil {
 				return err