aliyun_sls 0.0.3 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f99113f595c413af76c9c28a15fb4de46bd70b44
-  data.tar.gz: d79c1946dee0ab4a053aadae36cb43f3eed1ec05
+  metadata.gz: a8f3884c68b68d0dc9a0ffbb3b5873c186c5948c
+  data.tar.gz: 9adba5c42ec2db13887bcfcbad94ae7508aec135
 SHA512:
-  metadata.gz: 953ab3e11bc74648c3bcdf51e64ab6e3b95901bc09e154ee02f1fb1bfd26ba92da1379c9f1d28234ef103aa3137f9ab56920cd5b2ee05a321870d8d9a3390761
-  data.tar.gz: f8ac4988f9eea5905c4aa3edafc8c4ade033b65742f5a05242ad01f84ee6ac0cdd40613336d445684cb35e531300f70b380cdfe039e31d79dd9b17782131c2ea
+  metadata.gz: 14f9c36c56120debc5ebc4c959b1872065f006cc1e4f1c742a48e5cd485a875521bc7bb568c6e7b1884eaf089298ceee8f50eb0cac963eee4fc017d19f0666d4
+  data.tar.gz: 64d18c6e4725a6cd3af8ca246b0f646c146bd755a6957fde897ad991fa90ad055754895b433d6fdce5aec0a754f03b56768bffa2bf3ba9a825827d7611ae5b09

data/README.md

@@ -2,19 +2,21 @@
 
 ## 阿里云SLS服务Ruby SDK
 
-简单日志服务（Simple Log Service，简称SLS）是针对日志收集、存储和查询的平台化服务。服务提供各种类型日志的实时收集，平台化存储及实时查询海量的日志。并可以将日志归档至ODPS，以利用ODPS做大数据分析。除了通过管理控制台操作，SLS还提供了API（Application Programming Interface）方式写入、查询日志数据，管理自己的项目及日志库等。
+
+#### 简单日志服务（`Simple Log Service，简称SLS`）
+是针对日志收集、存储和查询的平台化服务。服务提供各种类型日志的实时收集，平台化存储及实时查询海量的日志。并可以将日志归档至ODPS，以利用ODPS做大数据分析。除了通过管理控制台操作，SLS还提供了API（Application Programming Interface）方式写入、查询日志数据，管理自己的项目及日志库等。
 
 #### SLS(简单日志服务)[介绍](http://docs.aliyun.com/?spm=5176.730001.3.10.5GpxDL#/sls)
 
 ------------
 ## 库用法
 
-### 查询Store清单(ListLogstores)
+### [查询Store清单](http://docs.aliyun.com/#/pub/sls/api/apilist&ListLogstores)
 
     con = AliyunSls::Connection.new("project", "region", "access_key_secret", "aliyun_access_key")
     con.list_logstores
 
-### 上传日志(PutLogs)
+### [上传日志](http://docs.aliyun.com/#/pub/sls/api/apilist&PutLogs)
 
     log = AliyunSls::Protobuf::Log.new(:time => Time.now.to_i, :contents => [])
 
@@ -35,11 +37,45 @@
     con = AliyunSls::Connection.new("project", "region", "access_key_secret", "aliyun_access_key")
     con.puts_logs("store", log_list)
 
