Deprecate WavefrontProxyClient (#69)

* Deprecate WavefrontProxyClient

* disabled duplicate-code check

* added uri dependency

* Fixed Travis CI Errors

* Re-Run Travis-CI Build

* incorporated review comments

* Added unit tests

* Fixed travis ci error

* deprecated proxy and direct client

* added a command to install a pkg

* Fix pylint error for python2

* Fix pylint error for python2

* removed py2 support from TravisCI

* removed py2 support from TravisCI

* Deprecate WavefrontProxyClient

* incorporated review comments

* Removed parameters from super method call

* incorporated review comments

* Added multiclient information

* Fixed travis ci errors

* Update wavefront_sdk/client_factory.py

Co-authored-by: Artem Ustinov <ustinov@users.noreply.github.com>

* Update wavefront_sdk/client_factory.py

Co-authored-by: Artem Ustinov <ustinov@users.noreply.github.com>

* Update wavefront_sdk/client_factory.py

Co-authored-by: Artem Ustinov <ustinov@users.noreply.github.com>

* Update test/test_wavefront_client.py

Co-authored-by: Artem Ustinov <ustinov@users.noreply.github.com>

* Update test/test_wavefront_client.py

Co-authored-by: Artem Ustinov <ustinov@users.noreply.github.com>

* Update test/test_wavefront_client.py

Co-authored-by: Artem Ustinov <ustinov@users.noreply.github.com>

* Update test/test_wavefront_client.py

Co-authored-by: Artem Ustinov <ustinov@users.noreply.github.com>

* Update test/test_wavefront_client.py

Co-authored-by: Artem Ustinov <ustinov@users.noreply.github.com>

Co-authored-by: Artem Ustinov <ustinov@users.noreply.github.com>

Author: yogeshprasad

.travis.yml

@@ -8,13 +8,14 @@ python:
 install:
   - pip install requests
   - pip install tdigest
+  - pip install Deprecated
   - pip install flake8 flake8-colors flake8-import-order
   - pip install pep8-naming
   - pip install pydocstyle
   - pip install pylint
 before_script:
   - python -m flake8
-  - python -m pylint wavefront_sdk
+  - python -m pylint -d duplicate-code wavefront_sdk
   - python -m pydocstyle
 script:
   - python -m unittest discover

README.md

@@ -139,8 +139,10 @@ You can send metrics, histograms, or trace data from your application to the Wav
 * Use a [**Wavefront proxy**](https://docs.wavefront.com/proxies.html), which then forwards the data to the Wavefront service. This is the recommended choice for a large-scale deployment that needs resilience to internet outages, control over data queuing and filtering, and more.
 
 You instantiate an object that corresponds to your choice:
-* Option 1: [Create a `WavefrontDirectClient`](#option-1-create-a-wavefrontdirectclient) to send data directly to a Wavefront service.
-* Option 2: [Create a `WavefrontProxyClient`](#option-2-create-a-wavefrontproxyclient) to send data to a Wavefront proxy.
+* Option 1 **(Deprecated)**: [Create a `WavefrontDirectClient`](#option-1-create-a-wavefrontdirectclient) to send data directly to a Wavefront service.
+* Option 2 **(Deprecated)**: [Create a `WavefrontProxyClient`](#option-2-create-a-wavefrontproxyclient) to send data to a Wavefront proxy.
+* Option 3: [Create a `WavefrontClient`](#option-3-create-a-wavefrontclient) to send data to a Wavefront service directly or via proxy.
+> **Deprecated implementations**: *`WavefrontDirectClient` and `WavefrontProxyClient` are deprecated from proxy version 7.0 onwards. We recommend all new applications to use the `WavefrontClient`.*
 
 ### Option 1: Create a WavefrontDirectClient
 When sending data via direct ingestion, you need to create a `WavefrontDirectClient`, and build it with the Wavefront URL and API token to send data directly to Wavefront.
@@ -188,7 +190,7 @@ wavefront_sender = WavefrontDirectClient(
 When sending data via the Wavefront proxy, you need to create a `WavefrontProxyClient`. Include the following information.
 
 * The name of the host that will run the Wavefront proxy.
-* One or more proxy listening ports to send data to. The ports you specify depend on the kinds of data you want to send (metrics, histograms, and/or trace data). You must specify at least one listener port. 
+* One or more proxy listening ports to send data to. The ports you specify depend on the kinds of data you want to send (metrics, histograms, and/or trace data). You must specify at least one listener port.
 * Optional settings for tuning communication with the proxy.
 
 > **Note**: See [Advanced Proxy Configuration and Installation](https://docs.wavefront.com/proxies_configuring.html) for details.
@@ -219,6 +221,52 @@ wavefront_sender = WavefrontProxyClient(
 | `distribution_port` | `histogramDistListenerPorts=` |
 | `tracing_port` | `traceListenerPorts=` |
 
+### Option 3: Create a WavefrontClient
+Use `WavefrontClientFactory` to create a `WavefrontClient` instance, which can send data directly to a Wavefront service or send data using a Wavefront Proxy.
+
+The `WavefrontClientFactory` supports multiple client bindings. If more than one client configuration is specified, you can create a `WavefrontMultiClient` instance, which can send data to multiple Wavefront services.
+### Prerequisites
+* Sending data via Wavefront proxy?
+  <br/>Before your application can use a `WavefrontClient` you must [set up and start a Wavefront proxy](https://docs.wavefront.com/proxies_installing.html).
+* Sending data via direct ingestion?
+  * Verify that you have the Direct Data Ingestion permission. For details, see [Examine Groups, Roles, and Permissions](https://docs.wavefront.com/users_account_managing.html#examine-groups-roles-and-permissions).
+  * The HTTP URL of your Wavefront instance. This is the URL you connect to when you log in to Wavefront, typically something like `http://<domain>.wavefront.com`.<br/> You can also use HTTP client with Wavefront Proxy version 7.0 or newer. Example: `http://proxy.acme.corp:2878`.
+  * [Obtain the API token](http://docs.wavefront.com/wavefront_api.html#generating-an-api-token).
+
+### Initialize the WavefrontClient
+```python
+from wavefront_sdk.client_factory import WavefrontClientFactory
+
+# Create a sender with:
+   # Required Parameter
+   #   URL format to send data via proxy: "proxy://<your.proxy.load.balancer.com>:<somePort>"
+   #   URL format to send data via direct ingestion: "https://TOKEN@DOMAIN.wavefront.com"
+   # Optional Parameter
+   #   max queue size (in data points). Default: 50000
+   #   batch size (in data points). Default: 10000
+   #   flush interval  (in seconds). Default: 1 second
+
+client_factory = WavefrontClientFactory()
+client_factory.add_client(
+    url="<URL for proxy or direct ingestions>",
+    max_queue_size=50000,
+    batch_size=10000,
+    flush_interval_seconds=5)
+wavefront_sender = client_factory.get_client()
+```
+#### Add multiple clients to client factory to send data to multiple Wavefront services.
+```
+from wavefront_sdk.client_factory import WavefrontClientFactory
+
+client_factory = WavefrontClientFactory()
+client_factory.add("proxy://our.proxy.lb.com:2878")
+client_factory.add("https://someToken@DOMAIN.wavefront.com")
+
+# Send traces and spans to the tracing port. If you are directly using the sender SDK to send spans without using any other SDK, use the same port as the customTracingListenerPorts configured in the wavefront proxy. Assume you have installed and started the proxy on <proxy_hostname>.
+client_factory.add("http://<proxy_hostname>:30000")
+
+wavefront_sender = client_factory.get_client()
+```
 
 ## Send a Single Data Point to Wavefront
 

example.py

@@ -5,6 +5,7 @@
 import time
 import uuid
 
+from wavefront_sdk.client_factory import WavefrontClientFactory
 from wavefront_sdk.direct import WavefrontDirectClient
 from wavefront_sdk.entities.histogram import histogram_granularity
 from wavefront_sdk.proxy import WavefrontProxyClient
@@ -106,6 +107,58 @@ def send_event_via_direct_ingestion(direct_ingestion_client):
          "details": "broker backup"})
 
 
+def send_metrics_multi_client(proxy_client):
+    """Send a metric using multi client."""
+    proxy_client.send_metric(
+        'python' + str(sys.version_info[0])
+        + '.multi.client.new york.power.usage',
+        42422.0, None, 'localhost', None)
+
+
+def send_delta_counter_multi_client(proxy_client):
+    """Send a delta counter using multi client."""
+    proxy_client.send_delta_counter(
+        'python' + str(sys.version_info[0])
+        + '.delta.multi.client.counter',
+        1.0, 'localhost', None)
+
+
+def send_histogram_multi_client(proxy_client):
+    """Send a histogram using multi client."""
+    proxy_client.send_distribution(
+        'python' + str(sys.version_info[0]) + '.multi.client.request.latency',
+        [(30, 20), (5.1, 10)],
+        {histogram_granularity.DAY, histogram_granularity.HOUR,
+            histogram_granularity.MINUTE},
+        None, 'appServer1', {'region': 'us-west'})
+
+
+def send_tracing_span_multi_client(proxy_client):
+    """Send a tracing span using multi client."""
+    proxy_client.send_span(
+        'getAllUsersFromPythonMultiClient',
+        int(time.time()), 34350, 'localhost',
+        uuid.UUID('7b3bf470-9456-11e8-9eb6-529269fb1459'),
+        uuid.UUID('0313bafe-9457-11e8-9eb6-529269fb1459'),
+        [uuid.UUID('2f64e538-9457-11e8-9eb6-529269fb1459')], None,
+        [('application', 'Wavefront'), ('service', 'testService'),
+         ('cluster', 'testCluster'), ('shard', 'testShard'),
+         ('http.method', 'GET')], None)
+
+
+def send_event_via_multi_client(direct_ingestion_client):
+    """Send an event through multi ingestion."""
+    direct_ingestion_client.send_event(
+        'event_via_multi_client',
+        time.time(),
+        None,
+        "localhost",
+        ["env:", "test"],
+        {"severity": "severe",
+         "type": "backup",
+         "details": "broker backup"})
+
+
 if __name__ == '__main__':
     wavefront_server = sys.argv[1]
     token = sys.argv[2]
@@ -114,6 +167,10 @@ def send_event_via_direct_ingestion(direct_ingestion_client):
     distribution_port = None if len(sys.argv) <= 5 else sys.argv[5]
     tracing_port = None if len(sys.argv) <= 6 else sys.argv[6]
     event_port = None if len(sys.argv) <= 7 else sys.argv[7]
+    # Proxy url: proxy://<proxy-host-ip>:2878
+    proxy_url = None if len(sys.argv) <= 8 else sys.argv[8]
+    # Direct url: https://<api-key>@<cluster-name>.wavefront.com
+    direct_url = None if len(sys.argv) <= 9 else sys.argv[9]
 
     wavefront_proxy_client = WavefrontProxyClient(
         host=proxy_host,
@@ -124,6 +181,11 @@ def send_event_via_direct_ingestion(direct_ingestion_client):
 
     wavefront_direct_client = WavefrontDirectClient(wavefront_server, token)
 
+    multi_client_factory = WavefrontClientFactory()
+    multi_client_factory.add_client(proxy_url)
+    multi_client_factory.add_client(direct_url)
+    multi_client = multi_client_factory.get_client()
+
     try:
         while True:
             send_metrics_via_proxy(wavefront_proxy_client)
@@ -138,7 +200,14 @@ def send_event_via_direct_ingestion(direct_ingestion_client):
             send_delta_counter_via_direct_ingestion(wavefront_direct_client)
             send_event_via_direct_ingestion(wavefront_direct_client)
 
+            send_metrics_multi_client(multi_client)
+            send_histogram_multi_client(multi_client)
+            send_tracing_span_multi_client(multi_client)
+            send_delta_counter_multi_client(multi_client)
+            send_event_via_multi_client(multi_client)
+
             time.sleep(1)
     finally:
         wavefront_proxy_client.close()
         wavefront_direct_client.close()
+        multi_client.close()

setup.py

@@ -15,7 +15,7 @@
 
 setuptools.setup(
     name='wavefront-sdk-python',
-    version='1.7.6',
+    version='1.7.7',
     author='Wavefront by VMware',
     author_email='chitimba@wavefront.com',
     url='https://github.com/wavefrontHQ/wavefront-sdk-python',
@@ -39,6 +39,7 @@
                                                'tests.*', 'tests')),
     install_requires=(
         'requests>=2.18.4',
-        'tdigest>=0.5.2'
+        'tdigest>=0.5.2',
+        'Deprecated>=1.2.10'
         )
 )

test/test_wavefront_client.py

@@ -0,0 +1,70 @@
+"""Unit Tests for Wavefront Client.
+
+@Yogesh Prasad Kurmi (ykurmi@vmware.com)
+"""
+
+import unittest
+
+import wavefront_sdk
+from wavefront_sdk.client_factory import WavefrontClientFactory
+
+
+class WavefrontClient(unittest.TestCase):
+    """Test Functions of wavefront_sdk.client_factory."""
+
+    def test_get_server_info_from_endpoint(self):
+        """Test get_server_info_from_endpoint of WavefrontClientFactory"""
+        direct_base_url = ("https://a87826d5-889d-4b23-98f0-2f3558zd007a"
+                           "@wfcluster.wavefront.com")
+        server, token = WavefrontClientFactory(
+            ).get_server_info_from_endpoint(direct_base_url)
+        self.assertEqual(server, "https://wfcluster.wavefront.com")
+        self.assertEqual(token, "a87826d5-889d-4b23-98f0-2f3558zd007a")
+
+        proxy_base_url = "proxy://10.112.71.230:2878"
+        server, token = WavefrontClientFactory(
+            ).get_server_info_from_endpoint(proxy_base_url)
+        self.assertEqual(server, "http://10.112.71.230:2878")
+        self.assertEqual(token, None)
+
+        http_proxy_base_url = "http://192.114.71.230:2878"
+        server, token = WavefrontClientFactory(
+            ).get_server_info_from_endpoint(http_proxy_base_url)
+        self.assertEqual(server, "http://192.114.71.230:2878")
+        self.assertEqual(token, None)
+
+    def test_get_client(self):
+        """Test get_client of WavefrontClientFactory"""
+
+        # get_client should return None if there is no client
+        client = WavefrontClientFactory().get_client()
+        self.assertEqual(client, None)
+
+        # get_client should return instance of WavefrontClient
+        # if there is only one client
+        direct_base_url = ("https://a87826d5-889d-4b23-98f0-2f3558zd007a"
+                           "@wfcluster.wavefront.com")
+        multi_client_factory = WavefrontClientFactory()
+        multi_client_factory.add_client(direct_base_url)
+        self.assertTrue(isinstance(multi_client_factory.get_client(),
+                                   wavefront_sdk.client.WavefrontClient))
+
+        # get_client should return instance of WavefrontMultiClient
+        # if there is more than one client
+        proxy_base_url = "proxy://192.114.71.230:2878"
+        multi_client_factory.add_client(proxy_base_url)
+        self.assertTrue(isinstance(multi_client_factory.get_client(),
+                                   wavefront_sdk.multi_clients
+                                   .WavefrontMultiClient))
+
+    def test_existing_client(self):
+        """Test existing_client of WavefrontClientFactory"""
+        server = "http://192.114.71.230:2878"
+
+        # existing_client should return False if client does not exists
+        self.assertFalse(WavefrontClientFactory().existing_client(server))
+
+
+if __name__ == '__main__':
+    # run 'python -m unittest discover' from top-level to run tests
+    unittest.main()

wavefront_sdk/__init__.py

@@ -9,11 +9,14 @@
 
 import pkg_resources
 
+from .client_factory import WavefrontClientFactory
 from .direct import WavefrontDirectClient
 from .proxy import WavefrontProxyClient
 
 
-__all__ = ['WavefrontDirectClient', 'WavefrontProxyClient']
+__all__ = ['WavefrontDirectClient',
+           'WavefrontProxyClient',
+           'WavefrontClientFactory']
 
 __version__ = None