great_expectations.core.usage_statistics.usage_statistics

Module Contents

Classes

UsageStatsExceptionPrefix()

Generic enumeration.

UsageStatisticsHandler(data_context: DataContext, data_context_id: str, usage_statistics_url: str)

Functions

get_usage_statistics_handler(args_array: list)

usage_statistics_enabled_method(func: Optional[Callable] = None, event_name: Optional[str] = None, args_payload_fn: Optional[Callable] = None, result_payload_fn: Optional[Callable] = None)

A decorator for usage statistics which defaults to the less detailed payload schema.

run_validation_operator_usage_statistics(data_context: DataContext, validation_operator_name: str, assets_to_validate: list, **kwargs)

save_expectation_suite_usage_statistics(data_context: DataContext, expectation_suite: ExpectationSuite, expectation_suite_name: Optional[str] = None, **kwargs)

edit_expectation_suite_usage_statistics(data_context: DataContext, expectation_suite_name: str, interactive_mode: Optional[CLISuiteInteractiveFlagCombinations] = None)

add_datasource_usage_statistics(data_context: DataContext, name: str, **kwargs)

get_batch_list_usage_statistics(data_context: DataContext, *args, **kwargs)

get_checkpoint_run_usage_statistics(checkpoint: Checkpoint, *args, **kwargs)

send_usage_message(data_context: DataContext, event: str, event_payload: Optional[dict] = None, success: Optional[bool] = None)

send a usage statistics message.

great_expectations.core.usage_statistics.usage_statistics.STOP_SIGNAL
great_expectations.core.usage_statistics.usage_statistics.logger
great_expectations.core.usage_statistics.usage_statistics._anonymizers
class great_expectations.core.usage_statistics.usage_statistics.UsageStatsExceptionPrefix

Bases: enum.Enum

Generic enumeration.

Derive from this class to define new enumerations.

EMIT_EXCEPTION = UsageStatsException
INVALID_MESSAGE = UsageStatsInvalidMessage
class great_expectations.core.usage_statistics.usage_statistics.UsageStatisticsHandler(data_context: DataContext, data_context_id: str, usage_statistics_url: str)
_teardown(self, signum: int, frame: Optional[FrameType])
_close_worker(self)
_requests_worker(self)
build_init_payload(self)

Adds information that may be available only after full data context construction, but is useful to calculate only one time (for example, anonymization).

build_envelope(self, message: dict)
static validate_message(message: dict, schema: dict)
send_usage_message(self, event: str, event_payload: Optional[dict] = None, success: Optional[bool] = None)

send a usage statistics message.

emit(self, message: dict)

Emit a message.

great_expectations.core.usage_statistics.usage_statistics.get_usage_statistics_handler(args_array: list) → Optional[UsageStatisticsHandler]
great_expectations.core.usage_statistics.usage_statistics.usage_statistics_enabled_method(func: Optional[Callable] = None, event_name: Optional[str] = None, args_payload_fn: Optional[Callable] = None, result_payload_fn: Optional[Callable] = None) → Callable

A decorator for usage statistics which defaults to the less detailed payload schema.

great_expectations.core.usage_statistics.usage_statistics.run_validation_operator_usage_statistics(data_context: DataContext, validation_operator_name: str, assets_to_validate: list, **kwargs) → dict
great_expectations.core.usage_statistics.usage_statistics.save_expectation_suite_usage_statistics(data_context: DataContext, expectation_suite: ExpectationSuite, expectation_suite_name: Optional[str] = None, **kwargs) → dict
great_expectations.core.usage_statistics.usage_statistics.edit_expectation_suite_usage_statistics(data_context: DataContext, expectation_suite_name: str, interactive_mode: Optional[CLISuiteInteractiveFlagCombinations] = None) → dict
great_expectations.core.usage_statistics.usage_statistics.add_datasource_usage_statistics(data_context: DataContext, name: str, **kwargs) → dict
great_expectations.core.usage_statistics.usage_statistics.get_batch_list_usage_statistics(data_context: DataContext, *args, **kwargs) → dict
great_expectations.core.usage_statistics.usage_statistics.get_checkpoint_run_usage_statistics(checkpoint: Checkpoint, *args, **kwargs) → dict
great_expectations.core.usage_statistics.usage_statistics.send_usage_message(data_context: DataContext, event: str, event_payload: Optional[dict] = None, success: Optional[bool] = None) → None

send a usage statistics message.