monitor retries and bumps

Author: SharonGrossman

package.json

@@ -35,6 +35,7 @@
     "@fastify/type-provider-typebox": "^2.0.1",
     "@godaddy/terminus": "^4.11.0",
     "@osskit/fastify-enforce-headers": "^0.0.5",
+    "@osskit/fetch-enhancers": "^3.0.0",
     "@osskit/monitor": "^5.0.0",
     "@sinclair/typebox": "^0.24.8",
     "dotenv": "^16.0.1",
@@ -46,6 +47,7 @@
     "mongodb": "^4.7.0",
     "pino": "^8.1.0",
     "prom-client": "^14.0.1",
+    "replace-url-values": "^1.0.0",
     "uuid": "^8.3.2"
   },
   "devDependencies": {

src/framework/environment.ts

@@ -1,6 +1,7 @@
 import env from 'env-var';
 
 export const nodeEnv = env.get('NODE_ENV').required().asString();
+export const serviceName = 'example-api';
 export const port = env.get('PORT').default(3000).asPortNumber();
 export const mongoUri = env.get('MONGO_URI').required().asString();
 export const mongoDb = env.get('MONGO_DB_NAME').required().asString();

src/framework/monitorRetry.ts

@@ -0,0 +1,18 @@
+import { Counter } from 'prom-client';
+import type { FetchError } from '@osskit/fetch-enhancers';
+import { replaceUrlValues } from 'replace-url-values';
+import { serviceName } from './environment.js';
+
+const retryCounter = new Counter({
+  name: `${serviceName.replaceAll('-', '_')}_retries`,
+  help: 'service retry counter',
+  labelNames: ['path', 'reason', 'attempt'],
+});
+
+export default (err: FetchError) => {
+  retryCounter.inc({
+    path: err.url ? replaceUrlValues(err.url) : 'unknown',
+    reason: err.data?.status ?? 'unknown',
+    attempt: err.data?.attempt,
+  });
+};

yarn.lock

@@ -780,6 +780,15 @@
     fastify-plugin "^3.0.1"
     http-errors "^2.0.0"
 
+"@osskit/fetch-enhancers@^3.0.0":
+  version "3.0.0"
+  resolved "https://registry.yarnpkg.com/@osskit/fetch-enhancers/-/fetch-enhancers-3.0.0.tgz#289766890a1ba32716c2af5fc1a1805b38cc7a04"
+  integrity sha512-2oTOclJS9BEdZ6AZSOOgSQ1DJimGvZ5K7UZIwhDSGglJOgoyXTjcGr4wCXvDZEd6ZtmOFl0YazkSf5h/9h0X7w==
+  dependencies:
+    abort-controller "^3.0.0"
+    async-retry "^1.3.3"
+    lodash.clonedeep "^4.5.0"
+
 "@osskit/monitor@^5.0.0":
   version "5.0.0"
   resolved "https://registry.yarnpkg.com/@osskit/monitor/-/monitor-5.0.0.tgz#26581986074f7ad54b6b8264e9438a05197fd549"
@@ -1320,6 +1329,13 @@ async-hook-jl@^1.7.6:
   dependencies:
     stack-chain "^1.3.7"
 
+async-retry@^1.3.3:
+  version "1.3.3"
+  resolved "https://registry.yarnpkg.com/async-retry/-/async-retry-1.3.3.tgz#0e7f36c04d8478e7a58bdbed80cedf977785f280"
+  integrity sha512-wfr/jstw9xNi/0teMHrRW7dsz3Lt5ARhYNZ2ewpadnhaIp5mbALhOAP+EAdsC7t4Z6wqsDVv9+W6gm1Dk9mEyw==
+  dependencies:
+    retry "0.13.1"
+
 asynchronous-local-storage@^1.0.2:
   version "1.0.2"
   resolved "https://registry.yarnpkg.com/asynchronous-local-storage/-/asynchronous-local-storage-1.0.2.tgz#df2491534707566e039e2508a019b6e348ef49cc"
@@ -3839,6 +3855,11 @@ locate-path@^5.0.0:
   dependencies:
     p-locate "^4.1.0"
 
+lodash.clonedeep@^4.5.0:
+  version "4.5.0"
+  resolved "https://registry.yarnpkg.com/lodash.clonedeep/-/lodash.clonedeep-4.5.0.tgz#e23f3f9c4f8fbdde872529c1071857a086e5ccef"
+  integrity sha512-H5ZhCF25riFd9uB5UCkVKo61m3S/xZk1x4wA6yp/L3RFP6Z/eHH1ymQcGLo7J3GMPfm0V/7m1tryHuGVxpqEBQ==
+
 lodash.memoize@4.x:
   version "4.1.2"
   resolved "https://registry.yarnpkg.com/lodash.memoize/-/lodash.memoize-4.1.2.tgz#bcc6c49a42a2840ed997f323eada5ecd182e0bfe"
@@ -4663,6 +4684,11 @@ registry-url@^5.0.0:
   dependencies:
     rc "^1.2.8"
 
+replace-url-values@^1.0.0:
+  version "1.0.0"
+  resolved "https://registry.yarnpkg.com/replace-url-values/-/replace-url-values-1.0.0.tgz#e8210935fd9b9d66ebd59c16b4b35258f59146c7"
+  integrity sha512-tH0mBmjqC22ZLQMiVdnPdHQs1PrrJwUBXECj8Gjal4JVd34fa4Qx1sw5ATKsUHxMg8yDJ+Y84NOzUuRI9GtPvA==
+
 require-directory@^2.1.1:
   version "2.1.1"
   resolved "https://registry.yarnpkg.com/require-directory/-/require-directory-2.1.1.tgz#8c64ad5fd30dab1c976e2344ffe7f792a6a6df42"
@@ -4724,6 +4750,11 @@ ret@~0.2.0:
   resolved "https://registry.yarnpkg.com/ret/-/ret-0.2.2.tgz#b6861782a1f4762dce43402a71eb7a283f44573c"
   integrity sha512-M0b3YWQs7R3Z917WRQy1HHA7Ba7D8hvZg6UE5mLykJxQVE2ju0IXbGlaHPPlkY+WN7wFP+wUMXmBFA0aV6vYGQ==
 
+retry@0.13.1:
+  version "0.13.1"
+  resolved "https://registry.yarnpkg.com/retry/-/retry-0.13.1.tgz#185b1587acf67919d63b357349e03537b2484658"
+  integrity sha512-XQBQ3I8W1Cge0Seh+6gjj03LbmRFWuoszgK9ooCpwYIrhhoO80pfq4cUkU5DkknwfOfFteRwlZ56PYOGYyFWdg==
+
 reusify@^1.0.4:
   version "1.0.4"
   resolved "https://registry.yarnpkg.com/reusify/-/reusify-1.0.4.tgz#90da382b1e126efc02146e90845a88db12925d76"