-### TODO
-
-- `ListTopics`  列出Logstore中的日志主题。
-- `GetHistograms`   查询Logstore中的日志在时间轴上的分布。
-- `GetLogs` 查询Logstore中的日志数据。
+### [列出日志主题](http://docs.aliyun.com/#/pub/sls/api/apilist&ListTopics)
+
+    con.list_topics("store")
+
+|名称|  类型|  必选|  描述|
+|-----|-----|----|-----|
+|logstorename|    字符串| 是|   需要查询的Logstore名称。|
+|type|    字符串| 是|   查询Logstore数据的类型，在ListTopics接口中该参数必须为"topic"。|
+|line|    整型|  否|   请求一次返回的Topic最大数目。取值范围为0~100，默认值为100。|
+|token|   字符串| 否|   请求返回Topic的起始点（按字典序）。默认值为空字符串，表示从头开始查询 |Logstore中的日志Topic。
+
+### [查询Logstore中的日志在时间轴上的分布](http://docs.aliyun.com/#/pub/sls/api/apilist&GetHistograms)
+
+    con.get_histograms("store")
+
+|名称|  类型|  必选|  描述|
+|----|----|------|------|
+|logstorename|    字符串| 是|   需要查询日志的Logstore名称。|
+|type|    字符串| 是|   查询Logstore数据的类型，在GetHistograms接口中该参数必须为"histogram"。|
+|from|    整型|  是|   查询开始时间点（精度为秒，从1970-1-1 00:00:00 UTC计算起的秒数）。|
+|to|  整型|  是|   查询结束时间点（精度为秒，从1970-1-1 00:00:00 UTC计算起的秒数）。|
+|topic|   字符串| 否|   查询日志主题。|
+|query|   字符串| 否|   查询表达式。关于查询表达式的详细语法请参考查询语法。|
+
+### [查询Logstore中的日志数据](http://docs.aliyun.com/#/pub/sls/api/apilist&GetLogs)
+
+    con.get_logs("store", :topic => "xxx")
+
+|名称 |  类型|  必选|  描述|
+|---|---|---||
+|logstorename |    字符串| 是|   需要查询日志的Logstore名称。|
+|type |    字符串| 是|   查询Logstore数据的类型，在GetLogs接口中该参数必须为"log"。|
+|from |    整型|  是|   查询开始时间点（精度为秒，从1970-1-1 00:00:00 UTC计算起的秒数）。|
+|to |  整型|  是|   查询结束时间点（精度为秒，从1970-1-1 00:00:00 UTC计算起的秒数）。|
+|topic |   字符串| 否|   查询日志主题。|
+|query |   字符串| 否|   查询表达式。关于查询表达式的详细语法请参考查询语法。|
+|line |    整型|  否|   请求返回的最大日志条数。取值范围0~100，默认值为100。|
+|offset |  整型|  否|   请求返回日志的起始点。取值范围0或正整数，默认值0。|
+|reverse | 布尔型| 否|   是否按日志时间戳逆序返回日志。true表示逆序，false表示顺序，默认值为false。|
 
 ## 命令行用法
 

data/aliyun_sls.gemspec

@@ -24,4 +24,5 @@ Gem::Specification.new do |spec|
   spec.add_dependency "beefcake"
   spec.add_dependency "file-tail"
   spec.add_dependency "ruby-hmac"
+  spec.add_dependency "addressable"
 end

data/lib/aliyun_sls/connection.rb

@@ -1,7 +1,11 @@
+require "addressable/uri"
 require 'rest_client'
 require 'hmac-sha1'
 require "base64"
 require "zlib"
+require "time"
+
+require "byebug"
 
 # log = AliyunSls::Protobuf::Log.new(:time => Time.now.to_i, :contents => [])
 
@@ -43,6 +47,90 @@ module AliyunSls
             @host = "#{project}.#{region}"
         end
 
+        # http://docs.aliyun.com/#/pub/sls/api/apilist&PutLogs
+        def puts_logs(logstorename, content)
+            # 压缩content数据
+            compressed = Zlib::Deflate.deflate(content.encode.to_s)
+            headers = compact_headers(content, compressed)
+            headers["Authorization"] = signature("POST", logstorename, headers, content, {})
+
+            u = URI.parse("http://#{@host}/logstores/#{logstorename}")
+            rsp = RestClient.post u.to_s, compressed, headers
+            parse_response(rsp)
+        end
+
+        # http://docs.aliyun.com/#/pub/sls/api/apilist&ListLogstores
+        def list_logstores
+            headers = compact_headers(nil, nil)
+            headers["Authorization"] = signature("GET", nil, headers, nil, {})
+
+            u = URI.parse("http://#{@host}/logstores")
+            headers["Referer"] = u.to_s
+            rsp = RestClient.get u.to_s, headers
+            parse_response(rsp)
+        end
+
+        # http://docs.aliyun.com/#/pub/sls/api/apilist&GetLogs
+        def get_logs(logstorename, opts={})
+            default_opts = {
+                :type => "log",
+                :from => Time.now.to_i - 60*5,#默认是五分钟前
+                :to => Time.now.to_i,
+                :line => 100,
+                :offset => 0,
+                :reverse => false
+            }
+            opts = default_opts.update opts
+            headers = compact_headers(nil, nil)
+            headers["Authorization"] = signature("GET", logstorename, headers, nil, opts)
+
+            u = Addressable::URI.parse("http://#{@host}/logstores/#{logstorename}")
+            headers["Referer"] = u.to_s
+            u.query_values = opts
+            rsp = RestClient.get u.to_s, headers
+            parse_response(rsp)
+        end
+
+        # http://docs.aliyun.com/#/pub/sls/api/apilist&ListTopics
+        def list_topics(logstorename, opts={})
+            default_opts = {
+                :type => "topic",
+                :line => 100,
+                :toke => ""
+            }
+            opts = default_opts.update opts
+            headers = compact_headers(nil, nil)
+            headers["Authorization"] = signature("GET", logstorename, headers, nil, opts)
+
+            u = Addressable::URI.parse("http://#{@host}/logstores/#{logstorename}")
+            headers["Referer"] = u.to_s
+            u.query_values = opts
+            rsp = RestClient.get u.to_s, headers
+            parse_response(rsp)
+        end
+
+        # http://docs.aliyun.com/#/pub/sls/api/apilist&GetHistograms
+        def get_histograms(logstorename, opts={})
+            default_opts = {
+                :type => "histogram",
+                :from => Time.now.to_i - 60*5,#默认是五分钟前
+                :to => Time.now.to_i,
+                :topic => "",
+                :query => 0,
+            }
+            opts = default_opts.update opts
+            headers = compact_headers(nil, nil)
+            headers["Authorization"] = signature("GET", logstorename, headers, nil, opts)
+
+            u = Addressable::URI.parse("http://#{@host}/logstores/#{logstorename}")
+            headers["Referer"] = u.to_s
+            u.query_values = opts
+            rsp = RestClient.get u.to_s, headers
+            parse_response(rsp)
+        end
+
+        private
+
         def string_to_sign(verb, logstorename, headers, content, query={})
             if content
                 string_to_sign_with_content(verb, logstorename, headers, query)
