org.apache.storm.utils

## Interface ShellLogHandler

- All Known Implementing Classes:
    DefaultShellLogHandler

      public interface ShellLogHandler

  Handle logging from non-JVM processes.

- - ### Method Summary

    All Methods Instance Methods Abstract Methods
    Modifier and Type | Method and Description
    --- | ---
    `void` | `log(ShellMsg msg)` Called by spouts and bolts when they receive a ‘log’ command from a multilang process.
    `void` | `setUpContext(Class<?> ownerCls, ShellProcess process, TopologyContext context)` Called at least once before `log(org.apache.storm.multilang.ShellMsg)` for each spout and bolt.

- - ### Method Detail

    - #### setUpContext

          void setUpContext(Class<?> ownerCls,
                            ShellProcess process,
                            TopologyContext context)

      Called at least once before `log(org.apache.storm.multilang.ShellMsg)` for each spout and bolt. Allows implementing classes to save information about the current running context e.g. pid, thread, task.

      Parameters:
        `ownerCls` -
        - the class which instantiated this ShellLogHandler.
        `process` -
        - the current `ShellProcess`.
        `context` -
        - the current `TopologyContext`.

    - #### log

          void log(ShellMsg msg)

      Called by spouts and bolts when they receive a ‘log’ command from a multilang process.

      Parameters:
        `msg` -
        - the `ShellMsg` containing the message to log.

Copyright © 2021 The Apache Software Foundation. All rights reserved.