nginx_utils 0.0.4 → 0.0.5

data/README.md

@@ -8,7 +8,9 @@ Nginx utilities.
 
 Add this line to your application's Gemfile:
 
-    gem 'nginx_utils'
+```ruby
+gem 'nginx_utils'
+```
 
 And then execute:
 
@@ -20,13 +22,34 @@ Or install it yourself as:
 
 ## Usage
 
-```
+From console:
+
+    $ nginx_logrotate -h
+    Usage: nginx_logrotate [options]
+    -d, --[no-]debug                 Debug mode. Run only log output to STDOUT.
+        --script_log=VAL             Log file for script.
+        --log_level=VAL              Log level of script log.
+        --root_dir=VAL               Root directory of Nginx.
+        --target_logs=VAL            Specify logs of target.
+        --retention=VAL              Specify in days the retention period of log.
+        --pid_file=VAL               PID file of Nginx
+    $ nginx_status -h
+    Usage: nginx_status [options]
+        --only-value                 The output only the value.
+
+From ruby:
+
+```ruby
 require 'nginx_utils'
 ```
 
-Logrotate:
+### Logrotate
 
-```
+Logs of rename target: `Dir.glob "#{root_dir}/**/#{target_logs}"`
+Logs of delete target: `Dir.glob "#{root_dir}/**/#{target_logs}.*"`
+
+```ruby
+# Following parameters are default.
 params = {
   debug: false,
   script_log: "/tmp/nginx_rotate.log",
@@ -39,28 +62,78 @@ params = {
 }
 
 rotate = NginxUtils::Logrotate.new(params)
+# == Configure
+# rotate.config log_level: :worn
+
+# == Accessor
+# rotate.logger.formatter = proc { |severity, datetime, progname, msg|
+#   "#{datetime}: #{msg}\n"
+# }
+# rotate.rename_logs << add_rename_log
+# rotate.delete_logs << add_delete_log
+
 rotate.execute
 ```
 
-Status:
+Options that can be specified:
 
-```
-p NginxUtils::Status.get # => {active_connection: 1, accepts: 4, handled: 5, requests: 51, reading: 1, writing: 3, waiting: 2}
-```
+* `:debug` => `true` or `false`. If `:debug` is true, it is not execute.
+* `:script_log` => `"/path/to/nginx_rotate.log"`. If `:script` is false, do not output logs.
+* `:log_level` => `:debug` or `:info` or `:warn` or `:error` or `:fatal`.
+* `:root_dir` => `"/path/to/nginx"`. Root directory of Nginx.
+* `:target_logs` => `"*.log"`. Specify logs of target.
+* `:prefix` => `Time.now.strftime("%Y%m%d%H%M%S")`. Prefix use to rename.
+* `:retention` => `90`. Specify in days the retention period of log.
+* `:pid_file` => `"/path/to/nginx.pid"`. Use to restart Nginx.
 
-Logreader:
+### Status
 
+Require **HttpStubStatusModule**.
+
+```ruby
+# http://localhost/nginx_status
+NginxUtils::Status.get # => {active_connection: 1, accepts: 4, handled: 5, requests: 51, reading: 1, writing: 3, waiting: 2}
+
+# Apache like
+# http://example.com/server-status
+NginxUtils::Status.get(host: "example.com", path: "/server-status")
 ```
-reader = NginxUtils::Logreader.new("/path/to/nginx/logs/access.log")
+
+### Logreader
+
+LTSV:
+
+The default format is `:ltsv`.
+
+```ruby
+log_file = "/path/to/nginx/logs/access.log.ltsv"
+reader = NginxUtils::Logreader.new(log_file)
 reader.each do |line|
   p line # => {time: "2013-05-19T08:13:14+00:00", host: "192.168.1.10", ...}
 end
 ```
 
+Combined:
+
+```ruby
+log_file = "/path/to/nginx/logs/access.log.combined"
+reader = NginxUtils::Logreader.new(log_file, format: :combined)
+reader.each {|line| p line} # => {:remote_addr=>"x.x.x.x", :remote_user=>"-", :time_local=>"19/May/2013:23:14:04 +0900", :request=>"GET / HTTP/1.1", :status=>"200", :body_bytes_sent=>"564", :http_referer=>"-", :http_user_agent=>"-"}
+```
+
+Custom:
+
+```ruby
+log_file = "/path/to/nginx/logs/access.log.combined"
+parser = /\[(.*)\]\s"(.*?)"/
+reader = NginxUtils::Logreader.new(log_file, parser: parser)
+reader.each {|line| p line.first} #=> ["19/May/2013:23:13:52 +0900", "GET / HTTP/1.1"]
+```
+
 Options that can be specified:
 
-* :format => :ltsv or :combined
-* :parser => Parse with scan method. Specified in Regexp.
+* `:format` => `:ltsv` or `:combined`. If parser is specified, format is automatically `:custom`.
+* `:parser` => Parse with `String#scan`. Specified in Regexp.
 
 ## Contributing
 
@@ -68,4 +141,4 @@ Options that can be specified:
 2. Create your feature branch (`git checkout -b my-new-feature`)
 3. Commit your changes (`git commit -am 'Add some feature'`)
 4. Push to the branch (`git push origin my-new-feature`)
