@teemill/metrics

@teemill/metrics@0.11.6

This generator creates TypeScript/JavaScript client that utilizes axios. The generated Node module can be used in the following environments:

Environment

• Node.js
• Webpack
• Browserify

Language level

• ES5 - you must have a Promises/A+ library installed
• ES6

Module system

• CommonJS
• ES6 module system

It can be used in both TypeScript and JavaScript. In TypeScript, the definition will be automatically resolved via package.json. (Reference)

Building

To build and compile the typescript sources to javascript use:

npm install
npm run build

Publishing

First build the package then run npm publish

Consuming

navigate to the folder of your consuming project and run one of the following commands.

published:

npm install @teemill/metrics@0.11.6 --save

unPublished (not recommended):

npm install PATH_TO_GENERATED_PACKAGE --save

Documentation for API Endpoints

All URIs are relative to https://api.podos.io/v1/enforcer

Class	Method	HTTP request	Description
MetricsApi	getMetric	GET /metrics/{metricId}	Get metric
MetricsApi	getMonitor	GET /monitors/{monitorId}	Get monitor
MetricsApi	getMonitors	GET /monitors	Get monitors
MetricsApi	ingest	POST /ingest	Ingest metric data
MetricsApi	inspectMonitor	GET /monitors/{monitorId}/inspect	Inspect monitor
MetricsApi	listMetrics	GET /metrics	List metrics
MetricsApi	queryAdminMetrics	POST /admin/query	Query metrics as an admin
MetricsApi	queryMetric	GET /query	Query metric
MetricsApi	queryMetrics	POST /query	Query metrics
MetricsApi	recordMetrics	POST /	Record metrics
MetricsApi	updateMonitorSettings	POST /monitors/{monitorId}/settings	Update monitor settings

Documentation For Models

• ApiError
• Dataset
• IngestRequestInner
• ListMetric
• ListMetrics200Response
• Metric
• Monitor
• MonitorCheck
• MonitorCheckData
• MonitorCheckLabelsValue
• MonitorCondition
• MonitorConditionListItem
• MonitorConditionListItemTestsInner
• MonitorDisplayFormat
• MonitorInspectResponse
• MonitorTestResult
• MonitorsResponse
• QueryAdminMetricsRequest
• QueryMetricsRequest
• QueryMetricsRequestFormulasInner
• QueryMetricsRequestQueriesInner
• QueryResult
• RecordMetricsRequestInner
• RecordMetricsRequestInnerMetricsInner
• Series
• UpdateMonitorSettingsRequest
• ValidationError

Documentation For Authorization

Authentication schemes defined for the API:

api-key

• Type: API key
• API key parameter name: Authorization
• Location: HTTP header

session-oauth

• Type: OAuth
• Flow: password
• Authorization URL:
• Scopes: N/A