...
Administrator Controls
Reload configuration files (blade, crews, limits):
http://ENGINE/Tractor/ctrl?q=reconfigureReload a single configuration file, for example: limits.config
http://ENGINE/Tractor/ctrl?q=reconfigure&file=limits.configQuery basic engine state:
http://ENGINE/Tractor/ctrl?q=statusQuery current active limit tallies:
http://ENGINE/Tractor/queue?q=limits
NOTE: this query is relatively expensive, it locks all threads. Add &full=1 to also include zero-valued "transitory" limits not defined in limits.config:**
Query unrolled crew definitions:
Query the current Dispatching Tier definitions:
Query unrolled blade profile definitions:
http://ENGINE/Tractor/config?q=get&file=blade.configList recently connected Dashboard users (session mailboxes):
http://ENGINE/Tractor/monitor?q=mboxesTrace engine assignment decisions:
http://ENGINE/Tractor/ctrl?q=tracer&fmt=plain -- next assignment pass
add &t=bbbb -- for blade named bbbb add &t=jjjj -- for job with jid jjjj
Remove an old entry from the displayed list of active blades:
http://ENGINE/Tractor/btrack?q=delist&id=hhhhh/aa.aa.aa.aa
where hhhhh is the blade's hostname and aa.aa.aa.aa is the blade's current tcp/ip address.
Diagnostic: query engine internal message queue lengths:
http://ENGINE/Tractor/ctrl?q=status&qlen=1
NOTE: this query is relatively expensive, it locks all threads.
Engine log level: change the logging threshold level of the engine's own diagnostic logs:
http://ENGINE/Tractor/ctrl?q=loglevel&v=debug
Recognized level names are: severe, notice, info, debug, trace
Engine database contexts: bounce the engine's own internal client connections to the database server:
http://ENGINE/Tractor/ctrl?q=dbreconnectBlade Queries and Controls
List all of the currently connected blades, with a recent status snapshot:
http://ENGINE/Tractor/monitor?q=bladesStop and Requeue all currently active tasks on a particular blade:
http://ENGINE/Tractor/queue?q=ejectall&blade=host/addr&tsid=sssQuery the engine for its information on a specific blade:
http://ENGINE/Tractor/monitor?q=bdetails&b=NAMEQuery the engine for blade information, and include results from an (expensive) direct probe of the blade itself:
http://ENGINE/Tractor/monitor?q=bdetails&b=NAME&probe=1
Use this query cautiously, especially in scripts, since it can cause processing delays on the engine as it waits for the blade response -- especially when probing blades that are slow to respond. In this form of the query, the NAME parameter can be "hostname" or "hostname/address". The address portion is historical and is ignored, the engine derives blade addresses from the last entry in the blade database.
Query the current state of a blade directly:
http://BLADE/blade/statusChange the NIMBY state of a blade, via the engine:
First, send a login request to receive a session ID (tsid), then:
http://ENGINE/Tractor/ctrl?q=battribute&tsid=SSS&b=BBB&nimby=NNN
where:
Change the NIMBY state of a blade via direct http connection to the blade:
http://BLADE/blade/ctrl?nimby=NNN
Where NNN is the same as for the engine proxy case, above. Note that this direct type of connection may be disallowed by the NimbyConnectPolicy setting in blade.config.
Engine Metrics and Statistics
Get the most recent engine health statistics:
http://ENGINE/Tractor/monitor?q=statistics
The query returns various tractor-engine performance and status metrics. The currently provided values are intended to give administrators a quick set of engine "vital signs" to check when looking at overall Tractor health or for engine hot spots.
The statistics report is organized as a JSON dictionary. Each key in the dictionary represents one type of metric. The value field in the dictionary for each key is an array of recent samples for that metric.
The current dictionary metrics names are listed here. The list may evolve over time.
- "dt" - the actual length of each sampling interval
- "enla" - engine normalized load avg, cpu load on the engine host
- "rtot" - total inbound engine queries in the interval
- "asn" - assignments made during the interval
- "nrun" - count of currently dispatched cmds running on the farm
- "nctot" - total backlog of unexecuted commands in all waiting jobs
- "ncrdy" - total backlog of ready commands in all waiting jobs
- "nslot" - total slots on the farm reported by blades
- "nsin" - total slots in use on the farm
- "tecpu" - estimate of current CPU utilization due to tractor-engine
- "temem" - estimate of current RAM utilization due to tractor-engine
- "dbcpu" - estimate of current CPU utilization due to the job database
- "dbmem" - estimate of current RAM utilization due to the job database
- "dbcqn" - backlog of pending job state database commits
- "iqn" - backlog of waiting requests on the main intake queue
- "sqn" - backlog of waiting requests on the shipper pool queue
- "aqn" - backlog of waiting requests on the assigner queue
- "qqn" - backlog of waiting requests on the job archive queue
- "jqn" - backlog of waiting requests on the job submission queue
- "mqn" - backlog of waiting requests on the monitor UI queue
- "nmbox" - subscribed UI sessions
Get a recent history of engine statistics:
http://ENGINE/Tractor/monitor?q=statslog
This query is like q=statistics, above, but it returns several minutes worth of samples for each metric.
Note: for continuous monitoring add "&stats=1" to your recurring q=subscribe request; statistics will arrive as 's' mbox messages.
The last entry in each array is the most recent sample. The engine maintains a simple ring buffer of these samples, so on the next update the first array element is dropped and all of the other samples appear to "shift left" with a new value appearing at the end. The statslog query returns all of the samples in the buffer so that a UI can generate a complete graph from a single query.