Syntax
data_source_factory(name=None, **properties)Wraps a data source defined as a factory.
Description
The data source APIs provide a way to generate metric timeslice data using a pull-style API rather than the push-style API implemented by record_custom_metric. For more about why and how to use data sources for custom metrics, see Custom metric data sources.
The data_source_factory decorator wraps a data source defined as a factory. The decorator can be applied to a class or a function. The class constructor or function must accept arguments of settings (configuration settings for the data source) and environ (information about context in which the data source is being used).
The resulting object must be a callable which directly returns an iterable/generator with the metrics for each sample.
Parameters
Parameter | Description |
|---|---|
string | Optional. The name of the data source. This is used only for logging purposes. If not provided, it defaults to the callable name derived from the decorated function. |
dictionary | Optional. Any additional properties to pass to the data source factory. The possible fields for a dictionary are:
|
Return values
Returns a function.
Examples
data_source_factory example
An example:
import osimport timeimport multiprocessing
@newrelic.agent.data_source_factory(name='CPU Usage')class CPUMetricsDataSource(object):
def __init__(self, settings, environ): self.last_timestamp = None self.times = None def start(self): self.last_timestamp = time.time() self.times = os.times() def stop(self): self.last_timestamp = None self.times = None
def __call__(self): if self.times is None: return
now = time.time() new_times = os.times() elapsed_time = now - self.last_timestamp user_time = new_times[0] - self.times[0] utilization = user_time / (elapsed_time*multiprocessing.cpu_count()) self.last_timestamp = now self.times = new_times
yield ('Custom/CPU/User Time', user_time) yield ('Custom/CPU/User/Utilization', utilization)
newrelic.agent.register_data_source(CPUMetricsDataSource)For more help
If you need more help, check out these support and learning resources:
- Browse the Explorers Hub to get help from the community and join in discussions.
- Find answers on our sites and learn how to use our support portal.
- Run New Relic Diagnostics, our troubleshooting tool for Linux, Windows, and macOS.
- Review New Relic's and and documentation.