aliyun-log-python-sdk 0.9.11__tar.gz → 0.9.13__tar.gz

{aliyun-log-python-sdk-0.9.11/aliyun_log_python_sdk.egg-info → aliyun_log_python_sdk-0.9.13}/PKG-INFO

@@ -1,19 +1,19 @@
 Metadata-Version: 2.1
 Name: aliyun-log-python-sdk
-Version: 0.9.11
+Version: 0.9.13
 Summary: Aliyun log service Python client SDK
 Home-page: https://github.com/aliyun/aliyun-log-python-sdk
 Author: Aliyun
 Classifier: Development Status :: 5 - Production/Stable
 Classifier: License :: OSI Approved :: MIT License
 Classifier: Operating System :: OS Independent
-Classifier: Programming Language :: Python :: 2.6
 Classifier: Programming Language :: Python :: 2.7
-Classifier: Programming Language :: Python :: 3.3
-Classifier: Programming Language :: Python :: 3.4
-Classifier: Programming Language :: Python :: 3.5
-Classifier: Programming Language :: Python :: 3.6
 Classifier: Programming Language :: Python :: 3.7
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
 Classifier: Programming Language :: Python :: Implementation :: PyPy
 License-File: LICENSE
 Requires-Dist: six

{aliyun-log-python-sdk-0.9.11 → aliyun_log_python_sdk-0.9.13}/README.md

@@ -30,15 +30,8 @@ Don't want to write code? Try the [CLI](http://aliyun-log-cli.readthedocs.io/en/
 
 ### Supported Python：
 
-1. Python 2.6
-2. Python 2.7
-3. Python 3.3
-4. Python 3.4
-5. Python 3.5
-6. Python 3.6
-7. Python 3.7
-8. Pypy2
-9. Pypy3
+1. Python 2 with version >= 2.7  
+2. Python 3 with version >= 3.7  
 
 ### Supported Log Service API
 1. Log Service API 0.6

{aliyun-log-python-sdk-0.9.11 → aliyun_log_python_sdk-0.9.13}/aliyun/log/__init__.py

@@ -34,6 +34,7 @@ from .shipper_response import *
 from .common_response import *
 from .external_store_config_response import *
 from .proto import LogGroupRaw as LogGroup
+from .rebuild_index_response import *
 
 # logging handler
 from .logger_hanlder import SimpleLogHandler, QueuedLogHandler, LogFields, UwsgiQueuedLogHandler

{aliyun-log-python-sdk-0.9.11 → aliyun_log_python_sdk-0.9.13}/aliyun/log/logclient.py

@@ -37,6 +37,7 @@ from .logstore_config_response import *
 from .substore_config_response import *
 from .logtail_config_response import *
 from .machinegroup_response import *
+from .rebuild_index_response import *
 from .project_response import *
 from .pulllog_response import PullLogResponse
 from .putlogsresponse import PutLogsResponse
@@ -855,7 +856,7 @@ class LogClient(object):
         :raise: LogException
         """
         if not is_stats_query(sql):
-            raise LogException("parameter sql invalid, please follow 'Search|Analysis' syntax, refer to "
+            raise LogException("InvalidParameter", "parameter sql invalid, please follow 'Search|Analysis' syntax, refer to "
                                "https://help.aliyun.com/document_detail/43772.html")
         return self.get_log(project, logstore, from_time, to_time, topic=None,
                             query=sql, reverse=False, offset=0, size=100, power_sql=power_sql)
@@ -2560,6 +2561,31 @@ class LogClient(object):
 
         (resp, header) = self._send("POST", project_name, body, resource, params, headers)
         return CreateProjectResponse(header, resp)
+    
+    def update_project(self, project_name, project_des):
+        """ Update a project
+        Unsuccessful operation will cause an LogException.
+
+        :type project_name: string
+        :param project_name: the Project name
+
+        :type project_des: string
+        :param project_des: the description of a project
+
+        :return: UpdateProjectResponse
+
+        :raise: LogException
+        """
+
+        params = {}
+        body = {"description": project_des}
+
+        body = six.b(json.dumps(body))
+        headers = {'Content-Type': 'application/json', 'x-log-bodyrawsize': str(len(body))}
+        resource = "/"
+
+        (resp, header) = self._send("PUT", project_name, body, resource, params, headers)
+        return UpdateProjectResponse(header, resp)
 
     def get_project(self, project_name):
         """ get project
@@ -3052,7 +3078,7 @@ class LogClient(object):
             to_client = self
         return copy_project(self, to_client, from_project, to_project, copy_machine_group)
 
