事件¶

配置事件监听器¶

通过配置文件中的 [eventlistener:x] 部分指定管理程序事件侦听器。除了管理程序不遵守事件监听器进程的“捕获模式”输出（即，事件监听器不能是 PROCESS_COMMUNICATIONS_EVENT 事件生成器）之外，管理程序 [eventlistener:x] 部分几乎完全像处理器 [program:x] 部分一样处理它们的配置中允许的密钥。因此，在事件监听器的配置中指定 stdout_capture_maxbytes 或 stderr_capture_maxbytes 是错误的。对可以放入配置文件中的事件监听器部分的数量没有人为约束。

当定义 [eventlistener:x] 段时，它实际上定义了“池”，其中池中的事件监听器的数量由段内的 numprocs 值确定。

[eventlistener:x] 部分的 events 参数指定将发送到侦听器池的事件。编写良好的事件侦听器将忽略它无法处理的事件，但不能保证特定事件侦听器不会因接收到无法处理的事件类型而崩溃。因此，根据侦听器实现，在配置中指定它可以仅接收某些类型的事件可能是重要的。事件监听器的实现者是唯一能告诉你这些是什么（因此在 events 配置中有什么价值）的人。可以放置在 supervisord.conf 中的事件监听器配置的示例如下。

[eventlistener:memmon]
command=memmon -a 200MB -m bob@example.com
events=TICK_60

[eventlistener:mylistener]
command=my_custom_listener.py
events=PROCESS_STATE,TICK_60

当supervisor发送事件通知时，将找到所有预订接收事件类型的事件（由事件监听器部分中的 events 值过滤）的事件监听器池。每个侦听器池中的侦听器之一将接收事件通知（任何“可用”侦听器）。

事件侦听器池中的每个进程由管理员平等对待。如果池中的进程不可用（因为它已经在处理事件，因为它已经崩溃，或者因为它已经选择从池中删除它自己），管理员将从池中选择另一个进程。如果无法发送事件，因为池中的所有侦听器都“忙”，则事件将被缓冲，并且稍后将重试通知。 “稍后”被定义为“下一次 supervisord 选择循环执行”。为了令人满意的事件处理性能，您应该配置一个池，其中包含适当的事件侦听器进程以处理事件加载。这只能根据任何给定工作负载凭经验确定，没有“魔术数字”，但是为了帮助您确定给定池中的最佳监听器数量，当事件无法立即发送时，Supervisor将向其活动日志发出警告消息以缓冲拥塞。没有对池中可以存在的进程数量施加人为约束，它仅受平台约束的限制。

侦听器池具有事件缓冲区队列。队列的大小通过侦听器池的 buffer_size 配置文件选项。如果队列已满并且supervisor尝试缓冲事件，则超级用户将丢弃缓冲区中最旧的事件并记录错误。

编写事件侦听器¶

事件监听器实现是一个愿意在其stdin流上接受结构化输入并在其stdout流上产生结构化输出的程序。事件监听器实现应该在“无缓冲”模式下运行，或者每次它需要与supervisord进程通信时刷新它的stdout。事件侦听器可以写为长时间运行或可以在单个请求后退出（取决于事件侦听器配置中的实现和 autorestart 参数）。

事件监听器可以向其stderr发送任意输出，根据其 [eventlistener:x] 部分中与stderr相关的日志文件配置，superderord将记录或忽略该输出。

ver:3.0 server:supervisor serial:21 pool:listener poolserial:10 eventname:PROCESS_COMMUNICATION_STDOUT len:54

processname:foo groupname:bar pid:123
This is the data that was sent between the tags

import sys

def write_stdout(s):
    # only eventlistener protocol messages may be sent to stdout
    sys.stdout.write(s)
    sys.stdout.flush()

def write_stderr(s):
    sys.stderr.write(s)
    sys.stderr.flush()

def main():
    while 1:
        # transition from ACKNOWLEDGED to READY
        write_stdout('READY\n')

        # read header line and print it to stderr
        line = sys.stdin.readline()
        write_stderr(line)

        # read event payload and print it to stderr
        headers = dict([ x.split(':') for x in line.split() ])
        data = sys.stdin.read(int(headers['len']))
        write_stderr(data)

        # transition from READY to ACKNOWLEDGED
        write_stdout('RESULT 2\nOK')

if __name__ == '__main__':
    main()

EVENT 事件类型¶

