/usr/sbin/passenger-status is in passenger 5.0.30-1build2.
This file is owned by root:root, with mode 0o755.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 | #!/usr/bin/ruby
# Phusion Passenger - https://www.phusionpassenger.com/
# Copyright (c) 2010-2015 Phusion Holding B.V.
#
# "Passenger", "Phusion Passenger" and "Union Station" are registered
# trademarks of Phusion Holding B.V.
#
# Permission is hereby granted, free of charge, to any person obtaining a copy
# of this software and associated documentation files (the "Software"), to deal
# in the Software without restriction, including without limitation the rights
# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
# copies of the Software, and to permit persons to whom the Software is
# furnished to do so, subject to the following conditions:
#
# The above copyright notice and this permission notice shall be included in
# all copies or substantial portions of the Software.
#
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
# THE SOFTWARE.
## Magic comment: begin bootstrap ##
require 'phusion_passenger'
## Magic comment: end bootstrap ##
PhusionPassenger.locate_directories
PhusionPassenger.require_passenger_lib 'constants'
PhusionPassenger.require_passenger_lib 'platform_info'
PhusionPassenger.require_passenger_lib 'admin_tools/instance_registry'
PhusionPassenger.require_passenger_lib 'config/utils'
PhusionPassenger.require_passenger_lib 'utils/ansi_colors'
require 'optparse'
require 'socket'
require 'net/http'
include PhusionPassenger::SharedConstants
include PhusionPassenger::AdminTools
include PhusionPassenger::Utils::AnsiColors
DEFAULT_OPTIONS = { :show => 'pool', :color => STDOUT.tty? }.freeze
##### Show status command #####
def command_show_status(argv, options)
if argv.empty?
instance = find_sole_instance
else
instance = find_instance_by_name_prefix(argv[0])
end
show_status(instance, options)
end
def find_sole_instance
instances = InstanceRegistry.new.list
if instances.empty?
abort "ERROR: #{PROGRAM_NAME} doesn't seem to be running. If you " +
"are sure that it is running, then the causes of this problem could be:\n\n" +
"1. You customized the instance registry directory using Apache's " +
"PassengerInstanceRegistryDir option, Nginx's passenger_instance_registry_dir " +
"option, or #{PROGRAM_NAME} Standalone's --instance-registry-dir command line " +
"argument. If so, please set the environment variable PASSENGER_INSTANCE_REGISTRY_DIR " +
"to that directory and run passenger-status again.\n" +
"2. The instance directory has been removed by an operating system background service. " +
"Please set a different instance registry directory using Apache's " +
"PassengerInstanceRegistryDir option, Nginx's passenger_instance_registry_dir " +
"option, or #{PROGRAM_NAME} Standalone's --instance-registry-dir command line " +
"argument."
elsif instances.size == 1
return instances.first
else
puts "It appears that multiple #{PROGRAM_NAME} instances are running. Please"
puts "select a specific one by running:"
puts
puts " passenger-status <NAME>"
puts
PhusionPassenger::Config::Utils.list_all_passenger_instances(instances)
exit 1
end
end
def find_instance_by_name_prefix(name)
instance = InstanceRegistry.new.find_by_name_prefix(name)
if instance == :ambigious
abort "ERROR: there are multiple instances whose name start with '#{name}'. Please specify the full name."
elsif instance
return instance
else
abort "ERROR: there doesn't seem to be a #{PROGRAM_NAME} instance running with the name '#{name}'."
end
end
def show_status(instance, options)
# if the noshow override is not specified, the default is to show the header, unless show=xml
if options[:noheader] != true && options[:show] != 'xml'
print_header(STDOUT, instance)
end
case options[:show]
when 'pool'
request = Net::HTTP::Get.new("/pool.txt?colorize=#{options[:color]}&verbose=#{options[:verbose]}")
try_performing_ro_admin_basic_auth(request, instance)
response = instance.http_request("agents.s/core_api", request)
if response.code.to_i / 100 == 2
puts response.body
elsif response.code.to_i == 401
if response["pool-empty"] == "true"
puts "#{PROGRAM_NAME} is currently not serving any applications."
else
print_permission_error_message
exit 2
end
else
STDERR.puts "*** An error occured."
STDERR.puts "#{response.code}: #{response.body}"
exit 2
end
when 'requests', 'server'
request = Net::HTTP::Get.new("/server.json")
try_performing_ro_admin_basic_auth(request, instance)
response = instance.http_request("agents.s/core_api", request)
if response.code.to_i / 100 == 2
puts response.body
elsif response.code.to_i == 401
print_permission_error_message
exit 2
else
STDERR.puts "*** An error occured."
STDERR.puts "#{response.code}: #{response.body}"
exit 2
end
when 'backtraces'
request = Net::HTTP::Get.new("/backtraces.txt")
try_performing_ro_admin_basic_auth(request, instance)
response = instance.http_request("agents.s/core_api", request)
if response.code.to_i / 100 == 2
text = response.body
# Colorize output
color = PhusionPassenger::Utils::AnsiColors.new
text.gsub!(/^(Thread .*:)$/, color.black_bg + color.yellow + '\1' + color.reset)
text.gsub!(/^( +in '.*? )(.*?)\(/, '\1' + color.bold + '\2' + color.reset + '(')
puts text
elsif response.code.to_i == 401
print_permission_error_message
exit 2
else
STDERR.puts "*** An error occured."
STDERR.puts "#{response.code}: #{response.body}"
exit 2
end
when 'xml'
request = Net::HTTP::Get.new("/pool.xml?secrets=#{options[:verbose]}")
try_performing_ro_admin_basic_auth(request, instance)
response = instance.http_request("agents.s/core_api", request)
if response.code.to_i / 100 == 2
indented = format_with_xmllint(response.body)
if indented
puts indented
else
puts response.body
STDERR.puts "*** Tip: if you install the 'xmllint' command then the XML output will be indented."
end
elsif response.code.to_i == 401
if response["pool-empty"] == "true"
puts "#{PROGRAM_NAME} is currently not serving any applications."
else
print_permission_error_message
exit 2
end
else
STDERR.puts "*** An error occured."
STDERR.puts "#{response.code}: #{response.body}"
exit 2
end
when 'union_station'
request = Net::HTTP::Get.new("/server.json")
try_performing_ro_admin_basic_auth(request, instance)
response = instance.http_request("agents.s/ust_router_api", request)
if response.code.to_i / 100 == 2
puts response.body
elsif response.code.to_i == 401
print_permission_error_message
exit 2
else
STDERR.puts "*** An error occured."
STDERR.puts "#{response.code}: #{response.body}"
exit 2
end
end
end
def print_header(io, instance)
io.puts "Version : #{PhusionPassenger::VERSION_STRING}"
io.puts "Date : #{Time.now}"
io.puts "Instance: #{instance.name} (#{instance.server_software})"
io.puts
end
def try_performing_ro_admin_basic_auth(request, instance)
begin
password = instance.read_only_admin_password
rescue Errno::EACCES
return
end
request.basic_auth("ro_admin", password)
end
def print_permission_error_message
PhusionPassenger.require_passenger_lib 'platform_info/ruby'
STDERR.puts "*** ERROR: You are not authorized to query the status for this " <<
"#{PROGRAM_NAME} instance. Please try again with '#{PhusionPassenger::PlatformInfo.ruby_sudo_command}'."
end
def format_with_xmllint(xml)
return nil if !PhusionPassenger::PlatformInfo.find_command('xmllint')
require 'open3'
require 'thread'
ENV['XMLLINT_INDENT'] = ' '
Open3.popen3("xmllint", "--format", "-") do |stdin, stdout, stderr|
stdout_text = nil
stderr_text = nil
thread1 = Thread.new do
stdin.write(xml)
stdin.close
end
thread2 = Thread.new do
stdout_text = stdout.read
stdout.close
end
thread3 = Thread.new do
stderr_text = stderr.read
stderr.close
end
thread1.join
thread2.join
thread3.join
if stdout_text.nil? || stdout_text.empty?
if stderr_text !~ /No such file or directory/ && stderr_text !~ /command not found/
STDERR.puts stderr_text
end
return nil
else
return stdout_text
end
end
end
##### Main command dispatcher #####
def create_option_parser(options)
return OptionParser.new do |opts|
nl = "\n" << " " * 37
opts.banner = "Usage: passenger-status [options] [instance name]"
opts.separator ""
opts.separator "Tool for inspecting Phusion Passenger's internal status."
opts.separator ""
opts.separator "Options:"
opts.on("--show=pool|server|backtraces|xml|union_station", String,
"Whether to show the pool's contents,#{nl}" <<
"the currently running requests,#{nl}" <<
"the backtraces of all threads or an XML#{nl}" <<
"description of the pool.") do |what|
if what !~ /\A(pool|server|requests|backtraces|xml|union_station)\Z/
STDERR.puts "Invalid argument for --show."
exit 1
else
options[:show] = what
end
end
opts.on("--no-header", "Do not display an informative header#{nl}" <<
"containing the timestamp, version number,#{nl}" <<
"etc.") do
options[:noheader] = true
end
opts.on("--force-colors", "Display colors even if stdout is not a TTY") do
options[:color] = true
end
opts.on("--verbose", "-v", "Show verbose information.") do
options[:verbose] = true
end
end
end
def parse_argv
options = DEFAULT_OPTIONS.dup
parser = create_option_parser(options)
begin
parser.parse!
rescue OptionParser::ParseError => e
puts e
puts
puts "Please see '--help' for valid options."
exit 1
end
return options
end
def infer_command
if !ARGV[0] || ARGV[0] !~ /^-/
return [:show_status, ARGV.dup]
else
command_name, *argv = ARGV
if respond_to?("command_#{command_name}")
return [command_name, argv]
else
abort "ERROR: unrecognized command '#{command_name}'"
end
end
end
def start
options = parse_argv
command, argv = infer_command
send("command_#{command}", argv, options)
end
start
|