-    def copy_logstore(self, from_project, from_logstore, to_logstore, to_project=None, to_client=None, to_region_endpoint=None):
+    def copy_logstore(self, from_project, from_logstore, to_logstore, to_project=None, to_client=None, to_region_endpoint=None, keep_config_name=False):
         """
         copy logstore, index, logtail config to target logstore, machine group are not included yet.
         the target logstore will be crated if not existing
@@ -3077,7 +3103,7 @@ class LogClient(object):
 
         :return:
         """
-        return copy_logstore(self, from_project, from_logstore, to_logstore, to_project=to_project, to_client=to_client, to_region_endpoint=to_region_endpoint)
+        return copy_logstore(self, from_project, from_logstore, to_logstore, to_project=to_project, to_client=to_client, to_region_endpoint=to_region_endpoint, keep_config_name=keep_config_name)
 
     def list_project(self, offset=0, size=100, project_name_pattern=None, resource_group_id=''):
         """ list the project
@@ -5772,6 +5798,73 @@ class LogClient(object):
         (resp, header) = self._send("POST", project, body_str, resource, params, headers)
         return CreateEntityResponse(header, resp)
 
+    def create_rebuild_index(self, project, logstore, job_name, display_name, from_time, to_time):
+        """Create a job that rebuild index for a logstore
+        type: (string, string, string, string, int, int) -> CreateRebuildIndexResponse
+
+        :type project: string
+        :param project: the project name
+
+        :type logstore: string
+        :param logstore: the logstore name
+        
+        :type job_name: string
+        :param job_name: job name
+        
+        :type display_name: string
+        :param display_name: display name for the job
+        
+        :type from_time: int
+        :param from_time: from time, in unix timestamp format, eg 1736156803
+
+        
+        :type to_time: int
+        :param to_time: to time, in unix timestamp format, eg 1736156803, to_time should not large than the unix_timestamp before 900 seconds ago
+
+        :return: CreateRebuildIndexResponse
+
+        :raise: LogException
+        """
+        
+        params = {}
+        headers = {"Content-Type": "application/json"}
+        body = {
+                "configuration":
+                {
+                    "fromTime": from_time,
+                    "toTime": to_time,
+                    "logstore": logstore,
+                },
+                "displayName": display_name,
+                "name": job_name,
+                "recyclable": False,
+                "type": "RebuildIndex"
+        }
+        data = six.b(json.dumps(body))
+
+        resource = "/jobs"
+        (resp, header) = self._send("POST", project, data, resource, params, headers)
+        return CreateRebuildIndexResponse(header, resp)
+    
+    def get_rebuild_index(self, project, job_name):
+        """get rebuild index by the given job_name
+
+        :type project: string
+        :param project: the project name
+
+        :type job_name: string
+        :param job_name: the job name
+
+        :return: GetRebuildIndexResponse
+
+        :raise: LogException
+        """
+        headers = {}
+        params = {}
+        resource = "/jobs/" + job_name
+        (resp, header) = self._send("GET", project, None, resource, params, headers)
+        return GetRebuildIndexResponse(header, resp)
+
 # make_lcrud_methods(LogClient, 'job', name_field='name', root_resource='/jobs', entities_key='results')
 # make_lcrud_methods(LogClient, 'dashboard', name_field='dashboardName')
 # make_lcrud_methods(LogClient, 'alert', name_field='name', root_resource='/jobs', entities_key='results', job_type="Alert")

{aliyun-log-python-sdk-0.9.11 → aliyun_log_python_sdk-0.9.13}/aliyun/log/logclient_operator.py

@@ -186,7 +186,7 @@ def copy_project(from_client, to_client, from_project, to_project, copy_machine_
             break
 
 
-def copy_logstore(from_client, from_project, from_logstore, to_logstore, to_project=None, to_client=None, to_region_endpoint=None):
+def copy_logstore(from_client, from_project, from_logstore, to_logstore, to_project=None, to_client=None, to_region_endpoint=None, keep_config_name=False):
     """
     copy logstore, index, logtail config to target logstore, machine group are not included yet.
     the target logstore will be crated if not existing
