Change the default package name.

Author: mukundneharkarlm

README.md

@@ -1,13 +1,12 @@
-# The LogicMonitor Python Ingestion library
+# The LogicMonitor Python Data library
 This Python Library is suitable for ingesting the metrics into the LogicMonitor Platform
 
-[![Build](https://circleci.com/gh/mukundneharkar/lmsdk.svg?style=svg)](https://circleci.com/gh/mukundneharkar/lmsdk.svg?style=svg)
-[![Documentation Status](https://readthedocs.org/projects/logicmonitor-api-sdk-py/badge/?version=latest)](https://logicmonitor-api-sdk-py.readthedocs.io/en/latest/?badge=latest)
-[![PyPI - Version](https://img.shields.io/pypi/v/logicmonitor-api-sdk-py.svg)](https://pypi.org/project/logicmonitor-api-sdk-py)
-[![PyPI - Downloads](https://pepy.tech/badge/logicmonitor-api-sdk-py)](https://pepy.tech/project/logicmonitor-api-sdk-py)
+[![Documentation Status](https://readthedocs.org/projects/logicmonitor-data-sdk-py/badge/?version=latest)](https://logicmonitor-data-sdk-py.readthedocs.io/en/latest/?badge=latest)
+[![PyPI - Version](https://img.shields.io/pypi/v/logicmonitor-data-sdk-py.svg)](https://pypi.org/project/logicmonitor-data-sdk-py)
+[![PyPI - Downloads](https://pepy.tech/badge/logicmonitor-data-sdk-py)](https://pepy.tech/project/logicmonitor-data-sdk-py)
 
 
-- Library Documentation: https://logicmonitor-api-sdk-py.readthedocs.io/en/latest/
+- Library Documentation: https://logicmonitor-data-sdk-py.readthedocs.io/en/latest/
 - LogicMonitor: https://LogicMonitor.com
 
 Overview
@@ -27,7 +26,7 @@ Python 2.7 and 3.4+
 
 Documentation
 -------------
-https://logicmonitor-api-sdk-py.readthedocs.io/en/latest/
+https://logicmonitor-data-sdk-py.readthedocs.io/en/latest/
 
 
 Getting Started
@@ -45,17 +44,17 @@ interval.
 
     import psutil as psutil
 
-    import logicmonitor_api_sdk
-    from logicmonitor_api_sdk.api.response_interface import ResonseInterface
-    from logicmonitor_api_sdk.models import Resource, DataSource, DataPoint, \
+    import logicmonitor_data_sdk
+    from logicmonitor_data_sdk.api.response_interface import ResonseInterface
+    from logicmonitor_data_sdk.models import Resource, DataSource, DataPoint, \
       DataSourceInstance
 
-    from logicmonitor_api_sdk.api.metrics import Metrics
+    from logicmonitor_data_sdk.api.metrics import Metrics
 
-    logger = logging.getLogger('lmingest.api')
+    logger = logging.getLogger('lmdata.api')
     logger.setLevel(logging.INFO)
 
-    configuration = logicmonitor_api_sdk.Configuration()
+    configuration = logicmonitor_data_sdk.Configuration()
     # For debug log, set the value to True
     configuration.debug = True
 
@@ -81,7 +80,7 @@ interval.
                           create=True)
       datasource = DataSource(name="DiskUsingSDK")
       datapoints = ['total', 'used', 'free']
-      metric_api = Metrics(batch=True, interval=10, response_callback=MyResponse())
+      metric_api = Metrics(batch=True, interval=30, response_callback=MyResponse())
       while True:
         partitions = psutil.disk_partitions()
         for p in partitions:
@@ -99,7 +98,7 @@ interval.
                                     instance=instance,
                                     datapoint=datapoint,
                                     values=values)
-        time.sleep(10)
+        time.sleep(5)
 
 
     if __name__ == "__main__":
@@ -118,5 +117,4 @@ Then run the program as:
 
 Get in Touch
 ------------
-
-If you'd like to suggest a feature or report a bug, please add an issue `here <https://github.com/logicmonitor/logicmonitor_api_sdk_py/issues>`_.
+If you have questions in general, reach out to our [support](mailto:support@logicmonitor.com)

docs/source/conf.py

@@ -18,10 +18,10 @@
 
 # -- Project information -----------------------------------------------------
 _version = {}
-with open("../../logicmonitor_api_sdk/version.py") as fp:
+with open("../../logicmonitor_data_sdk/version.py") as fp:
   exec(fp.read(), _version)
 
-project = 'LogicMonitor API SDK Python'
+project = 'LogicMonitor DATA SDK Python'
 copyright = '2021, Logicmonitor'
 author = 'Logicmonitor'
 

docs/source/index.rst

@@ -1,5 +1,5 @@
 *****************************************
-Python Ingestion library for LogicMonitor
+Python Data SDK library for LogicMonitor
 *****************************************
 
 This Python Library for ingesting the metrics into the LogicMonitor Platform
@@ -21,6 +21,8 @@ alerting.
 More details are available on `support
 site <https://www.logicmonitor.com/support>`__
 
+The :mod:`logicmonitor_data_sdk` module provides
+  - :mod:`logicmonitor_data_sdk.api.metrics`: a HTTP Api client for ingesting the metrics data.
 
 Requirements.
 *************
@@ -35,30 +37,26 @@ Installation
 pip install
 ===========
 
-If the python package ishosted on Github, you can install directly from
-Github
+Install from PyPI.
 
 .. code:: sh
 
-    pip install logicmonitor_api_sdk
+    pip install logicmonitor_data_sdk
 
-| (you may need to run ``pip`` with root permission:
-
-``sudo pip install logicmonitor_api_sdk``)
 
 Then import the package:
 
 .. code:: python
 
-    import logicmonitor_api_sdk
+    import logicmonitor_data_sdk
 
 
 Getting Started
 ***************
 
 Please follow the :ref:`RST Installation` and then run below a working example for submitting the disk
 metrics to your LM account. This script will monitor the Usage, Free and Total of the disk at
-every 10 sec interval.
+every 5 sec interval.
 
 .. literalinclude:: ../../example/disk_metrics.py
   :language: python
@@ -75,10 +73,10 @@ Then run the program as:
 
 Configuration
 *************
-SDK must be configured with logicmonitor_api_sdk.Configuration().
+SDK must be configured with logicmonitor_data_sdk.Configuration().
 The account name, an API key and its id are required.
 
-.. automodule:: logicmonitor_api_sdk.configuration
+.. automodule:: logicmonitor_data_sdk.configuration
    :members:
 
 API Calls
@@ -94,7 +92,7 @@ Be sure to initialize the client using :ref:`RST Configuration` and then use :re
 
 Metrics Ingestion API
 =====================
-.. automodule:: logicmonitor_api_sdk.api.metrics
+.. automodule:: logicmonitor_data_sdk.api.metrics
    :members:
 
 
@@ -103,28 +101,28 @@ Models
 
 Resource
 ==========
-.. automodule:: logicmonitor_api_sdk.models.resource
+.. automodule:: logicmonitor_data_sdk.models.resource
    :members:
 
 DataSource
 ============
-.. automodule:: logicmonitor_api_sdk.models.datasource
+.. automodule:: logicmonitor_data_sdk.models.datasource
    :members:
 
 DataSourceInstance
 ====================
-.. automodule:: logicmonitor_api_sdk.models.datasource_instance
+.. automodule:: logicmonitor_data_sdk.models.datasource_instance
    :members:
 
 DataPoint
 ============
-.. automodule:: logicmonitor_api_sdk.models.datapoint
+.. automodule:: logicmonitor_data_sdk.models.datapoint
    :members:
 
 
 ResonseInterface
 ==================
-.. automodule:: logicmonitor_api_sdk.api.response_interface
+.. automodule:: logicmonitor_data_sdk.api.response_interface
     :members:
 
 .. toctree::
@@ -143,5 +141,4 @@ ResonseInterface
 
 Get in Touch
 ============
-
-If you'd like to suggest a feature or report a bug, please add an issue `here <https://github.com/logicmonitor/logicmonitor_api_sdk_py/issues>`_.
+If you have questions in general, reach out to our support@logicmonitor.com

example/cpu_metrics.py

@@ -6,17 +6,17 @@
 import psutil as psutil
 
 sys.path.append("..")
-import logicmonitor_api_sdk
-from logicmonitor_api_sdk.api.response_interface import ResonseInterface
-from logicmonitor_api_sdk.models import Resource, DataSource, DataPoint, \
+import logicmonitor_data_sdk
+from logicmonitor_data_sdk.api.response_interface import ResonseInterface
+from logicmonitor_data_sdk.models import Resource, DataSource, DataPoint, \
   DataSourceInstance
 
-from logicmonitor_api_sdk.api.metrics import Metrics
+from logicmonitor_data_sdk.api.metrics import Metrics
 
-logger = logging.getLogger('lmingest.api')
+logger = logging.getLogger('lmdata.api')
 logger.setLevel(logging.INFO)
 
-configuration = logicmonitor_api_sdk.Configuration()
+configuration = logicmonitor_data_sdk.Configuration()
 # For debug log, set the value to True
 configuration.debug = False
 

example/disk_metrics.py

@@ -4,16 +4,16 @@
 
 import psutil as psutil
 
-import logicmonitor_api_sdk
-from logicmonitor_api_sdk.api.metrics import Metrics
-from logicmonitor_api_sdk.api.response_interface import ResonseInterface
-from logicmonitor_api_sdk.models import Resource, DataSource, DataPoint, \
+import logicmonitor_data_sdk
+from logicmonitor_data_sdk.api.metrics import Metrics
+from logicmonitor_data_sdk.api.response_interface import ResonseInterface
+from logicmonitor_data_sdk.models import Resource, DataSource, DataPoint, \
   DataSourceInstance
 
-logger = logging.getLogger('lmingest.api')
+logger = logging.getLogger('lmdata.api')
 logger.setLevel(logging.INFO)
 
-configuration = logicmonitor_api_sdk.Configuration()
+configuration = logicmonitor_data_sdk.Configuration()
 # For debug log, set the value to True
 configuration.debug = False
 
@@ -39,13 +39,15 @@ def MetricRequest():
                       create=True)
   datasource = DataSource(name="DiskUsingSDK")
   datapoints = ['total', 'used', 'free']
-  metric_api = Metrics(batch=True, interval=10, response_callback=MyResponse())
+  metric_api = Metrics(batch=True, interval=30, response_callback=MyResponse())
   while True:
     partitions = psutil.disk_partitions()
     for p in partitions:
       # Using the device as instance name. We can use the mountpoint as well.
+
       instance_name = p.device
       usage = psutil.disk_usage(instance_name)._asdict()
+
       # Create the instance object for every device. Name should not have the
       # special characters so replacing it with the '-'.
       instance = DataSourceInstance(name=instance_name.replace('/', '-'),
@@ -58,7 +60,7 @@ def MetricRequest():
                                 instance=instance,
                                 datapoint=datapoint,
                                 values=values)
-    time.sleep(10)
+    time.sleep(5)
 
 
 if __name__ == "__main__":

example/test_property.py

@@ -2,16 +2,16 @@
 import sys
 
 sys.path.append("..")
-import logicmonitor_api_sdk
-from logicmonitor_api_sdk.api.metrics import Metrics
+import logicmonitor_data_sdk
+from logicmonitor_data_sdk.api.metrics import Metrics
 
-logger = logging.getLogger('lmingest.api')
+logger = logging.getLogger('lmdata.api')
 logger.setLevel(logging.INFO)
 
-configuration = logicmonitor_api_sdk.Configuration(company='COMPANY',
-                                                   authentication={
-                                                     'id': 'ID',
-                                                     'key': 'KEY'})
+configuration = logicmonitor_data_sdk.Configuration(company='COMPANY',
+                                                    authentication={
+                                                      'id': 'ID',
+                                                      'key': 'KEY'})
 
 configuration.debug = False
 

logicmonitor_api_sdk/__init__.py

@@ -0,0 +1,27 @@
+# coding: utf-8
+
+# flake8: noqa
+
+from __future__ import absolute_import
+
+# import apis into sdk package
+# import ApiClient
+from logicmonitor_data_sdk.api_client import ApiClient
+from logicmonitor_data_sdk.configuration import Configuration
+# import models into sdk package
+from logicmonitor_data_sdk.models.list_rest_data_point_v1 import \
+  ListRestDataPointV1
+from logicmonitor_data_sdk.models.list_rest_data_source_instance_v1 import \
+  ListRestDataSourceInstanceV1
+from logicmonitor_data_sdk.models.map_string_string import MapStringString
+from logicmonitor_data_sdk.models.push_metric_api_response import \
+  PushMetricAPIResponse
+from logicmonitor_data_sdk.models.rest_data_point_v1 import RestDataPointV1
+from logicmonitor_data_sdk.models.rest_data_source_instance_v1 import \
+  RestDataSourceInstanceV1
+from logicmonitor_data_sdk.models.rest_instance_properties_v1 import \
+  RestInstancePropertiesV1
+from logicmonitor_data_sdk.models.rest_metrics_v1 import RestMetricsV1
+from logicmonitor_data_sdk.models.rest_resource_properties_v1 import \
+  RestResourcePropertiesV1
+from logicmonitor_data_sdk.version import __version__