Add metrics to JS getting started (#2576)

Signed-off-by: svrnm <[email protected]> Co-authored-by: Marc Pichler <[email protected]> Co-authored-by: Patrice Chalin <[email protected]>
open-telemetry · Apr 11, 2023 · 2403de2 · 2403de2
1 parent 72fa1cf
commit 2403de2
Show file tree

Hide file tree

Showing 2 changed files with 88 additions and 23 deletions.
diff --git a/content/en/docs/instrumentation/js/exporters.md b/content/en/docs/instrumentation/js/exporters.md
@@ -15,28 +15,35 @@ matching exporters.
 
 To send trace data to a OTLP endpoint (like the [collector](/docs/collector) or
 Jaeger) you'll want to use an exporter package, such as
-`@opentelemetry/exporter-trace-otlp-http`:
+`@opentelemetry/exporter-trace-otlp-proto`:
 
 ```shell
-npm install --save @opentelemetry/exporter-trace-otlp-http
+npm install --save @opentelemetry/exporter-trace-otlp-proto \
+  opentelemetry/exporter-metrics-otlp-proto
 ```
 
 Next, configure the exporter to point at an OTLP endpoint. For example you can
-update `tracing.ts|js` from the
+update `instrumentation.ts|js` from the
 [Getting Started](/docs/instrumentation/js/getting-started/nodejs/) like the
 following:
 
 <!-- prettier-ignore-start -->
 {{< tabpane langEqualsHeader=true >}}
 {{< tab Typescript >}}
 /*tracing.ts*/
-import * as opentelemetry from '@opentelemetry/sdk-node';
+import * as opentelemetry from "@opentelemetry/sdk-node";
 import {
   getNodeAutoInstrumentations,
 } from "@opentelemetry/auto-instrumentations-node";
 import {
   OTLPTraceExporter,
-} from "@opentelemetry/exporter-trace-otlp-http";
+} from "@opentelemetry/exporter-trace-otlp-proto";
+import {
+  OTLPMetricExporter
+} from "@opentelemetry/exporter-metrics-otlp-proto";
+import {
+  PeriodicExportingMetricReader
+} from "@opentelemetry/sdk-metrics";
 
 const sdk = new opentelemetry.NodeSDK({
   traceExporter: new OTLPTraceExporter({
@@ -45,6 +52,12 @@ const sdk = new opentelemetry.NodeSDK({
     // optional - collection of custom headers to be sent with each request, empty by default
     headers: {},
   }),
+  metricReader: new PeriodicExportingMetricReader({
+    exporter: new OTLPMetricExporter({
+      url: '<your-otlp-endpoint>/v1/metrics', // url is optional and can be omitted - default is http://localhost:4318/v1/metrics
+      headers: {}, // an optional object containing custom headers to be sent with each request
+    }),
+  }),
   instrumentations: [getNodeAutoInstrumentations()],
 });
 sdk.start();
@@ -58,7 +71,10 @@ const {
 } = require("@opentelemetry/auto-instrumentations-node");
 const {
   OTLPTraceExporter,
-} = require("@opentelemetry/exporter-trace-otlp-http");
+} = require("@opentelemetry/exporter-trace-otlp-proto");
+const {
+  OTLPMetricExporter
+} = require("@opentelemetry/exporter-metrics-otlp-proto");
 
 const sdk = new opentelemetry.NodeSDK({
   traceExporter: new OTLPTraceExporter({
@@ -67,6 +83,13 @@ const sdk = new opentelemetry.NodeSDK({
     // optional - collection of custom headers to be sent with each request, empty by default
     headers: {},
   }),
+  metricReader: new PeriodicExportingMetricReader({
+    exporter: new OTLPMetricExporter({
+      url: '<your-otlp-endpoint>/v1/metrics', // url is optional and can be omitted - default is http://localhost:4318/v1/metrics
+      headers: {}, // an optional object containing custom headers to be sent with each request
+      concurrencyLimit: 1, // an optional limit on pending requests
+    }),
+  }),
   instrumentations: [getNodeAutoInstrumentations()],
 });
 sdk.start();

diff --git a/content/en/docs/instrumentation/js/getting-started/nodejs.md b/content/en/docs/instrumentation/js/getting-started/nodejs.md
@@ -4,7 +4,7 @@ aliases: [/docs/js/getting_started/nodejs]
 weight: 2
 ---
 
-This guide will show you how to get started with tracing in Node.js.
+This page will show you how to get started with OpenTelemetry in Node.js.
 
 ## Prerequisites
 
@@ -113,17 +113,17 @@ Listening for requests on http://localhost:8080
 {{< /tabpane >}}
 <!-- prettier-ignore-end -->
 
-## Tracing
+## Instrumentation
 
 The following shows how to install, initialize, and run an application
-instrumented with traces.
+instrumented with OpenTelemetry.
 
 ### Dependencies
 
 First, install the Node SDK and autoinstrumentations package.
 
-The Node SDK lets you intialize OpenTelemetry with several configuration
-defaults that are correct for the majorty of use cases.
+The Node SDK lets you initialize OpenTelemetry with several configuration
+defaults that are correct for the majority of use cases.
 
 The `auto-instrumentations-node` package installs instrumentation packages that
 will automatically create spans corresponding to code called in libraries. In
@@ -132,32 +132,38 @@ automatically create spans for each incoming request.
 
 ```shell
 npm install @opentelemetry/sdk-node \
-  @opentelemetry/auto-instrumentations-node
+  @opentelemetry/auto-instrumentations-node \
+  @opentelemetry/sdk-metrics
 ```
 
 To find all autoinstrumentation modules, you can look at the
 [registry](/ecosystem/registry/?language=js&component=instrumentation).
 
 ### Setup
 
-The tracing setup and configuration must be run _before_ your application code.
-One tool commonly used for this task is the
+The instrumentation setup and configuration must be run _before_ your
+application code. One tool commonly used for this task is the
 [`-r, --require module`](https://nodejs.org/api/cli.html#cli_r_require_module)
 flag.
 
-Create a file named `tracing.ts|js`, which will contain your tracing setup code.
+Create a file named `instrumentation.ts|js`, which will contain your
+instrumentation setup code.
 
 <!-- prettier-ignore-start -->
 {{< tabpane langEqualsHeader=true >}}
 
 {{< tab TypeScript >}}
-/*tracing.ts*/
+/*instrumentation.ts*/
 import { NodeSDK } from '@opentelemetry/sdk-node';
 import { ConsoleSpanExporter } from '@opentelemetry/sdk-trace-node';
 import { getNodeAutoInstrumentations } from '@opentelemetry/auto-instrumentations-node';
+import { PeriodicExportingMetricReader } from '@opentelemetry/sdk-metrics';
 
 const sdk = new NodeSDK({
   traceExporter: new ConsoleSpanExporter(),
+  metricReader: new PeriodicExportingMetricReader({
+    exporter: new opentelemetry.metrics.ConsoleMetricExporter()
+  }),
   instrumentations: [getNodeAutoInstrumentations()]
 });
 
@@ -167,19 +173,22 @@ sdk
 {{< /tab >}}
 
 {{< tab JavaScript >}}
-/*tracing.js*/
+/*instrumentation.js*/
 // Require dependencies
 const opentelemetry = require("@opentelemetry/sdk-node");
 const { getNodeAutoInstrumentations } = require("@opentelemetry/auto-instrumentations-node");
+const { PeriodicExportingMetricReader } = require('@opentelemetry/sdk-metrics');
 
 const sdk = new opentelemetry.NodeSDK({
   traceExporter: new opentelemetry.tracing.ConsoleSpanExporter(),
+  metricReader: new PeriodicExportingMetricReader({
+    exporter: new opentelemetry.metrics.ConsoleMetricExporter()
+  }),
   instrumentations: [getNodeAutoInstrumentations()]
 });
 
 sdk
   .start()
-
 {{< /tab >}}
 
 {{< /tabpane >}}
@@ -188,18 +197,18 @@ sdk
 ### Run Application
 
 Now you can run your application as you normally would, but you can use the
-`--require` flag to load the tracing code before the application code.
+`--require` flag to load the instrumentation before the application code.
 
 <!-- prettier-ignore-start -->
 {{< tabpane lang=console persistLang=false >}}
 
 {{< tab TypeScript >}}
-$ ts-node --require ./tracing.ts app.ts
+$ ts-node --require ./instrumentation.ts app.ts
 Listening for requests on http://localhost:8080
 {{< /tab >}}
 
 {{< tab JavaScript >}}
-$ node --require ./tracing.js app.js
+$ node --require ./instrumentation.js app.js
 Listening for requests on http://localhost:8080
 {{< /tab >}}
 
@@ -290,6 +299,39 @@ times, after a while you should see the spans printed in the console by the
   "status": { "code": 1 },
   "events": []
 }
+{
+  descriptor: {
+    name: 'http.server.duration',
+    type: 'HISTOGRAM',
+    description: 'measures the duration of the inbound HTTP requests',
+    unit: 'ms',
+    valueType: 1
+  },
+  dataPointType: 0,
+  dataPoints: []
+}
+{
+  descriptor: {
+    name: 'http.client.duration',
+    type: 'HISTOGRAM',
+    description: 'measures the duration of the outbound HTTP requests',
+    unit: 'ms',
+    valueType: 1
+  },
+  dataPointType: 0,
+  dataPoints: []
+}
+{
+  descriptor: {
+    name: 'db.client.connections.usage',
+    type: 'UP_DOWN_COUNTER',
+    description: 'The number of connections that are currently in the state referenced by the attribute "state".',
+    unit: '{connections}',
+    valueType: 1
+  },
+  dataPointType: 3,
+  dataPoints: []
+}
 ```
 
 </details>
@@ -313,7 +355,7 @@ OpenTelemetry is initialized correctly:
 {{< tabpane langEqualsHeader=true >}}
 
 {{< tab TypeScript >}}
-/*tracing.ts*/
+/*instrumentation.ts*/
 import { diag, DiagConsoleLogger, DiagLogLevel } from '@opentelemetry/api';
 
 // For troubleshooting, set the log level to DiagLogLevel.DEBUG
@@ -323,7 +365,7 @@ diag.setLogger(new DiagConsoleLogger(), DiagLogLevel.INFO);
 {{< /tab >}}
 
 {{< tab JavaScript >}}
-/*tracing.js*/
+/*instrumentation.js*/
 // Require dependencies
 const { diag, DiagConsoleLogger, DiagLogLevel } = require('@opentelemetry/api');