@@ -211,6 +211,9 @@ def copy_logstore(from_client, from_project, from_logstore, to_logstore, to_proj
 
     :type to_region_endpoint: string
     :param to_region_endpoint: target region, use it to operate on the "to_project" while "to_client" not be specified
+    
+    :type keep_config_name: bool
+    :param keep_config_name: use the same logtail config name as the source one, note that the config name must be unique in the same project
 
     :return:
     """
@@ -299,8 +302,10 @@ def copy_logstore(from_client, from_project, from_logstore, to_logstore, to_proj
             config = ret.logtail_config
             if config.logstore_name != from_logstore:
                 continue
-
-            config.config_name = to_logstore + '_' + config_name
+            if keep_config_name:
+                config.config_name = config_name
+            else:
+                config.config_name = to_logstore + '_' + config_name
             config.logstore_name = to_logstore
             ret = to_client.create_logtail_config(to_project, config)
 

{aliyun-log-python-sdk-0.9.11 → aliyun_log_python_sdk-0.9.13}/aliyun/log/logitem.py

@@ -12,7 +12,7 @@ class LogItem(object):
     """ LogItem used to present a log, it contains log time and multiple
     key/value pairs to present the log contents.
 
-    :type timestamp: int
+    :type timestamp: int with seconds as unit
     :param timestamp: time of the log item, the default time is the now time.
 
     :type contents: tuple(key-value) list
@@ -20,9 +20,12 @@ class LogItem(object):
     """
 
     def __init__(self, timestamp=None, time_nano_part=None, contents=None):
-        nano_time = int(time.time()* 10**9)
+        nano_time = int(time.time() * 10**9)
         self.timestamp = int(timestamp) if timestamp else int(nano_time / 1000000000)
-        self.time_nano_part= int(time_nano_part) if time_nano_part else int(nano_time%1000000000)
+        # milliseconds
+        if self.timestamp > 1e10:
+            self.timestamp = int(self.timestamp / 1000.0)
+        self.time_nano_part = int(time_nano_part) if time_nano_part else int(nano_time % 1000000000)
         self.contents = copy.deepcopy(contents) if contents else []
 
     def push_back(self, key, value):
@@ -70,6 +73,9 @@ class LogItem(object):
         :type timestamp: int
         :param timestamp: log time
         """
+        # milliseconds
+        if timestamp > 1e10:
+            timestamp = timestamp / 1000.0
         self.timestamp = int(timestamp)
 
     def set_time_nano_part(self, time_nano_part):

{aliyun-log-python-sdk-0.9.11 → aliyun_log_python_sdk-0.9.13}/aliyun/log/project_response.py

@@ -9,7 +9,7 @@ from .logresponse import LogResponse
 from .util import Util
 
 __all__ = [
-    'CreateProjectResponse', 'DeleteProjectResponse',
+    'CreateProjectResponse', 'UpdateProjectResponse', 'DeleteProjectResponse',
     'GetProjectResponse', 'ListProjectResponse',
     'GetProjectTagsResponse',
 ]
@@ -26,6 +26,17 @@ class CreateProjectResponse(LogResponse):
         print('CreateProjectResponse:')
         print('headers:', self.get_all_headers())
 
+class UpdateProjectResponse(LogResponse):
+    """
+    Response of update_project
+    """
+    def __init__(self, header, resp=''):
+        LogResponse.__init__(self, header, resp)
+
+    def log_print(self):
+        print('UpdateProjectResponse:')
+        print('headers:', self.get_all_headers())
+
 
 class DeleteProjectResponse(LogResponse):
     def __init__(self, header, resp=''):

aliyun_log_python_sdk-0.9.13/aliyun/log/rebuild_index_response.py

@@ -0,0 +1,60 @@
+from .logresponse import LogResponse
+
+__all__ = ['CreateRebuildIndexResponse', 'GetRebuildIndexResponse']
+
+
+class CreateRebuildIndexResponse(LogResponse):
+    """ Response of create_rebuild_index
+
+    :type resp: dict
+    :param resp: CreateRebuildIndexResponse HTTP response body
+
+    :type header: dict
+    :param header: CreateRebuildIndexResponse HTTP response header
+    """
+
+    def __init__(self, header, resp):
+        LogResponse.__init__(self, header, resp)
+
+    def log_print(self):
+        print('CreateRebuildIndexResponse:')
+        print('headers:', self.get_all_headers())
+
+
+class GetRebuildIndexResponse(LogResponse):
+    """ The response of the get_rebuild_index.
+
+    :type resp: dict
+    :param resp: GetRebuildIndexResponse HTTP response body
+
+    :type header: dict
+    :param header: GetRebuildIndexResponse HTTP response header
+    """
+
+    def __init__(self, header, resp):
+        LogResponse.__init__(self, header, resp)
+        self._status = resp['status']
+        self._execution_details = resp.get('executionDetails')
+        self._configuration = resp['configuration']
+
+    def get_status(self):
+        """job status
+        """
+        return self._status
+
+    def get_execution_details(self):
+        """job execution details
+        """
+        return self._execution_details
+
+    def get_configuration(self):
+        """job configuration
+        """
+        return self._configuration
+
+    def log_print(self):
+        print('GetRebuildIndexResponse:')
+        print('headers:', self.get_all_headers())
+        print('status: ', self.get_status())
+        print('execution_details: ', self.get_execution_details())
+        print('configuration: ', self.get_configuration())