# metric-reporter-node

> Atom Metric Reporter

Latest version **1.0.5** (published 2020-07-29) · MIT license · 0 weekly downloads

## Install

```sh
npm install metric-reporter-node
pnpm add metric-reporter-node
yarn add metric-reporter-node
bun add metric-reporter-node
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.5 |
| Published | 2020-07-29 |
| First published | 2019-03-27 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 3 |
| Unpacked size | 14.9 KB |
| Known vulnerabilities | 0 (+3 in 2 direct dependencies) |
| Install scripts | no |
| Author | g8y3e |
| Maintainers | g8y3e |
| Keywords | reporter |

## Links

- npm: https://www.npmjs.com/package/metric-reporter-node
- Repository: https://github.com/ironSource/metric-reporter-node
- Homepage: https://github.com/ironSource/metric-reporter-node#readme
- Issues: https://github.com/ironSource/metric-reporter-node/issues
- npm.io page: https://npm.io/package/metric-reporter-node

## Dependencies (3)

- [moment](https://npm.io/package/moment.md) 2.23.0
- [request](https://npm.io/package/request.md) 2.88.0
- [bluebird](https://npm.io/package/bluebird.md) 3.5.3

## Recent versions

- 1.0.5 (latest) — 2020-07-29
- 1.0.4 — 2020-07-29
- 1.0.3 — 2020-07-29
- 1.0.2 — 2019-06-11
- 1.0.1 — 2019-03-27
- 1.0.0 — 2019-03-27

## README

# metric-reporter-node   

[![License][license-image]][license-url]
[![Docs][docs-image]][docs-url]

metric-reporter-node is SDK for Node.JS Javascript to send reports for applications monitoring like: [Datadog](https://www.datadoghq.com/), 
[Appoptics](https://www.appoptics.com) etc.

- [Documentation][docs-url]
- [Installation](#installation)
- [Usage](#usage)
- [Change Log](#change-log)
- [Example](#example)

## Installation
### Installation using npm
```sh
$ npm install metric-reporter-node --save
```

## Usage
Create metric reporter for specific driver (datadog or appoptics)
```js
 // constructor args: <driver_name>, <driver_config>, <flush_interval>, <max_metrics>, <metric_prefix>, <logger_instance>
 let reporter = new MetricReporter("appoptics", {token: "test_token"}, 2, 140, "", logger);
```

Send report
```js
// send args: <metric_name>, <metric_value>, <tags>
reporter.send("test_metric", 1, { test: "" });
```

Save shutdown reporter:
```js
['exit', 'SIGINT', 'SIGHUP', 'SIGQUIT', 'SIGABRT', 'SIGTERM'].map(function (event) {
    process.on(event, () => {
        console.info('SIGTERM signal received: ' + event);
        reporter.stop();
    });
});
```

## Example
You can use our [example][example-url] for sending reports.

## License
[MIT](LICENSE)

[example-url]: metric_reporter_test.js

[license-image]: https://img.shields.io/badge/license-MIT-blue.svg?style=square
[license-url]: LICENSE

[docs-url]: https://ironsource.github.io/metric-reporter-node/
[docs-image]: https://img.shields.io/badge/docs-latest-blue.svg

---
_Source: https://npm.io/package/metric-reporter-node · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._