You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@solr.apache.org by sv...@apache.org on 2023/10/15 15:24:09 UTC
svn commit: r1084409 [28/41] - in /sites/solr/guide: ./ solr/9_0/ solr/9_0/configuration-guide/ solr/9_0/deployment-guide/ solr/9_0/getting-started/ solr/9_0/indexing-guide/ solr/9_0/query-guide/ solr/9_0/upgrade-notes/ solr/9_1/ solr/9_1/configuration...
Modified: sites/solr/guide/solr/latest/deployment-guide/aliases.html
URL: http://svn.apache.org/viewvc/sites/solr/guide/solr/latest/deployment-guide/aliases.html?rev=1084409&r1=1084408&r2=1084409&view=diff
==============================================================================
--- sites/solr/guide/solr/latest/deployment-guide/aliases.html (original)
+++ sites/solr/guide/solr/latest/deployment-guide/aliases.html Sun Oct 15 15:24:01 2023
@@ -39,7 +39,7 @@
<div class="navbar-item has-dropdown is-hoverable">
<a class="navbar-link" href="#">Resources</a>
<div class="navbar-dropdown">
- <a class="navbar-item" href="https://solr.apache.org/docs/9_3_0/index.html" target="_blank" rel="noreferrer nopener">Solr Javadocs</a>
+ <a class="navbar-item" href="https://solr.apache.org/docs/9_4_0/index.html" target="_blank" rel="noreferrer nopener">Solr Javadocs</a>
<a class="navbar-item" href="https://solr.apache.org/community.html#version-control" target="_blank" rel="noreferrer nopener">Source Code</a>
<a class="navbar-item" href="https://solr.apache.org/community.html" target="_blank" rel="noreferrer nopener">Community Links</a>
<a class="navbar-item" href="https://github.com/apache/solr/tree/main/dev-docs/ref-guide" target="_blank" rel="noreferrer nopener">Contribute</a>
@@ -56,25 +56,25 @@
</nav>
</header>
<div class="body">
-<div class="nav-container" data-component="solr" data-version="9_3">
+<div class="nav-container" data-component="solr" data-version="9_4">
<aside class="nav">
<div class="panels">
<!-- Solr Changes - Start -->
<div class="nav-panel-explore" data-panel="explore">
<div class="context">
<span class="title">Solr Reference Guide</span>
- <span class="version">9.3</span>
+ <span class="version">9.4</span>
</div>
<!-- Programmatically creates the component and version list -->
<ul class="components">
<li class="component is-current">
<a class="title" href="../index.html">Solr Reference Guide</a>
<ul class="versions">
- <li class="version">
- <a href="../../9_4/index.html">9.4-beta</a>
- </li>
<li class="version is-current is-latest">
- <a href="../index.html">9.3</a>
+ <a href="../index.html">9.4</a>
+ </li>
+ <li class="version">
+ <a href="../../9_3/index.html">9.3</a>
</li>
<li class="version">
<a href="../../9_2/index.html">9.2</a>
@@ -694,7 +694,7 @@
<a class="nav-link" href="../indexing-guide/filters.html">Filters</a>
</li>
<li class="nav-item" data-depth="2">
- <a class="nav-link" href="../indexing-guide/charfilterfactories.html">CharFilterFactories</a>
+ <a class="nav-link" href="../indexing-guide/charfilters.html">CharFilters</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../indexing-guide/language-analysis.html">Language Analysis</a>
@@ -1077,10 +1077,10 @@
</ul>
</nav>
<div class="page-versions">
- <button class="version-menu-toggle" title="Show other versions of page">9.3</button>
+ <button class="version-menu-toggle" title="Show other versions of page">9.4</button>
<div class="version-menu">
- <a class="version" href="../../9_4/deployment-guide/aliases.html">9.4-beta</a>
- <a class="version is-current" href="aliases.html">9.3</a>
+ <a class="version is-current" href="aliases.html">9.4</a>
+ <a class="version" href="../../9_3/deployment-guide/aliases.html">9.3</a>
<a class="version" href="../../9_2/deployment-guide/aliases.html">9.2</a>
<a class="version" href="../../9_1/deployment-guide/aliases.html">9.1</a>
<a class="version" href="../../9_0/deployment-guide/aliases.html">9.0</a>
@@ -1088,7 +1088,7 @@
</div>
<!-- Solr Additions - Start -->
<!-- Solr New File -->
-<span class="perma-link-copy" version="9_3">
+<span class="perma-link-copy" version="9_4">
</span><!-- Solr Additions - End -->
<div class="edit-this-page"><a href="https://github.com/apache/solr/tree/main/solr/solr-ref-guide/modules/deployment-guide/pages/aliases.adoc">Edit this Page</a></div>
</div>
Modified: sites/solr/guide/solr/latest/deployment-guide/audit-logging.html
URL: http://svn.apache.org/viewvc/sites/solr/guide/solr/latest/deployment-guide/audit-logging.html?rev=1084409&r1=1084408&r2=1084409&view=diff
==============================================================================
--- sites/solr/guide/solr/latest/deployment-guide/audit-logging.html (original)
+++ sites/solr/guide/solr/latest/deployment-guide/audit-logging.html Sun Oct 15 15:24:01 2023
@@ -39,7 +39,7 @@
<div class="navbar-item has-dropdown is-hoverable">
<a class="navbar-link" href="#">Resources</a>
<div class="navbar-dropdown">
- <a class="navbar-item" href="https://solr.apache.org/docs/9_3_0/index.html" target="_blank" rel="noreferrer nopener">Solr Javadocs</a>
+ <a class="navbar-item" href="https://solr.apache.org/docs/9_4_0/index.html" target="_blank" rel="noreferrer nopener">Solr Javadocs</a>
<a class="navbar-item" href="https://solr.apache.org/community.html#version-control" target="_blank" rel="noreferrer nopener">Source Code</a>
<a class="navbar-item" href="https://solr.apache.org/community.html" target="_blank" rel="noreferrer nopener">Community Links</a>
<a class="navbar-item" href="https://github.com/apache/solr/tree/main/dev-docs/ref-guide" target="_blank" rel="noreferrer nopener">Contribute</a>
@@ -56,25 +56,25 @@
</nav>
</header>
<div class="body">
-<div class="nav-container" data-component="solr" data-version="9_3">
+<div class="nav-container" data-component="solr" data-version="9_4">
<aside class="nav">
<div class="panels">
<!-- Solr Changes - Start -->
<div class="nav-panel-explore" data-panel="explore">
<div class="context">
<span class="title">Solr Reference Guide</span>
- <span class="version">9.3</span>
+ <span class="version">9.4</span>
</div>
<!-- Programmatically creates the component and version list -->
<ul class="components">
<li class="component is-current">
<a class="title" href="../index.html">Solr Reference Guide</a>
<ul class="versions">
- <li class="version">
- <a href="../../9_4/index.html">9.4-beta</a>
- </li>
<li class="version is-current is-latest">
- <a href="../index.html">9.3</a>
+ <a href="../index.html">9.4</a>
+ </li>
+ <li class="version">
+ <a href="../../9_3/index.html">9.3</a>
</li>
<li class="version">
<a href="../../9_2/index.html">9.2</a>
@@ -694,7 +694,7 @@
<a class="nav-link" href="../indexing-guide/filters.html">Filters</a>
</li>
<li class="nav-item" data-depth="2">
- <a class="nav-link" href="../indexing-guide/charfilterfactories.html">CharFilterFactories</a>
+ <a class="nav-link" href="../indexing-guide/charfilters.html">CharFilters</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../indexing-guide/language-analysis.html">Language Analysis</a>
@@ -1076,10 +1076,10 @@
</ul>
</nav>
<div class="page-versions">
- <button class="version-menu-toggle" title="Show other versions of page">9.3</button>
+ <button class="version-menu-toggle" title="Show other versions of page">9.4</button>
<div class="version-menu">
- <a class="version" href="../../9_4/deployment-guide/audit-logging.html">9.4-beta</a>
- <a class="version is-current" href="audit-logging.html">9.3</a>
+ <a class="version is-current" href="audit-logging.html">9.4</a>
+ <a class="version" href="../../9_3/deployment-guide/audit-logging.html">9.3</a>
<a class="version" href="../../9_2/deployment-guide/audit-logging.html">9.2</a>
<a class="version" href="../../9_1/deployment-guide/audit-logging.html">9.1</a>
<a class="version" href="../../9_0/deployment-guide/audit-logging.html">9.0</a>
@@ -1087,7 +1087,7 @@
</div>
<!-- Solr Additions - Start -->
<!-- Solr New File -->
-<span class="perma-link-copy" version="9_3">
+<span class="perma-link-copy" version="9_4">
</span><!-- Solr Additions - End -->
<div class="edit-this-page"><a href="https://github.com/apache/solr/tree/main/solr/solr-ref-guide/modules/deployment-guide/pages/audit-logging.adoc">Edit this Page</a></div>
</div>
@@ -1464,7 +1464,7 @@ This will likely mostly be used in conju
</div>
<div class="paragraph">
<p>Note that logging to alternate destinations would need to be defined with a custom audit logging plugin.
-See the javadocs for the base class at <a href="https://solr.apache.org/docs/9_3_0/core/org/apache/solr/security/AuditLoggerPlugin.html">AuditLoggerPlugin</a>.</p>
+See the javadocs for the base class at <a href="https://solr.apache.org/docs/9_4_0/core/org/apache/solr/security/AuditLoggerPlugin.html">AuditLoggerPlugin</a>.</p>
</div>
</div>
</div>
Modified: sites/solr/guide/solr/latest/deployment-guide/authentication-and-authorization-plugins.html
URL: http://svn.apache.org/viewvc/sites/solr/guide/solr/latest/deployment-guide/authentication-and-authorization-plugins.html?rev=1084409&r1=1084408&r2=1084409&view=diff
==============================================================================
--- sites/solr/guide/solr/latest/deployment-guide/authentication-and-authorization-plugins.html (original)
+++ sites/solr/guide/solr/latest/deployment-guide/authentication-and-authorization-plugins.html Sun Oct 15 15:24:01 2023
@@ -39,7 +39,7 @@
<div class="navbar-item has-dropdown is-hoverable">
<a class="navbar-link" href="#">Resources</a>
<div class="navbar-dropdown">
- <a class="navbar-item" href="https://solr.apache.org/docs/9_3_0/index.html" target="_blank" rel="noreferrer nopener">Solr Javadocs</a>
+ <a class="navbar-item" href="https://solr.apache.org/docs/9_4_0/index.html" target="_blank" rel="noreferrer nopener">Solr Javadocs</a>
<a class="navbar-item" href="https://solr.apache.org/community.html#version-control" target="_blank" rel="noreferrer nopener">Source Code</a>
<a class="navbar-item" href="https://solr.apache.org/community.html" target="_blank" rel="noreferrer nopener">Community Links</a>
<a class="navbar-item" href="https://github.com/apache/solr/tree/main/dev-docs/ref-guide" target="_blank" rel="noreferrer nopener">Contribute</a>
@@ -56,25 +56,25 @@
</nav>
</header>
<div class="body">
-<div class="nav-container" data-component="solr" data-version="9_3">
+<div class="nav-container" data-component="solr" data-version="9_4">
<aside class="nav">
<div class="panels">
<!-- Solr Changes - Start -->
<div class="nav-panel-explore" data-panel="explore">
<div class="context">
<span class="title">Solr Reference Guide</span>
- <span class="version">9.3</span>
+ <span class="version">9.4</span>
</div>
<!-- Programmatically creates the component and version list -->
<ul class="components">
<li class="component is-current">
<a class="title" href="../index.html">Solr Reference Guide</a>
<ul class="versions">
- <li class="version">
- <a href="../../9_4/index.html">9.4-beta</a>
- </li>
<li class="version is-current is-latest">
- <a href="../index.html">9.3</a>
+ <a href="../index.html">9.4</a>
+ </li>
+ <li class="version">
+ <a href="../../9_3/index.html">9.3</a>
</li>
<li class="version">
<a href="../../9_2/index.html">9.2</a>
@@ -694,7 +694,7 @@
<a class="nav-link" href="../indexing-guide/filters.html">Filters</a>
</li>
<li class="nav-item" data-depth="2">
- <a class="nav-link" href="../indexing-guide/charfilterfactories.html">CharFilterFactories</a>
+ <a class="nav-link" href="../indexing-guide/charfilters.html">CharFilters</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../indexing-guide/language-analysis.html">Language Analysis</a>
@@ -1076,10 +1076,10 @@
</ul>
</nav>
<div class="page-versions">
- <button class="version-menu-toggle" title="Show other versions of page">9.3</button>
+ <button class="version-menu-toggle" title="Show other versions of page">9.4</button>
<div class="version-menu">
- <a class="version" href="../../9_4/deployment-guide/authentication-and-authorization-plugins.html">9.4-beta</a>
- <a class="version is-current" href="authentication-and-authorization-plugins.html">9.3</a>
+ <a class="version is-current" href="authentication-and-authorization-plugins.html">9.4</a>
+ <a class="version" href="../../9_3/deployment-guide/authentication-and-authorization-plugins.html">9.3</a>
<a class="version" href="../../9_2/deployment-guide/authentication-and-authorization-plugins.html">9.2</a>
<a class="version" href="../../9_1/deployment-guide/authentication-and-authorization-plugins.html">9.1</a>
<a class="version" href="../../9_0/deployment-guide/authentication-and-authorization-plugins.html">9.0</a>
@@ -1087,7 +1087,7 @@
</div>
<!-- Solr Additions - Start -->
<!-- Solr New File -->
-<span class="perma-link-copy" version="9_3">
+<span class="perma-link-copy" version="9_4">
</span><!-- Solr Additions - End -->
<div class="edit-this-page"><a href="https://github.com/apache/solr/tree/main/solr/solr-ref-guide/modules/deployment-guide/pages/authentication-and-authorization-plugins.adoc">Edit this Page</a></div>
</div>
@@ -1313,7 +1313,7 @@ A custom plugin can be implemented by ex
<h2 id="configuring-authorization"><a class="anchor" href="#configuring-authorization"></a>Authorization</h2>
<div class="sectionbody">
<div class="paragraph">
-<p>An authorization plugin can be written for Solr by extending the <a href="https://solr.apache.org/docs/9_3_0/core/org/apache/solr/security/AuthorizationPlugin.html">AuthorizationPlugin</a> interface.</p>
+<p>An authorization plugin can be written for Solr by extending the <a href="https://solr.apache.org/docs/9_4_0/core/org/apache/solr/security/AuthorizationPlugin.html">AuthorizationPlugin</a> interface.</p>
</div>
<div class="sect2">
<h3 id="enabling-an-authorization-plugin"><a class="anchor" href="#enabling-an-authorization-plugin"></a>Enabling an Authorization Plugin</h3>
Modified: sites/solr/guide/solr/latest/deployment-guide/backup-restore.html
URL: http://svn.apache.org/viewvc/sites/solr/guide/solr/latest/deployment-guide/backup-restore.html?rev=1084409&r1=1084408&r2=1084409&view=diff
==============================================================================
--- sites/solr/guide/solr/latest/deployment-guide/backup-restore.html (original)
+++ sites/solr/guide/solr/latest/deployment-guide/backup-restore.html Sun Oct 15 15:24:01 2023
@@ -39,7 +39,7 @@
<div class="navbar-item has-dropdown is-hoverable">
<a class="navbar-link" href="#">Resources</a>
<div class="navbar-dropdown">
- <a class="navbar-item" href="https://solr.apache.org/docs/9_3_0/index.html" target="_blank" rel="noreferrer nopener">Solr Javadocs</a>
+ <a class="navbar-item" href="https://solr.apache.org/docs/9_4_0/index.html" target="_blank" rel="noreferrer nopener">Solr Javadocs</a>
<a class="navbar-item" href="https://solr.apache.org/community.html#version-control" target="_blank" rel="noreferrer nopener">Source Code</a>
<a class="navbar-item" href="https://solr.apache.org/community.html" target="_blank" rel="noreferrer nopener">Community Links</a>
<a class="navbar-item" href="https://github.com/apache/solr/tree/main/dev-docs/ref-guide" target="_blank" rel="noreferrer nopener">Contribute</a>
@@ -56,25 +56,25 @@
</nav>
</header>
<div class="body">
-<div class="nav-container" data-component="solr" data-version="9_3">
+<div class="nav-container" data-component="solr" data-version="9_4">
<aside class="nav">
<div class="panels">
<!-- Solr Changes - Start -->
<div class="nav-panel-explore" data-panel="explore">
<div class="context">
<span class="title">Solr Reference Guide</span>
- <span class="version">9.3</span>
+ <span class="version">9.4</span>
</div>
<!-- Programmatically creates the component and version list -->
<ul class="components">
<li class="component is-current">
<a class="title" href="../index.html">Solr Reference Guide</a>
<ul class="versions">
- <li class="version">
- <a href="../../9_4/index.html">9.4-beta</a>
- </li>
<li class="version is-current is-latest">
- <a href="../index.html">9.3</a>
+ <a href="../index.html">9.4</a>
+ </li>
+ <li class="version">
+ <a href="../../9_3/index.html">9.3</a>
</li>
<li class="version">
<a href="../../9_2/index.html">9.2</a>
@@ -694,7 +694,7 @@
<a class="nav-link" href="../indexing-guide/filters.html">Filters</a>
</li>
<li class="nav-item" data-depth="2">
- <a class="nav-link" href="../indexing-guide/charfilterfactories.html">CharFilterFactories</a>
+ <a class="nav-link" href="../indexing-guide/charfilters.html">CharFilters</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../indexing-guide/language-analysis.html">Language Analysis</a>
@@ -1076,10 +1076,10 @@
</ul>
</nav>
<div class="page-versions">
- <button class="version-menu-toggle" title="Show other versions of page">9.3</button>
+ <button class="version-menu-toggle" title="Show other versions of page">9.4</button>
<div class="version-menu">
- <a class="version" href="../../9_4/deployment-guide/backup-restore.html">9.4-beta</a>
- <a class="version is-current" href="backup-restore.html">9.3</a>
+ <a class="version is-current" href="backup-restore.html">9.4</a>
+ <a class="version" href="../../9_3/deployment-guide/backup-restore.html">9.3</a>
<a class="version" href="../../9_2/deployment-guide/backup-restore.html">9.2</a>
<a class="version" href="../../9_1/deployment-guide/backup-restore.html">9.1</a>
<a class="version" href="../../9_0/deployment-guide/backup-restore.html">9.0</a>
@@ -1087,7 +1087,7 @@
</div>
<!-- Solr Additions - Start -->
<!-- Solr New File -->
-<span class="perma-link-copy" version="9_3">
+<span class="perma-link-copy" version="9_4">
</span><!-- Solr Additions - End -->
<div class="edit-this-page"><a href="https://github.com/apache/solr/tree/main/solr/solr-ref-guide/modules/deployment-guide/pages/backup-restore.adoc">Edit this Page</a></div>
</div>
Modified: sites/solr/guide/solr/latest/deployment-guide/basic-authentication-plugin.html
URL: http://svn.apache.org/viewvc/sites/solr/guide/solr/latest/deployment-guide/basic-authentication-plugin.html?rev=1084409&r1=1084408&r2=1084409&view=diff
==============================================================================
--- sites/solr/guide/solr/latest/deployment-guide/basic-authentication-plugin.html (original)
+++ sites/solr/guide/solr/latest/deployment-guide/basic-authentication-plugin.html Sun Oct 15 15:24:01 2023
@@ -39,7 +39,7 @@
<div class="navbar-item has-dropdown is-hoverable">
<a class="navbar-link" href="#">Resources</a>
<div class="navbar-dropdown">
- <a class="navbar-item" href="https://solr.apache.org/docs/9_3_0/index.html" target="_blank" rel="noreferrer nopener">Solr Javadocs</a>
+ <a class="navbar-item" href="https://solr.apache.org/docs/9_4_0/index.html" target="_blank" rel="noreferrer nopener">Solr Javadocs</a>
<a class="navbar-item" href="https://solr.apache.org/community.html#version-control" target="_blank" rel="noreferrer nopener">Source Code</a>
<a class="navbar-item" href="https://solr.apache.org/community.html" target="_blank" rel="noreferrer nopener">Community Links</a>
<a class="navbar-item" href="https://github.com/apache/solr/tree/main/dev-docs/ref-guide" target="_blank" rel="noreferrer nopener">Contribute</a>
@@ -56,25 +56,25 @@
</nav>
</header>
<div class="body">
-<div class="nav-container" data-component="solr" data-version="9_3">
+<div class="nav-container" data-component="solr" data-version="9_4">
<aside class="nav">
<div class="panels">
<!-- Solr Changes - Start -->
<div class="nav-panel-explore" data-panel="explore">
<div class="context">
<span class="title">Solr Reference Guide</span>
- <span class="version">9.3</span>
+ <span class="version">9.4</span>
</div>
<!-- Programmatically creates the component and version list -->
<ul class="components">
<li class="component is-current">
<a class="title" href="../index.html">Solr Reference Guide</a>
<ul class="versions">
- <li class="version">
- <a href="../../9_4/index.html">9.4-beta</a>
- </li>
<li class="version is-current is-latest">
- <a href="../index.html">9.3</a>
+ <a href="../index.html">9.4</a>
+ </li>
+ <li class="version">
+ <a href="../../9_3/index.html">9.3</a>
</li>
<li class="version">
<a href="../../9_2/index.html">9.2</a>
@@ -694,7 +694,7 @@
<a class="nav-link" href="../indexing-guide/filters.html">Filters</a>
</li>
<li class="nav-item" data-depth="2">
- <a class="nav-link" href="../indexing-guide/charfilterfactories.html">CharFilterFactories</a>
+ <a class="nav-link" href="../indexing-guide/charfilters.html">CharFilters</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../indexing-guide/language-analysis.html">Language Analysis</a>
@@ -1077,10 +1077,10 @@
</ul>
</nav>
<div class="page-versions">
- <button class="version-menu-toggle" title="Show other versions of page">9.3</button>
+ <button class="version-menu-toggle" title="Show other versions of page">9.4</button>
<div class="version-menu">
- <a class="version" href="../../9_4/deployment-guide/basic-authentication-plugin.html">9.4-beta</a>
- <a class="version is-current" href="basic-authentication-plugin.html">9.3</a>
+ <a class="version is-current" href="basic-authentication-plugin.html">9.4</a>
+ <a class="version" href="../../9_3/deployment-guide/basic-authentication-plugin.html">9.3</a>
<a class="version" href="../../9_2/deployment-guide/basic-authentication-plugin.html">9.2</a>
<a class="version" href="../../9_1/deployment-guide/basic-authentication-plugin.html">9.1</a>
<a class="version" href="../../9_0/deployment-guide/basic-authentication-plugin.html">9.0</a>
@@ -1088,7 +1088,7 @@
</div>
<!-- Solr Additions - Start -->
<!-- Solr New File -->
-<span class="perma-link-copy" version="9_3">
+<span class="perma-link-copy" version="9_4">
</span><!-- Solr Additions - End -->
<div class="edit-this-page"><a href="https://github.com/apache/solr/tree/main/solr/solr-ref-guide/modules/deployment-guide/pages/basic-authentication-plugin.adoc">Edit this Page</a></div>
</div>
@@ -1576,7 +1576,7 @@ SOLR_AUTHENTICATION_OPTS="-Dbasicauth=so
<div class="listingblock">
<div class="content">
<pre class="highlightjs highlight"><code class="language-bash hljs" data-lang="bash">SOLR_AUTH_TYPE="basic"
-SOLR_AUTHENTICATION_OPTS="-Dsolr.httpclient.config=/path/to/solr-9.3.0/server/solr/basicAuth.conf"</code></pre>
+SOLR_AUTHENTICATION_OPTS="-Dsolr.httpclient.config=/path/to/solr-9.4.0/server/solr/basicAuth.conf"</code></pre>
</div>
</div>
</div>
Modified: sites/solr/guide/solr/latest/deployment-guide/cert-authentication-plugin.html
URL: http://svn.apache.org/viewvc/sites/solr/guide/solr/latest/deployment-guide/cert-authentication-plugin.html?rev=1084409&r1=1084408&r2=1084409&view=diff
==============================================================================
--- sites/solr/guide/solr/latest/deployment-guide/cert-authentication-plugin.html (original)
+++ sites/solr/guide/solr/latest/deployment-guide/cert-authentication-plugin.html Sun Oct 15 15:24:01 2023
@@ -39,7 +39,7 @@
<div class="navbar-item has-dropdown is-hoverable">
<a class="navbar-link" href="#">Resources</a>
<div class="navbar-dropdown">
- <a class="navbar-item" href="https://solr.apache.org/docs/9_3_0/index.html" target="_blank" rel="noreferrer nopener">Solr Javadocs</a>
+ <a class="navbar-item" href="https://solr.apache.org/docs/9_4_0/index.html" target="_blank" rel="noreferrer nopener">Solr Javadocs</a>
<a class="navbar-item" href="https://solr.apache.org/community.html#version-control" target="_blank" rel="noreferrer nopener">Source Code</a>
<a class="navbar-item" href="https://solr.apache.org/community.html" target="_blank" rel="noreferrer nopener">Community Links</a>
<a class="navbar-item" href="https://github.com/apache/solr/tree/main/dev-docs/ref-guide" target="_blank" rel="noreferrer nopener">Contribute</a>
@@ -56,25 +56,25 @@
</nav>
</header>
<div class="body">
-<div class="nav-container" data-component="solr" data-version="9_3">
+<div class="nav-container" data-component="solr" data-version="9_4">
<aside class="nav">
<div class="panels">
<!-- Solr Changes - Start -->
<div class="nav-panel-explore" data-panel="explore">
<div class="context">
<span class="title">Solr Reference Guide</span>
- <span class="version">9.3</span>
+ <span class="version">9.4</span>
</div>
<!-- Programmatically creates the component and version list -->
<ul class="components">
<li class="component is-current">
<a class="title" href="../index.html">Solr Reference Guide</a>
<ul class="versions">
- <li class="version">
- <a href="../../9_4/index.html">9.4-beta</a>
- </li>
<li class="version is-current is-latest">
- <a href="../index.html">9.3</a>
+ <a href="../index.html">9.4</a>
+ </li>
+ <li class="version">
+ <a href="../../9_3/index.html">9.3</a>
</li>
<li class="version">
<a href="../../9_2/index.html">9.2</a>
@@ -694,7 +694,7 @@
<a class="nav-link" href="../indexing-guide/filters.html">Filters</a>
</li>
<li class="nav-item" data-depth="2">
- <a class="nav-link" href="../indexing-guide/charfilterfactories.html">CharFilterFactories</a>
+ <a class="nav-link" href="../indexing-guide/charfilters.html">CharFilters</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../indexing-guide/language-analysis.html">Language Analysis</a>
@@ -1077,10 +1077,10 @@
</ul>
</nav>
<div class="page-versions">
- <button class="version-menu-toggle" title="Show other versions of page">9.3</button>
+ <button class="version-menu-toggle" title="Show other versions of page">9.4</button>
<div class="version-menu">
- <a class="version" href="../../9_4/deployment-guide/cert-authentication-plugin.html">9.4-beta</a>
- <a class="version is-current" href="cert-authentication-plugin.html">9.3</a>
+ <a class="version is-current" href="cert-authentication-plugin.html">9.4</a>
+ <a class="version" href="../../9_3/deployment-guide/cert-authentication-plugin.html">9.3</a>
<a class="version" href="../../9_2/deployment-guide/cert-authentication-plugin.html">9.2</a>
<a class="version" href="../../9_1/deployment-guide/cert-authentication-plugin.html">9.1</a>
<a class="version" href="../../9_0/deployment-guide/cert-authentication-plugin.html">9.0</a>
@@ -1088,7 +1088,7 @@
</div>
<!-- Solr Additions - Start -->
<!-- Solr New File -->
-<span class="perma-link-copy" version="9_3">
+<span class="perma-link-copy" version="9_4">
</span><!-- Solr Additions - End -->
<div class="edit-this-page"><a href="https://github.com/apache/solr/tree/main/solr/solr-ref-guide/modules/deployment-guide/pages/cert-authentication-plugin.adoc">Edit this Page</a></div>
</div>
Modified: sites/solr/guide/solr/latest/deployment-guide/circuit-breakers.html
URL: http://svn.apache.org/viewvc/sites/solr/guide/solr/latest/deployment-guide/circuit-breakers.html?rev=1084409&r1=1084408&r2=1084409&view=diff
==============================================================================
--- sites/solr/guide/solr/latest/deployment-guide/circuit-breakers.html (original)
+++ sites/solr/guide/solr/latest/deployment-guide/circuit-breakers.html Sun Oct 15 15:24:01 2023
@@ -39,7 +39,7 @@
<div class="navbar-item has-dropdown is-hoverable">
<a class="navbar-link" href="#">Resources</a>
<div class="navbar-dropdown">
- <a class="navbar-item" href="https://solr.apache.org/docs/9_3_0/index.html" target="_blank" rel="noreferrer nopener">Solr Javadocs</a>
+ <a class="navbar-item" href="https://solr.apache.org/docs/9_4_0/index.html" target="_blank" rel="noreferrer nopener">Solr Javadocs</a>
<a class="navbar-item" href="https://solr.apache.org/community.html#version-control" target="_blank" rel="noreferrer nopener">Source Code</a>
<a class="navbar-item" href="https://solr.apache.org/community.html" target="_blank" rel="noreferrer nopener">Community Links</a>
<a class="navbar-item" href="https://github.com/apache/solr/tree/main/dev-docs/ref-guide" target="_blank" rel="noreferrer nopener">Contribute</a>
@@ -56,25 +56,25 @@
</nav>
</header>
<div class="body">
-<div class="nav-container" data-component="solr" data-version="9_3">
+<div class="nav-container" data-component="solr" data-version="9_4">
<aside class="nav">
<div class="panels">
<!-- Solr Changes - Start -->
<div class="nav-panel-explore" data-panel="explore">
<div class="context">
<span class="title">Solr Reference Guide</span>
- <span class="version">9.3</span>
+ <span class="version">9.4</span>
</div>
<!-- Programmatically creates the component and version list -->
<ul class="components">
<li class="component is-current">
<a class="title" href="../index.html">Solr Reference Guide</a>
<ul class="versions">
- <li class="version">
- <a href="../../9_4/index.html">9.4-beta</a>
- </li>
<li class="version is-current is-latest">
- <a href="../index.html">9.3</a>
+ <a href="../index.html">9.4</a>
+ </li>
+ <li class="version">
+ <a href="../../9_3/index.html">9.3</a>
</li>
<li class="version">
<a href="../../9_2/index.html">9.2</a>
@@ -694,7 +694,7 @@
<a class="nav-link" href="../indexing-guide/filters.html">Filters</a>
</li>
<li class="nav-item" data-depth="2">
- <a class="nav-link" href="../indexing-guide/charfilterfactories.html">CharFilterFactories</a>
+ <a class="nav-link" href="../indexing-guide/charfilters.html">CharFilters</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../indexing-guide/language-analysis.html">Language Analysis</a>
@@ -1076,10 +1076,10 @@
</ul>
</nav>
<div class="page-versions">
- <button class="version-menu-toggle" title="Show other versions of page">9.3</button>
+ <button class="version-menu-toggle" title="Show other versions of page">9.4</button>
<div class="version-menu">
- <a class="version" href="../../9_4/deployment-guide/circuit-breakers.html">9.4-beta</a>
- <a class="version is-current" href="circuit-breakers.html">9.3</a>
+ <a class="version is-current" href="circuit-breakers.html">9.4</a>
+ <a class="version" href="../../9_3/deployment-guide/circuit-breakers.html">9.3</a>
<a class="version" href="../../9_2/deployment-guide/circuit-breakers.html">9.2</a>
<a class="version" href="../../9_1/deployment-guide/circuit-breakers.html">9.1</a>
<a class="version" href="../../9_0/deployment-guide/circuit-breakers.html">9.0</a>
@@ -1087,7 +1087,7 @@
</div>
<!-- Solr Additions - Start -->
<!-- Solr New File -->
-<span class="perma-link-copy" version="9_3">
+<span class="perma-link-copy" version="9_4">
</span><!-- Solr Additions - End -->
<div class="edit-this-page"><a href="https://github.com/apache/solr/tree/main/solr/solr-ref-guide/modules/deployment-guide/pages/circuit-breakers.adoc">Edit this Page</a></div>
</div>
@@ -1112,10 +1112,16 @@ resource configuration.</p>
<div class="sectionbody">
<div class="paragraph">
<p>Circuit breakers should be used when the user wishes to trade request throughput for a higher Solr stability.
-If circuit breakers are enabled, requests may be rejected under the condition of high node duress with an appropriate HTTP error code (typically 503).</p>
+If circuit breakers are enabled, requests may be rejected under the condition of high node duress with HTTP error code 429 'Too Many Requests'.</p>
+</div>
+<div class="paragraph">
+<p>It is up to the client to handle this error and potentially build retry logic as this should be a transient situation.</p>
</div>
<div class="paragraph">
-<p>It is up to the client to handle this error and potentially build a retrial logic as this should ideally be a transient situation.</p>
+<p>In a sharded collection, when a circuit breaker trips on one shard, the entire query will fail,
+even if the other shard requests succeed. This will multiply the failures seen by the end users.
+Setting the <code>shards.tolerant=true</code> parameter on requests can help with graceful degradation when
+circuit breaker thresholds are reached on some nodes. See the <a href="#shards.tolerant Parameter">[shards.tolerant Parameter]</a> for details.</p>
</div>
</div>
</div>
@@ -1123,96 +1129,145 @@ If circuit breakers are enabled, request
<h2 id="circuit-breaker-configurations"><a class="anchor" href="#circuit-breaker-configurations"></a>Circuit Breaker Configurations</h2>
<div class="sectionbody">
<div class="paragraph">
-<p>All circuit breaker configurations are listed in the <code><circuitBreaker></code> tags in <code>solrconfig.xml</code> as shown below:</p>
-</div>
-<div class="listingblock">
-<div class="content">
-<pre class="highlightjs highlight"><code class="language-xml hljs" data-lang="xml"><circuitBreaker class="solr.CircuitBreakerManager" enabled="true">
- <!-- All specific configs in this section -->
-</circuitBreaker></code></pre>
-</div>
-</div>
-<div class="paragraph">
-<p>The <code>enabled</code> attribute controls the global activation/deactivation of circuit breakers.
-If this flag is disabled, all circuit breakers will be disabled globally.
-Per circuit breaker configurations are specified in their respective sections later.</p>
-</div>
-<div class="paragraph">
-<p>This attribute acts as the highest authority and global controller of circuit breakers.
-For using specific circuit breakers, each one needs to be individually enabled in addition to this flag being enabled.</p>
-</div>
-<div class="paragraph">
-<p><code>CircuitBreakerManager</code> is the default manager for all circuit breakers that should be defined in the tag unless the user wishes to use a custom implementation.</p>
+<p>All circuit breaker configurations are listed as independent <code><circuitBreaker></code> entries in <code>solrconfig.xml</code> as shown below.
+A circuit breaker can register itself to trip for query requests and/or update requests. By default only search requests are affected. A user may register multiple circuit breakers of the same type with different thresholds for each request type.</p>
</div>
</div>
</div>
<div class="sect1">
<h2 id="currently-supported-circuit-breakers"><a class="anchor" href="#currently-supported-circuit-breakers"></a>Currently Supported Circuit Breakers</h2>
<div class="sectionbody">
+<div class="admonitionblock note">
+<table>
+<tr>
+<td class="icon">
+<i class="fa icon-note" title="Note"></i>
+</td>
+<td class="content">
+<div class="paragraph">
+<p>The legacy configuration syntax using <code>CircuitBreakerManager</code> is deprecated as of Solr 9.4, but will
+continue to work. The "CPU" circuit breaker used by this legacy plugin when configuring a <code>cpuThreshold</code>
+is actually the <code>LoadAverageCircuitBreaker</code> described below. Also, the <code>CircuitBreakerManager</code> will
+return a HTTP 503 code instead of the HTTP 429 code used by the new circuit breakers.</p>
+</div>
+</td>
+</tr>
+</table>
+</div>
<div class="sect2">
<h3 id="jvm-heap-usage"><a class="anchor" href="#jvm-heap-usage"></a>JVM Heap Usage</h3>
<div class="paragraph">
-<p>This circuit breaker tracks JVM heap memory usage and rejects incoming search requests with a 503 error code if the heap usage exceeds a configured percentage of maximum heap allocated to the JVM (-Xmx).
+<p>This circuit breaker tracks JVM heap memory usage and rejects incoming requests with a 429 error code if the heap usage exceeds a configured percentage of maximum heap allocated to the JVM (-Xmx).
The main configuration for this circuit breaker is controlling the threshold percentage at which the breaker will trip.</p>
</div>
<div class="paragraph">
-<p>Configuration for JVM heap usage based circuit breaker:</p>
+<p>To enable and configure the JVM heap usage based circuit breaker, add the following:</p>
</div>
<div class="listingblock">
<div class="content">
-<pre class="highlightjs highlight"><code class="language-xml hljs" data-lang="xml"><str name="memEnabled">true</str></code></pre>
+<pre class="highlightjs highlight"><code class="language-xml hljs" data-lang="xml"><circuitBreaker class="org.apache.solr.util.circuitbreaker.MemoryCircuitBreaker">
+ <double name="threshold">75</double>
+</circuitBreaker></code></pre>
</div>
</div>
<div class="paragraph">
-<p>Note that this configuration will be overridden by the global circuit breaker flag — if circuit breakers are disabled, this flag will not help you.</p>
+<p>The <code>threshold</code> is defined as a percentage of the max heap allocated to the JVM.</p>
</div>
<div class="paragraph">
-<p>The triggering threshold is defined as a percentage of the max heap allocated to the JVM.
-It is controlled by the below configuration:</p>
-</div>
-<div class="listingblock">
-<div class="content">
-<pre class="highlightjs highlight"><code class="language-xml hljs" data-lang="xml"><str name="memThreshold">75</str></code></pre>
-</div>
+<p>For the circuit breaker configuration, a value of "0" maps to 0% usage and a value of "100" maps to 100% usage.</p>
</div>
<div class="paragraph">
-<p>It does not logically make sense to have a threshold below 50% and above 95% of the max heap allocated to the JVM.
+<p>It does not logically make sense to have a threshold below 50% or above 95% of the max heap allocated to the JVM.
Hence, the range of valid values for this parameter is [50, 95], both inclusive.</p>
</div>
<div class="paragraph">
<p>Consider the following example:</p>
</div>
<div class="paragraph">
-<p>JVM has been allocated a maximum heap of 5GB (-Xmx) and <code>memThreshold</code> is set to <code>75</code>.
+<p>JVM has been allocated a maximum heap of 5GB (-Xmx) and <code>threshold</code> is set to <code>75</code>.
In this scenario, the heap usage at which the circuit breaker will trip is 3.75GB.</p>
</div>
</div>
<div class="sect2">
-<h3 id="cpu-utilization"><a class="anchor" href="#cpu-utilization"></a>CPU Utilization</h3>
+<h3 id="system-cpu-usage-circuit-breaker"><a class="anchor" href="#system-cpu-usage-circuit-breaker"></a>System CPU Usage Circuit Breaker</h3>
<div class="paragraph">
-<p>This circuit breaker tracks CPU utilization and triggers if the average CPU utilization over the last one minute exceeds a configurable threshold.
-Note that the value used in computation is over the last one minute — so a sudden spike in traffic that goes down might still cause the circuit breaker to trigger for a short while before it resolves and updates the value.
-For more details of the calculation, please see <a href="https://en.wikipedia.org/wiki/Load_(computing" class="bare">https://en.wikipedia.org/wiki/Load_(computing</a>)</p>
+<p>This circuit breaker tracks system CPU usage and triggers if the recent CPU usage exceeds a configurable threshold.</p>
</div>
<div class="paragraph">
-<p>Configuration for CPU utilization based circuit breaker:</p>
+<p>This is tracked with the JMX metric <code>OperatingSystemMXBean.getSystemCpuLoad()</code>. That measures the
+recent CPU usage for the whole system. This metric is provided by the <code>com.sun.management</code> package,
+which is not implemented on all JVMs. If the metric is not available, the circuit breaker will be
+disabled and log an error message. An alternative can then be to use the <a href="#system-load-average-circuit-breaker">System Load Average Circuit Breaker</a>.</p>
+</div>
+<div class="paragraph">
+<p>To enable and configure the CPU utilization based circuit breaker:</p>
</div>
<div class="listingblock">
<div class="content">
-<pre class="highlightjs highlight"><code class="language-xml hljs" data-lang="xml"><str name="cpuEnabled">true</str></code></pre>
+<pre class="highlightjs highlight"><code class="language-xml hljs" data-lang="xml"><circuitBreaker class="org.apache.solr.util.circuitbreaker.CPUCircuitBreaker">
+ <double name="threshold">75</double>
+</circuitBreaker></code></pre>
+</div>
+</div>
+<div class="paragraph">
+<p>The triggering threshold is defined in percent CPU usage. A value of "0" maps to 0% usage
+and a value of "100" maps to 100% usage. The example above will trip when the CPU usage is
+equal to or greater than 75%.</p>
</div>
</div>
+<div class="sect2">
+<h3 id="system-load-average-circuit-breaker"><a class="anchor" href="#system-load-average-circuit-breaker"></a>System Load Average Circuit Breaker</h3>
+<div class="paragraph">
+<p>This circuit breaker tracks system load average and triggers if the recent load average exceeds a configurable threshold.</p>
+</div>
<div class="paragraph">
-<p>Note that this configuration will be overridden by the global circuit breaker flag — if circuit breakers are disabled, this flag will not help you.</p>
+<p>This is tracked with the JMX metric <code>OperatingSystemMXBean.getSystemLoadAverage()</code>. That measures the
+recent load average for the whole system. A "load average" is the number of processes using or waiting for a CPU,
+usually averaged over one minute. Some systems include processes waiting on IO in the load average. Check the
+documentation for your system and JVM to understand this metric. For more information, see the
+<a href="https://en.wikipedia.org/wiki/Load_(computing)">Wikipedia page for Load</a>,</p>
</div>
<div class="paragraph">
-<p>The triggering threshold is defined in units of CPU utilization.
-The configuration to control this is as below:</p>
+<p>To enable and configure the CPU utilization based circuit breaker:</p>
</div>
<div class="listingblock">
<div class="content">
-<pre class="highlightjs highlight"><code class="language-xml hljs" data-lang="xml"><str name="cpuThreshold">75</str></code></pre>
+<pre class="highlightjs highlight"><code class="language-xml hljs" data-lang="xml"><circuitBreaker class="org.apache.solr.util.circuitbreaker.LoadAverageCircuitBreaker">
+ <double name="threshold">8.0</double>
+</circuitBreaker></code></pre>
+</div>
</div>
+<div class="paragraph">
+<p>The triggering threshold is a floating point number matching load average.
+The example circuit breaker above will trip when the load average is equal to or greater than 8.0.</p>
+</div>
+</div>
+</div>
+</div>
+<div class="sect1">
+<h2 id="advanced-example"><a class="anchor" href="#advanced-example"></a>Advanced example</h2>
+<div class="sectionbody">
+<div class="paragraph">
+<p>In this example we will prevent update requests above 80% CPU load, and prevent query requests above 95% CPU load. Supported request types are <code>query</code> and <code>update</code>.
+This would prevent expensive bulk updates from impacting search. Note also the support for short-form class name.</p>
+</div>
+<div class="listingblock">
+<div class="content">
+<pre class="highlightjs highlight"><code class="language-xml hljs" data-lang="xml"><config>
+ <circuitBreaker class="solr.CPUCircuitBreaker">
+ <double name="threshold">80</double>
+ <arr name="requestTypes">
+ <str>update</str>
+ </arr>
+ </circuitBreaker>
+
+ <circuitBreaker class="solr.CPUCircuitBreaker">
+ <double name="threshold">95</double>
+ <arr name="requestTypes">
+ <str>query</str>
+ </arr>
+ </circuitBreaker>
+</config></code></pre>
</div>
</div>
</div>
@@ -1221,10 +1276,11 @@ The configuration to control this is as
<h2 id="performance-considerations"><a class="anchor" href="#performance-considerations"></a>Performance Considerations</h2>
<div class="sectionbody">
<div class="paragraph">
-<p>It is worth noting that while JVM or CPU circuit breakers do not add any noticeable overhead per query, having too many circuit breakers checked for a single request can cause a performance overhead.</p>
+<p>While JVM or CPU circuit breakers do not add any noticeable overhead per request, having too many circuit breakers checked for a single request can cause a performance overhead.</p>
</div>
<div class="paragraph">
-<p>In addition, it is a good practice to exponentially back off while retrying requests on a busy node.</p>
+<p>In addition, it is a good practice to exponentially back off while retrying requests on a busy node.
+See the <a href="https://en.wikipedia.org/wiki/Exponential_backoff">Wikipedia page for Exponential Backoff</a>.</p>
</div>
</div>
</div>
Modified: sites/solr/guide/solr/latest/deployment-guide/client-apis.html
URL: http://svn.apache.org/viewvc/sites/solr/guide/solr/latest/deployment-guide/client-apis.html?rev=1084409&r1=1084408&r2=1084409&view=diff
==============================================================================
--- sites/solr/guide/solr/latest/deployment-guide/client-apis.html (original)
+++ sites/solr/guide/solr/latest/deployment-guide/client-apis.html Sun Oct 15 15:24:01 2023
@@ -39,7 +39,7 @@
<div class="navbar-item has-dropdown is-hoverable">
<a class="navbar-link" href="#">Resources</a>
<div class="navbar-dropdown">
- <a class="navbar-item" href="https://solr.apache.org/docs/9_3_0/index.html" target="_blank" rel="noreferrer nopener">Solr Javadocs</a>
+ <a class="navbar-item" href="https://solr.apache.org/docs/9_4_0/index.html" target="_blank" rel="noreferrer nopener">Solr Javadocs</a>
<a class="navbar-item" href="https://solr.apache.org/community.html#version-control" target="_blank" rel="noreferrer nopener">Source Code</a>
<a class="navbar-item" href="https://solr.apache.org/community.html" target="_blank" rel="noreferrer nopener">Community Links</a>
<a class="navbar-item" href="https://github.com/apache/solr/tree/main/dev-docs/ref-guide" target="_blank" rel="noreferrer nopener">Contribute</a>
@@ -56,25 +56,25 @@
</nav>
</header>
<div class="body">
-<div class="nav-container" data-component="solr" data-version="9_3">
+<div class="nav-container" data-component="solr" data-version="9_4">
<aside class="nav">
<div class="panels">
<!-- Solr Changes - Start -->
<div class="nav-panel-explore" data-panel="explore">
<div class="context">
<span class="title">Solr Reference Guide</span>
- <span class="version">9.3</span>
+ <span class="version">9.4</span>
</div>
<!-- Programmatically creates the component and version list -->
<ul class="components">
<li class="component is-current">
<a class="title" href="../index.html">Solr Reference Guide</a>
<ul class="versions">
- <li class="version">
- <a href="../../9_4/index.html">9.4-beta</a>
- </li>
<li class="version is-current is-latest">
- <a href="../index.html">9.3</a>
+ <a href="../index.html">9.4</a>
+ </li>
+ <li class="version">
+ <a href="../../9_3/index.html">9.3</a>
</li>
<li class="version">
<a href="../../9_2/index.html">9.2</a>
@@ -694,7 +694,7 @@
<a class="nav-link" href="../indexing-guide/filters.html">Filters</a>
</li>
<li class="nav-item" data-depth="2">
- <a class="nav-link" href="../indexing-guide/charfilterfactories.html">CharFilterFactories</a>
+ <a class="nav-link" href="../indexing-guide/charfilters.html">CharFilters</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../indexing-guide/language-analysis.html">Language Analysis</a>
@@ -1075,10 +1075,10 @@
</ul>
</nav>
<div class="page-versions">
- <button class="version-menu-toggle" title="Show other versions of page">9.3</button>
+ <button class="version-menu-toggle" title="Show other versions of page">9.4</button>
<div class="version-menu">
- <a class="version" href="../../9_4/deployment-guide/client-apis.html">9.4-beta</a>
- <a class="version is-current" href="client-apis.html">9.3</a>
+ <a class="version is-current" href="client-apis.html">9.4</a>
+ <a class="version" href="../../9_3/deployment-guide/client-apis.html">9.3</a>
<a class="version" href="../../9_2/deployment-guide/client-apis.html">9.2</a>
<a class="version" href="../../9_1/deployment-guide/client-apis.html">9.1</a>
<a class="version" href="../../9_0/deployment-guide/client-apis.html">9.0</a>
@@ -1086,7 +1086,7 @@
</div>
<!-- Solr Additions - Start -->
<!-- Solr New File -->
-<span class="perma-link-copy" version="9_3">
+<span class="perma-link-copy" version="9_4">
</span><!-- Solr Additions - End -->
<div class="edit-this-page"><a href="https://github.com/apache/solr/tree/main/solr/solr-ref-guide/modules/deployment-guide/pages/client-apis.adoc">Edit this Page</a></div>
</div>
Modified: sites/solr/guide/solr/latest/deployment-guide/cloud-screens.html
URL: http://svn.apache.org/viewvc/sites/solr/guide/solr/latest/deployment-guide/cloud-screens.html?rev=1084409&r1=1084408&r2=1084409&view=diff
==============================================================================
--- sites/solr/guide/solr/latest/deployment-guide/cloud-screens.html (original)
+++ sites/solr/guide/solr/latest/deployment-guide/cloud-screens.html Sun Oct 15 15:24:01 2023
@@ -39,7 +39,7 @@
<div class="navbar-item has-dropdown is-hoverable">
<a class="navbar-link" href="#">Resources</a>
<div class="navbar-dropdown">
- <a class="navbar-item" href="https://solr.apache.org/docs/9_3_0/index.html" target="_blank" rel="noreferrer nopener">Solr Javadocs</a>
+ <a class="navbar-item" href="https://solr.apache.org/docs/9_4_0/index.html" target="_blank" rel="noreferrer nopener">Solr Javadocs</a>
<a class="navbar-item" href="https://solr.apache.org/community.html#version-control" target="_blank" rel="noreferrer nopener">Source Code</a>
<a class="navbar-item" href="https://solr.apache.org/community.html" target="_blank" rel="noreferrer nopener">Community Links</a>
<a class="navbar-item" href="https://github.com/apache/solr/tree/main/dev-docs/ref-guide" target="_blank" rel="noreferrer nopener">Contribute</a>
@@ -56,25 +56,25 @@
</nav>
</header>
<div class="body">
-<div class="nav-container" data-component="solr" data-version="9_3">
+<div class="nav-container" data-component="solr" data-version="9_4">
<aside class="nav">
<div class="panels">
<!-- Solr Changes - Start -->
<div class="nav-panel-explore" data-panel="explore">
<div class="context">
<span class="title">Solr Reference Guide</span>
- <span class="version">9.3</span>
+ <span class="version">9.4</span>
</div>
<!-- Programmatically creates the component and version list -->
<ul class="components">
<li class="component is-current">
<a class="title" href="../index.html">Solr Reference Guide</a>
<ul class="versions">
- <li class="version">
- <a href="../../9_4/index.html">9.4-beta</a>
- </li>
<li class="version is-current is-latest">
- <a href="../index.html">9.3</a>
+ <a href="../index.html">9.4</a>
+ </li>
+ <li class="version">
+ <a href="../../9_3/index.html">9.3</a>
</li>
<li class="version">
<a href="../../9_2/index.html">9.2</a>
@@ -694,7 +694,7 @@
<a class="nav-link" href="../indexing-guide/filters.html">Filters</a>
</li>
<li class="nav-item" data-depth="2">
- <a class="nav-link" href="../indexing-guide/charfilterfactories.html">CharFilterFactories</a>
+ <a class="nav-link" href="../indexing-guide/charfilters.html">CharFilters</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../indexing-guide/language-analysis.html">Language Analysis</a>
@@ -1078,10 +1078,10 @@
</ul>
</nav>
<div class="page-versions">
- <button class="version-menu-toggle" title="Show other versions of page">9.3</button>
+ <button class="version-menu-toggle" title="Show other versions of page">9.4</button>
<div class="version-menu">
- <a class="version" href="../../9_4/deployment-guide/cloud-screens.html">9.4-beta</a>
- <a class="version is-current" href="cloud-screens.html">9.3</a>
+ <a class="version is-current" href="cloud-screens.html">9.4</a>
+ <a class="version" href="../../9_3/deployment-guide/cloud-screens.html">9.3</a>
<a class="version" href="../../9_2/deployment-guide/cloud-screens.html">9.2</a>
<a class="version" href="../../9_1/deployment-guide/cloud-screens.html">9.1</a>
<a class="version" href="../../9_0/deployment-guide/cloud-screens.html">9.0</a>
@@ -1089,7 +1089,7 @@
</div>
<!-- Solr Additions - Start -->
<!-- Solr New File -->
-<span class="perma-link-copy" version="9_3">
+<span class="perma-link-copy" version="9_4">
</span><!-- Solr Additions - End -->
<div class="edit-this-page"><a href="https://github.com/apache/solr/tree/main/solr/solr-ref-guide/modules/deployment-guide/pages/cloud-screens.adoc">Edit this Page</a></div>
</div>
Modified: sites/solr/guide/solr/latest/deployment-guide/cluster-node-management.html
URL: http://svn.apache.org/viewvc/sites/solr/guide/solr/latest/deployment-guide/cluster-node-management.html?rev=1084409&r1=1084408&r2=1084409&view=diff
==============================================================================
--- sites/solr/guide/solr/latest/deployment-guide/cluster-node-management.html (original)
+++ sites/solr/guide/solr/latest/deployment-guide/cluster-node-management.html Sun Oct 15 15:24:01 2023
@@ -39,7 +39,7 @@
<div class="navbar-item has-dropdown is-hoverable">
<a class="navbar-link" href="#">Resources</a>
<div class="navbar-dropdown">
- <a class="navbar-item" href="https://solr.apache.org/docs/9_3_0/index.html" target="_blank" rel="noreferrer nopener">Solr Javadocs</a>
+ <a class="navbar-item" href="https://solr.apache.org/docs/9_4_0/index.html" target="_blank" rel="noreferrer nopener">Solr Javadocs</a>
<a class="navbar-item" href="https://solr.apache.org/community.html#version-control" target="_blank" rel="noreferrer nopener">Source Code</a>
<a class="navbar-item" href="https://solr.apache.org/community.html" target="_blank" rel="noreferrer nopener">Community Links</a>
<a class="navbar-item" href="https://github.com/apache/solr/tree/main/dev-docs/ref-guide" target="_blank" rel="noreferrer nopener">Contribute</a>
@@ -56,25 +56,25 @@
</nav>
</header>
<div class="body">
-<div class="nav-container" data-component="solr" data-version="9_3">
+<div class="nav-container" data-component="solr" data-version="9_4">
<aside class="nav">
<div class="panels">
<!-- Solr Changes - Start -->
<div class="nav-panel-explore" data-panel="explore">
<div class="context">
<span class="title">Solr Reference Guide</span>
- <span class="version">9.3</span>
+ <span class="version">9.4</span>
</div>
<!-- Programmatically creates the component and version list -->
<ul class="components">
<li class="component is-current">
<a class="title" href="../index.html">Solr Reference Guide</a>
<ul class="versions">
- <li class="version">
- <a href="../../9_4/index.html">9.4-beta</a>
- </li>
<li class="version is-current is-latest">
- <a href="../index.html">9.3</a>
+ <a href="../index.html">9.4</a>
+ </li>
+ <li class="version">
+ <a href="../../9_3/index.html">9.3</a>
</li>
<li class="version">
<a href="../../9_2/index.html">9.2</a>
@@ -694,7 +694,7 @@
<a class="nav-link" href="../indexing-guide/filters.html">Filters</a>
</li>
<li class="nav-item" data-depth="2">
- <a class="nav-link" href="../indexing-guide/charfilterfactories.html">CharFilterFactories</a>
+ <a class="nav-link" href="../indexing-guide/charfilters.html">CharFilters</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../indexing-guide/language-analysis.html">Language Analysis</a>
@@ -1078,10 +1078,10 @@
</ul>
</nav>
<div class="page-versions">
- <button class="version-menu-toggle" title="Show other versions of page">9.3</button>
+ <button class="version-menu-toggle" title="Show other versions of page">9.4</button>
<div class="version-menu">
- <a class="version" href="../../9_4/deployment-guide/cluster-node-management.html">9.4-beta</a>
- <a class="version is-current" href="cluster-node-management.html">9.3</a>
+ <a class="version is-current" href="cluster-node-management.html">9.4</a>
+ <a class="version" href="../../9_3/deployment-guide/cluster-node-management.html">9.3</a>
<a class="version" href="../../9_2/deployment-guide/cluster-node-management.html">9.2</a>
<a class="version" href="../../9_1/deployment-guide/cluster-node-management.html">9.1</a>
<a class="version" href="../../9_0/deployment-guide/cluster-node-management.html">9.0</a>
@@ -1089,7 +1089,7 @@
</div>
<!-- Solr Additions - Start -->
<!-- Solr New File -->
-<span class="perma-link-copy" version="9_3">
+<span class="perma-link-copy" version="9_4">
</span><!-- Solr Additions - End -->
<div class="edit-this-page"><a href="https://github.com/apache/solr/tree/main/solr/solr-ref-guide/modules/deployment-guide/pages/cluster-node-management.adoc">Edit this Page</a></div>
</div>
Modified: sites/solr/guide/solr/latest/deployment-guide/cluster-types.html
URL: http://svn.apache.org/viewvc/sites/solr/guide/solr/latest/deployment-guide/cluster-types.html?rev=1084409&r1=1084408&r2=1084409&view=diff
==============================================================================
--- sites/solr/guide/solr/latest/deployment-guide/cluster-types.html (original)
+++ sites/solr/guide/solr/latest/deployment-guide/cluster-types.html Sun Oct 15 15:24:01 2023
@@ -39,7 +39,7 @@
<div class="navbar-item has-dropdown is-hoverable">
<a class="navbar-link" href="#">Resources</a>
<div class="navbar-dropdown">
- <a class="navbar-item" href="https://solr.apache.org/docs/9_3_0/index.html" target="_blank" rel="noreferrer nopener">Solr Javadocs</a>
+ <a class="navbar-item" href="https://solr.apache.org/docs/9_4_0/index.html" target="_blank" rel="noreferrer nopener">Solr Javadocs</a>
<a class="navbar-item" href="https://solr.apache.org/community.html#version-control" target="_blank" rel="noreferrer nopener">Source Code</a>
<a class="navbar-item" href="https://solr.apache.org/community.html" target="_blank" rel="noreferrer nopener">Community Links</a>
<a class="navbar-item" href="https://github.com/apache/solr/tree/main/dev-docs/ref-guide" target="_blank" rel="noreferrer nopener">Contribute</a>
@@ -56,25 +56,25 @@
</nav>
</header>
<div class="body">
-<div class="nav-container" data-component="solr" data-version="9_3">
+<div class="nav-container" data-component="solr" data-version="9_4">
<aside class="nav">
<div class="panels">
<!-- Solr Changes - Start -->
<div class="nav-panel-explore" data-panel="explore">
<div class="context">
<span class="title">Solr Reference Guide</span>
- <span class="version">9.3</span>
+ <span class="version">9.4</span>
</div>
<!-- Programmatically creates the component and version list -->
<ul class="components">
<li class="component is-current">
<a class="title" href="../index.html">Solr Reference Guide</a>
<ul class="versions">
- <li class="version">
- <a href="../../9_4/index.html">9.4-beta</a>
- </li>
<li class="version is-current is-latest">
- <a href="../index.html">9.3</a>
+ <a href="../index.html">9.4</a>
+ </li>
+ <li class="version">
+ <a href="../../9_3/index.html">9.3</a>
</li>
<li class="version">
<a href="../../9_2/index.html">9.2</a>
@@ -694,7 +694,7 @@
<a class="nav-link" href="../indexing-guide/filters.html">Filters</a>
</li>
<li class="nav-item" data-depth="2">
- <a class="nav-link" href="../indexing-guide/charfilterfactories.html">CharFilterFactories</a>
+ <a class="nav-link" href="../indexing-guide/charfilters.html">CharFilters</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../indexing-guide/language-analysis.html">Language Analysis</a>
@@ -1076,10 +1076,10 @@
</ul>
</nav>
<div class="page-versions">
- <button class="version-menu-toggle" title="Show other versions of page">9.3</button>
+ <button class="version-menu-toggle" title="Show other versions of page">9.4</button>
<div class="version-menu">
- <a class="version" href="../../9_4/deployment-guide/cluster-types.html">9.4-beta</a>
- <a class="version is-current" href="cluster-types.html">9.3</a>
+ <a class="version is-current" href="cluster-types.html">9.4</a>
+ <a class="version" href="../../9_3/deployment-guide/cluster-types.html">9.3</a>
<a class="version" href="../../9_2/deployment-guide/cluster-types.html">9.2</a>
<a class="version" href="../../9_1/deployment-guide/cluster-types.html">9.1</a>
<a class="version" href="../../9_0/deployment-guide/cluster-types.html">9.0</a>
@@ -1087,7 +1087,7 @@
</div>
<!-- Solr Additions - Start -->
<!-- Solr New File -->
-<span class="perma-link-copy" version="9_3">
+<span class="perma-link-copy" version="9_4">
</span><!-- Solr Additions - End -->
<div class="edit-this-page"><a href="https://github.com/apache/solr/tree/main/solr/solr-ref-guide/modules/deployment-guide/pages/cluster-types.adoc">Edit this Page</a></div>
</div>
Modified: sites/solr/guide/solr/latest/deployment-guide/collection-management.html
URL: http://svn.apache.org/viewvc/sites/solr/guide/solr/latest/deployment-guide/collection-management.html?rev=1084409&r1=1084408&r2=1084409&view=diff
==============================================================================
--- sites/solr/guide/solr/latest/deployment-guide/collection-management.html (original)
+++ sites/solr/guide/solr/latest/deployment-guide/collection-management.html Sun Oct 15 15:24:01 2023
@@ -39,7 +39,7 @@
<div class="navbar-item has-dropdown is-hoverable">
<a class="navbar-link" href="#">Resources</a>
<div class="navbar-dropdown">
- <a class="navbar-item" href="https://solr.apache.org/docs/9_3_0/index.html" target="_blank" rel="noreferrer nopener">Solr Javadocs</a>
+ <a class="navbar-item" href="https://solr.apache.org/docs/9_4_0/index.html" target="_blank" rel="noreferrer nopener">Solr Javadocs</a>
<a class="navbar-item" href="https://solr.apache.org/community.html#version-control" target="_blank" rel="noreferrer nopener">Source Code</a>
<a class="navbar-item" href="https://solr.apache.org/community.html" target="_blank" rel="noreferrer nopener">Community Links</a>
<a class="navbar-item" href="https://github.com/apache/solr/tree/main/dev-docs/ref-guide" target="_blank" rel="noreferrer nopener">Contribute</a>
@@ -56,25 +56,25 @@
</nav>
</header>
<div class="body">
-<div class="nav-container" data-component="solr" data-version="9_3">
+<div class="nav-container" data-component="solr" data-version="9_4">
<aside class="nav">
<div class="panels">
<!-- Solr Changes - Start -->
<div class="nav-panel-explore" data-panel="explore">
<div class="context">
<span class="title">Solr Reference Guide</span>
- <span class="version">9.3</span>
+ <span class="version">9.4</span>
</div>
<!-- Programmatically creates the component and version list -->
<ul class="components">
<li class="component is-current">
<a class="title" href="../index.html">Solr Reference Guide</a>
<ul class="versions">
- <li class="version">
- <a href="../../9_4/index.html">9.4-beta</a>
- </li>
<li class="version is-current is-latest">
- <a href="../index.html">9.3</a>
+ <a href="../index.html">9.4</a>
+ </li>
+ <li class="version">
+ <a href="../../9_3/index.html">9.3</a>
</li>
<li class="version">
<a href="../../9_2/index.html">9.2</a>
@@ -694,7 +694,7 @@
<a class="nav-link" href="../indexing-guide/filters.html">Filters</a>
</li>
<li class="nav-item" data-depth="2">
- <a class="nav-link" href="../indexing-guide/charfilterfactories.html">CharFilterFactories</a>
+ <a class="nav-link" href="../indexing-guide/charfilters.html">CharFilters</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../indexing-guide/language-analysis.html">Language Analysis</a>
@@ -1078,10 +1078,10 @@
</ul>
</nav>
<div class="page-versions">
- <button class="version-menu-toggle" title="Show other versions of page">9.3</button>
+ <button class="version-menu-toggle" title="Show other versions of page">9.4</button>
<div class="version-menu">
- <a class="version" href="../../9_4/deployment-guide/collection-management.html">9.4-beta</a>
- <a class="version is-current" href="collection-management.html">9.3</a>
+ <a class="version is-current" href="collection-management.html">9.4</a>
+ <a class="version" href="../../9_3/deployment-guide/collection-management.html">9.3</a>
<a class="version" href="../../9_2/deployment-guide/collection-management.html">9.2</a>
<a class="version" href="../../9_1/deployment-guide/collection-management.html">9.1</a>
<a class="version" href="../../9_0/deployment-guide/collection-management.html">9.0</a>
@@ -1089,7 +1089,7 @@
</div>
<!-- Solr Additions - Start -->
<!-- Solr New File -->
-<span class="perma-link-copy" version="9_3">
+<span class="perma-link-copy" version="9_4">
</span><!-- Solr Additions - End -->
<div class="edit-this-page"><a href="https://github.com/apache/solr/tree/main/solr/solr-ref-guide/modules/deployment-guide/pages/collection-management.adoc">Edit this Page</a></div>
</div>
@@ -3657,7 +3657,7 @@ This parameter has no effect if <code>in
<tbody>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Optional</p></td>
-<td class="tableblock halign-left valign-top"><p class="tableblock">Default: true</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Default: <code>true</code></p></td>
</tr>
</tbody>
</table>
@@ -3665,6 +3665,27 @@ This parameter has no effect if <code>in
<p>Indicates if configset files should be included with the index backup or not. Note that in order to restore a collection, the configset must either exist in ZooKeeper or be part of the backup. Only set this to <code>false</code> if you can restore configsets by other means external to Solr (i.e. you have it stored with your application source code, is part of your ZooKeeper backups, etc).</p>
</div>
</dd>
+<dt class="hdlist1"><code>property.<propertyName></code> (V1), <code>extraProperties</code> (V2)</dt>
+</dl>
+</div>
+<table class="tableblock frame-none grid-all fit-content">
+<colgroup>
+<col>
+<col>
+</colgroup>
+<tbody>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Optional</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Default: none</p></td>
+</tr>
+</tbody>
+</table>
+<div class="paragraph">
+<p>+
+Allows storing additional key/value pairs for custom information related to the backup. In v2, the value is a map of key-value pairs.</p>
+</div>
+<div class="dlist">
+<dl>
<dt class="hdlist1"><code>incremental</code></dt>
<dd>
<table class="tableblock frame-none grid-all fit-content">
Modified: sites/solr/guide/solr/latest/deployment-guide/collections-core-admin.html
URL: http://svn.apache.org/viewvc/sites/solr/guide/solr/latest/deployment-guide/collections-core-admin.html?rev=1084409&r1=1084408&r2=1084409&view=diff
==============================================================================
--- sites/solr/guide/solr/latest/deployment-guide/collections-core-admin.html (original)
+++ sites/solr/guide/solr/latest/deployment-guide/collections-core-admin.html Sun Oct 15 15:24:01 2023
@@ -39,7 +39,7 @@
<div class="navbar-item has-dropdown is-hoverable">
<a class="navbar-link" href="#">Resources</a>
<div class="navbar-dropdown">
- <a class="navbar-item" href="https://solr.apache.org/docs/9_3_0/index.html" target="_blank" rel="noreferrer nopener">Solr Javadocs</a>
+ <a class="navbar-item" href="https://solr.apache.org/docs/9_4_0/index.html" target="_blank" rel="noreferrer nopener">Solr Javadocs</a>
<a class="navbar-item" href="https://solr.apache.org/community.html#version-control" target="_blank" rel="noreferrer nopener">Source Code</a>
<a class="navbar-item" href="https://solr.apache.org/community.html" target="_blank" rel="noreferrer nopener">Community Links</a>
<a class="navbar-item" href="https://github.com/apache/solr/tree/main/dev-docs/ref-guide" target="_blank" rel="noreferrer nopener">Contribute</a>
@@ -56,25 +56,25 @@
</nav>
</header>
<div class="body">
-<div class="nav-container" data-component="solr" data-version="9_3">
+<div class="nav-container" data-component="solr" data-version="9_4">
<aside class="nav">
<div class="panels">
<!-- Solr Changes - Start -->
<div class="nav-panel-explore" data-panel="explore">
<div class="context">
<span class="title">Solr Reference Guide</span>
- <span class="version">9.3</span>
+ <span class="version">9.4</span>
</div>
<!-- Programmatically creates the component and version list -->
<ul class="components">
<li class="component is-current">
<a class="title" href="../index.html">Solr Reference Guide</a>
<ul class="versions">
- <li class="version">
- <a href="../../9_4/index.html">9.4-beta</a>
- </li>
<li class="version is-current is-latest">
- <a href="../index.html">9.3</a>
+ <a href="../index.html">9.4</a>
+ </li>
+ <li class="version">
+ <a href="../../9_3/index.html">9.3</a>
</li>
<li class="version">
<a href="../../9_2/index.html">9.2</a>
@@ -694,7 +694,7 @@
<a class="nav-link" href="../indexing-guide/filters.html">Filters</a>
</li>
<li class="nav-item" data-depth="2">
- <a class="nav-link" href="../indexing-guide/charfilterfactories.html">CharFilterFactories</a>
+ <a class="nav-link" href="../indexing-guide/charfilters.html">CharFilters</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../indexing-guide/language-analysis.html">Language Analysis</a>
@@ -1078,10 +1078,10 @@
</ul>
</nav>
<div class="page-versions">
- <button class="version-menu-toggle" title="Show other versions of page">9.3</button>
+ <button class="version-menu-toggle" title="Show other versions of page">9.4</button>
<div class="version-menu">
- <a class="version" href="../../9_4/deployment-guide/collections-core-admin.html">9.4-beta</a>
- <a class="version is-current" href="collections-core-admin.html">9.3</a>
+ <a class="version is-current" href="collections-core-admin.html">9.4</a>
+ <a class="version" href="../../9_3/deployment-guide/collections-core-admin.html">9.3</a>
<a class="version" href="../../9_2/deployment-guide/collections-core-admin.html">9.2</a>
<a class="version" href="../../9_1/deployment-guide/collections-core-admin.html">9.1</a>
<a class="version" href="../../9_0/deployment-guide/collections-core-admin.html">9.0</a>
@@ -1089,7 +1089,7 @@
</div>
<!-- Solr Additions - Start -->
<!-- Solr New File -->
-<span class="perma-link-copy" version="9_3">
+<span class="perma-link-copy" version="9_4">
</span><!-- Solr Additions - End -->
<div class="edit-this-page"><a href="https://github.com/apache/solr/tree/main/solr/solr-ref-guide/modules/deployment-guide/pages/collections-core-admin.adoc">Edit this Page</a></div>
</div>
Modified: sites/solr/guide/solr/latest/deployment-guide/configuring-logging.html
URL: http://svn.apache.org/viewvc/sites/solr/guide/solr/latest/deployment-guide/configuring-logging.html?rev=1084409&r1=1084408&r2=1084409&view=diff
==============================================================================
--- sites/solr/guide/solr/latest/deployment-guide/configuring-logging.html (original)
+++ sites/solr/guide/solr/latest/deployment-guide/configuring-logging.html Sun Oct 15 15:24:01 2023
@@ -39,7 +39,7 @@
<div class="navbar-item has-dropdown is-hoverable">
<a class="navbar-link" href="#">Resources</a>
<div class="navbar-dropdown">
- <a class="navbar-item" href="https://solr.apache.org/docs/9_3_0/index.html" target="_blank" rel="noreferrer nopener">Solr Javadocs</a>
+ <a class="navbar-item" href="https://solr.apache.org/docs/9_4_0/index.html" target="_blank" rel="noreferrer nopener">Solr Javadocs</a>
<a class="navbar-item" href="https://solr.apache.org/community.html#version-control" target="_blank" rel="noreferrer nopener">Source Code</a>
<a class="navbar-item" href="https://solr.apache.org/community.html" target="_blank" rel="noreferrer nopener">Community Links</a>
<a class="navbar-item" href="https://github.com/apache/solr/tree/main/dev-docs/ref-guide" target="_blank" rel="noreferrer nopener">Contribute</a>
@@ -56,25 +56,25 @@
</nav>
</header>
<div class="body">
-<div class="nav-container" data-component="solr" data-version="9_3">
+<div class="nav-container" data-component="solr" data-version="9_4">
<aside class="nav">
<div class="panels">
<!-- Solr Changes - Start -->
<div class="nav-panel-explore" data-panel="explore">
<div class="context">
<span class="title">Solr Reference Guide</span>
- <span class="version">9.3</span>
+ <span class="version">9.4</span>
</div>
<!-- Programmatically creates the component and version list -->
<ul class="components">
<li class="component is-current">
<a class="title" href="../index.html">Solr Reference Guide</a>
<ul class="versions">
- <li class="version">
- <a href="../../9_4/index.html">9.4-beta</a>
- </li>
<li class="version is-current is-latest">
- <a href="../index.html">9.3</a>
+ <a href="../index.html">9.4</a>
+ </li>
+ <li class="version">
+ <a href="../../9_3/index.html">9.3</a>
</li>
<li class="version">
<a href="../../9_2/index.html">9.2</a>
@@ -694,7 +694,7 @@
<a class="nav-link" href="../indexing-guide/filters.html">Filters</a>
</li>
<li class="nav-item" data-depth="2">
- <a class="nav-link" href="../indexing-guide/charfilterfactories.html">CharFilterFactories</a>
+ <a class="nav-link" href="../indexing-guide/charfilters.html">CharFilters</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../indexing-guide/language-analysis.html">Language Analysis</a>
@@ -1076,10 +1076,10 @@
</ul>
</nav>
<div class="page-versions">
- <button class="version-menu-toggle" title="Show other versions of page">9.3</button>
+ <button class="version-menu-toggle" title="Show other versions of page">9.4</button>
<div class="version-menu">
- <a class="version" href="../../9_4/deployment-guide/configuring-logging.html">9.4-beta</a>
- <a class="version is-current" href="configuring-logging.html">9.3</a>
+ <a class="version is-current" href="configuring-logging.html">9.4</a>
+ <a class="version" href="../../9_3/deployment-guide/configuring-logging.html">9.3</a>
<a class="version" href="../../9_2/deployment-guide/configuring-logging.html">9.2</a>
<a class="version" href="../../9_1/deployment-guide/configuring-logging.html">9.1</a>
<a class="version" href="../../9_0/deployment-guide/configuring-logging.html">9.0</a>
@@ -1087,7 +1087,7 @@
</div>
<!-- Solr Additions - Start -->
<!-- Solr New File -->
-<span class="perma-link-copy" version="9_3">
+<span class="perma-link-copy" version="9_4">
</span><!-- Solr Additions - End -->
<div class="edit-this-page"><a href="https://github.com/apache/solr/tree/main/solr/solr-ref-guide/modules/deployment-guide/pages/configuring-logging.adoc">Edit this Page</a></div>
</div>
Modified: sites/solr/guide/solr/latest/deployment-guide/distributed-tracing.html
URL: http://svn.apache.org/viewvc/sites/solr/guide/solr/latest/deployment-guide/distributed-tracing.html?rev=1084409&r1=1084408&r2=1084409&view=diff
==============================================================================
--- sites/solr/guide/solr/latest/deployment-guide/distributed-tracing.html (original)
+++ sites/solr/guide/solr/latest/deployment-guide/distributed-tracing.html Sun Oct 15 15:24:01 2023
@@ -39,7 +39,7 @@
<div class="navbar-item has-dropdown is-hoverable">
<a class="navbar-link" href="#">Resources</a>
<div class="navbar-dropdown">
- <a class="navbar-item" href="https://solr.apache.org/docs/9_3_0/index.html" target="_blank" rel="noreferrer nopener">Solr Javadocs</a>
+ <a class="navbar-item" href="https://solr.apache.org/docs/9_4_0/index.html" target="_blank" rel="noreferrer nopener">Solr Javadocs</a>
<a class="navbar-item" href="https://solr.apache.org/community.html#version-control" target="_blank" rel="noreferrer nopener">Source Code</a>
<a class="navbar-item" href="https://solr.apache.org/community.html" target="_blank" rel="noreferrer nopener">Community Links</a>
<a class="navbar-item" href="https://github.com/apache/solr/tree/main/dev-docs/ref-guide" target="_blank" rel="noreferrer nopener">Contribute</a>
@@ -56,25 +56,25 @@
</nav>
</header>
<div class="body">
-<div class="nav-container" data-component="solr" data-version="9_3">
+<div class="nav-container" data-component="solr" data-version="9_4">
<aside class="nav">
<div class="panels">
<!-- Solr Changes - Start -->
<div class="nav-panel-explore" data-panel="explore">
<div class="context">
<span class="title">Solr Reference Guide</span>
- <span class="version">9.3</span>
+ <span class="version">9.4</span>
</div>
<!-- Programmatically creates the component and version list -->
<ul class="components">
<li class="component is-current">
<a class="title" href="../index.html">Solr Reference Guide</a>
<ul class="versions">
- <li class="version">
- <a href="../../9_4/index.html">9.4-beta</a>
- </li>
<li class="version is-current is-latest">
- <a href="../index.html">9.3</a>
+ <a href="../index.html">9.4</a>
+ </li>
+ <li class="version">
+ <a href="../../9_3/index.html">9.3</a>
</li>
<li class="version">
<a href="../../9_2/index.html">9.2</a>
@@ -694,7 +694,7 @@
<a class="nav-link" href="../indexing-guide/filters.html">Filters</a>
</li>
<li class="nav-item" data-depth="2">
- <a class="nav-link" href="../indexing-guide/charfilterfactories.html">CharFilterFactories</a>
+ <a class="nav-link" href="../indexing-guide/charfilters.html">CharFilters</a>
</li>
<li class="nav-item" data-depth="2">
<a class="nav-link" href="../indexing-guide/language-analysis.html">Language Analysis</a>
@@ -1076,10 +1076,10 @@
</ul>
</nav>
<div class="page-versions">
- <button class="version-menu-toggle" title="Show other versions of page">9.3</button>
+ <button class="version-menu-toggle" title="Show other versions of page">9.4</button>
<div class="version-menu">
- <a class="version" href="../../9_4/deployment-guide/distributed-tracing.html">9.4-beta</a>
- <a class="version is-current" href="distributed-tracing.html">9.3</a>
+ <a class="version is-current" href="distributed-tracing.html">9.4</a>
+ <a class="version" href="../../9_3/deployment-guide/distributed-tracing.html">9.3</a>
<a class="version" href="../../9_2/deployment-guide/distributed-tracing.html">9.2</a>
<a class="version" href="../../9_1/deployment-guide/distributed-tracing.html">9.1</a>
<a class="version" href="../../9_0/deployment-guide/distributed-tracing.html">9.0</a>
@@ -1087,7 +1087,7 @@
</div>
<!-- Solr Additions - Start -->
<!-- Solr New File -->
-<span class="perma-link-copy" version="9_3">
+<span class="perma-link-copy" version="9_4">
</span><!-- Solr Additions - End -->
<div class="edit-this-page"><a href="https://github.com/apache/solr/tree/main/solr/solr-ref-guide/modules/deployment-guide/pages/distributed-tracing.adoc">Edit this Page</a></div>
</div>
@@ -1118,6 +1118,21 @@
</div>
</div>
<div class="sect1">
+<h2 id="always-on-trace-id-generation"><a class="anchor" href="#always-on-trace-id-generation"></a>Always-on Trace Id generation</h2>
+<div class="sectionbody">
+<div class="paragraph">
+<p>Solr includes an always-on trace id generator. This will inject trace id headers for every Solr request, propagating the client supplied value or generating a new id as needed and replaces the existing <code>rid</code> mechanism.</p>
+</div>
+<div class="paragraph">
+<p>The header name it uses for propagation is <code>X-Trace-Id</code>, this can be changed by updating the system property <code>solr.traceIdHeader</code>.</p>
+</div>
+<div class="paragraph">
+<p>This plugin will not be enabled if another Tracing mechanism is setup via Solr config.
+This plugin can be disabled by setting the <code>solr.alwaysOnTraceId</code> system property to <code>false</code>.</p>
+</div>
+</div>
+</div>
+<div class="sect1">
<h2 id="modules-and-configuration"><a class="anchor" href="#modules-and-configuration"></a>Modules and Configuration</h2>
<div class="sectionbody">
<div class="paragraph">
@@ -1158,12 +1173,15 @@ By doing this, some backends like DataDo
</div>
</div>
<div class="paragraph">
+<p>As an alternative to changing the <code>solr.xml</code> file, the <code>OTEL</code> tracer will be enabled if the system property <code>otel.service.name</code> or environment variable <code>OTEL_SERVICE_NAME</code> is present. The <code>opentelemetry</code> module still needs to be enabled for the tracer to work.</p>
+</div>
+<div class="paragraph">
<p>Enable the module with either system property <code>-Dsolr.modules=opentelemetry</code> or environment variable <code>SOLR_MODULES=opentelemetry</code>.</p>
</div>
<div class="sect2">
<h3 id="configuration"><a class="anchor" href="#configuration"></a>Configuration</h3>
<div class="paragraph">
-<p>The tracer can be configured through environment variables or Java system properties, see <a href="https://opentelemetry.io/docs/reference/specification/sdk-environment-variables/">OTEL SDK Environment Variables</a> and <a href="https://github.com/open-telemetry/opentelemetry-java/blob/v1.21.0/sdk-extensions/autoconfigure/README.md">Java SDK Autoconfigure</a>.</p>
+<p>The tracer can be configured through environment variables or Java system properties, see <a href="https://opentelemetry.io/docs/reference/specification/sdk-environment-variables/">OTEL SDK Environment Variables</a> and <a href="https://github.com/open-telemetry/opentelemetry-java/blob/v1.30.1/sdk-extensions/autoconfigure/README.md">Java SDK Autoconfigure</a>.</p>
</div>
<div class="paragraph">
<p>The default configuration will ship traces to a collector running on localhost, using <a href="https://opentelemetry.io/docs/reference/specification/protocol/">OTLP</a> over <a href="https://grpc.io">gRPC</a>, and will propagate trace IDs using <a href="https://www.w3.org/TR/trace-context/">W3C TraceContext</a>. Here are the environment settings that are enabled by default:</p>
@@ -1207,7 +1225,7 @@ OTEL_TRACES_SAMPLER_ARG=0.1</code></pre>
</div>
<div class="paragraph">
<p>Consult the <a href="https://opentelemetry.io/docs/reference/specification/sdk-environment-variables/">OTEL documentation</a> for details on all the configuration options.
-This version of Solr uses <a href="https://github.com/open-telemetry/opentelemetry-java/tree/v1.21.0">OpenTelemetry SDK v1.21.0</a>.</p>
+This version of Solr uses <a href="https://github.com/open-telemetry/opentelemetry-java/tree/v1.30.1">OpenTelemetry SDK v1.30.1</a>.</p>
</div>
</div>
<div class="sect2">