@opentelemetry/instrumentation-graphql - npm Package Compare versions

Comparing version 0.23.0 to 0.24.0

build/src/instrumentation.d.ts

@@ -7,3 +7,3 @@ import { InstrumentationBase, InstrumentationConfig, InstrumentationNodeModuleDefinition } from '@opentelemetry/instrumentation';
     private _getConfig;
-    setConfig(config?: GraphQLInstrumentationConfig & InstrumentationConfig): void;
+    setConfig(config?: GraphQLInstrumentationConfig): void;
     protected init(): InstrumentationNodeModuleDefinition<typeof graphqlTypes>;
@@ -10,0 +10,0 @@ private _addPatchingExecute;

build/src/version.d.ts

@@ -1,2 +0,2 @@
-export declare const VERSION = "0.23.0";
+export declare const VERSION = "0.24.0";
 //# sourceMappingURL=version.d.ts.map

build/src/version.js

@@ -20,3 +20,3 @@ "use strict";
 // this is autogenerated file, see scripts/version-update.js
-exports.VERSION = '0.23.0';
+exports.VERSION = '0.24.0';
 //# sourceMappingURL=version.js.map

package.json

 {
   "name": "@opentelemetry/instrumentation-graphql",
-  "version": "0.23.0",
+  "version": "0.24.0",
   "description": "OpenTelemetry @opentelemetry/instrumentation-graphql automatic instrumentation package.",
@@ -50,6 +50,6 @@ "main": "build/src/index.js",
     "@opentelemetry/api": "1.0.1",
-    "@opentelemetry/tracing": "0.23.0",
-    "@types/mocha": "8.2.2",
-    "@types/node": "14.17.4",
-    "codecov": "3.8.2",
+    "@opentelemetry/tracing": "0.24.0",
+    "@types/mocha": "8.2.3",
+    "@types/node": "14.17.5",
+    "codecov": "3.8.3",
     "graphql": "15.5.1",
@@ -64,6 +64,6 @@ "gts": "3.1.0",
   "dependencies": {
-    "@opentelemetry/instrumentation": "^0.23.0",
+    "@opentelemetry/instrumentation": "^0.24.0",
     "@types/graphql": "14.5.0"
   },
-  "gitHead": "eea5f3ef0382c3c8f6d5aca796e3babf7ad4a6c8"
+  "gitHead": "e4757035a7b4012703a98b5609b8ac0f859e9726"
 }

README.md

@@ -10,2 +10,6 @@ # OpenTelemetry Instrumentation GraphQL
 
+*Note*: graphql plugin instruments graphql directly. it should work with any package that wraps the graphql package (e.g apollo).
+
+Minimum required graphql version is `v14`
+
 ## Installation
@@ -42,2 +46,14 @@
 
+## Optional Parameters
+
+|    Param    |   type  | Default Value |                                                                        Description                                                                        |   |
+|:-----------:|:-------:|:-------------:|:---------------------------------------------------------------------------------------------------------------------------------------------------------:|:-:|
+|  mergeItems | boolean |     false     |                    Whether to merge list items into a single element. example: `users.*.name` instead of `users.0.name`, `users.1.name`                   |   |
+|    depth    |  number |       -1      |                       The maximum depth of fields/resolvers to instrument. When set to 0 it will not instrument fields and resolvers. When set to -1 it will instrument all fields and resolvers.                      |   |
+| allowValues | boolean |     false     | When set to true it will not remove attributes values from schema source.   By default all values that can be sensitive are removed and replaced with "*" |   |
+| responseHook | GraphQLInstrumentationExecutionResponseHook |     undefined     | Hook that allows adding custom span attributes based on the data returned from "execute" GraphQL action. |   |
+
+## Examples
+Can be found [here](https://github.com/open-telemetry/opentelemetry-js-contrib/tree/main/examples/graphql)
+
 ## Useful links
@@ -48,3 +64,2 @@
 - For help or feedback on this project, join us in [GitHub Discussions][discussions-url]
-
 ## License
@@ -51,0 +66,0 @@

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

73695

increased by2.16%

Number of lines in readme file

75

increased by25%

Dependency changes

• + Added@opentelemetry/api-metrics@0.24.0(transitive)

• + Added@opentelemetry/instrumentation@0.24.0(transitive)

• - Removed@opentelemetry/api-metrics@0.23.0(transitive)

• - Removed@opentelemetry/instrumentation@0.23.0(transitive)

• Updated@opentelemetry/instrumentation@^0.24.0