Typescript library for publishing metrics from Ceramic nodes, as ceramic model instance documents
npm install @ceramicnetwork/node-metricsPublishes metrics about Ceramic Nodes, on the Ceramic Network
## Purpose
Uses the decentralized CeramicNetwork to publish metrics and data about Ceramic Nodes
In your daemon.config.json file (often found in ~/.ceramic directory), add the following setting:
``
"metrics": {
"metrics-publisher-enabled": true
}
and restart your ceramic daemon.
Since the code to record metrics will already be incorporated into the daemon, no further action is necessary.
---
Note, this class will be included as a dependency in ceramic daemon, so installation is not necessary.
However, if using in your own project, the package can be installed normally.
`sh`
npm install @ceramicnetwork/node-metrics
Import the class, start the metrics publishing service and record metrics.
`ts
import { NodeMetrics, Counter, Observable } from '@ceramicnetwork/node-metrics'
NodeMetrics.start({ceramic: ceramic, network: 'dev-unstable', intervalMS: 30000})
NodeMetrics.observe(Observable.TOTAL_PINNED_STREAMS, 100)
NodeMetrics.count(Counter.RECENT_COMPLETED_REQUESTS, 20)
ModelMetris.recordError('oops')
NodeMetrics.stopPublishing()
`
If wishing to modify the metrics model, start by updating the model definition in the ./composites directory, then`ts
composedb composite:create your-schema.graphql --output=../__generated__/definition.json --did-private-key=your-private-key
cd ../__generated__
composedb composite:deploy definition.json --ceramic-url=http://localhost:7007 --did-private-key=...
composedb composite:compile definition.json definition.js
`
Depending on the changes made, code changes may need to be made as well, in particular start with the list of models defined in