blob: e1ea2a36f4ef0a2523473ac6bf44a5c469d8258c [file] [log] [blame]
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (17) -->
<title>Uses of Class org.apache.logging.log4j.core.layout.LoggerFields (Apache Log4j Core 2.23.1 API)</title>
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta name="description" content="use: package: org.apache.logging.log4j.core.layout, class: LoggerFields">
<meta name="generator" content="javadoc/ClassUseWriter">
<link rel="stylesheet" type="text/css" href="../../../../../../../stylesheet.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../../../../../../script-dir/jquery-ui.min.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../../../../../../jquery-ui.overrides.css" title="Style">
<script type="text/javascript" src="../../../../../../../script.js"></script>
<script type="text/javascript" src="../../../../../../../script-dir/jquery-3.6.1.min.js"></script>
<script type="text/javascript" src="../../../../../../../script-dir/jquery-ui.min.js"></script>
</head>
<body class="class-use-page">
<script type="text/javascript">var pathtoroot = "../../../../../../../";
loadScripts(document, 'script');</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<div class="flex-box">
<header role="banner" class="flex-header">
<nav role="navigation">
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="top-nav" id="navbar-top">
<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div>
<ul id="navbar-top-firstrow" class="nav-list" title="Navigation">
<li><a href="../../../../../../../index.html">Overview</a></li>
<li><a href="../package-summary.html">Package</a></li>
<li><a href="../LoggerFields.html" title="class in org.apache.logging.log4j.core.layout">Class</a></li>
<li class="nav-bar-cell1-rev">Use</li>
<li><a href="../package-tree.html">Tree</a></li>
<li><a href="../../../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../../../index-all.html">Index</a></li>
<li><a href="../../../../../../../help-doc.html#use">Help</a></li>
</ul>
</div>
<div class="sub-nav">
<div class="nav-list-search"><label for="search-input">SEARCH:</label>
<input type="text" id="search-input" value="search" disabled="disabled">
<input type="reset" id="reset-button" value="reset" disabled="disabled">
</div>
</div>
<!-- ========= END OF TOP NAVBAR ========= -->
<span class="skip-nav" id="skip-navbar-top"></span></nav>
</header>
<div class="flex-content">
<main role="main">
<div class="header">
<h1 title="Uses of Class org.apache.logging.log4j.core.layout.LoggerFields" class="title">Uses of Class<br>org.apache.logging.log4j.core.layout.LoggerFields</h1>
</div>
<div class="caption"><span>Packages that use <a href="../LoggerFields.html" title="class in org.apache.logging.log4j.core.layout">LoggerFields</a></span></div>
<div class="summary-table two-column-summary">
<div class="table-header col-first">Package</div>
<div class="table-header col-last">Description</div>
<div class="col-first even-row-color"><a href="#org.apache.logging.log4j.core.appender">org.apache.logging.log4j.core.appender</a></div>
<div class="col-last even-row-color">
<div class="block">Log4j 2 Appenders.</div>
</div>
<div class="col-first odd-row-color"><a href="#org.apache.logging.log4j.core.layout">org.apache.logging.log4j.core.layout</a></div>
<div class="col-last odd-row-color">
<div class="block">Log4j 2 Layout support.</div>
</div>
</div>
<section class="class-uses">
<ul class="block-list">
<li>
<section class="detail" id="org.apache.logging.log4j.core.appender">
<h2>Uses of <a href="../LoggerFields.html" title="class in org.apache.logging.log4j.core.layout">LoggerFields</a> in <a href="../../appender/package-summary.html">org.apache.logging.log4j.core.appender</a></h2>
<div class="caption"><span>Methods in <a href="../../appender/package-summary.html">org.apache.logging.log4j.core.appender</a> that return <a href="../LoggerFields.html" title="class in org.apache.logging.log4j.core.layout">LoggerFields</a></span></div>
<div class="summary-table three-column-summary">
<div class="table-header col-first">Modifier and Type</div>
<div class="table-header col-second">Method</div>
<div class="table-header col-last">Description</div>
<div class="col-first even-row-color"><code><a href="../LoggerFields.html" title="class in org.apache.logging.log4j.core.layout">LoggerFields</a>[]</code></div>
<div class="col-second even-row-color"><span class="type-name-label">SyslogAppender.Builder.</span><code><a href="../../appender/SyslogAppender.Builder.html#getLoggerFields()" class="member-name-link">getLoggerFields</a>()</code></div>
<div class="col-last even-row-color">&nbsp;</div>
</div>
<div class="caption"><span>Methods in <a href="../../appender/package-summary.html">org.apache.logging.log4j.core.appender</a> with parameters of type <a href="../LoggerFields.html" title="class in org.apache.logging.log4j.core.layout">LoggerFields</a></span></div>
<div class="summary-table three-column-summary">
<div class="table-header col-first">Modifier and Type</div>
<div class="table-header col-second">Method</div>
<div class="table-header col-last">Description</div>
<div class="col-first even-row-color"><code>static &lt;B extends <a href="../../appender/SyslogAppender.Builder.html" title="class in org.apache.logging.log4j.core.appender">SyslogAppender.Builder</a>&lt;B&gt;&gt;<br><a href="../../appender/SyslogAppender.html" title="class in org.apache.logging.log4j.core.appender">SyslogAppender</a></code></div>
<div class="col-second even-row-color"><span class="type-name-label">SyslogAppender.</span><code><a href="../../appender/SyslogAppender.html#createAppender(java.lang.String,int,java.lang.String,org.apache.logging.log4j.core.net.ssl.SslConfiguration,int,int,boolean,java.lang.String,boolean,boolean,org.apache.logging.log4j.core.net.Facility,java.lang.String,int,boolean,java.lang.String,java.lang.String,java.lang.String,boolean,java.lang.String,java.lang.String,java.lang.String,java.lang.String,java.lang.String,java.lang.String,java.lang.String,org.apache.logging.log4j.core.Filter,org.apache.logging.log4j.core.config.Configuration,java.nio.charset.Charset,java.lang.String,org.apache.logging.log4j.core.layout.LoggerFields%5B%5D,boolean)" class="member-name-link">createAppender</a><wbr>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;host,
int&nbsp;port,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;protocolStr,
<a href="../../net/ssl/SslConfiguration.html" title="class in org.apache.logging.log4j.core.net.ssl">SslConfiguration</a>&nbsp;sslConfiguration,
int&nbsp;connectTimeoutMillis,
int&nbsp;reconnectDelayMillis,
boolean&nbsp;immediateFail,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;name,
boolean&nbsp;immediateFlush,
boolean&nbsp;ignoreExceptions,
<a href="../../net/Facility.html" title="enum in org.apache.logging.log4j.core.net">Facility</a>&nbsp;facility,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;id,
int&nbsp;enterpriseNumber,
boolean&nbsp;includeMdc,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;mdcId,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;mdcPrefix,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;eventPrefix,
boolean&nbsp;newLine,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;escapeNL,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;appName,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;msgId,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;excludes,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;includes,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;required,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;format,
<a href="../../Filter.html" title="interface in org.apache.logging.log4j.core">Filter</a>&nbsp;filter,
<a href="../../config/Configuration.html" title="interface in org.apache.logging.log4j.core.config">Configuration</a>&nbsp;configuration,
<a href="https://docs.oracle.com/javase/8/docs/api/java/nio/charset/Charset.html" title="class or interface in java.nio.charset" class="external-link">Charset</a>&nbsp;charset,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;exceptionPattern,
<a href="../LoggerFields.html" title="class in org.apache.logging.log4j.core.layout">LoggerFields</a>[]&nbsp;loggerFields,
boolean&nbsp;advertise)</code></div>
<div class="col-last even-row-color">
<div class="block"><span class="deprecated-label">Deprecated.</span>
<div class="deprecation-comment">Use <a href="../../appender/SyslogAppender.html#newSyslogAppenderBuilder()"><code>SyslogAppender.newSyslogAppenderBuilder()</code></a>.</div>
</div>
</div>
<div class="col-first odd-row-color"><code><a href="../../appender/SyslogAppender.Builder.html" title="type parameter in SyslogAppender.Builder">B</a></code></div>
<div class="col-second odd-row-color"><span class="type-name-label">SyslogAppender.Builder.</span><code><a href="../../appender/SyslogAppender.Builder.html#setLoggerFields(org.apache.logging.log4j.core.layout.LoggerFields%5B%5D)" class="member-name-link">setLoggerFields</a><wbr>(<a href="../LoggerFields.html" title="class in org.apache.logging.log4j.core.layout">LoggerFields</a>[]&nbsp;loggerFields)</code></div>
<div class="col-last odd-row-color">&nbsp;</div>
</div>
</section>
</li>
<li>
<section class="detail" id="org.apache.logging.log4j.core.layout">
<h2>Uses of <a href="../LoggerFields.html" title="class in org.apache.logging.log4j.core.layout">LoggerFields</a> in <a href="../package-summary.html">org.apache.logging.log4j.core.layout</a></h2>
<div class="caption"><span>Methods in <a href="../package-summary.html">org.apache.logging.log4j.core.layout</a> that return <a href="../LoggerFields.html" title="class in org.apache.logging.log4j.core.layout">LoggerFields</a></span></div>
<div class="summary-table three-column-summary">
<div class="table-header col-first">Modifier and Type</div>
<div class="table-header col-second">Method</div>
<div class="table-header col-last">Description</div>
<div class="col-first even-row-color"><code>static <a href="../LoggerFields.html" title="class in org.apache.logging.log4j.core.layout">LoggerFields</a></code></div>
<div class="col-second even-row-color"><span class="type-name-label">LoggerFields.</span><code><a href="../LoggerFields.html#createLoggerFields(org.apache.logging.log4j.core.util.KeyValuePair%5B%5D,java.lang.String,java.lang.String,boolean)" class="member-name-link">createLoggerFields</a><wbr>(<a href="../../util/KeyValuePair.html" title="class in org.apache.logging.log4j.core.util">KeyValuePair</a>[]&nbsp;keyValuePairs,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;sdId,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;enterpriseId,
boolean&nbsp;discardIfAllFieldsAreEmpty)</code></div>
<div class="col-last even-row-color">
<div class="block">Create a LoggerFields from KeyValuePairs.</div>
</div>
</div>
<div class="caption"><span>Methods in <a href="../package-summary.html">org.apache.logging.log4j.core.layout</a> with parameters of type <a href="../LoggerFields.html" title="class in org.apache.logging.log4j.core.layout">LoggerFields</a></span></div>
<div class="summary-table three-column-summary">
<div class="table-header col-first">Modifier and Type</div>
<div class="table-header col-second">Method</div>
<div class="table-header col-last">Description</div>
<div class="col-first even-row-color"><code>static <a href="../Rfc5424Layout.html" title="class in org.apache.logging.log4j.core.layout">Rfc5424Layout</a></code></div>
<div class="col-second even-row-color"><span class="type-name-label">Rfc5424Layout.</span><code><a href="../Rfc5424Layout.html#createLayout(org.apache.logging.log4j.core.net.Facility,java.lang.String,int,boolean,java.lang.String,java.lang.String,java.lang.String,boolean,java.lang.String,java.lang.String,java.lang.String,java.lang.String,java.lang.String,java.lang.String,java.lang.String,boolean,org.apache.logging.log4j.core.layout.LoggerFields%5B%5D,org.apache.logging.log4j.core.config.Configuration)" class="member-name-link">createLayout</a><wbr>(<a href="../../net/Facility.html" title="enum in org.apache.logging.log4j.core.net">Facility</a>&nbsp;facility,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;id,
int&nbsp;enterpriseNumber,
boolean&nbsp;includeMDC,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;mdcId,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;mdcPrefix,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;eventPrefix,
boolean&nbsp;newLine,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;escapeNL,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;appName,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;msgId,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;excludes,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;includes,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;required,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;exceptionPattern,
boolean&nbsp;useTlsMessageFormat,
<a href="../LoggerFields.html" title="class in org.apache.logging.log4j.core.layout">LoggerFields</a>[]&nbsp;loggerFields,
<a href="../../config/Configuration.html" title="interface in org.apache.logging.log4j.core.config">Configuration</a>&nbsp;config)</code></div>
<div class="col-last even-row-color">
<div class="block"><span class="deprecated-label">Deprecated.</span>
<div class="deprecation-comment">Use <a href="../Rfc5424Layout.Rfc5424LayoutBuilder.html" title="class in org.apache.logging.log4j.core.layout"><code>instead</code></a></div>
</div>
</div>
<div class="col-first odd-row-color"><code><a href="../Rfc5424Layout.Rfc5424LayoutBuilder.html" title="class in org.apache.logging.log4j.core.layout">Rfc5424Layout.Rfc5424LayoutBuilder</a></code></div>
<div class="col-second odd-row-color"><span class="type-name-label">Rfc5424Layout.Rfc5424LayoutBuilder.</span><code><a href="../Rfc5424Layout.Rfc5424LayoutBuilder.html#setLoggerFields(org.apache.logging.log4j.core.layout.LoggerFields%5B%5D)" class="member-name-link">setLoggerFields</a><wbr>(<a href="../LoggerFields.html" title="class in org.apache.logging.log4j.core.layout">LoggerFields</a>[]&nbsp;loggerFields)</code></div>
<div class="col-last odd-row-color">&nbsp;</div>
</div>
</section>
</li>
</ul>
</section>
</main>
<footer role="contentinfo">
<hr>
<p class="legal-copy"><small><p align="center"> Copyright &copy; 1999-2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All Rights Reserved.<br/> Apache Logging, Apache Log4j, Log4j, Apache, the Apache feather logo, the Apache Logging project logo, and the Apache Log4j logo are trademarks of The Apache Software Foundation. </p></small></p>
</footer>
</div>
</div>
</body>
</html>