npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

prom-api-client

v0.1.6

Published

A client to support Prometheus HTTP API

Downloads

5

Readme

Prom-API-Client

A user-friendly package to use Prometheus HTTP-API in more easier way.

If any features you want feel free to raise a issue in github

Import Class and Instance

import { PrometheusQuery, PrometheusRules, PrometheusMetadata } from 'prom-api-client';

// Prometheus Query --> 
const prometheusQueryInstance = new PrometheusQuery('http://localhost:9090');
// Prometheus Alert
const prometheusAlertInstance = new PrometheusRules('http://localhost:9090');
// Prometheus Metadata
const prometheusMetadataInstance = new PrometheusMetadata('http://localhost:9090');

Header feature support

This will helps to add additional headers (enables to pass the tenant Id)

// Passed the headers on instance definition
const headers = {
  // used in MIMIR to support multi-tenant
  'X-Scope-OrgID': "dd51439f-64f6-42d3-92c1-634faf6af418",
}
const prometheusAlertInstance = new PrometheusRules('http://localhost:9090', headers);
// OR used it as a chain
const prometheusAlertInstance = new PrometheusRules('http://localhost:9090');
const activeAlertData = await prometheusAlertInstance.setHeaders(headers).getActiveAlerts();

Rules

Get Alert Rules

const alertRules = await prometheusAlertInstance.getAlertRules({rule_name: 'test'});

Get all active alerts

const activeAlertData = await prometheusAlertInstance.getActiveAlerts();

Query

Query Instant

const queryResult = await prometheusQueryInstance.getQueryInstant({
  query: 'up'
});

Query Range

const data = await prometheusQueryInstance.getQueryRange({
  query: 'up{job="prometheus"}',
  start: '1711046500',
  end: '1711046510',
  step: '2s'
});

Get Label Name

const dataLabel = await prometheusQueryInstance.getLabelNames();
const dataLabel = await prometheusQueryInstance.getLabelNames({
  match: ['up{job="prometheus"}'],
  start: 1711217119,
  end: 1711217121,
});

Get Series

const dataSeries = await prometheusQueryInstance.getSeries({
  match: ['up{job="prometheus"}'],
  start: 1711217119,
  end: 1711217121,
});

Get Label Values by Label Names

const dataLabelValues = await prometheusQueryInstance.getLabelValuesByLabelName('job', {
  match: ['up{job="prometheus"}']
});

Metadata and Targets

Get alertmanager service discovery

const alertmanagerData = await prometheusMetadataInstance.getAlertManagerList();
console.log(JSON.stringify(alertmanagerData));

Get all target discovery

const allTargetDiscovery = await prometheusMetadataInstance.getTargetDiscovery();

Get target discovery with state and scrapePool

const targetDiscovery = await prometheusMetadataInstance.getTargetDiscovery({
  state: 'dropped',
  scrapePool: 'prometheus'
});

Get target Metadata

const targetMeta = await prometheusMetadataInstance.getTargetMetadata({
  match_target: '{job="prometheus"}',
  metric: 'go_goroutines',
  limit: 2,
});

get metadata

const metaData = await prometheusMetadataInstance.getMetadata({
  metric: 'http_requests_total'
});

get flags

const promFlag = await prometheusMetadataInstance.getFlag();
console.log(promFlag);

get runtime info

const promRuntimeInfo = await prometheusMetadataInstance.getRunTimeInfo()
console.log(promRuntimeInfo);

get build info

const promBuildInfo = await prometheusMetadataInstance.getBuildInfo()
console.log(promBuildInfo);

get tsdb info

const promTsdb = await prometheusMetadataInstance.getTsdb()
console.log(JSON.stringify(promTsdb));

get walreplay

const walreplay = await prometheusMetadataInstance.getWlRePlay()
console.log(JSON.stringify(walreplay));