feat: parse log severity number

Author: wrn14897

package.json

@@ -31,6 +31,7 @@
     "eslint": "^8.42.0",
     "eslint-config-prettier": "^8.8.0",
     "eslint-plugin-jest": "^27.2.1",
+    "eslint-plugin-simple-import-sort": "^12.1.1",
     "husky": "^8.0.3",
     "jest": "^29.5.0",
     "lint-staged": "^13.2.2",

packages/node-opentelemetry/.eslintrc.json

@@ -10,7 +10,7 @@
     "sourceType": "module",
     "ecmaVersion": 2020
   },
-  "plugins": ["@typescript-eslint", "jest"],
+  "plugins": ["@typescript-eslint", "jest", "simple-import-sort"],
   "extends": [
     "eslint:recommended",
     "plugin:@typescript-eslint/recommended",
@@ -24,6 +24,8 @@
     // https://typescript-eslint.io/rules/explicit-function-return-type/
     "@typescript-eslint/explicit-function-return-type": "warn",
     "@typescript-eslint/ban-ts-comment": "warn",
-    "@typescript-eslint/no-this-alias": "warn"
+    "@typescript-eslint/no-this-alias": "warn",
+    "simple-import-sort/imports": "error",
+    "simple-import-sort/exports": "error"
   }
 }

packages/node-opentelemetry/bin/opentelemetry-instrument.ts

@@ -1,7 +1,7 @@
 #!/usr/bin/env node
 
-import process from 'process';
 import fs from 'fs';
+import process from 'process';
 import { promisify } from 'util';
 
 const realpath = promisify(fs.realpath);

packages/node-opentelemetry/src/MutableAsyncLocalStorageContextManager.ts

@@ -16,6 +16,7 @@
 
 import { Context, ROOT_CONTEXT } from '@opentelemetry/api';
 import { AsyncLocalStorage } from 'async_hooks';
