| <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> |
| <html xmlns="http://www.w3.org/1999/xhtml"> |
| <head> |
| <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> |
| <meta http-equiv="X-UA-Compatible" content="IE=9"/> |
| <meta name="generator" content="Doxygen 1.8.5"/> |
| <title>Apache Mesos: mesos::internal::slave::SandboxContainerLogger Class Reference</title> |
| <link href="tabs.css" rel="stylesheet" type="text/css"/> |
| <script type="text/javascript" src="jquery.js"></script> |
| <script type="text/javascript" src="dynsections.js"></script> |
| <link href="doxygen.css" rel="stylesheet" type="text/css" /> |
| </head> |
| <body> |
| <div id="top"><!-- do not remove this div, it is closed by doxygen! --> |
| <div id="titlearea"> |
| <table cellspacing="0" cellpadding="0"> |
| <tbody> |
| <tr style="height: 56px;"> |
| <td style="padding-left: 0.5em;"> |
| <div id="projectname">Apache Mesos |
| </div> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| <!-- end header part --> |
| <!-- Generated by Doxygen 1.8.5 --> |
| <div id="navrow1" class="tabs"> |
| <ul class="tablist"> |
| <li><a href="index.html"><span>Main Page</span></a></li> |
| <li><a href="pages.html"><span>Related Pages</span></a></li> |
| <li><a href="namespaces.html"><span>Namespaces</span></a></li> |
| <li class="current"><a href="annotated.html"><span>Classes</span></a></li> |
| <li><a href="files.html"><span>Files</span></a></li> |
| <li><a href="examples.html"><span>Examples</span></a></li> |
| </ul> |
| </div> |
| <div id="navrow2" class="tabs2"> |
| <ul class="tablist"> |
| <li><a href="annotated.html"><span>Class List</span></a></li> |
| <li><a href="classes.html"><span>Class Index</span></a></li> |
| <li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li> |
| <li><a href="functions.html"><span>Class Members</span></a></li> |
| </ul> |
| </div> |
| <div id="nav-path" class="navpath"> |
| <ul> |
| <li class="navelem"><a class="el" href="namespacemesos.html">mesos</a></li><li class="navelem"><a class="el" href="namespacemesos_1_1internal.html">internal</a></li><li class="navelem"><a class="el" href="namespacemesos_1_1internal_1_1slave.html">slave</a></li><li class="navelem"><a class="el" href="classmesos_1_1internal_1_1slave_1_1SandboxContainerLogger.html">SandboxContainerLogger</a></li> </ul> |
| </div> |
| </div><!-- top --> |
| <div class="header"> |
| <div class="summary"> |
| <a href="#pub-methods">Public Member Functions</a> | |
| <a href="#pro-attribs">Protected Attributes</a> | |
| <a href="classmesos_1_1internal_1_1slave_1_1SandboxContainerLogger-members.html">List of all members</a> </div> |
| <div class="headertitle"> |
| <div class="title">mesos::internal::slave::SandboxContainerLogger Class Reference</div> </div> |
| </div><!--header--> |
| <div class="contents"> |
| |
| <p><code>#include <<a class="el" href="sandbox_8hpp_source.html">sandbox.hpp</a>></code></p> |
| <div class="dynheader"> |
| Inheritance diagram for mesos::internal::slave::SandboxContainerLogger:</div> |
| <div class="dyncontent"> |
| <div class="center"> |
| <img src="classmesos_1_1internal_1_1slave_1_1SandboxContainerLogger.png" usemap="#mesos::internal::slave::SandboxContainerLogger_map" alt=""/> |
| <map id="mesos::internal::slave::SandboxContainerLogger_map" name="mesos::internal::slave::SandboxContainerLogger_map"> |
| <area href="classmesos_1_1slave_1_1ContainerLogger.html" title="A containerizer component used to manage container logs. " alt="mesos::slave::ContainerLogger" shape="rect" coords="0,0,281,24"/> |
| </map> |
| </div></div> |
| <table class="memberdecls"> |
| <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a> |
| Public Member Functions</h2></td></tr> |
| <tr class="memitem:a1b8a9a82650a01ad58e6e83a76b249e9"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classmesos_1_1internal_1_1slave_1_1SandboxContainerLogger.html#a1b8a9a82650a01ad58e6e83a76b249e9">SandboxContainerLogger</a> ()</td></tr> |
| <tr class="separator:a1b8a9a82650a01ad58e6e83a76b249e9"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a49bed83196f230c48c0363464b6c2e32"><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classmesos_1_1internal_1_1slave_1_1SandboxContainerLogger.html#a49bed83196f230c48c0363464b6c2e32">~SandboxContainerLogger</a> ()</td></tr> |
| <tr class="separator:a49bed83196f230c48c0363464b6c2e32"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:aa7a5dd7cd2385baf009fbff4bfcfc234"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="classTry.html">Try</a>< <a class="el" href="structNothing.html">Nothing</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classmesos_1_1internal_1_1slave_1_1SandboxContainerLogger.html#aa7a5dd7cd2385baf009fbff4bfcfc234">initialize</a> ()</td></tr> |
| <tr class="memdesc:aa7a5dd7cd2385baf009fbff4bfcfc234"><td class="mdescLeft"> </td><td class="mdescRight">Initializes this container logger. <a href="#aa7a5dd7cd2385baf009fbff4bfcfc234">More...</a><br/></td></tr> |
| <tr class="separator:aa7a5dd7cd2385baf009fbff4bfcfc234"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a4e8ddc5cdf7acee8ececd652f2fe470d"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="classprocess_1_1Future.html">process::Future</a><br class="typebreak"/> |
| < <a class="el" href="structmesos_1_1slave_1_1ContainerIO.html">mesos::slave::ContainerIO</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classmesos_1_1internal_1_1slave_1_1SandboxContainerLogger.html#a4e8ddc5cdf7acee8ececd652f2fe470d">prepare</a> (const ExecutorInfo &executorInfo, const std::string &sandboxDirectory, const <a class="el" href="classOption.html">Option</a>< std::string > &user)</td></tr> |
| <tr class="memdesc:a4e8ddc5cdf7acee8ececd652f2fe470d"><td class="mdescLeft"> </td><td class="mdescRight">Called before Mesos creates a container. <a href="#a4e8ddc5cdf7acee8ececd652f2fe470d">More...</a><br/></td></tr> |
| <tr class="separator:a4e8ddc5cdf7acee8ececd652f2fe470d"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="inherit_header pub_methods_classmesos_1_1slave_1_1ContainerLogger"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classmesos_1_1slave_1_1ContainerLogger')"><img src="closed.png" alt="-"/> Public Member Functions inherited from <a class="el" href="classmesos_1_1slave_1_1ContainerLogger.html">mesos::slave::ContainerLogger</a></td></tr> |
| <tr class="memitem:a2655dbc87f01116b204bcc03a199da16 inherit pub_methods_classmesos_1_1slave_1_1ContainerLogger"><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classmesos_1_1slave_1_1ContainerLogger.html#a2655dbc87f01116b204bcc03a199da16">~ContainerLogger</a> ()</td></tr> |
| <tr class="separator:a2655dbc87f01116b204bcc03a199da16 inherit pub_methods_classmesos_1_1slave_1_1ContainerLogger"><td class="memSeparator" colspan="2"> </td></tr> |
| </table><table class="memberdecls"> |
| <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-attribs"></a> |
| Protected Attributes</h2></td></tr> |
| <tr class="memitem:ae6d52b98a684d49fa90ea828cf8a6b8c"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classprocess_1_1Owned.html">process::Owned</a><br class="typebreak"/> |
| < SandboxContainerLoggerProcess > </td><td class="memItemRight" valign="bottom"><a class="el" href="classmesos_1_1internal_1_1slave_1_1SandboxContainerLogger.html#ae6d52b98a684d49fa90ea828cf8a6b8c">process</a></td></tr> |
| <tr class="separator:ae6d52b98a684d49fa90ea828cf8a6b8c"><td class="memSeparator" colspan="2"> </td></tr> |
| </table><table class="memberdecls"> |
| <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="inherited"></a> |
| Additional Inherited Members</h2></td></tr> |
| <tr class="inherit_header pub_static_methods_classmesos_1_1slave_1_1ContainerLogger"><td colspan="2" onclick="javascript:toggleInherit('pub_static_methods_classmesos_1_1slave_1_1ContainerLogger')"><img src="closed.png" alt="-"/> Static Public Member Functions inherited from <a class="el" href="classmesos_1_1slave_1_1ContainerLogger.html">mesos::slave::ContainerLogger</a></td></tr> |
| <tr class="memitem:a730e7d402fa06c15886eff94cf0b40d5 inherit pub_static_methods_classmesos_1_1slave_1_1ContainerLogger"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="classTry.html">Try</a>< <a class="el" href="classmesos_1_1slave_1_1ContainerLogger.html">ContainerLogger</a> * > </td><td class="memItemRight" valign="bottom"><a class="el" href="classmesos_1_1slave_1_1ContainerLogger.html#a730e7d402fa06c15886eff94cf0b40d5">create</a> (const <a class="el" href="classOption.html">Option</a>< std::string > &type)</td></tr> |
| <tr class="memdesc:a730e7d402fa06c15886eff94cf0b40d5 inherit pub_static_methods_classmesos_1_1slave_1_1ContainerLogger"><td class="mdescLeft"> </td><td class="mdescRight">Create and initialize a container logger instance of the given type, specified by the <code>container_logger</code> agent flag. <a href="#a730e7d402fa06c15886eff94cf0b40d5">More...</a><br/></td></tr> |
| <tr class="separator:a730e7d402fa06c15886eff94cf0b40d5 inherit pub_static_methods_classmesos_1_1slave_1_1ContainerLogger"><td class="memSeparator" colspan="2"> </td></tr> |
| </table> |
| <h2 class="groupheader">Constructor & Destructor Documentation</h2> |
| <a class="anchor" id="a1b8a9a82650a01ad58e6e83a76b249e9"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">mesos::internal::slave::SandboxContainerLogger::SandboxContainerLogger </td> |
| <td>(</td> |
| <td class="paramname"></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| </div> |
| </div> |
| <a class="anchor" id="a49bed83196f230c48c0363464b6c2e32"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">virtual mesos::internal::slave::SandboxContainerLogger::~SandboxContainerLogger </td> |
| <td>(</td> |
| <td class="paramname"></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">virtual</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| </div> |
| </div> |
| <h2 class="groupheader">Member Function Documentation</h2> |
| <a class="anchor" id="aa7a5dd7cd2385baf009fbff4bfcfc234"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">virtual <a class="el" href="classTry.html">Try</a><<a class="el" href="structNothing.html">Nothing</a>> mesos::internal::slave::SandboxContainerLogger::initialize </td> |
| <td>(</td> |
| <td class="paramname"></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">virtual</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Initializes this container logger. </p> |
| <p>This method must be called before any other member function is called.</p> |
| <p>The container logger module should return an error if the particular module is not supported. For example, if the module implements log rotation via the <code>logrotate</code> utility, the module can return an error if the utility is not found. </p> |
| |
| <p>Implements <a class="el" href="classmesos_1_1slave_1_1ContainerLogger.html#abf91d08c21dae805eed4fdd9f9f5fbd5">mesos::slave::ContainerLogger</a>.</p> |
| |
| </div> |
| </div> |
| <a class="anchor" id="a4e8ddc5cdf7acee8ececd652f2fe470d"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">virtual <a class="el" href="classprocess_1_1Future.html">process::Future</a><<a class="el" href="structmesos_1_1slave_1_1ContainerIO.html">mesos::slave::ContainerIO</a>> mesos::internal::slave::SandboxContainerLogger::prepare </td> |
| <td>(</td> |
| <td class="paramtype">const ExecutorInfo & </td> |
| <td class="paramname"><em>executorInfo</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">const std::string & </td> |
| <td class="paramname"><em>sandboxDirectory</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">const <a class="el" href="classOption.html">Option</a>< std::string > & </td> |
| <td class="paramname"><em>user</em> </td> |
| </tr> |
| <tr> |
| <td></td> |
| <td>)</td> |
| <td></td><td></td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">virtual</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Called before Mesos creates a container. </p> |
| <p>The container logger is given some of the arguments which the containerizer will use to launch a container. The container logger should return a <code>ContainerIO</code> which tells the containerizer how to handle the stdout and stderr of the container. The container logger can modify the fields within the <code>ContainerIO</code> as much as necessary, with some exceptions; see the struct <code>ContainerIO</code> above.</p> |
| <p>NOTE: The container logger should not lose stdout/stderr if the agent fails over. Additionally, if the container logger is stateful, the logger should be capable of recovering managed executors during the agent recovery process. See <code>ContainerLogger::recover</code>.</p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">executorInfo</td><td>Provided for the container logger to track logs. </td></tr> |
| <tr><td class="paramname">sandboxDirectory</td><td>An absolute path to the executor's sandbox. This is provided in case the container logger needs to store files in the executor's sandbox, such as persistent state between agent failovers. NOTE: All files in the sandbox are exposed via the <code>/files</code> endpoint. </td></tr> |
| </table> |
| </dd> |
| </dl> |
| |
| <p>Implements <a class="el" href="classmesos_1_1slave_1_1ContainerLogger.html#ad5f5c3cb7cbe6499cc609a165917cc72">mesos::slave::ContainerLogger</a>.</p> |
| |
| </div> |
| </div> |
| <h2 class="groupheader">Member Data Documentation</h2> |
| <a class="anchor" id="ae6d52b98a684d49fa90ea828cf8a6b8c"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname"><a class="el" href="classprocess_1_1Owned.html">process::Owned</a><SandboxContainerLoggerProcess> mesos::internal::slave::SandboxContainerLogger::process</td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">protected</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| </div> |
| </div> |
| <hr/>The documentation for this class was generated from the following file:<ul> |
| <li>src/slave/container_loggers/<a class="el" href="sandbox_8hpp_source.html">sandbox.hpp</a></li> |
| </ul> |
| </div><!-- contents --> |
| <!-- start footer part --> |
| <hr class="footer"/><address class="footer"><small> |
| Generated by  <a href="http://www.doxygen.org/index.html"> |
| <img class="footer" src="doxygen.png" alt="doxygen"/> |
| </a> 1.8.5 |
| </small></address> |
| </body> |
| </html> |
