From 8b8bfebdd6b4f43a8df540979874a6c01c999957 Mon Sep 17 00:00:00 2001
From: Haddas Bronfman <85441461+haddasbronfman@users.noreply.github.com>
Date: Wed, 4 Jan 2023 15:03:10 +0200
Subject: [PATCH] feat(mysql): Metrics for mysql (#1220)
---
.../examples/README.md | 12 +-
.../collector/otel-collector-config.yaml | 44 +
.../examples/docker/docker-compose.yaml | 68 +
.../examples/docker/grafana/grafana.ini | 1170 +++++++++++++
.../dashboards/opentelemetry-collector.json | 1554 +++++++++++++++++
.../provisioning/datasources/default.yaml | 7 +
.../examples/docker/mysql/init.sql | 2 +
.../docker/prometheus/prometheus.yaml | 6 +
.../examples/package.json | 1 +
.../examples/src/client.ts | 32 +
.../examples/src/server.ts | 92 +
.../examples/src/tracer.ts | 28 +-
.../package.json | 5 +-
.../src/instrumentation.ts | 114 +-
.../src/utils.ts | 14 +
.../test/index.metrics.test.ts | 360 ++++
.../test/index.test.ts | 2 +-
.../test/utils.test.ts | 53 +
18 files changed, 3553 insertions(+), 11 deletions(-)
create mode 100644 plugins/node/opentelemetry-instrumentation-mysql/examples/docker/collector/otel-collector-config.yaml
create mode 100644 plugins/node/opentelemetry-instrumentation-mysql/examples/docker/docker-compose.yaml
create mode 100644 plugins/node/opentelemetry-instrumentation-mysql/examples/docker/grafana/grafana.ini
create mode 100644 plugins/node/opentelemetry-instrumentation-mysql/examples/docker/grafana/provisioning/dashboards/opentelemetry-collector.json
create mode 100644 plugins/node/opentelemetry-instrumentation-mysql/examples/docker/grafana/provisioning/datasources/default.yaml
create mode 100644 plugins/node/opentelemetry-instrumentation-mysql/examples/docker/mysql/init.sql
create mode 100644 plugins/node/opentelemetry-instrumentation-mysql/examples/docker/prometheus/prometheus.yaml
create mode 100644 plugins/node/opentelemetry-instrumentation-mysql/test/index.metrics.test.ts
create mode 100644 plugins/node/opentelemetry-instrumentation-mysql/test/utils.test.ts
diff --git a/plugins/node/opentelemetry-instrumentation-mysql/examples/README.md b/plugins/node/opentelemetry-instrumentation-mysql/examples/README.md
index 7b3180e372..f9bad1d088 100644
--- a/plugins/node/opentelemetry-instrumentation-mysql/examples/README.md
+++ b/plugins/node/opentelemetry-instrumentation-mysql/examples/README.md
@@ -1,6 +1,6 @@
# Overview
-OpenTelemetry MySQL Instrumentation allows the user to automatically collect trace data and export them to the backend of choice (we can use Zipkin or Jaeger for this example), to give observability to distributed systems.
+OpenTelemetry MySQL Instrumentation allows the user to automatically collect trace data and metrics and export them to the backend of choice (we can use Zipkin, Jaeger or Grafana for this example), to give observability to distributed systems.
This is a modification of the HTTP example that executes multiple parallel requests that interact with a MySQL server backend using the `mysql` npm module. The example displays traces using multiple connection methods.
@@ -8,6 +8,10 @@ This is a modification of the HTTP example that executes multiple parallel reque
- Pool Connection Query
- Cluster Pool Connection Query
+## supported metrics
+
+- Currently only `db.client.connections.usage` is supported, which denoted the number of idle/used connections.
+
## Installation
```sh
@@ -19,6 +23,12 @@ Setup [Zipkin Tracing](https://zipkin.io/pages/quickstart.html)
or
Setup [Jaeger Tracing](https://www.jaegertracing.io/docs/latest/getting-started/#all-in-one)
+In case you want to see also metrics:
+
+1. Go to `docker` folder
+2. Run `docker compose up`. This will set up Zipkin, Jaeger, otel collector, Prometheus and Grafana.
+3. To see your metrics, go to `http://localhost:3000/`.
+
## Run the Application
### Zipkin
diff --git a/plugins/node/opentelemetry-instrumentation-mysql/examples/docker/collector/otel-collector-config.yaml b/plugins/node/opentelemetry-instrumentation-mysql/examples/docker/collector/otel-collector-config.yaml
new file mode 100644
index 0000000000..bf4e67b135
--- /dev/null
+++ b/plugins/node/opentelemetry-instrumentation-mysql/examples/docker/collector/otel-collector-config.yaml
@@ -0,0 +1,44 @@
+receivers:
+ otlp:
+ protocols:
+ grpc:
+
+exporters:
+ prometheus:
+ endpoint: "0.0.0.0:8889"
+ const_labels:
+ label1: value1
+
+ logging:
+ loglevel: debug
+
+ zipkin:
+ endpoint: "http://zipkin-all-in-one:9411/api/v2/spans"
+ format: proto
+
+ jaeger:
+ endpoint: jaeger-all-in-one:14250
+ tls:
+ insecure: true
+
+processors:
+ batch:
+
+extensions:
+ health_check:
+ pprof:
+ endpoint: :1888
+ zpages:
+ endpoint: :55679
+
+service:
+ extensions: [pprof, zpages, health_check]
+ pipelines:
+ traces:
+ receivers: [otlp]
+ processors: [batch]
+ exporters: [logging]
+ metrics:
+ receivers: [otlp]
+ processors: [batch]
+ exporters: [logging, prometheus]
diff --git a/plugins/node/opentelemetry-instrumentation-mysql/examples/docker/docker-compose.yaml b/plugins/node/opentelemetry-instrumentation-mysql/examples/docker/docker-compose.yaml
new file mode 100644
index 0000000000..88cc5e4c0e
--- /dev/null
+++ b/plugins/node/opentelemetry-instrumentation-mysql/examples/docker/docker-compose.yaml
@@ -0,0 +1,68 @@
+version: "2"
+services:
+
+# mysql
+ mysql:
+ image: mysql:5.7
+ command: --init-file /etc/mysql/init.sql
+ volumes:
+ - ./mysql/init.sql:/etc/mysql/init.sql
+ environment:
+ - MYSQL_ROOT_PASSWORD=secret
+ ports:
+ - "3306:3306"
+
+# Jaeger
+
+ jaeger-all-in-one:
+ image: jaegertracing/all-in-one:latest
+ ports:
+ - "16686:16686"
+ - "14268"
+ - "14250"
+
+# Zipkin
+
+ zipkin-all-in-one:
+ image: openzipkin/zipkin:latest
+ ports:
+ - "9411:9411"
+
+# Collector
+
+ otel-collector:
+ image: otel/opentelemetry-collector-contrib:0.61.0
+ command: ["--config=/etc/otel-collector-config.yaml", ""]
+ volumes:
+ - ./collector/otel-collector-config.yaml:/etc/otel-collector-config.yaml
+ ports:
+ - "1888:1888" # pprof extension
+ - "8888:8888" # Prometheus metrics exposed by the collector
+ - "8889:8889" # Prometheus exporter metrics
+ - "13133:13133" # health_check extension
+ - "4317:4317" # OTLP gRPC receiver
+ - "55679:55679" # zpages extension
+ depends_on:
+ - jaeger-all-in-one
+ - zipkin-all-in-one
+
+# Prometheus
+
+ prometheus:
+ image: quay.io/prometheus/prometheus:v2.34.0
+ command: --config.file=/etc/prometheus/prometheus.yml --no-scrape.adjust-timestamps
+ volumes:
+ - ./prometheus/prometheus.yaml:/etc/prometheus/prometheus.yml
+ ports:
+ - "9090:9090"
+
+# Grafana
+
+ grafana:
+ image: grafana/grafana:9.0.1
+ container_name: grafana
+ volumes:
+ - ./grafana/grafana.ini:/etc/grafana/grafana.ini
+ - ./grafana/provisioning/:/etc/grafana/provisioning/
+ ports:
+ - "3000:3000"
diff --git a/plugins/node/opentelemetry-instrumentation-mysql/examples/docker/grafana/grafana.ini b/plugins/node/opentelemetry-instrumentation-mysql/examples/docker/grafana/grafana.ini
new file mode 100644
index 0000000000..519810a52b
--- /dev/null
+++ b/plugins/node/opentelemetry-instrumentation-mysql/examples/docker/grafana/grafana.ini
@@ -0,0 +1,1170 @@
+##################### 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}
+
+# force migration will run migrations that might cause dataloss
+;force_migration = false
+
+#################################### 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
+
+# For "mysql" only if lockingMigration feature toggle is set. How many seconds to wait before failing to lock the database for the migrations, default is 0.
+;locking_attempt_timeout_sec = 0
+
+################################### 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
+
+# Optionally limits the total number of connections per host, including connections in the dialing,
+# active, and idle states. On limit violation, dials will block.
+# A value of zero (0) means no limit.
+;max_conns_per_host = 0
+
+# The maximum number of idle connections that Grafana will keep alive.
+;max_idle_connections = 100
+
+# 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
+
+# Limit the amount of bytes that will be read/accepted from responses of outgoing HTTP requests.
+;response_limit = 0
+
+# Limits the number of rows that Grafana will process from SQL data sources.
+;row_limit = 1000000
+
+#################################### 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.com
+# for new versions of grafana. The check is used
+# in some UI views to notify that a grafana update exists.
+# This option does not cause any auto updates, nor send any information
+# only a GET request to https://raw.githubusercontent.com/grafana/grafana/main/latest.json to get the latest version.
+;check_for_updates = true
+
+# Set to false to disable all checks to https://grafana.com
+# for new versions of plugins. The check is used
+# in some UI views to notify that a plugin update exists.
+# This option does not cause any auto updates, nor send any information
+# only a GET request to https://grafana.com to get the latest versions.
+;check_for_plugin_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 =
+
+# Rudderstack write key, enabled only if rudderstack_data_plane_url is also set
+;rudderstack_write_key =
+
+# Rudderstack data plane url, enabled only if rudderstack_write_key is also set
+;rudderstack_data_plane_url =
+
+# Rudderstack SDK url, optional, only valid if rudderstack_write_key and rudderstack_data_plane_url is also set
+;rudderstack_sdk_url =
+
+# Rudderstack Config url, optional, used by Rudderstack SDK to fetch source config
+;rudderstack_config_url =
+
+# Controls if the UI contains any links to user feedback forms
+;feedback_links_enabled = true
+
+#################################### 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
+
+# current key provider used for envelope encryption, default to static value specified by secret_key
+;encryption_provider = secretKey.v1
+
+# list of configured key providers, space separated (Enterprise only): e.g., awskms.v1 azurekv.v1
+;available_encryption_providers =
+
+# 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 ,