Code formatting with prettier (#4)

* Setup prettier, pre-commit hooks

* Remove husky, add lint step in CI/CD

* Prettier changes

* Tweak README with link and version

* Fix homepage and repo url

.eslintrc.json

@@ -1,5 +1,9 @@
 {
-  "extends": ["eslint:recommended", "plugin:@typescript-eslint/recommended"],
+  "extends": [
+    "eslint:recommended",
+    "plugin:@typescript-eslint/recommended",
+    "prettier"
+  ],
   "parser": "@typescript-eslint/parser",
   "plugins": ["@typescript-eslint"],
   "root": true

.github/dependabot.yml

@@ -5,11 +5,11 @@
 
 version: 2
 updates:
-  - package-ecosystem: "npm" # See documentation for possible values
-    directory: "/" # Location of package manifests
+  - package-ecosystem: 'npm' # See documentation for possible values
+    directory: '/' # Location of package manifests
     schedule:
-      interval: "weekly"
-  - package-ecosystem: "github-actions"
-    directory: "/"
+      interval: 'weekly'
+  - package-ecosystem: 'github-actions'
+    directory: '/'
     schedule:
-      interval: "weekly"
+      interval: 'weekly'

.github/workflows/main.yml

@@ -9,7 +9,7 @@ on:
       - main
       - release
     tags:
-      - "beta-v*"
+      - 'beta-v*'
   pull_request:
     # Trigger only for PRs that target main branch
     branches:
@@ -24,6 +24,7 @@ jobs:
         with:
           node-version: 18
       - run: npm ci
+      - run: npm run lint
       - run: npm test --if-present
 
   publish-npm:

.prettierignore

@@ -0,0 +1,13 @@
+node_modules
+**/**/node_modules
+
+*.lock
+*.log
+
+.gitignore
+.npmignore
+.prettierignore
+.DS_Store
+.eslintignore
+
+**/LICENSE

.prettierrc.js

@@ -0,0 +1,11 @@
+module.exports = {
+  bracketSpacing: true,
+  bracketSameLine: true,
+  singleQuote: true,
+  jsxSingleQuote: true,
+  trailingComma: 'es5',
+  semi: true,
+  printWidth: 110,
+  arrowParens: 'always',
+  importOrderSeparation: true,
+};

README.md

@@ -1,2 +1,5 @@
-# metrics
+# @boxyhq/metrics
+
+<a href="https://www.npmjs.com/package/@boxyhq/metrics"><img src="https://img.shields.io/npm/v/@boxyhq/metrics.svg" alt="npm" ></a>
+
 Package for OTel instrumentation

package.json

@@ -9,22 +9,22 @@
   ],
   "scripts": {
     "build": "tsc -p tsconfig.json",
-    "prepublishOnly": "npm run build"
+    "prepublishOnly": "npm run build",
+    "lint": "eslint -c .eslintrc.json --ext .ts ./"
   },
   "repository": {
     "type": "git",
-    "url": "git+https://github.com/boxyhq/jackson.git",
-    "directory": "metrics"
+    "url": "git+https://github.com/boxyhq/metrics.git"
   },
   "keywords": [
     "otel",
     "telemetry"
   ],
   "license": "Apache-2.0",
   "bugs": {
-    "url": "https://github.com/boxyhq/jackson/issues"
+    "url": "https://github.com/boxyhq/metrics/issues"
   },
-  "homepage": "https://github.com/boxyhq/jackson#readme",
+  "homepage": "https://github.com/boxyhq/metrics#readme",
   "dependencies": {
     "@opentelemetry/api": "1.4.1",
     "@opentelemetry/exporter-metrics-otlp-grpc": "0.37.0",
@@ -38,6 +38,8 @@
     "@typescript-eslint/eslint-plugin": "5.57.1",
     "@typescript-eslint/parser": "5.57.1",
     "eslint": "8.38.0",
+    "eslint-config-prettier": "8.8.0",
+    "prettier": "2.8.7",
     "typescript": "5.0.4"
   }
 }