-5. Create new Pull Request
+5. Create new Pull Request

data/bin/nginx_logrotate

@@ -0,0 +1,29 @@
+#!/usr/bin/env ruby
+# coding: utf-8
+
+require "optparse"
+
+begin
+  require "nginx_utils"
+rescue LoadError => e
+  puts e
+  exit 1
+end
+
+# Option parse
+options = {}
+
+opt = OptionParser.new
+Version = "0.0.1"
+opt.on("-d", "--[no-]debug", "Debug mode. Run only log output to STDOUT.") {|v| options[:debug] = v}
+opt.on("--script_log=VAL", "Log file for script.") {|v| options[:script_log] = v}
+opt.on("--log_level=VAL", "Log level of script log.") {|v| options[:log_level] = v.to_sym}
+opt.on("--root_dir=VAL", "Root directory of Nginx.") {|v| options[:root_dir] = v}
+opt.on("--target_logs=VAL", "Specify logs of target.") {|v| options[:target_logs] = v}
+opt.on("--retention=VAL", "Specify in days the retention period of log.") {|v| options[:retention] = v.to_i}
+opt.on("--pid_file=VAL", "PID file of Nginx") {|v| options[:pid_file] = v}
+
+opt.parse! ARGV
+
+rotate = NginxUtils::Logrotate.new(options)
+rotate.execute

data/bin/nginx_status

@@ -0,0 +1,35 @@
+#!/usr/bin/env ruby
+# coding: utf-8
+
+require "optparse"
+
+begin
+  require "nginx_utils"
+rescue LoadError => e
+  puts e
+  exit 1
+end
+
+# Option parse
+options = {}
+
+opt = OptionParser.new
+Version = "0.0.1"
+opt.on("--only-value", "The output only the value.") {|v| options[:only_value] = v}
+
+opt.parse! ARGV
+
+if ARGV.size > 0
+  host = ARGV.shift
+  result = NginxUtils::Status.get host: host
+else
+  result = NginxUtils::Status.get
+end
+
+if options[:only_value]
+  puts result.values.join("\t")
+else
+  puts "Active Connections: #{result[:active_connection]}"
+  puts "Accepts: #{result[:accepts]} Handled: #{result[:handled]} Requests: #{result[:requests]}"
+  puts "Reading: #{result[:reading]} Writing: #{result[:writing]} Waiting: #{result[:waiting]}"
+end

data/lib/nginx_utils/status.rb

@@ -3,15 +3,18 @@
 module NginxUtils
   module Status
     class << self
-      def get(options={host: "localhost", port: 80, path: "/nginx_status"})
+      def get(options={})
+        host = options[:host] || "localhost"
+        port = options[:port] || 80
+        path = options[:path] || "/nginx_status"
         begin
-          req = Net::HTTP::Get.new(options[:path])
-          res = Net::HTTP.start(options[:host], options[:port]){|http| http.request(req)}
+          req = Net::HTTP::Get.new(path)
+          res = Net::HTTP.start(host, port){|http| http.request(req)}
           status = res.body.split("\n")
           server = status[2].split.map{|i| i.to_i}
           rww = status[3].split.select{|i| /^[0-9]+$/ =~ i}.map{|i| i.to_i}
           {
-            active_connection: status[0].split(":").last.gsub(/\s/, "").to_i,
+            active_connections: status[0].split(":").last.gsub(/\s/, "").to_i,
             accepts: server[0],
             handled: server[1],
             requests: server[2],

data/lib/nginx_utils/version.rb

@@ -1,3 +1,3 @@
 module NginxUtils
-  VERSION = "0.0.4"
+  VERSION = "0.0.5"
 end

data/spec/nginx_utils/status_spec.rb

@@ -7,7 +7,7 @@ describe NginxUtils do
     describe ".get" do
       it "should get status" do
         body = "Active connections: 1 \nserver accepts handled requests\n 4 5 51 \nReading: 1 Writing: 3 Waiting: 2 \n"
-        status = {active_connection: 1, accepts: 4, handled: 5, requests: 51, reading: 1, writing: 3, waiting: 2}
+        status = {active_connections: 1, accepts: 4, handled: 5, requests: 51, reading: 1, writing: 3, waiting: 2}
         response = double("http response mock", body: body)
         Net::HTTP.should_receive(:start).and_return(response)
         expect(NginxUtils::Status.get).to eq(status)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: nginx_utils
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.5
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-05-20 00:00:00.000000000 Z
+date: 2013-05-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -78,7 +78,9 @@ dependencies:
 description: The various utilities on nginx
 email:
 - i2bskn@gmail.com
-executables: []
+executables:
+- nginx_logrotate
+- nginx_status
 extensions: []
 extra_rdoc_files: []
 files:
@@ -88,6 +90,8 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
+- bin/nginx_logrotate
+- bin/nginx_status
 - lib/nginx_utils.rb
 - lib/nginx_utils/logreader.rb
 - lib/nginx_utils/logrotate.rb
@@ -113,7 +117,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -10429621290292328
+      hash: -837549919504176739
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -122,7 +126,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -10429621290292328
+      hash: -837549919504176739
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.25