# pip-clients-metrics-node
> Client SDK to metrics microservice in Node.js
Latest version **1.0.1** (published 2020-01-07) · MIT license · 0 weekly downloads
## Install
```sh
npm install pip-clients-metrics-node
pnpm add pip-clients-metrics-node
yarn add pip-clients-metrics-node
bun add pip-clients-metrics-node
```
## Health
**Score 25/100 (F)** — status: abandoned.
Positive: has types; no vulnerabilities; high quality score.
Warnings: low downloads; no esm support.
Negative: abandoned; low maintenance score.
## Facts
| | |
|---|---|
| Version | 1.0.1 |
| Published | 2020-01-07 |
| First published | 2019-12-13 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Node | >=0.6.14 |
| Dependencies | 5 |
| Unpacked size | 66.4 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Conceptual Vision Consulting LLC |
| Maintainers | pipdeveloper |
| Keywords | metrics, microservice |
## Links
- npm: https://www.npmjs.com/package/pip-clients-metrics-node
- Repository: https://github.com/pip-services-infrastructure/pip-clients-metrics-node
- Homepage: https://github.com/pip-services-infrastructure/pip-clients-metrics-node#readme
- Issues: https://github.com/pip-services-infrastructure/pip-clients-metrics-node/issues
- npm.io page: https://npm.io/package/pip-clients-metrics-node
## Dependencies (5)
- [pip-services3-aws-node](https://npm.io/package/pip-services3-aws-node.md) ^3.0.0
- [pip-services3-rpc-node](https://npm.io/package/pip-services3-rpc-node.md) ^3.0.0
- [pip-services3-commons-node](https://npm.io/package/pip-services3-commons-node.md) ^3.0.0
- [pip-services3-container-node](https://npm.io/package/pip-services3-container-node.md) ^3.0.0
- [pip-services3-components-node](https://npm.io/package/pip-services3-components-node.md) ^3.0.0
## Recent versions
- 1.0.1 (latest) — 2020-01-07
- 1.0.0 — 2019-12-13
## README
# 
Metrics Microservice client SDK for Node.js
Quick Links:
* [Download Links](doc/Downloads.md)
* [Development Guide](doc/Development.md)
* [Client API version 1](doc/NodeClientApiV1.md)
* Service
- [Metrics service](https://github.com/pip-services-infrastructure/pip-services-metrics-node)
This is a Node.js client SDK for [pip-services-metrics](https://github.com/pip-services-infrastructure/pip-services-metrics-node) microservice.
It provides an easy to use abstraction over communication protocols:
- Direct client for monolythic deployments
- Http client
- Null client to be used in testing
## Install
Add dependency to the client SDK into **package.json** file of your project
```typescript
{
...
"dependencies": {
....
"pip-clients-metrics-node": "^1.0.*",
...
}
}
```
Then install the dependency using **npm** tool
```bash
# Install new dependencies
npm install
# Update already installed dependencies
npm update
```
## Use
Inside your code get the reference to the client SDK
```typescript
import { MetricsHttpClientV1 } from 'pip-clients-metrics-node';
```
Define client configuration parameters.
```typescript
// Client configuration
let httpConfig = ConfigParams.fromTuples(
'connection.protocol', 'http',
'connection.port', 3000,
'connection.host', 'localhost'
);
client.configure(httpConfig);
```
Instantiate the client and open connection to the microservice
```typescript
// Create the client instance
client = new MetricssHttpClientV1();
// Connect to the microservice
client.open(null, function(err) {
if (err) {
console.error('Connection to the microservice failed');
console.error(err);
return;
});
// Work with the microservice
...
```
Now the client is ready to perform operations:
Update if exist metric or create otherwise:
```typescript
client.updateMetric(
null,
{
name: "metric1",
dimension1: "A",
dimension2: "B",
dimension3: null,
year: 2018,
month: 8,
day: 26,
hour: 12,
value: 123
},
TimeHorizonV1.Hour,
(err: any)=>{
if (err != null) {
console.error('Update/create metric are failed');
console.error(err);
}
}
);
```
Update if exist metrics or create otherwise::
```typescript
client.updateMetrics(
null,
[
{
name: "metric1",
dimension1: "A",
dimension2: "B",
dimension3: null,
year: 2018,
month: 8,
day: 26,
hour: 13,
value: 321
},
{
name: "metric2",
dimension1: "A",
dimension2: null,
dimension3: "C",
year: 2018,
month: 8,
day: 26,
hour: 13,
value: 321
}
],
TimeHorizonV1.Hour,
(err: any)=>{
if (err != null) {
console.error('Update/create metric are failed');
console.error(err);
}
}
);
```
Get metrics by filter:
```typescript
client.getMetricsByFilter(null,
FilterParams.fromTuples("name", "metric1"),
new PagingParams(),
(err, page) => {
if (err != null) {
console.error("Can\'t get metrics by filter");
console.error(err);
return;
}
console.log("Metrics:");
console.log(page.data);
}
);
```
Get all metrics definitions:
```typescript
client.getMetricDefinitions(
null,
(err, definitions) => {
if (err != null) {
console.error("Can\'t get metrics definitions");
console.error(err);
return;
}
console.log("All metrics definition:");
console.log(definitions);
}
);
```
Get metric definition by name:
```typescript
client.getMetricDefinitionByName(
null,
"metric2",
(err, definition) => {
if (err != null) {
console.error("Can\'t get metrics definition by name");
console.error(err);
return;
}
console.log("Metric definition name %s:", definition.name);
console.log(definition);
});
```
## Acknowledgements
This client SDK was created and currently maintained by *Sergey Seroukhov* and *Levichev Dmitry*.
---
_Source: https://npm.io/package/pip-clients-metrics-node · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._