基本事件类型。此事件类型是抽象的。它永远不会直接发送。订阅此事件类型将导致订阅者接收Supervisor发出的所有事件通知。

Name：EVENT

子类型：N/A

身体描述：N/A

PROCESS_STATE 事件类型¶

此进程类型表示进程已从一个状态移动到另一个状态。有关过程在其生命周期中经历的状态的描述，请参阅 过程国。这个事件类型是抽象的，它永远不会被直接发送。订阅此事件类型将导致订阅者接收作为 PROCESS_STATE 的子类型的所有事件类型的事件通知。

Name：PROCESS_STATE

子类型：EVENT

PROCESS_STATE_STARTING 事件类型¶

表示进程已从状态切换到STARTING状态。

Name：PROCESS_STATE_STARTING

子类型：PROCESS_STATE

processname:cat groupname:cat from_state:STOPPED tries:0

PROCESS_STATE_RUNNING 事件类型¶

表示进程已从 STARTING 状态转移到 RUNNING 状态。这意味着就Supervisor而言，该流程已成功启动。

Name：PROCESS_STATE_RUNNING

子类型：PROCESS_STATE

processname:cat groupname:cat from_state:STARTING pid:2766

PROCESS_STATE_BACKOFF 事件类型¶

表示进程已从 STARTING 状态转移到 BACKOFF 状态。这意味着进程未成功进入RUNNING状态，并且Supervisor将尝试重新启动它，除非它已超过其“startretries”配置限制。

Name：PROCESS_STATE_BACKOFF

子类型：PROCESS_STATE

processname:cat groupname:cat from_state:STOPPED tries:0

PROCESS_STATE_STOPPING 事件类型¶

表示进程已从 RUNNING 状态或 STARTING 状态转移到 STOPPING 状态。

Name：PROCESS_STATE_STOPPING

子类型：PROCESS_STATE

processname:cat groupname:cat from_state:STARTING pid:2766

PROCESS_STATE_EXITED 事件类型¶

表示进程已从 RUNNING 状态转移到 EXITED 状态。

Name：PROCESS_STATE_EXITED

子类型：PROCESS_STATE

processname:cat groupname:cat from_state:RUNNING expected:0 pid:2766

PROCESS_STATE_STOPPED 事件类型¶

表示进程已从 STOPPING 状态转移到 STOPPED 状态。

Name：PROCESS_STATE_STOPPED

子类型：PROCESS_STATE

processname:cat groupname:cat from_state:STOPPING pid:2766

PROCESS_STATE_FATAL 事件类型¶

表示进程已从 BACKOFF 状态转移到 FATAL 状态。这意味着Supervisor尝试 startretries 次数不成功启动进程，并放弃了尝试重新启动它。

Name：PROCESS_STATE_FATAL

子类型：PROCESS_STATE

processname:cat groupname:cat from_state:BACKOFF

PROCESS_STATE_UNKNOWN 事件类型¶

表示进程已从任何状态转移到 UNKNOWN 状态（表示 supervisord 中的错误）。只有在 supervisord 本身有编程错误时，才会发生这种状态转换。

Name：PROCESS_STATE_UNKNOWN

子类型：PROCESS_STATE

processname:cat groupname:cat from_state:BACKOFF

REMOTE_COMMUNICATION 事件类型¶

在Supervisor的RPC接口上调用 supervisor.sendRemoteCommEvent() 方法时引发的事件类型。 type 和 data 是RPC方法的参数。

Name：REMOTE_COMMUNICATION

子类型：EVENT

type:type
data

PROCESS_LOG 事件类型¶

当进程写入stdout或stderr时发出的事件类型。仅当文件描述符不处于捕获模式并且 stdout_events_enabled 或 stderr_events_enabled 配置选项设置为 true 时，才会发出事件。这个事件类型是抽象的，它永远不会被直接发送。订阅此事件类型将导致订阅者接收 PROCESS_LOG 的所有子类型的事件通知。

Name：PROCESS_LOG

子类型：EVENT

身体描述：N/A

PROCESS_LOG_STDOUT 事件类型¶

表示进程已写入其stdout文件描述符。仅当文件描述符不处于捕获模式并且 stdout_events_enabled 配置选项设置为 true 时，才会发出该事件。

Name：PROCESS_LOG_STDOUT

子类型：PROCESS_LOG

processname:name groupname:name pid:pid
data

PROCESS_LOG_STDERR 事件类型¶

