@oas-tools/oas-telemetry 0.1.9 → 0.2.0

package/README.md

@@ -55,7 +55,7 @@ OAS Telemetry middleware adds the following endpoints to your Express applicatio
 - /telemetry/heapStats: Shows v8 heapStats.
 
 
-## Simple Example
+## Simple Example [ES Module](https://nodejs.org/docs/latest/api/esm.html) (*.mjs)
 ```js index.mjs
 import oasTelemetry from '@oas-tools/oas-telemetry';
 import express from 'express';
@@ -93,3 +93,41 @@ app.listen(port, () => {
 });
 ```
 
+## Simple Example [Common.js Module](https://nodejs.org/docs/latest/api/modules.html) (*.cjs)
+```js index.cjs
+let oasTelemetry = require('@oas-tools/oas-telemetry');
+let express = require('express');
+
+const app = express();
+const port = 3000;
+
+const spec = { "paths": {
+                    "/api/v1/pets": {
+                        "get": {
+                            "summary": "Get pets",
+                            "responses":{
+                                "200": {
+                                    "description": "Success"
+                                }
+                            }
+                        }
+                    }
+                }
+            }
+
+app.use(oasTelemetry({
+    spec : JSON.stringify(spec)
+}))
+
+app.use(express.json());
+
+app.get("/api/v1/pets", (req, res) => {
+    res.send([{ name: "rocky"},{ name: "pikachu"}]);
+});
+
+app.listen(port, () => {
+    console.log(`Example app listening at http://localhost:${port}`);
+    console.log(`Telemetry portal available at http://localhost:${port}/telemetry`);
+});
+```
+

package/dist/index.cjs

@@ -10,6 +10,7 @@ var _v = _interopRequireDefault(require("v8"));
 var _fs = require("fs");
 var _path = _interopRequireDefault(require("path"));
 var _jsYaml = _interopRequireDefault(require("js-yaml"));
+var _url = require("url");
 var _ui = _interopRequireDefault(require("./ui.cjs"));
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
 // telemetryMiddleware.js
@@ -34,14 +35,17 @@ function oasTelemetry(tlConfig) {
     }
   }
   const router = (0, _express.Router)();
+
+  //const baseURL = telemetryConfig.baseURL;
+
   router.get(baseURL, mainPage);
   router.get(baseURL + "/detail/*", detailPage);
   router.get(baseURL + "/spec", specLoader);
   router.get(baseURL + "/api", apiPage);
-  router.get(baseURL + "/reset", resetTelemetry);
   router.get(baseURL + "/start", startTelemetry);
   router.get(baseURL + "/stop", stopTelemetry);
   router.get(baseURL + "/status", statusTelemetry);
+  router.get(baseURL + "/reset", resetTelemetry);
   router.get(baseURL + "/list", listTelemetry);
   router.post(baseURL + "/find", findTelemetry);
   router.get(baseURL + "/heapStats", heapStats);
@@ -63,9 +67,11 @@ const apiPage = (req, res) => {
   res.send(text);
 };
 const mainPage = (req, res) => {
+  res.set('Content-Type', 'text/html');
   res.send((0, _ui.default)().main);
 };
 const detailPage = (req, res) => {
+  res.set('Content-Type', 'text/html');
   res.send((0, _ui.default)().detail);
 };
 const specLoader = (req, res) => {
@@ -84,7 +90,7 @@ const specLoader = (req, res) => {
       console.log(`ERROR loading spec file ${telemetryConfig.specFileName}: ${e}`);
     }
   } else {
-    if (typeof telemetryConfig.spec === 'string' || telemetryConfig.spec instanceof String) {
+    if (telemetryConfig.spec) {
       let spec = false;
       try {
         spec = JSON.parse(telemetryConfig.spec);
@@ -101,11 +107,6 @@ const specLoader = (req, res) => {
         res.setHeader('Content-Type', 'application/json');
         res.send(spec);
       }
-    } else if (typeof telemetryConfig.spec === 'object') {
-      res.setHeader('Content-Type', 'application/json');
-      res.send(telemetryConfig.spec);
-    } else {
-      res.status(404);
     }
   }
 };

package/dist/telemetry.cjs

@@ -12,35 +12,12 @@ var _instrumentationHttp = require("@opentelemetry/instrumentation-http");
 var _InMemoryDbExporter = require("./exporters/InMemoryDbExporter.cjs");
 // import { getNodeAutoInstrumentations } from '@opentelemetry/auto-instrumentations-node';
 
-// initialize the SDK and register with the OpenTelemetry API
-// import { NodeTracerProvider } from '@opentelemetry/sdk-trace-node';
-// import { SimpleSpanProcessor } from '@opentelemetry/sdk-trace-base';
-
 // Create an in-memory span exporter
 const inMemoryExporter = exports.inMemoryExporter = new _InMemoryDbExporter.InMemoryExporter();
-// configure the SDK to export telemetry data to the console
-// enable all auto-instrumentations from the meta package
 const traceExporter = inMemoryExporter;
 const sdk = new _sdkNode.NodeSDK({
   resource: new _resources.Resource(),
   traceExporter,
   instrumentations: [new _instrumentationHttp.HttpInstrumentation()]
 });
-sdk.start();
-// Create a tracer provider
-// const tracerProvider = new NodeTracerProvider({
-//   resource: new Resource({
-//     [SemanticResourceAttributes.SERVICE_NAME]: 'basic-service',
-//   }),
-//   instrumentations: [new HttpInstrumentation()],
-// });
-
-// // maybe BatchSpanProcessorBase
-// tracerProvider.addSpanProcessor(new SimpleSpanProcessor(inMemoryExporter));
-
-// // Register the tracer provider
-// tracerProvider.register();
-
-//WARNING: this is configured with batchSpanProcessor, it takes 5 seconds to flush the spans
-// import {startTracesInstrumentation} from '@restsense/agent/api'
-// startTracesInstrumentation(inMemoryExporter,resource);
+sdk.start();