src/index.ts

@@ -1,2 +1,2 @@
-export * from "./init";
-export * from "./instruments";
+export * from './init';
+export * from './instruments';

src/init.ts

@@ -1,17 +1,9 @@
-import {
-  DiagConsoleLogger,
-  DiagLogLevel,
-  diag,
-  metrics,
-} from "@opentelemetry/api";
-import { OTLPMetricExporter } from "@opentelemetry/exporter-metrics-otlp-http";
-import { OTLPMetricExporter as OTLPMetricExporterGRPC } from "@opentelemetry/exporter-metrics-otlp-grpc";
-import {
-  MeterProvider,
-  PeriodicExportingMetricReader,
-} from "@opentelemetry/sdk-metrics";
-import { Resource } from "@opentelemetry/resources";
-import { SemanticResourceAttributes } from "@opentelemetry/semantic-conventions";
+import { DiagConsoleLogger, DiagLogLevel, diag, metrics } from '@opentelemetry/api';
+import { OTLPMetricExporter } from '@opentelemetry/exporter-metrics-otlp-http';
+import { OTLPMetricExporter as OTLPMetricExporterGRPC } from '@opentelemetry/exporter-metrics-otlp-grpc';
+import { MeterProvider, PeriodicExportingMetricReader } from '@opentelemetry/sdk-metrics';
+import { Resource } from '@opentelemetry/resources';
+import { SemanticResourceAttributes } from '@opentelemetry/semantic-conventions';
 
 type ServiceInfo = {
   name: string;
@@ -25,10 +17,7 @@ type ServiceInfo = {
  */
 
 function initializeMetrics(serviceInfo: ServiceInfo) {
-  if (
-    process.env.OTEL_EXPORTER_OTLP_METRICS_ENDPOINT ||
-    process.env.OTEL_EXPORTER_OTLP_ENDPOINT
-  ) {
+  if (process.env.OTEL_EXPORTER_OTLP_METRICS_ENDPOINT || process.env.OTEL_EXPORTER_OTLP_ENDPOINT) {
     const meterProvider = new MeterProvider({
       resource: new Resource({
         [SemanticResourceAttributes.SERVICE_NAME]: `${serviceInfo.name}`,
@@ -38,8 +27,8 @@ function initializeMetrics(serviceInfo: ServiceInfo) {
 
     let metricExporter;
     if (
-      process.env.OTEL_EXPORTER_OTLP_PROTOCOL === "grpc" ||
-      process.env.OTEL_EXPORTER_OTLP_METRICS_PROTOCOL === "grpc"
+      process.env.OTEL_EXPORTER_OTLP_PROTOCOL === 'grpc' ||
+      process.env.OTEL_EXPORTER_OTLP_METRICS_PROTOCOL === 'grpc'
     ) {
       metricExporter = new OTLPMetricExporterGRPC();
     } else {

src/instruments/counter.ts

@@ -1,5 +1,5 @@
-import type { Attributes, Counter, MetricOptions } from "@opentelemetry/api";
-import { acquireMeter } from "../lib/meter";
+import type { Attributes, Counter, MetricOptions } from '@opentelemetry/api';
+import { acquireMeter } from '../lib/meter';
 
 const counters: Record<string, Counter<Attributes>> = {};
 

src/instruments/gauge.ts

@@ -1,9 +1,5 @@
-import type {
-  Attributes,
-  MetricOptions,
-  ObservableGauge,
-} from "@opentelemetry/api";
-import { acquireMeter } from "../lib/meter";
+import type { Attributes, MetricOptions, ObservableGauge } from '@opentelemetry/api';
+import { acquireMeter } from '../lib/meter';
 
 const gauges: Record<string, ObservableGauge<Attributes>> = {};
 
@@ -20,13 +16,7 @@ type GaugeOperationParams = {
   gaugeAttributes?: Attributes;
 };
 
-const observeGauge = ({
-  meter,
-  name,
-  val,
-  gaugeOptions,
-  gaugeAttributes,
-}: GaugeOperationParams) => {
+const observeGauge = ({ meter, name, val, gaugeOptions, gaugeAttributes }: GaugeOperationParams) => {
   let gauge = gauges[name];
   if (gauge === undefined) {
     const _otelMeter = acquireMeter(meter);

src/instruments/histogram.ts

@@ -1,5 +1,5 @@
-import type { Attributes, MetricOptions, Histogram } from "@opentelemetry/api";
-import { acquireMeter } from "../lib/meter";
+import type { Attributes, MetricOptions, Histogram } from '@opentelemetry/api';
+import { acquireMeter } from '../lib/meter';
 
 const histograms: Record<string, Histogram<Attributes>> = {};
 
@@ -26,10 +26,7 @@ const recordHistogram = ({
   let histogram = histograms[name];
   if (histogram === undefined) {
     const _otelMeter = acquireMeter(meter);
-    histogram = histograms[name] = _otelMeter.createHistogram(
-      name,
-      histogramOptions
-    );
+    histogram = histograms[name] = _otelMeter.createHistogram(name, histogramOptions);
   }
   histogram.record(val, histogramAttributes);
 };

src/instruments/index.ts

@@ -1,5 +1,5 @@
-export * from "./counter";
-export * from "./gauge";
-export * from "./histogram";
-export * from "./timer";
-export * from "./instrument";
+export * from './counter';
+export * from './gauge';
+export * from './histogram';
+export * from './timer';
+export * from './instrument';

src/instruments/instrument.ts

@@ -1,6 +1,6 @@
-import type { Attributes } from "@opentelemetry/api";
-import { incrementCounter } from "./counter";
-import { recordTimer } from "./timer";
+import type { Attributes } from '@opentelemetry/api';
+import { incrementCounter } from './counter';
+import { recordTimer } from './timer';
 
 type InstrumentOperationParams = {
   /** OTel meter name */
@@ -19,19 +19,14 @@ type InstrumentOperationParams = {
  * @param operationParams
  */
 
-async function instrument({
-  meter,
-  name,
-  delegate,
-  instrumentAttributes,
-}: InstrumentOperationParams) {
+async function instrument({ meter, name, delegate, instrumentAttributes }: InstrumentOperationParams) {
   const start = process.hrtime();
   try {
     return await delegate();
   } catch (err) {
     incrementCounter({
       meter,
-      name: "function.errors",
+      name: 'function.errors',
       counterAttributes: { function: name, ...instrumentAttributes },
     });
     throw err;
@@ -40,7 +35,7 @@ async function instrument({
     const elapsedNanos = elapsed[0] * 1000000000 + elapsed[1];
     recordTimer({
       meter,
-      name: "function.executionTime",
+      name: 'function.executionTime',
       val: elapsedNanos,
       timerAttributes: { function: name, ...instrumentAttributes },
     });

src/instruments/timer.ts

@@ -1,5 +1,5 @@
-import type { Attributes, MetricOptions, Histogram } from "@opentelemetry/api";
-import { acquireMeter } from "../lib/meter";
+import type { Attributes, MetricOptions, Histogram } from '@opentelemetry/api';
+import { acquireMeter } from '../lib/meter';
 
 const timers: Record<string, Histogram<Attributes>> = {};
 
@@ -16,19 +16,13 @@ type TimerOperationParams = {
   timerAttributes?: Attributes;
 };
 
-const recordTimer = ({
-  meter,
-  name,
-  val,
-  timerOptions,
-  timerAttributes,
-}: TimerOperationParams) => {
+const recordTimer = ({ meter, name, val, timerOptions, timerAttributes }: TimerOperationParams) => {
   let timer = timers[name];
   if (timer === undefined) {
     const _otelMeter = acquireMeter(meter);
     timer = timers[name] = _otelMeter.createHistogram(name, {
       ...timerOptions,
-      unit: "ns",
+      unit: 'ns',
     });
   }
   timer.record(val, timerAttributes);