From ebdd3281a4a33ffef43cfc037e4be1fb3548f1b1 Mon Sep 17 00:00:00 2001 From: eduardo aleixo Date: Wed, 5 Jan 2022 11:20:11 -0300 Subject: [PATCH] Feat/support variables in queries (#2) feat: support queries with variables --- docker-compose.yml | 30 + golang-example/Dockerfile | 13 + golang-example/main.go | 48 + grafana-provisioning/dashboards/main.yml | 8 + .../dashboards/panel-with-tag-variables.json | 100 ++ .../dashboards/panel-with-variable.json | 110 ++ .../dashboards/single-panel.json | 71 ++ .../datasources/datasources.yml | 11 + grafana.ini | 976 ++++++++++++++++++ src/QueryEditor.tsx | 73 +- src/datasource.ts | 29 +- src/types.ts | 7 +- 12 files changed, 1426 insertions(+), 50 deletions(-) create mode 100644 docker-compose.yml create mode 100644 golang-example/Dockerfile create mode 100644 golang-example/main.go create mode 100644 grafana-provisioning/dashboards/main.yml create mode 100644 grafana-provisioning/dashboards/panel-with-tag-variables.json create mode 100644 grafana-provisioning/dashboards/panel-with-variable.json create mode 100644 grafana-provisioning/dashboards/single-panel.json create mode 100644 grafana-provisioning/datasources/datasources.yml create mode 100644 grafana.ini diff --git a/docker-compose.yml b/docker-compose.yml new file mode 100644 index 0000000..f17fb6d --- /dev/null +++ b/docker-compose.yml @@ -0,0 +1,30 @@ +--- +version: '3.9' +services: + grafana: + image: grafana/grafana:8.1.1 + volumes: + - ./dist:/var/lib/grafana/plugins/pyroscope-datasource + - ./grafana.ini:/etc/grafana/grafana.ini + - ./grafana-provisioning:/etc/grafana/provisioning + environment: + - GF_PLUGINS_ALLOW_LOADING_UNSIGNED_PLUGINS=pyroscope-datasource,pyroscope-panel + - GF_INSTALL_PLUGINS=https://github.com/pyroscope-io/grafana-panel-plugin/releases/download/v1.1.0/pyroscope-panel-1.1.0.zip;pyroscope-panel + ports: + - 3000:3000 + + pyroscope: + image: + 'pyroscope/pyroscope:latest' + ports: + - 4040:4040 + command: + - server + environment: + - PYROSCOPE_LOG_LEVEL=info + + # an app with tags + app: + build: golang-example + environment: + - PYROSCOPE_SERVER_ADDRESS=http://pyroscope:4040 diff --git a/golang-example/Dockerfile b/golang-example/Dockerfile new file mode 100644 index 0000000..d46a14c --- /dev/null +++ b/golang-example/Dockerfile @@ -0,0 +1,13 @@ +FROM golang:1.15.6 + +WORKDIR /go/src/app + +COPY main.go ./main.go + +RUN go get -d ./ +RUN go build -o main . + +RUN adduser --disabled-password --gecos --quiet pyroscope +USER pyroscope + +CMD ["./main"] diff --git a/golang-example/main.go b/golang-example/main.go new file mode 100644 index 0000000..26993a8 --- /dev/null +++ b/golang-example/main.go @@ -0,0 +1,48 @@ +package main + +import ( + "context" + "os" + "runtime/pprof" + + "github.com/pyroscope-io/client/pyroscope" +) + +//go:noinline +func work(n int) { + // revive:disable:empty-block this is fine because this is a example app, not real production code + for i := 0; i < n; i++ { + } + // revive:enable:empty-block +} + +func fastFunction(c context.Context) { + pyroscope.TagWrapper(c, pyroscope.Labels("function", "fast"), func(c context.Context) { + work(20000000) + }) +} + +func slowFunction(c context.Context) { + // standard pprof.Do wrappers work as well + pprof.Do(c, pprof.Labels("function", "slow"), func(c context.Context) { + work(80000000) + }) +} + +func main() { + serverAddress := os.Getenv("PYROSCOPE_SERVER_ADDRESS") + if serverAddress == "" { + serverAddress = "http://localhost:4040" + } + pyroscope.Start(pyroscope.Config{ + ApplicationName: "simple.golang.app", + ServerAddress: serverAddress, + Logger: pyroscope.StandardLogger, + }) + pyroscope.TagWrapper(context.Background(), pyroscope.Labels("foo", "bar"), func(c context.Context) { + for { + fastFunction(c) + slowFunction(c) + } + }) +} diff --git a/grafana-provisioning/dashboards/main.yml b/grafana-provisioning/dashboards/main.yml new file mode 100644 index 0000000..736aa1f --- /dev/null +++ b/grafana-provisioning/dashboards/main.yml @@ -0,0 +1,8 @@ +apiVersion: 1 + +providers: + - name: dashboards + type: file + updateIntervalSeconds: 5 + options: + path: /etc/grafana/provisioning/dashboards diff --git a/grafana-provisioning/dashboards/panel-with-tag-variables.json b/grafana-provisioning/dashboards/panel-with-tag-variables.json new file mode 100644 index 0000000..2aa2098 --- /dev/null +++ b/grafana-provisioning/dashboards/panel-with-tag-variables.json @@ -0,0 +1,100 @@ +{ + "annotations": { + "list": [ + { + "builtIn": 1, + "datasource": "-- Grafana --", + "enable": true, + "hide": true, + "iconColor": "rgba(0, 211, 255, 1)", + "name": "Annotations & Alerts", + "target": { + "limit": 100, + "matchAny": false, + "tags": [], + "type": "dashboard" + }, + "type": "dashboard" + } + ] + }, + "editable": true, + "gnetId": null, + "graphTooltip": 0, + "iteration": 1641309987641, + "links": [], + "panels": [ + { + "datasource": "Pyroscope", + "gridPos": { + "h": 17, + "w": 24, + "x": 0, + "y": 0 + }, + "id": 2, + "options": { + "showToolbar": false + }, + "targets": [ + { + "format": "json", + "from": "now-1h", + "name": "simple.golang.app.cpu{function=\"$function\"}", + "queryType": "randomWalk", + "refId": "A", + "until": "now" + } + ], + "title": "simple.golang.app.cpu", + "type": "pyroscope-panel" + } + ], + "schemaVersion": 30, + "style": "dark", + "tags": [], + "templating": { + "list": [ + { + "allValue": null, + "current": { + "selected": true, + "text": "fast", + "value": "fast" + }, + "description": null, + "error": null, + "hide": 0, + "includeAll": false, + "label": null, + "multi": false, + "name": "function", + "options": [ + { + "selected": false, + "text": "slow", + "value": "slow" + }, + { + "selected": true, + "text": "fast", + "value": "fast" + } + ], + "query": "slow,fast", + "queryValue": "", + "skipUrlSync": false, + "type": "custom" + } + ] + }, + "time": { + "from": "now-30m", + "to": "now" + }, + "timepicker": {}, + "timezone": "", + "title": "Panel with variable for tags", + "uid": "panel-with-tag-variable", + "version": 2 +} diff --git a/grafana-provisioning/dashboards/panel-with-variable.json b/grafana-provisioning/dashboards/panel-with-variable.json new file mode 100644 index 0000000..65ac0c8 --- /dev/null +++ b/grafana-provisioning/dashboards/panel-with-variable.json @@ -0,0 +1,110 @@ +{ + "annotations": { + "list": [ + { + "builtIn": 1, + "datasource": "-- Grafana --", + "enable": true, + "hide": true, + "iconColor": "rgba(0, 211, 255, 1)", + "name": "Annotations & Alerts", + "target": { + "limit": 100, + "matchAny": false, + "tags": [], + "type": "dashboard" + }, + "type": "dashboard" + } + ] + }, + "editable": true, + "gnetId": null, + "graphTooltip": 0, + "iteration": 1641304888885, + "links": [], + "panels": [ + { + "datasource": "Pyroscope", + "gridPos": { + "h": 9, + "w": 12, + "x": 0, + "y": 0 + }, + "id": 2, + "options": { + "showToolbar": false + }, + "targets": [ + { + "format": "json", + "from": "now-1h", + "name": "$query", + "queryType": "randomWalk", + "refId": "A", + "until": "now" + } + ], + "title": "$query", + "type": "pyroscope-panel" + } + ], + "schemaVersion": 30, + "style": "dark", + "tags": [], + "templating": { + "list": [ + { + "allValue": null, + "current": { + "selected": true, + "text": "pyroscope.server.inuse_objects", + "value": "pyroscope.server.inuse_objects" + }, + "description": null, + "error": null, + "hide": 0, + "includeAll": false, + "label": null, + "multi": false, + "name": "query", + "options": [ + { + "selected": false, + "text": "pyroscope.server.cpu", + "value": "pyroscope.server.cpu" + }, + { + "selected": false, + "text": "pyroscope.server.alloc_objects", + "value": "pyroscope.server.alloc_objects" + }, + { + "selected": false, + "text": "pyroscope.server.alloc_space", + "value": "pyroscope.server.alloc_space" + }, + { + "selected": true, + "text": "pyroscope.server.inuse_objects", + "value": "pyroscope.server.inuse_objects" + } + ], + "query": "pyroscope.server.cpu,pyroscope.server.alloc_objects,pyroscope.server.alloc_space,pyroscope.server.inuse_objects", + "queryValue": "", + "skipUrlSync": false, + "type": "custom" + } + ] + }, + "time": { + "from": "now-5m", + "to": "now" + }, + "timepicker": {}, + "timezone": "", + "title": "Panel with variable", + "uid": "panel-with-variable", + "version": 1 +} diff --git a/grafana-provisioning/dashboards/single-panel.json b/grafana-provisioning/dashboards/single-panel.json new file mode 100644 index 0000000..c784bef --- /dev/null +++ b/grafana-provisioning/dashboards/single-panel.json @@ -0,0 +1,71 @@ +{ + "annotations": { + "list": [ + { + "builtIn": 1, + "datasource": "-- Grafana --", + "enable": true, + "hide": true, + "iconColor": "rgba(0, 211, 255, 1)", + "name": "Annotations & Alerts", + "target": { + "limit": 100, + "matchAny": false, + "tags": [], + "type": "dashboard" + }, + "type": "dashboard" + } + ] + }, + "editable": true, + "gnetId": null, + "graphTooltip": 0, + "links": [], + "panels": [ + { + "datasource": "Pyroscope", + "gridPos": { + "h": 17, + "w": 24, + "x": 0, + "y": 0 + }, + "id": 2, + "options": { + "showToolbar": false + }, + "pluginVersion": "7.3.6", + "targets": [ + { + "format": "json", + "from": "now-1h", + "name": "pyroscope.server.cpu", + "queryType": "randomWalk", + "refId": "A", + "until": "now" + } + ], + "timeFrom": null, + "timeShift": null, + "title": "Pyroscope Server CPU", + "type": "pyroscope-panel" + } + ], + "refresh": "", + "schemaVersion": 30, + "style": "dark", + "tags": [], + "templating": { + "list": [] + }, + "time": { + "from": "now-5m", + "to": "now" + }, + "timepicker": {}, + "timezone": "", + "title": "Single Panel Dashboard", + "uid": "single-panel", + "version": 3 +} diff --git a/grafana-provisioning/datasources/datasources.yml b/grafana-provisioning/datasources/datasources.yml new file mode 100644 index 0000000..984bbd0 --- /dev/null +++ b/grafana-provisioning/datasources/datasources.yml @@ -0,0 +1,11 @@ +--- +apiVersion: 1 + +datasources: + - name: Pyroscope + type: pyroscope-datasource + access: proxy + orgId: 1 + uid: pyroscope + jsonData: + path: http://pyroscope:4040 diff --git a/grafana.ini b/grafana.ini new file mode 100644 index 0000000..9939cbb --- /dev/null +++ b/grafana.ini @@ -0,0 +1,976 @@ +##################### Grafana Configuration Example ##################### +# +# Everything has defaults so you only need to uncomment things you want to +# change + +# possible values : production, development +;app_mode = production + +# instance name, defaults to HOSTNAME environment variable value or hostname if HOSTNAME var is empty +;instance_name = ${HOSTNAME} + +#################################### Paths #################################### +[paths] +# Path to where grafana can store temp files, sessions, and the sqlite3 db (if that is used) +;data = /var/lib/grafana + +# Temporary files in `data` directory older than given duration will be removed +;temp_data_lifetime = 24h + +# Directory where grafana can store logs +;logs = /var/log/grafana + +# Directory where grafana will automatically scan and look for plugins +;plugins = /var/lib/grafana/plugins + +# folder that contains provisioning config files that grafana will apply on startup and while running. +provisioning = /etc/grafana/provisioning + +#################################### Server #################################### +[server] +# Protocol (http, https, h2, socket) +;protocol = http + +# The ip address to bind to, empty will bind to all interfaces +;http_addr = + +# The http port to use +;http_port = 3000 + +# The public facing domain name used to access grafana from a browser +;domain = localhost + +# Redirect to correct domain if host header does not match domain +# Prevents DNS rebinding attacks +;enforce_domain = false + +# The full public facing url you use in browser, used for redirects and emails +# If you use reverse proxy and sub path specify full url (with sub path) +;root_url = %(protocol)s://%(domain)s:%(http_port)s/ + +# Serve Grafana from subpath specified in `root_url` setting. By default it is set to `false` for compatibility reasons. +;serve_from_sub_path = false + +# Log web requests +;router_logging = false + +# the path relative working path +;static_root_path = public + +# enable gzip +;enable_gzip = false + +# https certs & key file +;cert_file = +;cert_key = + +# Unix socket path +;socket = + +# CDN Url +;cdn_url = + +# Sets the maximum time using a duration format (5s/5m/5ms) before timing out read of an incoming request and closing idle connections. +# `0` means there is no timeout for reading the request. +;read_timeout = 0 + +#################################### Database #################################### +[database] +# You can configure the database connection by specifying type, host, name, user and password +# as separate properties or as on string using the url properties. + +# Either "mysql", "postgres" or "sqlite3", it's your choice +;type = sqlite3 +;host = 127.0.0.1:3306 +;name = grafana +;user = root +# If the password contains # or ; you have to wrap it with triple quotes. Ex """#password;""" +;password = + +# Use either URL or the previous fields to configure the database +# Example: mysql://user:secret@host:port/database +;url = + +# For "postgres" only, either "disable", "require" or "verify-full" +;ssl_mode = disable + +# Database drivers may support different transaction isolation levels. +# Currently, only "mysql" driver supports isolation levels. +# If the value is empty - driver's default isolation level is applied. +# For "mysql" use "READ-UNCOMMITTED", "READ-COMMITTED", "REPEATABLE-READ" or "SERIALIZABLE". +;isolation_level = + +;ca_cert_path = +;client_key_path = +;client_cert_path = +;server_cert_name = + +# For "sqlite3" only, path relative to data_path setting +;path = grafana.db + +# Max idle conn setting default is 2 +;max_idle_conn = 2 + +# Max conn setting default is 0 (mean not set) +;max_open_conn = + +# Connection Max Lifetime default is 14400 (means 14400 seconds or 4 hours) +;conn_max_lifetime = 14400 + +# Set to true to log the sql calls and execution times. +;log_queries = + +# For "sqlite3" only. cache mode setting used for connecting to the database. (private, shared) +;cache_mode = private + +################################### Data sources ######################### +[datasources] +# Upper limit of data sources that Grafana will return. This limit is a temporary configuration and it will be deprecated when pagination will be introduced on the list data sources API. +;datasource_limit = 5000 + +#################################### Cache server ############################# +[remote_cache] +# Either "redis", "memcached" or "database" default is "database" +;type = database + +# cache connectionstring options +# database: will use Grafana primary database. +# redis: config like redis server e.g. `addr=127.0.0.1:6379,pool_size=100,db=0,ssl=false`. Only addr is required. ssl may be 'true', 'false', or 'insecure'. +# memcache: 127.0.0.1:11211 +;connstr = + +#################################### Data proxy ########################### +[dataproxy] + +# This enables data proxy logging, default is false +;logging = false + +# How long the data proxy waits to read the headers of the response before timing out, default is 30 seconds. +# This setting also applies to core backend HTTP data sources where query requests use an HTTP client with timeout set. +;timeout = 30 + +# How long the data proxy waits to establish a TCP connection before timing out, default is 10 seconds. +;dialTimeout = 10 + +# How many seconds the data proxy waits before sending a keepalive probe request. +;keep_alive_seconds = 30 + +# How many seconds the data proxy waits for a successful TLS Handshake before timing out. +;tls_handshake_timeout_seconds = 10 + +# How many seconds the data proxy will wait for a server's first response headers after +# fully writing the request headers if the request has an "Expect: 100-continue" +# header. A value of 0 will result in the body being sent immediately, without +# waiting for the server to approve. +;expect_continue_timeout_seconds = 1 + +# The maximum number of idle connections that Grafana will keep alive. +;max_idle_connections = 100 + +# The maximum number of idle connections per host that Grafana will keep alive. +;max_idle_connections_per_host = 2 + +# How many seconds the data proxy keeps an idle connection open before timing out. +;idle_conn_timeout_seconds = 90 + +# If enabled and user is not anonymous, data proxy will add X-Grafana-User header with username into the request, default is false. +;send_user_header = false + +#################################### Analytics #################################### +[analytics] +# Server reporting, sends usage counters to stats.grafana.org every 24 hours. +# No ip addresses are being tracked, only simple counters to track +# running instances, dashboard and error counts. It is very helpful to us. +# Change this option to false to disable reporting. +;reporting_enabled = true + +# The name of the distributor of the Grafana instance. Ex hosted-grafana, grafana-labs +;reporting_distributor = grafana-labs + +# Set to false to disable all checks to https://grafana.net +# for new versions (grafana itself and plugins), check is used +# in some UI views to notify that grafana or plugin update exists +# This option does not cause any auto updates, nor send any information +# only a GET request to http://grafana.com to get latest versions +;check_for_updates = true + +# Google Analytics universal tracking code, only enabled if you specify an id here +;google_analytics_ua_id = + +# Google Tag Manager ID, only enabled if you specify an id here +;google_tag_manager_id = + +#################################### Security #################################### +[security] +# disable creation of admin user on first start of grafana +;disable_initial_admin_creation = false + +# default admin user, created on startup +;admin_user = admin + +# default admin password, can be changed before first start of grafana, or in profile settings +;admin_password = admin + +# used for signing +;secret_key = SW2YcwTIb9zpOOhoPsMm + +# disable gravatar profile images +;disable_gravatar = false + +# data source proxy whitelist (ip_or_domain:port separated by spaces) +;data_source_proxy_whitelist = + +# disable protection against brute force login attempts +;disable_brute_force_login_protection = false + +# set to true if you host Grafana behind HTTPS. default is false. +;cookie_secure = false + +# set cookie SameSite attribute. defaults to `lax`. can be set to "lax", "strict", "none" and "disabled" +;cookie_samesite = lax + +# set to true if you want to allow browsers to render Grafana in a ,