@oas-tools/oas-telemetry 0.1.3 → 0.1.4

package/README.md

@@ -1,6 +1,6 @@
 # OAS TELEMETRY
 
-OAS Telemetry offer an express middleware designed for collecting telemetry data using Open Telemetry in applications built using the OpenAPI Specification (OAS). This middleware allows developers to easily incorporate telemetry functionality into their APIs.
+OAS Telemetry offers an express middleware designed for collecting telemetry data using Open Telemetry in applications built using the OpenAPI Specification (OAS). This middleware allows developers to easily incorporate telemetry functionality into their APIs.
 
 OAS Telemetry provides a set of endpoints that can be accessed to perform various actions related to telemetry data, such as starting and stopping data collection, resetting telemetry data, listing collected data, and searching for specific telemetry records. These endpoints can be easily integrated into an Express.js application, providing developers with a convenient way to manage and analyze telemetry data.
 
@@ -53,11 +53,12 @@ OAS Telemetry middleware adds the following endpoints to your Express applicatio
 - /telemetry/reset: Reset telemetry data.
 - /telemetry/list: List all telemetry data.
 - /telemetry/find (POST): Search telemetry data.
+- /telemetry/heapStats: Shows v8 heapStats.
 
 ## CommonJs Example
 ```js index.cjs
 // this MUST be the first line in your file (before any imports)
-const oasTelemetry = require('oas-telemetry');
+const oasTelemetry = require('@oas-tools/oas-telemetry');
 
 const express = require('express');
 const app = express();
@@ -79,7 +80,7 @@ app.listen(port, () => {
 ## ESM Example
 ```js index.mjs
 // simple express API in ES6 Syntax
-import oasTelemetry from 'oas-telemetry';
+import oasTelemetry from '@oas-tools/oas-telemetry';
 import express from 'express';
 const app = express();
 const port = 3000;

package/dist/index.cjs

@@ -39,6 +39,7 @@ const landingPage = (req, res) => {
         <li><a href="/telemetry/stop">/telemetry/stop</a></li>
         <li><a href="/telemetry/reset">/telemetry/reset</a></li>
         <li><a href="/telemetry/list">/telemetry/list</a></li>
+        <li><a href="/telemetry/heapStats">/telemetry/heapStats</a></li>
         <li>/telemetry/find [POST]</li>
     </ul>
     `;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@oas-tools/oas-telemetry",
-  "version": "0.1.3",
-  "description": "This package export an express midelware that allows to trace the requests and responses of an express application using OpenTelemetry",
+  "version": "0.1.4",
+  "description": "This package exports an express midelware that allows to trace the requests and responses of an express application using OpenTelemetry",
   "author": "Manuel Otero",
   "contributors": [
     "Alejandro Santisteban"

package/src/index.js

@@ -35,6 +35,7 @@ const landingPage = (req, res) => {
         <li><a href="/telemetry/stop">/telemetry/stop</a></li>
         <li><a href="/telemetry/reset">/telemetry/reset</a></li>
         <li><a href="/telemetry/list">/telemetry/list</a></li>
+        <li><a href="/telemetry/heapStats">/telemetry/heapStats</a></li>
         <li>/telemetry/find [POST]</li>
     </ul>
     `;