Add Knex.js instrumentation (#803)

- Add the Knex.js instrumentation package as a dependency.
- Load it by default.
- Add an integration test app for Knex.js.

Part of #762

.changesets/add-knex-js-instrumentation.md

@@ -0,0 +1,6 @@
+---
+bump: "patch"
+type: "add"
+---
+
+Add Knex.js instrumentation. We will now auto instrument database queries made with Knex.js.

.semaphore/semaphore.yml

@@ -70,6 +70,9 @@ blocks:
     - name: Express + Redis
       commands:
       - script/integration_test_app express-redis
+    - name: Express + Knex.js
+      commands:
+      - script/integration_test_app express-knex
     - name: Koa + MySQL
       commands:
       - script/integration_test_app koa-mysql

build_matrix.yml

@@ -66,6 +66,9 @@ semaphore: # Default `.semaphore/semaphore.yml` contents
         - name: Express + Redis
           commands:
             - script/integration_test_app express-redis
+        - name: Express + Knex.js
+          commands:
+            - script/integration_test_app express-knex
         - name: Koa + MySQL
           commands:
             - script/integration_test_app koa-mysql

package.json

@@ -19,6 +19,7 @@
     "@opentelemetry/instrumentation-graphql": "^0.33.0",
     "@opentelemetry/instrumentation-http": "^0.34.0",
     "@opentelemetry/instrumentation-ioredis": "^0.33.0",
+    "@opentelemetry/instrumentation-knex": "^0.31.0",
     "@opentelemetry/instrumentation-koa": "^0.34.0",
     "@opentelemetry/instrumentation-mongodb": "0.33.0",
     "@opentelemetry/instrumentation-mongoose": "^0.32.0",

src/client.ts

@@ -20,6 +20,7 @@ import { FsInstrumentation } from "@opentelemetry/instrumentation-fs"
 import { GraphQLInstrumentation } from "@opentelemetry/instrumentation-graphql"
 import { HttpInstrumentation } from "@opentelemetry/instrumentation-http"
 import { IORedisInstrumentation } from "@opentelemetry/instrumentation-ioredis"
+import { KnexInstrumentation } from "@opentelemetry/instrumentation-knex"
 import { KoaInstrumentation } from "@opentelemetry/instrumentation-koa"
 import { MongoDBInstrumentation } from "@opentelemetry/instrumentation-mongodb"
 import { MongooseInstrumentation } from "@opentelemetry/instrumentation-mongoose"
@@ -42,6 +43,7 @@ const DefaultInstrumentations = {
   "@opentelemetry/instrumentation-graphql": GraphQLInstrumentation,
   "@opentelemetry/instrumentation-http": HttpInstrumentation,
   "@opentelemetry/instrumentation-ioredis": IORedisInstrumentation,
+  "@opentelemetry/instrumentation-knex": KnexInstrumentation,
   "@opentelemetry/instrumentation-koa": KoaInstrumentation,
   "@opentelemetry/instrumentation-mongodb": MongoDBInstrumentation,
   "@opentelemetry/instrumentation-mongoose": MongooseInstrumentation,

test/express-knex/app/.gitignore

@@ -0,0 +1 @@
+dist/

test/express-knex/app/Dockerfile

@@ -0,0 +1,5 @@
+FROM node:16
+
+COPY run.sh /
+
+ENTRYPOINT ["sh", "/run.sh"]

test/express-knex/app/knexfile.js

@@ -0,0 +1,30 @@
+// Update with your config settings.
+
+/**
+ * @type { Object.<string, import("knex").Knex.Config> }
+ */
+module.exports = {
+  development: {
+    client: "postgresql",
+    connection: process.env.DATABASE_URL,
+    pool: {
+      min: 2,
+      max: 10
+    },
+    migrations: {
+      tableName: "knex_migrations"
+    }
+  },
+
+  production: {
+    client: "postgresql",
+    connection: process.env.DATABASE_URL,
+    pool: {
+      min: 2,
+      max: 10
+    },
+    migrations: {
+      tableName: "knex_migrations"
+    }
+  }
+}

test/express-knex/app/migrations/20221121143401_create_posts.js

@@ -0,0 +1,19 @@
+/**
+ * @param { import("knex").Knex } knex
+ * @returns { Promise<void> }
+ */
+exports.up = function (knex) {
+  return knex.schema.createTable("posts", function (table) {
+    table.increments("id")
+    table.string("title", 255).notNullable()
+    table.string("body", 255).notNullable()
+  })
+}
+
+/**
+ * @param { import("knex").Knex } knex
+ * @returns { Promise<void> }
+ */
+exports.down = function (knex) {
+  return knex.schema.dropTable("posts")
+}