@hyperledger/cactus-plugin-consortium-manual
Advanced tools
A web service plugin that provides management capabilities on a Cactus consortium as a whole for administrative purposes.
@hyperledger/cactus-plugin-consortium-manualThis class creates a prometheus exporter, which scrapes the total Cactus node count.
The prometheus exporter object is initialized in the PluginConsortiumManual class constructor itself, so instantiating the object of the PluginConsortiumManual class, gives access to the exporter object.
You can also initialize the prometheus exporter object seperately and then pass it to the IPluginConsortiumManualOptions interface for PluginConsortiumManual constructor.
getPrometheusMetricsV1 function returns the prometheus exporter metrics, currently displaying the total cactus node count, which currently refreshes to match the node count in the consortium, everytime updateMetricNodeCount method of the PluginConsortiumManual class is called.
To use Prometheus with this exporter make sure to install Prometheus main component. Once Prometheus is setup, the corresponding scrape_config needs to be added to the prometheus.yml
- job_name: 'consortium_manual_exporter'
metrics_path: api/v1/plugins/@hyperledger/cactus-plugin-consortium-manual/get-prometheus-exporter-metrics
scrape_interval: 5s
static_configs:
- targets: ['{host}:{port}']
Here the host:port is where the prometheus exporter metrics are exposed. The test cases (For example, packages/cactus-plugin-consortium-manual/src/test/typescript/unit/consortium/get-node-jws-endpoint-v1.test.ts) exposes it over 0.0.0.0 and a random port(). The random port can be found in the running logs of the test case and looks like (42379 in the below mentioned URL)
Metrics URL: http://0.0.0.0:42379/api/v1/plugins/@hyperledger/cactus-plugin-consortium-manual/get-prometheus-exporter-metrics
Once edited, you can start the prometheus service by referencing the above edited prometheus.yml file. On the prometheus graphical interface (defaulted to http://localhost:9090), choose Graph from the menu bar, then select the Console tab. From the Insert metric at cursor drop down, select cactus_consortium_manual_total_node_count and click execute
This file contains the various responses of the metrics.
This file contains functions encasing the logic to process the data points.
This file lists all the prometheus metrics and what they are used for.
2.0.0-rc.2 (2024-07-03)
FAQs
A web service plugin that provides management capabilities on a Cactus consortium as a whole for administrative purposes.
We found that @hyperledger/cactus-plugin-consortium-manual demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 0 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Research
A malicious npm package disguised as a WhatsApp client is exploiting authentication flows with a remote kill switch to exfiltrate data and destroy files.
Security News
PyPI now supports digital attestations, enhancing security and trust by allowing package maintainers to verify the authenticity of Python packages.
Security News
GitHub removed 27 malicious pull requests attempting to inject harmful code across multiple open source repositories, in another round of low-effort attacks.