表示进程已经写入其stderr文件描述符。仅当文件描述符不处于捕获模式并且 stderr_events_enabled 配置选项设置为 true 时，才会发出该事件。

Name：PROCESS_LOG_STDERR

子类型：PROCESS_LOG

processname:name groupname:name pid:pid
data

PROCESS_COMMUNICATION 事件类型¶

当任何进程尝试在其输出中的 <!--XSUPERVISOR:BEGIN--> 和 <!--XSUPERVISOR:END--> 标记之间发送信息时引发的事件类型。这个事件类型是抽象的，它永远不会被直接发送。订阅此事件类型将导致订阅者接收 PROCESS_COMMUNICATION 的所有子类型的事件通知。

Name：PROCESS_COMMUNICATION

子类型：EVENT

身体描述：N/A

PROCESS_COMMUNICATION_STDOUT 事件类型¶

表示进程已经向其stdout文件描述符发送了一个消息给Supervisor。

Name：PROCESS_COMMUNICATION_STDOUT

子类型：PROCESS_COMMUNICATION

processname:name groupname:name pid:pid
data

PROCESS_COMMUNICATION_STDERR 事件类型¶

表示进程已经向其stderr文件描述符发送了一个消息给Supervisor。

Name：PROCESS_COMMUNICATION_STDERR

子类型：PROCESS_COMMUNICATION

processname:name groupname:name pid:pid
data

SUPERVISOR_STATE_CHANGE 事件类型¶

当 supervisord 进程的状态改变时引发的事件类型。这种类型是抽象的，它永远不会被直接发送。订阅此事件类型将导致订阅者接收 SUPERVISOR_STATE_CHANGE 的所有子类型的事件通知。

Name：SUPERVISOR_STATE_CHANGE

子类型：EVENT

身体描述：N/A

SUPERVISOR_STATE_CHANGE_RUNNING 事件类型¶

表示 supervisord 已启动。

Name：SUPERVISOR_STATE_CHANGE_RUNNING

子类型：SUPERVISOR_STATE_CHANGE

身体描述：空字符串

SUPERVISOR_STATE_CHANGE_STOPPING 事件类型¶

表示 supervisord 正在停止。

Name：SUPERVISOR_STATE_CHANGE_STOPPING

子类型：SUPERVISOR_STATE_CHANGE

身体描述：空字符串

TICK 事件类型¶

可以订阅的事件类型，用于事件监听器每N秒接收“唤醒”通知。这个事件类型是抽象的，它永远不会被直接发送。订阅此事件类型将导致订阅者接收 TICK 的所有子类型的事件通知。

请注意，唯一可用的 TICK 事件是下面列出的事件。您不能订阅任意 TICK 间隔。如果您需要下面未提供的间隔，您可以订阅以下给出的较短间隔之一，并记录事件侦听器中运行之间的时间。

Name：TICK

子类型：EVENT

身体描述：N/A

TICK_5 事件类型¶

可以订阅的事件类型，用于事件监听器每5秒钟接收“唤醒”通知。

Name：TICK_5

子类型：TICK

when:1201063880

TICK_60 事件类型¶

可以订阅的事件类型，用于事件侦听器每60秒接收“唤醒”通知。

Name：TICK_60

子类型：TICK

when:1201063880

TICK_3600 事件类型¶

可以订阅的事件类型，用于事件侦听器每3600秒（1小时）接收“唤醒”通知。

Name：TICK_3600

子类型：TICK

when:1201063880

PROCESS_GROUP 事件类型¶

向Supervisor添加或从Supervisor中删除进程组时引发的事件类型。这种类型是抽象的，它永远不会被直接发送。订阅此事件类型将导致订阅者接收 PROCESS_GROUP 的所有子类型的事件通知。

Name：PROCESS_GROUP

子类型：EVENT

身体描述：N/A

PROCESS_GROUP_ADDED 事件类型¶

表示进程组已添加到Supervisor的配置。

Name：PROCESS_GROUP_ADDED

子类型：PROCESS_GROUP

身体描述：这个主体是一个只有一个groupname键/值的令牌集。

groupname:cat

PROCESS_GROUP_REMOVED 事件类型¶

表示已从Supervisor的配置中删除进程组。

Name：PROCESS_GROUP_REMOVED

子类型：PROCESS_GROUP

身体描述：这个主体是一个只有一个groupname键/值的令牌集。

groupname:cat