Console¶

This consumer reads from stdin. A message is generated after each newline character. When attached to a fuse, this consumer will stop accepting messages in case that fuse is burned.

Parameters¶

Enable: Enable switches the consumer on or off. By default this value is set to true.
ID: ID allows this consumer to be found by other plugins by name. By default this is set to “” which does not register this consumer.
Stream: Stream contains either a single string or a list of strings defining the message channels this consumer will produce. By default this is set to “*” which means only producers set to consume “all streams” will get these messages.
Fuse: Fuse defines the name of a fuse to observe for this consumer. Producer may “burn” the fuse when they encounter errors. Consumers may react on this by e.g. closing connections to notify any writing services of the problem. Set to “” by default which disables the fuse feature for this consumer. It is up to the consumer implementation to react on a broken fuse in an appropriate manner.
Console: Console defines the pipe to read from. This can be “stdin” or the name of a named pipe that is created if not existing. The default is “stdin”.
Permissions: Permissions accepts an octal number string that contains the unix file permissions used when creating a named pipe. By default this is set to “0664”.
ExitOnEOF: ExitOnEOF can be set to true to trigger an exit signal if StdIn is closed (e.g. when a pipe is closed). This is set to false by default.

Example¶

- "consumer.Console":
    Enable: true
    ID: ""
    Fuse: ""
    Stream:
        - "foo"
        - "bar"
    Console: "stdin"
    Permissions: "0664"
    ExitOnEOF: false