@@ -96,9 +184,9 @@ DOC
 # 2. 放入要访问的SLS资源："/logstores/logstorename"（无logstorename则不填）；
 # 3. 如请求包含查询字符串（QUERY_STRING），则在CanonicalizedResource字符串尾部添加“？”和查询字符串。
         def canonicalized_resource(logstorename, query={})
-            u = logstorename ? URI.parse("/logstores/#{logstorename}") : URI.parse("/logstores")
+            u = logstorename ? Addressable::URI.parse("/logstores/#{logstorename}") : Addressable::URI.parse("/logstores")
             if query.size != 0
-                u.query = query.inject([]){|s, a| s << "#{a[0]}=#{a[1]}"}.join('&')
+                u.query_values = query
             end
             u.to_s
         end
@@ -135,27 +223,6 @@ DOC
             headers
         end
 
-        def puts_logs(logstorename, content)
-            # 压缩content数据
-            compressed = Zlib::Deflate.deflate(content.encode.to_s)
-            headers = compact_headers(content, compressed)
-            headers["Authorization"] = signature("POST", logstorename, headers, content, {})
-
-            u = URI.parse("http://#{@host}/logstores/#{logstorename}")
-            rsp = RestClient.post u.to_s, compressed, headers
-            parse_response(rsp)
-        end
-
-        def list_logstores
-            headers = compact_headers(nil, nil)
-            headers["Authorization"] = signature("GET", nil, headers, nil, {})
-
-            u = URI.parse("http://#{@host}/logstores")
-            headers["Referer"] = u.to_s
-            rsp = RestClient.get u.to_s, headers
-            parse_response(rsp)
-        end
-
         def parse_response(rsp)
             # 如果返回结果报错，则解析报错内容打印到日志中
             if rsp.code.to_s =~ /[4|5]\d\d/
@@ -166,6 +233,7 @@ DOC
                     puts msg
                 end
             end
+            rsp
         end
     end
 end

data/lib/aliyun_sls/version.rb

@@ -1,3 +1,3 @@
 module AliyunSls
-  VERSION = "0.0.3"
+  VERSION = "0.0.4"
 end

metadata

@@ -1,97 +1,111 @@
 --- !ruby/object:Gem::Specification
 name: aliyun_sls
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
 platform: ruby
 authors:
 - cuizheng
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-05-14 00:00:00.000000000 Z
+date: 2015-06-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.3'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: rest-client
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: beefcake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: file-tail
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: ruby-hmac
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: addressable
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 description: Gem for SLS of Aliyun
@@ -102,7 +116,7 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
+- ".gitignore"
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -123,19 +137,18 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.6
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: Gem for SLS of Aliyun
 test_files: []
-has_rdoc: