1.16.20
flytekit.interfaces.stats.client
Directory
Classes
| Class | Description |
|---|---|
DummyStatsClient |
A dummy client for statsd. |
ScopeableStatsProxy |
A Proxy object for an underlying statsd client. |
StatsClientProxy |
Methods
| Method | Description |
|---|---|
get_base_stats() |
|
get_stats() |
Variables
| Property | Type | Description |
|---|---|---|
RESERVED_TAG_WORDS |
frozenset |
Methods
get_base_stats()
def get_base_stats(
cfg: flytekit.configuration.StatsConfig,
prefix: str,
)| Parameter | Type | Description |
|---|---|---|
cfg |
flytekit.configuration.StatsConfig |
|
prefix |
str |
get_stats()
def get_stats(
cfg: flytekit.configuration.StatsConfig,
prefix: str,
)| Parameter | Type | Description |
|---|---|---|
cfg |
flytekit.configuration.StatsConfig |
|
prefix |
str |
flytekit.interfaces.stats.client.DummyStatsClient
A dummy client for statsd.
Parameters
class DummyStatsClient(
host,
port,
prefix,
maxudpsize,
ipv6,
)Create a new client.
| Parameter | Type | Description |
|---|---|---|
host |
||
port |
||
prefix |
||
maxudpsize |
||
ipv6 |
Methods
| Method | Description |
|---|---|
close() |
Used to close and clean up any underlying resources. |
decr() |
Decrement a stat by count. |
gauge() |
Set a gauge value. |
incr() |
Increment a stat by count. |
pipeline() |
|
set() |
Set a set value. |
timer() |
|
timing() |
Send new timing information. |
close()
def close()Used to close and clean up any underlying resources.
decr()
def decr(
stat,
count,
rate,
)Decrement a stat by count.
| Parameter | Type | Description |
|---|---|---|
stat |
||
count |
||
rate |
gauge()
def gauge(
stat,
value,
rate,
delta,
)Set a gauge value.
| Parameter | Type | Description |
|---|---|---|
stat |
||
value |
||
rate |
||
delta |
incr()
def incr(
stat,
count,
rate,
)Increment a stat by count.
| Parameter | Type | Description |
|---|---|---|
stat |
||
count |
||
rate |
pipeline()
def pipeline()set()
def set(
stat,
value,
rate,
)Set a set value.
| Parameter | Type | Description |
|---|---|---|
stat |
||
value |
||
rate |
timer()
def timer(
stat,
rate,
)| Parameter | Type | Description |
|---|---|---|
stat |
||
rate |
timing()
def timing(
stat,
delta,
rate,
)Send new timing information.
delta can be either a number of milliseconds or a timedelta.
| Parameter | Type | Description |
|---|---|---|
stat |
||
delta |
||
rate |
flytekit.interfaces.stats.client.ScopeableStatsProxy
A Proxy object for an underlying statsd client. Adds a new call, scope(prefix), which returns a new proxy to the same client which will prefix all calls to underlying methods with the scoped prefix: new_client = client.get_stats(‘a’) new_client.incr(‘b’) # Metric name = a.b This can be nested: newer_client = new_client.get_stats(‘subsystem’) newer_client.incr(‘bad’) # Metric name = a.subsystem.bad
Parameters
class ScopeableStatsProxy(
client,
prefix,
)| Parameter | Type | Description |
|---|---|---|
client |
||
prefix |
Methods
| Method | Description |
|---|---|
get_stats() |
|
pipeline() |
get_stats()
def get_stats(
name,
)| Parameter | Type | Description |
|---|---|---|
name |
pipeline()
def pipeline()flytekit.interfaces.stats.client.StatsClientProxy
Parameters
class StatsClientProxy(
client,
prefix,
)| Parameter | Type | Description |
|---|---|---|
client |
||
prefix |
Methods
| Method | Description |
|---|---|
get_stats() |
|
pipeline() |
get_stats()
def get_stats(
name,
)| Parameter | Type | Description |
|---|---|---|
name |
pipeline()
def pipeline()