API Reference

Base Classes

class base10.base.Dialect(*args, **kwargs)

__init__(*args, **kwargs)

x.__init__(…) initializes x; see help(type(x)) for signature

from_string(string)

to_string(metric)

class base10.base.Metric(name, fields, metadata, **kwargs)

Generic Metric class

__init__(name, fields, metadata, **kwargs)

Create a new Metric

Parameters:

• name – Name of the metric.
• fields – List of field names to include.
• metadata – List of metadata field names to include.
• **kwargs –

  Keyword values for the fields and metadata.

fields

Get Metric fields

metadata

Get Metric metadata

name

Get Metric name

values

Get Metric values

class base10.base.Reader(*args, **kwargs)

__init__(*args, **kwargs)

x.__init__(…) initializes x; see help(type(x)) for signature

read()

class base10.base.Writer(*args, **kwargs)

__init__(*args, **kwargs)

x.__init__(…) initializes x; see help(type(x)) for signature

write(string)

Helper CLasses

class base10.helpers.MetricHelper(**kwargs)

Exceptions

exception base10.exceptions.Base10Error

exception base10.exceptions.DialectError

exception base10.exceptions.TransportError

Dialects

class base10.dialects.json_dialect.JSONDialect(*args, **kwargs)

{

name: ‘cpu_usage’, fields: {

user: 0.2, free: 0.75

}, metadata: {

hostname: ‘host-1’

}, timestamp: 1489478831

}

Transports