Skip to content

Latest commit

 

History

History
32 lines (25 loc) · 2.17 KB

migrating_from_1.x.md

File metadata and controls

32 lines (25 loc) · 2.17 KB

Migrating from 1.x to 2.0

Fixed Method Signatures

All breaking changes in the 2.0 release revolve around ammending incorrect or updated method signatures in signal_analog. The below table illustrates the changes between releases:

1.x Method Signature 2.x Method Signature Documentation
bottom(by=None, over=None) bottom(count=None, percentage=None, by=None) link
delta(by=None, over=None) delta() link
percentile(by=None, over=None) percentile(over=None, by=None, percentage=None) link
random(by=None, over=None) random(count, percentage=None, by=None) link
top(by=None, over=None) bottom(count=None, percentage=None, by=None) link
timeshift(offset=None) timeshift(offset) link
ewma(alpha) ewma(alpha=None, over=None) link
promote(property) promote(*properties) link

Backwards incompatible behavior changes

Charts and Notifications optionally accept Program statements in place of raw flow statements. With version 2 of the library these Program objects will now run through a series of validations in order to warn or prevent bad programs from being sent to SignalFx.

Validations are now defined in the Programs.validate method and can optionally make use of user-defined validations.

The only default validation for the 2.0 release is one that verifies that at least one statement in a Program is published. This may invalidate previously accepted Programs.