@promster/apollo 1.0.8 → 3.0.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.
- package/dist/declarations/src/index.d.ts +3 -2
- package/dist/declarations/src/plugin/index.d.ts +2 -2
- package/dist/declarations/src/plugin/plugin.d.ts +9 -6
- package/dist/promster-apollo.cjs.d.ts +1 -0
- package/dist/promster-apollo.cjs.d.ts.map +1 -0
- package/dist/promster-apollo.cjs.dev.js +17 -8
- package/dist/promster-apollo.cjs.prod.js +17 -8
- package/package.json +15 -13
|
@@ -1,3 +1,4 @@
|
|
|
1
|
-
import { createPlugin, signalIsUp, signalIsNotUp } from
|
|
1
|
+
import { type TPromsterOptions, createPlugin, signalIsUp, signalIsNotUp } from "./plugin/index.js";
|
|
2
2
|
import { getSummary, getContentType, Prometheus, defaultRegister, defaultNormalizers, timing } from '@promster/metrics';
|
|
3
|
-
export { createPlugin, signalIsUp, signalIsNotUp, getSummary, getContentType, Prometheus, defaultRegister, defaultNormalizers, timing, };
|
|
3
|
+
export { type TPromsterOptions, createPlugin, signalIsUp, signalIsNotUp, getSummary, getContentType, Prometheus, defaultRegister, defaultNormalizers, timing, };
|
|
4
|
+
export * from '@promster/types';
|
|
@@ -1,2 +1,2 @@
|
|
|
1
|
-
import { createPlugin, signalIsUp, signalIsNotUp } from
|
|
2
|
-
export { createPlugin, signalIsUp, signalIsNotUp };
|
|
1
|
+
import { type TPromsterOptions, createPlugin, signalIsUp, signalIsNotUp } from "./plugin.js";
|
|
2
|
+
export { type TPromsterOptions, createPlugin, signalIsUp, signalIsNotUp };
|
|
@@ -1,11 +1,14 @@
|
|
|
1
|
-
import type
|
|
2
|
-
import type
|
|
3
|
-
import type
|
|
1
|
+
import { type ApolloServerPlugin, type BaseContext, type GraphQLRequestContext, type GraphQLRequest } from '@apollo/server';
|
|
2
|
+
import { type TOptionalPromsterOptions, type TLabelValues } from '@promster/types';
|
|
3
|
+
import { type TRequestRecorder } from '@promster/metrics';
|
|
4
4
|
declare const getRequestRecorder: () => TRequestRecorder;
|
|
5
5
|
declare const signalIsUp: () => void;
|
|
6
6
|
declare const signalIsNotUp: () => void;
|
|
7
|
-
type
|
|
8
|
-
|
|
7
|
+
type TSkipFunction = <TRequest extends GraphQLRequest, TResponse extends GraphQLRequestContext<BaseContext>['response']>(_req: TRequest, _res: TResponse, _labels: TLabelValues) => boolean;
|
|
8
|
+
export type TPromsterOptions = {
|
|
9
|
+
options?: TOptionalPromsterOptions & {
|
|
10
|
+
skip?: TSkipFunction;
|
|
11
|
+
};
|
|
9
12
|
};
|
|
10
|
-
declare const createPlugin: ({ options }?:
|
|
13
|
+
declare const createPlugin: ({ options }?: TPromsterOptions) => ApolloServerPlugin<BaseContext>;
|
|
11
14
|
export { createPlugin, getRequestRecorder, signalIsUp, signalIsNotUp };
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"promster-apollo.cjs.d.ts","sourceRoot":"","sources":["./declarations/src/index.d.ts"],"names":[],"mappings":"AAAA"}
|
|
@@ -4,6 +4,7 @@ Object.defineProperty(exports, '__esModule', { value: true });
|
|
|
4
4
|
|
|
5
5
|
var merge = require('merge-options');
|
|
6
6
|
var metrics = require('@promster/metrics');
|
|
7
|
+
var types = require('@promster/types');
|
|
7
8
|
|
|
8
9
|
function _interopDefault (e) { return e && e.__esModule ? e : { 'default': e }; }
|
|
9
10
|
|
|
@@ -45,10 +46,11 @@ const createPlugin = ({
|
|
|
45
46
|
function getDefaultLabelsOrSkipMeasurement(requestContext) {
|
|
46
47
|
var _allDefaultedOptions$, _allDefaultedOptions$2;
|
|
47
48
|
const labels = Object.assign({}, {
|
|
49
|
+
// eslint-disable-next-line camelcase
|
|
48
50
|
operation_name: requestContext.request.operationName
|
|
49
51
|
}, (_allDefaultedOptions$ = allDefaultedOptions.getLabelValues) === null || _allDefaultedOptions$ === void 0 ? void 0 : _allDefaultedOptions$.call(allDefaultedOptions, requestContext.request, requestContext.response));
|
|
50
52
|
const shouldSkipByRequest = (_allDefaultedOptions$2 = allDefaultedOptions.skip) === null || _allDefaultedOptions$2 === void 0 ? void 0 : _allDefaultedOptions$2.call(allDefaultedOptions, requestContext.request, requestContext.response, labels);
|
|
51
|
-
if (shouldSkipByRequest
|
|
53
|
+
if (shouldSkipByRequest !== null && shouldSkipByRequest !== void 0 ? shouldSkipByRequest : shouldSkipMetricsByEnvironment) {
|
|
52
54
|
return {};
|
|
53
55
|
}
|
|
54
56
|
return labels;
|
|
@@ -74,13 +76,13 @@ const createPlugin = ({
|
|
|
74
76
|
const labels = getDefaultLabelsOrSkipMeasurement(parsingRequestContext);
|
|
75
77
|
if (parseDurationSeconds !== undefined) {
|
|
76
78
|
var _graphQlMetrics$graph;
|
|
77
|
-
(_graphQlMetrics$graph = graphQlMetrics.graphQlParseDuration) === null || _graphQlMetrics$graph === void 0
|
|
79
|
+
(_graphQlMetrics$graph = graphQlMetrics.graphQlParseDuration) === null || _graphQlMetrics$graph === void 0 || _graphQlMetrics$graph.forEach(metric => {
|
|
78
80
|
metric.observe(labels, parseDurationSeconds);
|
|
79
81
|
});
|
|
80
82
|
}
|
|
81
83
|
if (error) {
|
|
82
84
|
var _graphQlMetrics$graph2;
|
|
83
|
-
(_graphQlMetrics$graph2 = graphQlMetrics.graphQlErrorsTotal) === null || _graphQlMetrics$graph2 === void 0
|
|
85
|
+
(_graphQlMetrics$graph2 = graphQlMetrics.graphQlErrorsTotal) === null || _graphQlMetrics$graph2 === void 0 || _graphQlMetrics$graph2.forEach(metric => {
|
|
84
86
|
metric.inc(Object.assign({}, labels, {
|
|
85
87
|
phase: 'parsing'
|
|
86
88
|
}));
|
|
@@ -97,13 +99,13 @@ const createPlugin = ({
|
|
|
97
99
|
const labels = getDefaultLabelsOrSkipMeasurement(validationRequestContext);
|
|
98
100
|
if (validationDurationSeconds !== undefined) {
|
|
99
101
|
var _graphQlMetrics$graph3;
|
|
100
|
-
(_graphQlMetrics$graph3 = graphQlMetrics.graphQlValidationDuration) === null || _graphQlMetrics$graph3 === void 0
|
|
102
|
+
(_graphQlMetrics$graph3 = graphQlMetrics.graphQlValidationDuration) === null || _graphQlMetrics$graph3 === void 0 || _graphQlMetrics$graph3.forEach(metric => {
|
|
101
103
|
metric.observe(labels, validationDurationSeconds);
|
|
102
104
|
});
|
|
103
105
|
}
|
|
104
106
|
if (error) {
|
|
105
107
|
var _graphQlMetrics$graph4;
|
|
106
|
-
(_graphQlMetrics$graph4 = graphQlMetrics.graphQlErrorsTotal) === null || _graphQlMetrics$graph4 === void 0
|
|
108
|
+
(_graphQlMetrics$graph4 = graphQlMetrics.graphQlErrorsTotal) === null || _graphQlMetrics$graph4 === void 0 || _graphQlMetrics$graph4.forEach(metric => {
|
|
107
109
|
metric.inc(Object.assign({}, labels, {
|
|
108
110
|
phase: 'validation'
|
|
109
111
|
}));
|
|
@@ -123,17 +125,18 @@ const createPlugin = ({
|
|
|
123
125
|
} = fieldResolveTiming.end().value();
|
|
124
126
|
const defaultLabels = getDefaultLabelsOrSkipMeasurement(executionRequestContext);
|
|
125
127
|
const labels = Object.assign({}, defaultLabels, {
|
|
128
|
+
// eslint-disable-next-line camelcase
|
|
126
129
|
field_name: info.fieldName
|
|
127
130
|
});
|
|
128
131
|
if (fieldResolveDurationSeconds !== undefined) {
|
|
129
132
|
var _graphQlMetrics$graph5;
|
|
130
|
-
(_graphQlMetrics$graph5 = graphQlMetrics.graphQlResolveFieldDuration) === null || _graphQlMetrics$graph5 === void 0
|
|
133
|
+
(_graphQlMetrics$graph5 = graphQlMetrics.graphQlResolveFieldDuration) === null || _graphQlMetrics$graph5 === void 0 || _graphQlMetrics$graph5.forEach(metric => {
|
|
131
134
|
metric.observe(labels, fieldResolveDurationSeconds);
|
|
132
135
|
});
|
|
133
136
|
}
|
|
134
137
|
if (error) {
|
|
135
138
|
var _graphQlMetrics$graph6;
|
|
136
|
-
(_graphQlMetrics$graph6 = graphQlMetrics.graphQlErrorsTotal) === null || _graphQlMetrics$graph6 === void 0
|
|
139
|
+
(_graphQlMetrics$graph6 = graphQlMetrics.graphQlErrorsTotal) === null || _graphQlMetrics$graph6 === void 0 || _graphQlMetrics$graph6.forEach(metric => {
|
|
137
140
|
metric.inc(Object.assign({}, labels, {
|
|
138
141
|
phase: 'execution'
|
|
139
142
|
}));
|
|
@@ -150,7 +153,7 @@ const createPlugin = ({
|
|
|
150
153
|
const labels = getDefaultLabelsOrSkipMeasurement(responseRequestContext);
|
|
151
154
|
if (requestDurationSeconds !== undefined) {
|
|
152
155
|
var _graphQlMetrics$graph7;
|
|
153
|
-
(_graphQlMetrics$graph7 = graphQlMetrics.graphQlRequestDuration) === null || _graphQlMetrics$graph7 === void 0
|
|
156
|
+
(_graphQlMetrics$graph7 = graphQlMetrics.graphQlRequestDuration) === null || _graphQlMetrics$graph7 === void 0 || _graphQlMetrics$graph7.forEach(metric => {
|
|
154
157
|
metric.observe(labels, requestDurationSeconds);
|
|
155
158
|
});
|
|
156
159
|
}
|
|
@@ -188,3 +191,9 @@ Object.defineProperty(exports, 'timing', {
|
|
|
188
191
|
exports.createPlugin = createPlugin;
|
|
189
192
|
exports.signalIsNotUp = signalIsNotUp;
|
|
190
193
|
exports.signalIsUp = signalIsUp;
|
|
194
|
+
Object.keys(types).forEach(function (k) {
|
|
195
|
+
if (k !== 'default' && !exports.hasOwnProperty(k)) Object.defineProperty(exports, k, {
|
|
196
|
+
enumerable: true,
|
|
197
|
+
get: function () { return types[k]; }
|
|
198
|
+
});
|
|
199
|
+
});
|
|
@@ -4,6 +4,7 @@ Object.defineProperty(exports, '__esModule', { value: true });
|
|
|
4
4
|
|
|
5
5
|
var merge = require('merge-options');
|
|
6
6
|
var metrics = require('@promster/metrics');
|
|
7
|
+
var types = require('@promster/types');
|
|
7
8
|
|
|
8
9
|
function _interopDefault (e) { return e && e.__esModule ? e : { 'default': e }; }
|
|
9
10
|
|
|
@@ -45,10 +46,11 @@ const createPlugin = ({
|
|
|
45
46
|
function getDefaultLabelsOrSkipMeasurement(requestContext) {
|
|
46
47
|
var _allDefaultedOptions$, _allDefaultedOptions$2;
|
|
47
48
|
const labels = Object.assign({}, {
|
|
49
|
+
// eslint-disable-next-line camelcase
|
|
48
50
|
operation_name: requestContext.request.operationName
|
|
49
51
|
}, (_allDefaultedOptions$ = allDefaultedOptions.getLabelValues) === null || _allDefaultedOptions$ === void 0 ? void 0 : _allDefaultedOptions$.call(allDefaultedOptions, requestContext.request, requestContext.response));
|
|
50
52
|
const shouldSkipByRequest = (_allDefaultedOptions$2 = allDefaultedOptions.skip) === null || _allDefaultedOptions$2 === void 0 ? void 0 : _allDefaultedOptions$2.call(allDefaultedOptions, requestContext.request, requestContext.response, labels);
|
|
51
|
-
if (shouldSkipByRequest
|
|
53
|
+
if (shouldSkipByRequest !== null && shouldSkipByRequest !== void 0 ? shouldSkipByRequest : shouldSkipMetricsByEnvironment) {
|
|
52
54
|
return {};
|
|
53
55
|
}
|
|
54
56
|
return labels;
|
|
@@ -74,13 +76,13 @@ const createPlugin = ({
|
|
|
74
76
|
const labels = getDefaultLabelsOrSkipMeasurement(parsingRequestContext);
|
|
75
77
|
if (parseDurationSeconds !== undefined) {
|
|
76
78
|
var _graphQlMetrics$graph;
|
|
77
|
-
(_graphQlMetrics$graph = graphQlMetrics.graphQlParseDuration) === null || _graphQlMetrics$graph === void 0
|
|
79
|
+
(_graphQlMetrics$graph = graphQlMetrics.graphQlParseDuration) === null || _graphQlMetrics$graph === void 0 || _graphQlMetrics$graph.forEach(metric => {
|
|
78
80
|
metric.observe(labels, parseDurationSeconds);
|
|
79
81
|
});
|
|
80
82
|
}
|
|
81
83
|
if (error) {
|
|
82
84
|
var _graphQlMetrics$graph2;
|
|
83
|
-
(_graphQlMetrics$graph2 = graphQlMetrics.graphQlErrorsTotal) === null || _graphQlMetrics$graph2 === void 0
|
|
85
|
+
(_graphQlMetrics$graph2 = graphQlMetrics.graphQlErrorsTotal) === null || _graphQlMetrics$graph2 === void 0 || _graphQlMetrics$graph2.forEach(metric => {
|
|
84
86
|
metric.inc(Object.assign({}, labels, {
|
|
85
87
|
phase: 'parsing'
|
|
86
88
|
}));
|
|
@@ -97,13 +99,13 @@ const createPlugin = ({
|
|
|
97
99
|
const labels = getDefaultLabelsOrSkipMeasurement(validationRequestContext);
|
|
98
100
|
if (validationDurationSeconds !== undefined) {
|
|
99
101
|
var _graphQlMetrics$graph3;
|
|
100
|
-
(_graphQlMetrics$graph3 = graphQlMetrics.graphQlValidationDuration) === null || _graphQlMetrics$graph3 === void 0
|
|
102
|
+
(_graphQlMetrics$graph3 = graphQlMetrics.graphQlValidationDuration) === null || _graphQlMetrics$graph3 === void 0 || _graphQlMetrics$graph3.forEach(metric => {
|
|
101
103
|
metric.observe(labels, validationDurationSeconds);
|
|
102
104
|
});
|
|
103
105
|
}
|
|
104
106
|
if (error) {
|
|
105
107
|
var _graphQlMetrics$graph4;
|
|
106
|
-
(_graphQlMetrics$graph4 = graphQlMetrics.graphQlErrorsTotal) === null || _graphQlMetrics$graph4 === void 0
|
|
108
|
+
(_graphQlMetrics$graph4 = graphQlMetrics.graphQlErrorsTotal) === null || _graphQlMetrics$graph4 === void 0 || _graphQlMetrics$graph4.forEach(metric => {
|
|
107
109
|
metric.inc(Object.assign({}, labels, {
|
|
108
110
|
phase: 'validation'
|
|
109
111
|
}));
|
|
@@ -123,17 +125,18 @@ const createPlugin = ({
|
|
|
123
125
|
} = fieldResolveTiming.end().value();
|
|
124
126
|
const defaultLabels = getDefaultLabelsOrSkipMeasurement(executionRequestContext);
|
|
125
127
|
const labels = Object.assign({}, defaultLabels, {
|
|
128
|
+
// eslint-disable-next-line camelcase
|
|
126
129
|
field_name: info.fieldName
|
|
127
130
|
});
|
|
128
131
|
if (fieldResolveDurationSeconds !== undefined) {
|
|
129
132
|
var _graphQlMetrics$graph5;
|
|
130
|
-
(_graphQlMetrics$graph5 = graphQlMetrics.graphQlResolveFieldDuration) === null || _graphQlMetrics$graph5 === void 0
|
|
133
|
+
(_graphQlMetrics$graph5 = graphQlMetrics.graphQlResolveFieldDuration) === null || _graphQlMetrics$graph5 === void 0 || _graphQlMetrics$graph5.forEach(metric => {
|
|
131
134
|
metric.observe(labels, fieldResolveDurationSeconds);
|
|
132
135
|
});
|
|
133
136
|
}
|
|
134
137
|
if (error) {
|
|
135
138
|
var _graphQlMetrics$graph6;
|
|
136
|
-
(_graphQlMetrics$graph6 = graphQlMetrics.graphQlErrorsTotal) === null || _graphQlMetrics$graph6 === void 0
|
|
139
|
+
(_graphQlMetrics$graph6 = graphQlMetrics.graphQlErrorsTotal) === null || _graphQlMetrics$graph6 === void 0 || _graphQlMetrics$graph6.forEach(metric => {
|
|
137
140
|
metric.inc(Object.assign({}, labels, {
|
|
138
141
|
phase: 'execution'
|
|
139
142
|
}));
|
|
@@ -150,7 +153,7 @@ const createPlugin = ({
|
|
|
150
153
|
const labels = getDefaultLabelsOrSkipMeasurement(responseRequestContext);
|
|
151
154
|
if (requestDurationSeconds !== undefined) {
|
|
152
155
|
var _graphQlMetrics$graph7;
|
|
153
|
-
(_graphQlMetrics$graph7 = graphQlMetrics.graphQlRequestDuration) === null || _graphQlMetrics$graph7 === void 0
|
|
156
|
+
(_graphQlMetrics$graph7 = graphQlMetrics.graphQlRequestDuration) === null || _graphQlMetrics$graph7 === void 0 || _graphQlMetrics$graph7.forEach(metric => {
|
|
154
157
|
metric.observe(labels, requestDurationSeconds);
|
|
155
158
|
});
|
|
156
159
|
}
|
|
@@ -188,3 +191,9 @@ Object.defineProperty(exports, 'timing', {
|
|
|
188
191
|
exports.createPlugin = createPlugin;
|
|
189
192
|
exports.signalIsNotUp = signalIsNotUp;
|
|
190
193
|
exports.signalIsUp = signalIsUp;
|
|
194
|
+
Object.keys(types).forEach(function (k) {
|
|
195
|
+
if (k !== 'default' && !exports.hasOwnProperty(k)) Object.defineProperty(exports, k, {
|
|
196
|
+
enumerable: true,
|
|
197
|
+
get: function () { return types[k]; }
|
|
198
|
+
});
|
|
199
|
+
});
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@promster/apollo",
|
|
3
|
-
"version": "
|
|
3
|
+
"version": "3.0.0",
|
|
4
4
|
"description": "Apollo server integrations of promster",
|
|
5
5
|
"main": "dist/promster-apollo.cjs.js",
|
|
6
6
|
"typings": "dist/promster-apollo.cjs.d.ts",
|
|
@@ -13,8 +13,8 @@
|
|
|
13
13
|
"modules/**"
|
|
14
14
|
],
|
|
15
15
|
"engines": {
|
|
16
|
-
"node": ">=
|
|
17
|
-
"npm": ">=
|
|
16
|
+
"node": ">=16",
|
|
17
|
+
"npm": ">=8"
|
|
18
18
|
},
|
|
19
19
|
"publishConfig": {
|
|
20
20
|
"access": "public"
|
|
@@ -36,17 +36,19 @@
|
|
|
36
36
|
"prometheus"
|
|
37
37
|
],
|
|
38
38
|
"dependencies": {
|
|
39
|
-
"@
|
|
40
|
-
"
|
|
39
|
+
"@apollo/server": "4.9.3",
|
|
40
|
+
"@promster/metrics": "^11.0.0",
|
|
41
|
+
"@promster/types": "^5.0.0",
|
|
41
42
|
"merge-options": "3.0.4",
|
|
42
|
-
"tslib": "2.
|
|
43
|
+
"tslib": "2.6.2"
|
|
43
44
|
},
|
|
44
45
|
"devDependencies": {
|
|
45
|
-
"@graphql-tools/schema": "
|
|
46
|
-
"@graphql-tools/utils": "
|
|
47
|
-
"apollo-server": "3.
|
|
48
|
-
"graphql": "16.
|
|
49
|
-
"node-fetch": "2.6.
|
|
50
|
-
"parse-prometheus-text-format": "1.1.1"
|
|
46
|
+
"@graphql-tools/schema": "10.0.0",
|
|
47
|
+
"@graphql-tools/utils": "10.0.5",
|
|
48
|
+
"apollo-server": "3.12.1",
|
|
49
|
+
"graphql": "16.8.0",
|
|
50
|
+
"node-fetch": "2.6.11",
|
|
51
|
+
"parse-prometheus-text-format": "1.1.1",
|
|
52
|
+
"@promster/server": "9.0.0"
|
|
51
53
|
}
|
|
52
|
-
}
|
|
54
|
+
}
|