@envelop/apollo-tracing 3.4.0-alpha-26c4ae2.0 → 3.4.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/README.md +33 -0
  2. package/package.json +2 -2
package/README.md ADDED
@@ -0,0 +1,33 @@
1
+ ## `@envelop/apollo-tracing`
2
+
3
+ This plugin tracks execution and resolvers and reports it using [`apollo-tracing`](https://github.com/apollographql/apollo-server/tree/main/packages/apollo-tracing) format (based on GraphQL `extensions`).
4
+
5
+ You can see the results of the collected metrics if you are using [GraphQL Playground](https://github.com/graphql/graphql-playground).
6
+
7
+ This is how it looks like (note the `TRACING` section):
8
+
9
+ ![Example](./example.png)
10
+
11
+ ## Getting Started
12
+
13
+ ```
14
+ yarn add @envelop/apollo-tracing
15
+ ```
16
+
17
+ ## Usage Example
18
+
19
+ ```ts
20
+ import { envelop } from '@envelop/core';
21
+ import { useApolloTracing } from '@envelop/apollo-tracing';
22
+
23
+ const getEnveloped = envelop({
24
+ plugins: [
25
+ // ... other plugins ...
26
+ useApolloTracing(),
27
+ ],
28
+ });
29
+ ```
30
+
31
+ ## Notes
32
+
33
+ It's recommended to keep this plugin active only while developing only, since it's mainly used for performance tracking while developing.
package/package.json CHANGED
@@ -1,9 +1,9 @@
1
1
  {
2
2
  "name": "@envelop/apollo-tracing",
3
- "version": "3.4.0-alpha-26c4ae2.0",
3
+ "version": "3.4.0",
4
4
  "sideEffects": false,
5
5
  "peerDependencies": {
6
- "@envelop/core": "2.4.0-alpha-26c4ae2.0",
6
+ "@envelop/core": "^2.4.0",
7
7
  "graphql": "^14.0.0 || ^15.0.0 || ^16.0.0"
8
8
  },
9
9
  "dependencies": {