aliyun-log-python-sdk 0.9.1__tar.gz → 0.9.3__tar.gz

{aliyun-log-python-sdk-0.9.1/aliyun_log_python_sdk.egg-info → aliyun-log-python-sdk-0.9.3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: aliyun-log-python-sdk
-Version: 0.9.1
+Version: 0.9.3
 Summary: Aliyun log service Python client SDK
 Home-page: https://github.com/aliyun/aliyun-log-python-sdk
 Author: Aliyun

{aliyun-log-python-sdk-0.9.1 → aliyun-log-python-sdk-0.9.3}/aliyun/log/auth.py

@@ -32,17 +32,16 @@ AUTH_VERSION_1 = 'v1'
 AUTH_VERSION_4 = 'v4'
 
 
-def make_auth(access_key_id, access_key_secret, auth_version=AUTH_VERSION_1, region=''):
+def make_auth(credentials_provider, auth_version=AUTH_VERSION_1, region=''):
     if auth_version == AUTH_VERSION_4:
-        return AuthV4(access_key_id, access_key_secret, region)
+        return AuthV4(credentials_provider, region)
     else:
-        return AuthV1(access_key_id, access_key_secret)
+        return AuthV1(credentials_provider)
 
 
 class AuthBase(object):
-    def __init__(self, access_key_id, access_key_secret):
-        self.access_key_id = access_key_id
-        self.access_key_secret = access_key_secret
+    def __init__(self, credentials_provider):
+        self.credentials_provider = credentials_provider
 
     def sign_request(self, method, resource, params, headers, body):
         pass
@@ -50,8 +49,8 @@ class AuthBase(object):
 
 class AuthV1(AuthBase):
 
-    def __init__(self, access_key_id, access_key_secret):
-        AuthBase.__init__(self, access_key_id, access_key_secret)
+    def __init__(self, credentials_provider):
+        AuthBase.__init__(self, credentials_provider)
 
     @staticmethod
     def _getGMT():
@@ -62,12 +61,16 @@ class AuthV1(AuthBase):
         return datetime.utcnow().strftime('%a, %d %b %Y %H:%M:%S GMT')
 
     def sign_request(self, method, resource, params, headers, body):
+        credentials = self.credentials_provider.get_credentials()
+        if credentials.get_security_token():
+            headers['x-acs-security-token'] = credentials.get_security_token()
+
         headers['x-log-signaturemethod'] = 'hmac-sha1'
         headers['Date'] = self._getGMT()
 
         if body:
             headers['Content-MD5'] = Util.cal_md5(body)
-        if not self.access_key_secret:
+        if not credentials.get_access_key_secret():
             return six.b('')
         content = method + '\n'
         if 'Content-MD5' in headers:
@@ -79,14 +82,14 @@ class AuthV1(AuthBase):
         content += headers['Date'] + '\n'
         content += Util.canonicalized_log_headers(headers)
         content += Util.canonicalized_resource(resource, params)
-        signature = Util.hmac_sha1(content, self.access_key_secret)
-        headers['Authorization'] = 'LOG ' + self.access_key_id + ':' + signature
+        signature = Util.hmac_sha1(content, credentials.get_access_key_secret())
+        headers['Authorization'] = 'LOG ' + credentials.get_access_key_id() + ':' + signature
         headers['x-log-date'] = headers['Date']  # bypass some proxy doesn't allow "Date" in header issue.
 
 
 class AuthV4(AuthBase):
-    def __init__(self, access_key_id, access_key_secret, region):
-        AuthBase.__init__(self, access_key_id, access_key_secret)
+    def __init__(self, credentials_provider, region):
+        AuthBase.__init__(self, credentials_provider)
         self._region = region
 
     def sign_request(self, method, resource, params, headers, body):
@@ -94,6 +97,11 @@ class AuthV4(AuthBase):
         headers['Authorization'] = self._do_sign_request(method, resource, params, headers, body, current_time)
 
     def _do_sign_request(self, method, resource, params, headers, body, current_time):
+        credentials = self.credentials_provider.get_credentials()
+
+        if credentials.get_security_token():
+            headers['x-acs-security-token'] = credentials.get_security_token()
+
         content_sha256 = sha256(body).hexdigest() \
             if body else 'e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855'
         headers['x-log-content-sha256'] = content_sha256
@@ -119,8 +127,9 @@ class AuthV4(AuthBase):
                          + current_time + '\n' \
                          + scope + '\n' \
                          + sha256(canonical_request.encode('utf-8')).hexdigest()
-        signature = self.build_sign_key(self.access_key_secret, self._region, current_date, string_to_sign)
-        return 'SLS4-HMAC-SHA256 Credential=%s/%s,Signature=%s' % (self.access_key_id, scope, signature)
+        signature = self.build_sign_key(credentials.get_access_key_secret(),
+                                        self._region, current_date, string_to_sign)
+        return 'SLS4-HMAC-SHA256 Credential=%s/%s,Signature=%s' % (credentials.get_access_key_id(), scope, signature)
 
     @staticmethod
     def build_canonical_request(method, resource, params, canonical_headers, signed_headers, hashed_payload):

aliyun-log-python-sdk-0.9.3/aliyun/log/credentials.py

@@ -0,0 +1,33 @@
+#!/usr/bin/env python
+# encoding: utf-8
+
+# Copyright (C) Alibaba Cloud Computing
+# All rights reserved.
+
+class Credentials(object):
+    def __init__(self, access_key_id, access_key_secret, security_token=None):
+        self.access_key_id = access_key_id
+        self.access_key_secret = access_key_secret
+        self.security_token = security_token
+
+    def get_access_key_id(self):
+        return self.access_key_id
+
+    def get_access_key_secret(self):
+        return self.access_key_secret
+
+    def get_security_token(self):
+        return self.security_token
+
+
+class CredentialsProvider(object):
+    def get_credentials(self):
+        return
+
+
+class StaticCredentialsProvider(CredentialsProvider):
+    def __init__(self, access_key_id="", access_key_secret="", security_token=""):
+        self.credentials = Credentials(access_key_id, access_key_secret, security_token)
+
+    def get_credentials(self):
+        return self.credentials

{aliyun-log-python-sdk-0.9.1 → aliyun-log-python-sdk-0.9.3}/aliyun/log/gethistogramsrequest.py

@@ -33,9 +33,12 @@ class GetHistogramsRequest(LogRequest):
 
     :type to_time_nano_part: int
     :param to_time_nano_part: nano part of query end time
+
+    :type shard_id: int
+    :param shard_id: specific shard id,-1 means all shard
     """
 
-    def __init__(self, project=None, logstore=None, fromTime=None, toTime=None, topic=None, query=None, accurate_query=True, from_time_nano_part=0 ,to_time_nano_part=0):
+    def __init__(self, project=None, logstore=None, fromTime=None, toTime=None, topic=None, query=None, accurate_query=True, from_time_nano_part=0, to_time_nano_part=0, shard_id=-1):
         LogRequest.__init__(self, project)
         self.logstore = logstore
         self.fromTime = parse_timestamp(fromTime)
@@ -45,6 +48,7 @@ class GetHistogramsRequest(LogRequest):
         self.accurate_query = accurate_query
         self.from_time_nano_part = from_time_nano_part
         self.to_time_nano_part = to_time_nano_part
+        self.shard_id = shard_id
 
     def get_logstore(self):
         """ Get logstore name
@@ -162,4 +166,19 @@ class GetHistogramsRequest(LogRequest):
         :type to_time_nano_part: int
         :param to_time_nano_part: to_time_nano_part part of query end time
         """
-        self.to_time_nano_part = to_time_nano_part
+        self.to_time_nano_part = to_time_nano_part
+
+    def set_shard_id(self, shard_id):
+        """ Set request shard_id
+
+        :type shard_id: int
+        :param shard_id: user defined shard_id
+        """
+        self.shard_id = shard_id
+
+    def get_shard_id(self):
+        """ Get request shard_id
+
+        :return: int, shard_id
+        """
+        return self.shard_id

{aliyun-log-python-sdk-0.9.1 → aliyun-log-python-sdk-0.9.3}/aliyun/log/getlogsresponse.py

@@ -63,18 +63,19 @@ class GetLogsResponse(LogResponse):
         }
         # parse query info
         query_info_str = Util.h_v_td(header, 'x-log-query-info', '')
-        query_info = json.loads(query_info_str)
-        meta_dict['mode'] = Util.h_v_td(query_info, 'mode', 0)
-        query_mode = GetLogsResponse.QueryMode(meta_dict['mode'])
-        if query_mode in (GetLogsResponse.QueryMode.SCAN, GetLogsResponse.QueryMode.SCAN_SQL):
-            meta_dict['scanBytes'] = Util.h_v_td(query_info, 'scanBytes', 0)
-        if query_mode in (GetLogsResponse.QueryMode.PHRASE, GetLogsResponse.QueryMode.SCAN):
-            scan_query_info = Util.h_v_td(query_info, 'phraseQueryInfo', dict())
-            meta_dict['phraseQueryInfo'] = {
-                'scanAll': (Util.h_v_td(scan_query_info, 'scanAll', 'false') != 'false'), 
-                'beginOffset': int(Util.h_v_td(scan_query_info, 'beginOffset', '0')),
-                'endOffset': int(Util.h_v_td(scan_query_info, 'endOffset', '0'))
-            }
+        if query_info_str != '':
+            query_info = json.loads(query_info_str)
+            meta_dict['mode'] = Util.h_v_td(query_info, 'mode', 0)
+            query_mode = GetLogsResponse.QueryMode(meta_dict['mode'])
+            if query_mode in (GetLogsResponse.QueryMode.SCAN, GetLogsResponse.QueryMode.SCAN_SQL):
+                meta_dict['scanBytes'] = Util.h_v_td(query_info, 'scanBytes', 0)
+            if query_mode in (GetLogsResponse.QueryMode.PHRASE, GetLogsResponse.QueryMode.SCAN):
+                scan_query_info = Util.h_v_td(query_info, 'phraseQueryInfo', dict())
+                meta_dict['phraseQueryInfo'] = {
+                    'scanAll': (Util.h_v_td(scan_query_info, 'scanAll', 'false') != 'false'), 
+                    'beginOffset': int(Util.h_v_td(scan_query_info, 'beginOffset', '0')),
+                    'endOffset': int(Util.h_v_td(scan_query_info, 'endOffset', '0'))
+                }
 
         return GetLogsResponse({
             "meta": meta_dict,
@@ -267,15 +268,15 @@ class GetLogsResponse(LogResponse):
 
             :return: bool, true if this logs query is completed
             """
-            return self._progress == 'Complete'
+            return self.get_progress() == 'Complete'
 
         def merge(self, other):
             """ merge with other GetLogsResponseMeta
 
             """
-            self._progress = other.progress
-            self._count += other.count
-            self._processed_rows += other.processed_rows
+            self._progress = other.get_progress()
+            self._count += other.get_count()
+            self._processed_rows += other.get_processed_rows()
             return self
 
         def get_count(self):
@@ -288,23 +289,22 @@ class GetLogsResponse(LogResponse):
         def _to_dict(self):
             """ to Dict
             """
-            phrase_query_info = None
-            if self._phrase_query_info is not None:
-                phrase_query_info = self._phrase_query_info._to_dict()
+            phrase_query_info = self.get_phrase_query_info()
+            phrase_query_info_dict = phrase_query_info._to_dict() if phrase_query_info is not None else None
 
             return {
-                'count': self._count,
-                'progress': self._progress,
-                'processedRows': self._processed_rows,
-                'elapsedMillisecond': self._elapsed_millisecond,
-                'hasSQL': self._has_sql,
-                'whereQuery': self._where_query,
-                'aggQuery': self._agg_query,
-                'cpuSec': self._cpu_sec,
-                'cpuCores': self._cpu_cores,
-                'mode': self._mode,
-                'scanBytes': self._scan_bytes,
-                'phraseQueryInfo': phrase_query_info,
+                'count': self.get_count(),
+                'progress': self.get_progress(),
+                'processedRows': self.get_processed_rows(),
+                'elapsedMillisecond': self.get_elapsed_millisecond(),
+                'hasSQL': self.get_has_sql(),
+                'whereQuery': self.get_where_query(),
+                'aggQuery': self.get_agg_query(),
+                'cpuSec': self.get_cpu_sec(),
+                'cpuCores': self.get_cpu_cores(),
+                'mode': self.get_mode(),
+                'scanBytes': self.get_scan_bytes(),
+                'phraseQueryInfo': phrase_query_info_dict,
                 # 'limited': self._limited,
                 # 'processedBytes': self._processed_bytes,
                 # 'telementryType': self._telemetry_type,  # not typo
@@ -515,10 +515,10 @@ class GetLogsResponse(LogResponse):
             """ to Dict
             """
             return {
-                "beginOffset": self._begin_offset,
-                "endOffset": self._end_offset,
-                "scanAll": self._scan_all,
-                "endTime": self._end_time
+                "beginOffset": self.get_begin_offset(),
+                "endOffset": self.get_end_offset(),
+                "scanAll": self.get_scan_all(),
+                "endTime": self.get_end_time()
             }
 
         def log_print(self):

{aliyun-log-python-sdk-0.9.1 → aliyun-log-python-sdk-0.9.3}/aliyun/log/index_config.py

@@ -193,7 +193,7 @@ class IndexLineConfig(object):
     def from_json(self, json_value):
         self.token_list = json_value["token"]
         self.case_sensitive = bool(json_value.get("caseSensitive", False))
-        self.chn = bool(json_value["caseSensitive"]) if "caseSensitive" in json_value else None
+        self.chn = bool(json_value["chn"]) if "chn" in json_value else None
 
 
 class IndexConfig(object):

aliyun-log-python-sdk-0.9.3/aliyun/log/log_logs_pb2.py

@@ -0,0 +1,33 @@
+# -*- coding: utf-8 -*-
+# Generated by the protocol buffer compiler.  DO NOT EDIT!
+# source: log_logs.proto
+"""Generated protocol buffer code."""
+from google.protobuf.internal import builder as _builder
+from google.protobuf import descriptor as _descriptor
+from google.protobuf import descriptor_pool as _descriptor_pool
+from google.protobuf import symbol_database as _symbol_database
+# @@protoc_insertion_point(imports)
+
+_sym_db = _symbol_database.Default()
+
+
+
+
+DESCRIPTOR = _descriptor_pool.Default().AddSerializedFile(b'\n\x0elog_logs.proto\"k\n\x03Log\x12\x0c\n\x04Time\x18\x01 \x02(\r\x12\x1e\n\x08\x43ontents\x18\x02 \x03(\x0b\x32\x0c.Log.Content\x12\x0f\n\x07Time_ns\x18\x04 \x01(\x07\x1a%\n\x07\x43ontent\x12\x0b\n\x03Key\x18\x01 \x02(\t\x12\r\n\x05Value\x18\x02 \x02(\t\"$\n\x06LogTag\x12\x0b\n\x03Key\x18\x01 \x02(\t\x12\r\n\x05Value\x18\x02 \x02(\t\"~\n\x08LogGroup\x12\x12\n\x04Logs\x18\x01 \x03(\x0b\x32\x04.Log\x12\x10\n\x08Reserved\x18\x02 \x01(\t\x12\r\n\x05Topic\x18\x03 \x01(\t\x12\x0e\n\x06Source\x18\x04 \x01(\t\x12\x13\n\x0bMachineUUID\x18\x05 \x01(\t\x12\x18\n\x07LogTags\x18\x06 \x03(\x0b\x32\x07.LogTag\",\n\x0cLogGroupList\x12\x1c\n\tLogGroups\x18\x01 \x03(\x0b\x32\t.LogGroup')
+
+_builder.BuildMessageAndEnumDescriptors(DESCRIPTOR, globals())
+_builder.BuildTopDescriptorsAndMessages(DESCRIPTOR, 'log_logs_pb2', globals())
+if _descriptor._USE_C_DESCRIPTORS == False:
+
+  DESCRIPTOR._options = None
+  _LOG._serialized_start=18
+  _LOG._serialized_end=125
+  _LOG_CONTENT._serialized_start=88
+  _LOG_CONTENT._serialized_end=125
+  _LOGTAG._serialized_start=127
+  _LOGTAG._serialized_end=163
+  _LOGGROUP._serialized_start=165
+  _LOGGROUP._serialized_end=291
+  _LOGGROUPLIST._serialized_start=293
+  _LOGGROUPLIST._serialized_end=337
+# @@protoc_insertion_point(module_scope)

aliyun-log-python-sdk-0.9.3/aliyun/log/log_logs_raw_pb2.py

@@ -0,0 +1,33 @@
+# -*- coding: utf-8 -*-
+# Generated by the protocol buffer compiler.  DO NOT EDIT!
+# source: log_logs_raw.proto
+"""Generated protocol buffer code."""
+from google.protobuf.internal import builder as _builder
+from google.protobuf import descriptor as _descriptor
+from google.protobuf import descriptor_pool as _descriptor_pool
+from google.protobuf import symbol_database as _symbol_database
+# @@protoc_insertion_point(imports)
+
+_sym_db = _symbol_database.Default()
+
+
+
+
+DESCRIPTOR = _descriptor_pool.Default().AddSerializedFile(b'\n\x12log_logs_raw.proto\"q\n\x06LogRaw\x12\x0c\n\x04Time\x18\x01 \x02(\r\x12!\n\x08\x43ontents\x18\x02 \x03(\x0b\x32\x0f.LogRaw.Content\x12\x0f\n\x07Time_ns\x18\x04 \x01(\x07\x1a%\n\x07\x43ontent\x12\x0b\n\x03Key\x18\x01 \x02(\t\x12\r\n\x05Value\x18\x02 \x02(\x0c\"\'\n\tLogTagRaw\x12\x0b\n\x03Key\x18\x01 \x02(\t\x12\r\n\x05Value\x18\x02 \x02(\t\"\x87\x01\n\x0bLogGroupRaw\x12\x15\n\x04Logs\x18\x01 \x03(\x0b\x32\x07.LogRaw\x12\x10\n\x08Reserved\x18\x02 \x01(\t\x12\r\n\x05Topic\x18\x03 \x01(\t\x12\x0e\n\x06Source\x18\x04 \x01(\t\x12\x13\n\x0bMachineUUID\x18\x05 \x01(\t\x12\x1b\n\x07LogTags\x18\x06 \x03(\x0b\x32\n.LogTagRaw\"2\n\x0fLogGroupListRaw\x12\x1f\n\tLogGroups\x18\x01 \x03(\x0b\x32\x0c.LogGroupRaw')
+
+_builder.BuildMessageAndEnumDescriptors(DESCRIPTOR, globals())
+_builder.BuildTopDescriptorsAndMessages(DESCRIPTOR, 'log_logs_raw_pb2', globals())
+if _descriptor._USE_C_DESCRIPTORS == False:
+
+  DESCRIPTOR._options = None
+  _LOGRAW._serialized_start=22
+  _LOGRAW._serialized_end=135
+  _LOGRAW_CONTENT._serialized_start=98
+  _LOGRAW_CONTENT._serialized_end=135
+  _LOGTAGRAW._serialized_start=137
+  _LOGTAGRAW._serialized_end=176
+  _LOGGROUPRAW._serialized_start=179
+  _LOGGROUPRAW._serialized_end=314
+  _LOGGROUPLISTRAW._serialized_start=316
+  _LOGGROUPLISTRAW._serialized_end=366
+# @@protoc_insertion_point(module_scope)

{aliyun-log-python-sdk-0.9.1 → aliyun-log-python-sdk-0.9.3}/aliyun/log/logclient.py

@@ -12,6 +12,7 @@ import time
 import zlib
 from datetime import datetime
 import logging
+from .credentials import StaticCredentialsProvider
 from .scheduled_sql import ScheduledSQLConfiguration
 from .scheduled_sql_response import *
 from itertools import cycle
@@ -154,8 +155,8 @@ class LogClient(object):
     __version__ = API_VERSION
     Version = __version__
 
-    def __init__(self, endpoint, accessKeyId, accessKey, securityToken=None, source=None,
-                 auth_version=AUTH_VERSION_1, region=''):
+    def __init__(self, endpoint, accessKeyId=None, accessKey=None, securityToken=None, source=None,
+                 auth_version=AUTH_VERSION_1, region='', credentials_provider=None):
         self._isRowIp = Util.is_row_ip(endpoint)
         self._setendpoint(endpoint)
         self._accessKeyId = accessKeyId
@@ -172,7 +173,11 @@ class LogClient(object):
         self._last_refresh = 0
         self._auth_version = auth_version
         self._region = region
-        self._auth = make_auth(accessKeyId, accessKey, auth_version, region)
+        if credentials_provider is not None:
+            self._auth = make_auth(credentials_provider, auth_version, region)
+        else:
+            self._auth = make_auth(StaticCredentialsProvider(accessKeyId, accessKey, securityToken),
+                                   auth_version, region)
         self._get_logs_v2_enabled = True
 
     def _replace_credentials(self):
@@ -185,8 +190,8 @@ class LogClient(object):
         self._last_refresh = time.time()
         for tries in range(DEFAULT_REFRESH_RETRY_COUNT + 1):
             try:
-                self._accessKeyId, self._accessKey, self._securityToken = self._credentials_auto_refresher()
-                self._auth = make_auth(self._accessKeyId, self._accessKey, self._auth_version, self._region)
+                self._auth = make_auth(StaticCredentialsProvider(self._credentials_auto_refresher()),
+                                       self._auth_version, self._region)
             except Exception as ex:
                 logger.error(
                     "failed to call _credentials_auto_refresher to refresh credentials, details: {0}".format(str(ex)))
@@ -545,6 +550,8 @@ class LogClient(object):
         params['accurate'] = request.get_accurate_query()
         params['fromNs'] = request.get_from_time_nano_part()
         params['toNs'] = request.get_to_time_nano_part()
+        if request.get_shard_id() != -1:
+            params['shard'] = request.get_shard_id()
         params['type'] = 'histogram'
         logstore = request.get_logstore()
         project = request.get_project()
@@ -947,7 +954,7 @@ class LogClient(object):
         project = request.get_project()
         resource = "/logs"
         (resp, header) = self._send("GET", project, None, resource, params, headers)
-        return GetLogsResponse(resp, header)
+        return GetLogsResponse._from_v1_resp(resp, header)
 
     def get_cursor(self, project_name, logstore_name, shard_id, start_time):
         """ Get cursor from log service for batch pull logs

{aliyun-log-python-sdk-0.9.1 → aliyun-log-python-sdk-0.9.3}/aliyun/log/version.py

@@ -1,4 +1,4 @@
-__version__ = '0.9.1'
+__version__ = '0.9.3'
 
 import sys
 OS_VERSION = str(sys.platform)

{aliyun-log-python-sdk-0.9.1 → aliyun-log-python-sdk-0.9.3/aliyun_log_python_sdk.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: aliyun-log-python-sdk
-Version: 0.9.1
+Version: 0.9.3
 Summary: Aliyun log service Python client SDK
 Home-page: https://github.com/aliyun/aliyun-log-python-sdk
 Author: Aliyun

{aliyun-log-python-sdk-0.9.1 → aliyun-log-python-sdk-0.9.3}/aliyun_log_python_sdk.egg-info/SOURCES.txt

@@ -9,6 +9,7 @@ aliyun/log/auth.py
 aliyun/log/common_response.py
 aliyun/log/consumer_group_request.py
 aliyun/log/consumer_group_response.py
+aliyun/log/credentials.py
 aliyun/log/cursor_response.py
 aliyun/log/cursor_time_response.py
 aliyun/log/etl_config_response.py