Install

This runs the installer. You can choose between a minified release (two smallest files), a packaged release (two readable files), or a full source release (many readable files).

wget run <https://pinestore.cc/d/14>

Resources will be installed to a telem folder in the current directory. A simple require() will load the library.

local telem = require 'telem'

Concepts

Metric

The fundamental element of Telem is a Metric , which is just a scalar (numeric) value with some properties attached to it.

Metric values MUST be scalar. Strings are not permitted. The reason for this is simple; telemetry means “remote measurement,” and a string (name, etc.) is not a “measurement” of anything.

Metrics also support a variety of labels which are exposed as string properties:

• name: Required. The primary label used to reference the metric.
• adapter: The name of the adapter producing the metric. This is applied automatically for all input adapters.
• source: The name of the component the adapter queried to produce the metric.
• unit: A string describing the kind of value being measured.

MetricCollection

A MetricCollection is a list of Metric elements, with some special properties attached. Luckily, those special properties are currently unused, so for the moment it’s just a list of Metric elements!

Adapters

There are two types of adapters: InputAdapter and OutputAdapter. The base classes themselves are abstract classes and cannot be instantiated. Instead, there are several implementations of these adapters targeting generic resource providers and machinery from supported mods.

Explore the API page to learn more about the specific adapters.