runtime-api-observer

Plug-and-play runtime failure detection for Node.js APIs. Collects API responses and runtime signals, helps detect anomalies, and surfaces actionable insights.

Installation

Install from npm:

npm install runtime-api-observer

Usage

CommonJS

const { createObserver } = require('runtime-api-observer')

const observer = createObserver({
	apiKey: process.env.OBSERVER_API_KEY,
	// options
})

observer.start()

ESM

import { createObserver } from 'runtime-api-observer'

const observer = createObserver({ apiKey: process.env.OBSERVER_API_KEY })
observer.start()

Refer to the exported types in the package for full configuration options.

Build

If you install from the Git repository, build before use:

npm run build

Publishing

This package includes a prepublishOnly script that runs npm run build so the dist/ output is published.

Contributing

1. Fork the repository and create a feature branch.
2. Run npm install and npm run build.
3. Open a pull request describing your changes.

License

MIT — see the LICENSE file.

Notes

• The package exports TypeScript types under dist when installed from npm.
• If you plan to publish from CI, use an automation token (NPM_TOKEN) with appropriate permissions and set it in CI secrets.