feat: Instrument typeorm query builder (#131)

* add query builder instrumentation

* trace SelectQueryBuilder execute methods

* rename to response

* remove `setConfig`

* add tav

* clean up

* remove component

* remove commented out code

* fix enableInternalInstrumentation

* - `enableInternalInstrumentation`
- `suppressInternalInstrumentation`

* fix suppress

* fix tests

* refactor tests

* add postgres to github tests

* refactor

* prettier

* use mocking for querybuilder tests

* fix conflict

* pr comments

* use in memory sqlite for tests

* add table name assertion to all test

* chore: prettier

* add tests

* added Supported Versions

* PR fixes

Author: mottibec

.github/workflows/test.yml

@@ -5,7 +5,6 @@ on:
     branches: [master]
 
 jobs:
-
   prettier:
     runs-on: ubuntu-latest
 
@@ -18,7 +17,6 @@ jobs:
   test:
     runs-on: ubuntu-latest
     services:
-
       mongo:
         image: mongo
         ports:
@@ -36,7 +34,6 @@ jobs:
         image: rabbitmq:3
         ports:
           - 22221:5672
-        
 
     steps:
       - uses: actions/checkout@v2

.gitignore

@@ -26,4 +26,7 @@ aspecto.json
 aspecto.log
 
 # created from sequelize unit tests
-memory 
+memory 
+
+#local database files
+*.db

packages/instrumentation-typeorm/.tav.yml

@@ -0,0 +1,4 @@
+'typeorm':
+  versions: ">0.2.28"
+  commands:
+    - yarn test

packages/instrumentation-typeorm/README.md

@@ -9,6 +9,9 @@ This module provides automatic instrumentation for [`TypeORM`](https://typeorm.i
 npm install --save opentelemetry-instrumentation-typeorm
 ```
 
+## Supported Versions
+This instrumentation supports `>0.2.28`:
+
 ## Usage
 For further automatic instrumentation instruction see the [@opentelemetry/instrumentation](https://github.com/open-telemetry/opentelemetry-js/tree/main/packages/opentelemetry-instrumentation) package.
 
@@ -42,7 +45,8 @@ TypeORM instrumentation has few options available to choose from. You can set th
 | -------------- | -------------------------------------- | ----------------------------------------------------------------------------------------------- |
 | `responseHook` | `TypeormResponseCustomAttributesFunction` | Hook called before response is returned, which allows to add custom attributes to span.      |
 | `moduleVersionAttributeName` | `string` | If passed, a span attribute will be added to all spans with key of the provided `moduleVersionAttributeName` and value of the patched module version |
-
+| `suppressInternalInstrumentation` | boolean | Typeorm operation use mongodb/postgres/mysql/mariadb/etc. under the hood. If, for example, postgres instrumentation is enabled, a postgres operation will also create a postgres span describing the communication. Setting the `suppressInternalInstrumentation` config value to `true` will cause the instrumentation to suppress instrumentation of underlying operations. |
+| `enableInternalInstrumentation` | boolean |  Some methods such as `getManyAndCount` can generate internally multiple spans. To instrument those set this to `true`
 
 ---
 

packages/instrumentation-typeorm/package.json

@@ -24,8 +24,9 @@
         "build": "tsc",
         "prepare": "yarn run build",
         "test": "mocha --require opentelemetry-instrumentation-testing-utils",
+        "test-all-versions": "tav",
         "test:jaeger": "OTEL_EXPORTER_JAEGER_AGENT_HOST=localhost mocha --require opentelemetry-instrumentation-testing-utils",
-        "test:ci": "yarn test",
+        "test:ci": "yarn test-all-versions",
         "watch": "tsc -w",
         "version:update": "node ../../scripts/version-update.js",
         "version": "yarn run version:update"
@@ -35,8 +36,10 @@
     },
     "dependencies": {
         "@opentelemetry/api": "^0.20.0",
+        "@opentelemetry/core": "^0.20.0",
         "@opentelemetry/instrumentation": "^0.20.0",
-        "@opentelemetry/semantic-conventions": "^0.20.0"
+        "@opentelemetry/semantic-conventions": "^0.20.0",
+        "is-promise": "^4.0.0"
     },
     "devDependencies": {
         "@opentelemetry/tracing": "^0.20.0",
@@ -46,6 +49,8 @@
         "opentelemetry-instrumentation-mocha": "^0.0.1-rc.1",
         "opentelemetry-instrumentation-testing-utils": "^0.5.1",
         "reflect-metadata": "^0.1.13",
+        "sqlite3": "^5.0.2",
+        "test-all-versions": "^5.0.1",
         "ts-node": "^9.1.1",
         "typeorm": "^0.2.26",
         "typescript": "^4.0.3"