|
| | __init__ (self, interval=1200, requested_package_size=10, cookie=None, query_whitelist=[], header_blacklist=[], share_percentage=1, endpoint="https://devices-v4.51degrees.com/new.ashx", request_timeout=REQUEST_TIMEOUT) |
| | Constructor for ShareUsage element.
|
| | __del__ (self) |
| | close (self) |
| | Wait for any usage data already being sent, then stop the threads that send it.
|
| | get_constant_xml (self) |
| | get_flow_elements (self) |
| | get_evidence_key_filter (self) |
| | The share useage element comes with its own evidence key filter that uses the whitelists and blacklists to determine which evidence to share.
|
| | share_send_usage (self) |
| | Internal method to send the share usage bundle to the 51Degrees servers.
|
| | send_thread (self, endpoint, data) |
| | add_to_share_usage (self, data) |
| | Internal method which adds to the share usage bundle (generating XML) @type key: dict.
|
| | process_internal (self, flow_data) |
| | Internal process method which uses the ShareUsageTracker to determine whether to add usage data to a batch and adds it if necessary.
|
| | get_data_from_evidence (self, flow_data) |
| | Creates a ShareUsageData instance populated from the evidence within the flow data provided.
|
| | __init__ (self, data_file=None) |
| | Constructor for an engine.
|
| | set_cache (self, cache) |
| | Add a cache to an engine @type cashe: Cache.
|
| | set_restricted_properties (self, properties_list) |
| | Add a subset of properties.
|
| | in_cache (self, flowdata) |
| | A method to check if a flowdata's evidence is in the cache.
|
| | refresh (self, identifier) |
| | process (self, flowdata) |
| | Engine's core process function.
|
| | on_registration (self, pipeline) |
| | Called when an engine is registered with a pipeline and if there is a data file, a data file update service is attached to the parent pipeline.
|
| | register_data_file (self, data_file) |
| | Register a data_file of the DataFile class with the engine @type data_file: DataFile.
|
| | __init__ (self) |
| | List of Pipelines the FlowElement has been added to.
|
| | filter_evidence (self, flowdata) |
| | Filter FlowData evidence using the FlowElement's EvidenceKeyFilter.
|
| | filter_evidence_key (self, key) |
| | Filter FlowData.evidence using the flowElement's EvidenceKeyFilter with the property key of evidence of interest.
|
| | get_properties (self) |
| | Get the FlowElement.properties of a FlowElement.
|
| fiftyone_pipeline_engines_fiftyone.share_usage.ShareUsage.__init__ |
( |
| self, |
|
|
| interval = 1200, |
|
|
| requested_package_size = 10, |
|
|
| cookie = None, |
|
|
| query_whitelist = [], |
|
|
| header_blacklist = [], |
|
|
| share_percentage = 1, |
|
|
| endpoint = "https://devices-v4.51degrees.com/new.ashx", |
|
|
| request_timeout = REQUEST_TIMEOUT ) |
Constructor for ShareUsage element.
@type interval: int
- Parameters
-
| interval | If exactly the same evidence values are seen multiple times within this time limit (in seconds) then they will only be shared once. @type requested_package_size: int |
| requested_package_size | The usage element will group data into single requests before sending it. This setting controls the minimum number of entries before data is sent. If you are sharing large amounts of data, increasing this value is recommended in order to reduce the overhead of sending HTTP messages. For example, the 51Degrees cloud service uses a value of 2500. @type cookie: string |
| cookie | If a cookie is being used to identify user sessions, it can be specified here in order to reduce the sharing of duplicated data. @type query_whitelist: list |
| query_whitelist | By default query string and HTTP form parameters are not shared unless prefixed with '51D_'. If you need to share query string parameters, a list can be specified here. @type query_blacklist: list |
| query_blacklist | By default, all HTTP headers (except a few, such as Cookies) are shared. Individual headers can be excluded from sharing by adding them to this list. @type share_percentage : float |
| share_percentage | approximate proportion of requests to be shared. 1 = 100%, 0.5 = 50%, etc.. |
| fiftyone_pipeline_engines_fiftyone.share_usage.ShareUsage.add_to_share_usage |
( |
| self, |
|
|
| data ) |
Internal method which adds to the share usage bundle (generating XML) @type key: dict.
- Parameters
-
| key | data value store of current evidence in FlowData |
| fiftyone_pipeline_engines_fiftyone.share_usage.ShareUsage.close |
( |
| self | ) |
|
Wait for any usage data already being sent, then stop the threads that send it.
The pipeline calls this when it is closed.
Reimplemented from fiftyone_pipeline_engines.engine.Engine.
| fiftyone_pipeline_engines_fiftyone.share_usage.ShareUsage.get_data_from_evidence |
( |
| self, |
|
|
| flow_data ) |
Creates a ShareUsageData instance populated from the evidence within the flow data provided.
- Parameters
-
| {FlowData} | flowData the flow data containing the evidence to use |
- Returns
- a new ShareUsageData instance, populated from the evidence provided
| fiftyone_pipeline_engines_fiftyone.share_usage.ShareUsage.get_evidence_key_filter |
( |
| self | ) |
|
The share useage element comes with its own evidence key filter that uses the whitelists and blacklists to determine which evidence to share.
Reimplemented from fiftyone_pipeline_core.flowelement.FlowElement.
| fiftyone_pipeline_engines_fiftyone.share_usage.ShareUsage.process_internal |
( |
| self, |
|
|
| flow_data ) |
Internal process method which uses the ShareUsageTracker to determine whether to add usage data to a batch and adds it if necessary.
@type flow_data: FlowData
- Parameters
-
| flow_data | FlowData to process |
Reimplemented from fiftyone_pipeline_core.flowelement.FlowElement.
| fiftyone_pipeline_engines_fiftyone.share_usage.ShareUsage.share_send_usage |
( |
| self | ) |
|
Internal method to send the share usage bundle to the 51Degrees servers.