+
 import { AbstractAsyncHooksContextManager } from './AbstractAsyncHooksContextManager';
 
 type MutableContextStore = {

packages/node-opentelemetry/src/constants.ts

@@ -1,5 +1,5 @@
+import { getEnv, getEnvWithoutDefaults } from '@opentelemetry/core';
 import { defaultServiceName } from '@opentelemetry/resources';
-import { getEnvWithoutDefaults, getEnv } from '@opentelemetry/core';
 
 import { stringToBoolean } from './utils';
 

packages/node-opentelemetry/src/gcp.ts

@@ -1,8 +1,8 @@
+import { context, SpanKind, trace } from '@opentelemetry/api';
 import { SemanticAttributes } from '@opentelemetry/semantic-conventions';
-import { SpanKind, context, trace } from '@opentelemetry/api';
 
-import { SDKConfig, initSDK } from './otel';
 import { name as PKG_NAME, version as PKG_VERSION } from '../package.json';
+import { initSDK, SDKConfig } from './otel';
 
 export const registerGCPCloudFunctionEventHandler = (
   handler: (event: any) => Promise<void>,

packages/node-opentelemetry/src/instrumentations/console.ts

@@ -1,15 +1,15 @@
-import isObject from 'lodash.isobject';
-import isPlainObject from 'lodash.isplainobject';
 import opentelemetry, { Attributes } from '@opentelemetry/api';
 import {
   InstrumentationBase,
   InstrumentationConfig,
   InstrumentationNodeModuleDefinition,
 } from '@opentelemetry/instrumentation';
+import isObject from 'lodash.isobject';
+import isPlainObject from 'lodash.isplainobject';
 
+import { MutableAsyncLocalStorageContextManager } from '../MutableAsyncLocalStorageContextManager';
 import { Logger, LoggerOptions } from '../otel-logger';
 import { parseWinstonLog } from '../otel-logger/winston';
-import { MutableAsyncLocalStorageContextManager } from '../MutableAsyncLocalStorageContextManager';
 
 const PACKAGE_NAME = '@hyperdx/instrumentation-console';
 const PACKAGE_VERSION = '0.1.0';

packages/node-opentelemetry/src/instrumentations/http.ts

@@ -1,9 +1,8 @@
+import { diag, Span } from '@opentelemetry/api';
+import { headerCapture } from '@opentelemetry/instrumentation-http';
 import * as http from 'http';
-import zlib from 'zlib';
 import { PassThrough, Readable } from 'stream';
-
-import { Span, diag } from '@opentelemetry/api';
-import { headerCapture } from '@opentelemetry/instrumentation-http';
+import zlib from 'zlib';
 
 const SENSITIVE_DATA_SUBSTITUTE = '[Filtered]';
 // https://github.com/getsentry/sentry-python/blob/1.18.0/sentry_sdk/scrubber.py#L17

packages/node-opentelemetry/src/logger.ts

@@ -5,11 +5,10 @@ import {
   DEFAULT_HDX_NODE_BETA_MODE,
   DEFAULT_SERVICE_NAME,
 } from './constants';
-import * as HyperDXPino from './otel-logger/pino';
-import HyperDXWinston from './otel-logger/winston';
-
 import type { HyperDXPinoOptions } from './otel-logger/pino';
+import * as HyperDXPino from './otel-logger/pino';
 import type { HyperDXWinstonOptions } from './otel-logger/winston';
+import HyperDXWinston from './otel-logger/winston';
 
 type WinstonTransportOptions = Omit<
   HyperDXWinstonOptions,

packages/node-opentelemetry/src/otel-logger/index.ts

@@ -1,22 +1,28 @@
 import { Attributes, diag } from '@opentelemetry/api';
-import { getEnvWithoutDefaults } from '@opentelemetry/core';
 import {
-  BatchLogRecordProcessor,
-  LoggerProvider,
-  NoopLogRecordProcessor,
-} from '@opentelemetry/sdk-logs';
-import { Logger as OtelLogger, logs } from '@opentelemetry/api-logs';
+  LogAttributes,
+  Logger as OtelLogger,
+  logs,
+  SeverityNumber,
+} from '@opentelemetry/api-logs';
+import { getEnvWithoutDefaults } from '@opentelemetry/core';
 import { OTLPLogExporter } from '@opentelemetry/exporter-logs-otlp-http';
 import {
-  Resource,
   detectResourcesSync,
   envDetectorSync,
   hostDetectorSync,
   osDetectorSync,
   processDetector,
+  Resource,
 } from '@opentelemetry/resources';
+import {
+  BatchLogRecordProcessor,
+  LoggerProvider,
+  NoopLogRecordProcessor,
+} from '@opentelemetry/sdk-logs';
 import { SEMRESATTRS_SERVICE_NAME } from '@opentelemetry/semantic-conventions';
 
+import { version as PKG_VERSION } from '../../package.json';
 import {
   DEFAULT_EXPORTER_BATCH_SIZE,
   DEFAULT_EXPORTER_TIMEOUT_MS,
@@ -25,7 +31,6 @@ import {
   DEFAULT_SEND_INTERVAL_MS,
   DEFAULT_SERVICE_NAME,
 } from '../constants';
-import { version as PKG_VERSION } from '../../package.json';
 
 const LOG_PREFIX = `⚠️  [LOGGER]`;
 
@@ -41,6 +46,45 @@ export type LoggerOptions = {
   timeout?: number; // The read/write/connection timeout in milliseconds
 };
 
+// https://github.com/open-telemetry/opentelemetry-js-contrib/blob/afccd0d62a0ea81afb8f5609f3ee802c038d11c6/packages/winston-transport/src/utils.ts
+const npmLevels: Record<string, number> = {
+  error: SeverityNumber.ERROR,
+  warn: SeverityNumber.WARN,
+  info: SeverityNumber.INFO,
+  http: SeverityNumber.DEBUG3,
+  verbose: SeverityNumber.DEBUG2,
+  debug: SeverityNumber.DEBUG,
+  silly: SeverityNumber.TRACE,
+};
+
+const sysLoglevels: Record<string, number> = {
+  emerg: SeverityNumber.FATAL3,
+  alert: SeverityNumber.FATAL2,
+  crit: SeverityNumber.FATAL,
+  error: SeverityNumber.ERROR,
+  warning: SeverityNumber.WARN,
+  notice: SeverityNumber.INFO2,
+  info: SeverityNumber.INFO,
+  debug: SeverityNumber.DEBUG,
+};
+
+const cliLevels: Record<string, number> = {
+  error: SeverityNumber.ERROR,
+  warn: SeverityNumber.WARN,
+  help: SeverityNumber.INFO3,
+  data: SeverityNumber.INFO2,
+  info: SeverityNumber.INFO,
+  debug: SeverityNumber.DEBUG,
+  prompt: SeverityNumber.TRACE4,
+  verbose: SeverityNumber.TRACE3,
+  input: SeverityNumber.TRACE2,
+  silly: SeverityNumber.TRACE,
+};
+
+function getSeverityNumber(level: string): SeverityNumber | undefined {
+  return npmLevels[level] ?? sysLoglevels[level] ?? cliLevels[level];
+}
+
 export class Logger {
   private readonly _url: string;
 
@@ -155,15 +199,25 @@ export class Logger {
     return this.processor.forceFlush();
   }
 
-  postMessage(level: string, body: string, attributes: Attributes = {}): void {
+  postMessage(
+    level: string,
+    body: string,
+    meta: Record<string, any> = {},
+  ): void {
+    const attributes: LogAttributes = {};
+    for (const key in meta) {
+      if (Object.prototype.hasOwnProperty.call(meta, key)) {
+        attributes[key] = meta[key];
+      }
+    }
     this.logger.emit({
       // TODO: should map to otel severity number
-      severityNumber: 0,
+      severityNumber: getSeverityNumber(level),
       // TODO: set up the mapping between different downstream log levels
       severityText: level,
       body,
       attributes,
-      timestamp: this.parseTimestamp(attributes),
+      timestamp: this.parseTimestamp(meta),
     });
   }
 }