blob: 0a059f10c7e48b2b24c38e8c67fbc05e7d0ae6c5 [file] [log] [blame]
---
layout: docpage
title: "Documentation"
is_homepage: false
is_sphinx_doc: true
doc-parent: "Configuring Cassandra"
doc-title: "jvm-* files"
doc-header-links: '
<link rel="top" title="Apache Cassandra Documentation v4.0-rc1" href="../index.html"/>
<link rel="up" title="Configuring Cassandra" href="index.html"/>
<link rel="next" title="Operating Cassandra" href="../operating/index.html"/>
<link rel="prev" title="logback.xml file" href="cass_logback_xml_file.html"/>
'
doc-search-path: "../search.html"
extra-footer: '
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: "",
VERSION: "",
COLLAPSE_INDEX: false,
FILE_SUFFIX: ".html",
HAS_SOURCE: false,
SOURCELINK_SUFFIX: ".txt"
};
</script>
'
---
<div class="container-fluid">
<div class="row">
<div class="col-md-3">
<div class="doc-navigation">
<div class="doc-menu" role="navigation">
<div class="navbar-header">
<button type="button" class="pull-left navbar-toggle" data-toggle="collapse" data-target=".sidebar-navbar-collapse">
<span class="sr-only">Toggle navigation</span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
</button>
</div>
<div class="navbar-collapse collapse sidebar-navbar-collapse">
<form id="doc-search-form" class="navbar-form" action="../search.html" method="get" role="search">
<div class="form-group">
<input type="text" size="30" class="form-control input-sm" name="q" placeholder="Search docs">
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</div>
</form>
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="../getting_started/index.html">Getting Started</a></li>
<li class="toctree-l1"><a class="reference internal" href="../new/index.html">New Features in Apache Cassandra 4.0</a></li>
<li class="toctree-l1"><a class="reference internal" href="../architecture/index.html">Architecture</a></li>
<li class="toctree-l1"><a class="reference internal" href="../cql/index.html">The Cassandra Query Language (CQL)</a></li>
<li class="toctree-l1"><a class="reference internal" href="../data_modeling/index.html">Data Modeling</a></li>
<li class="toctree-l1 current"><a class="reference internal" href="index.html">Configuring Cassandra</a><ul class="current">
<li class="toctree-l2"><a class="reference internal" href="cass_yaml_file.html">cassandra.yaml file configuration</a></li>
<li class="toctree-l2"><a class="reference internal" href="cass_rackdc_file.html">cassandra-rackdc.properties file</a></li>
<li class="toctree-l2"><a class="reference internal" href="cass_env_sh_file.html">cassandra-env.sh file</a></li>
<li class="toctree-l2"><a class="reference internal" href="cass_topo_file.html">cassandra-topologies.properties file</a></li>
<li class="toctree-l2"><a class="reference internal" href="cass_cl_archive_file.html">commitlog-archiving.properties file</a></li>
<li class="toctree-l2"><a class="reference internal" href="cass_logback_xml_file.html">logback.xml file</a></li>
<li class="toctree-l2 current"><a class="current reference internal" href="#">jvm-* files</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="../operating/index.html">Operating Cassandra</a></li>
<li class="toctree-l1"><a class="reference internal" href="../tools/index.html">Cassandra Tools</a></li>
<li class="toctree-l1"><a class="reference internal" href="../troubleshooting/index.html">Troubleshooting</a></li>
<li class="toctree-l1"><a class="reference internal" href="../development/index.html">Contributing to Cassandra</a></li>
<li class="toctree-l1"><a class="reference internal" href="../faq/index.html">Frequently Asked Questions</a></li>
<li class="toctree-l1"><a class="reference internal" href="../plugins/index.html">Third-Party Plugins</a></li>
<li class="toctree-l1"><a class="reference internal" href="../bugs.html">Reporting Bugs</a></li>
<li class="toctree-l1"><a class="reference internal" href="../contactus.html">Contact us</a></li>
</ul>
</div><!--/.nav-collapse -->
</div>
</div>
</div>
<div class="col-md-8">
<div class="content doc-content">
<div class="content-container">
<div class="section" id="jvm-files">
<span id="cassandra-jvm-options"></span><h1>jvm-* files<a class="headerlink" href="#jvm-files" title="Permalink to this headline">ΒΆ</a></h1>
<p>Several files for JVM configuration are included in Cassandra. The <code class="docutils literal notranslate"><span class="pre">jvm-server.options</span></code> file, and corresponding files <code class="docutils literal notranslate"><span class="pre">jvm8-server.options</span></code> and <code class="docutils literal notranslate"><span class="pre">jvm11-server.options</span></code> are the main file for settings that affect the operation of the Cassandra JVM on cluster nodes. The file includes startup parameters, general JVM settings such as garbage collection, and heap settings. The <code class="docutils literal notranslate"><span class="pre">jvm-clients.options</span></code> and corresponding <code class="docutils literal notranslate"><span class="pre">jvm8-clients.options</span></code> and <code class="docutils literal notranslate"><span class="pre">jvm11-clients.options</span></code> files can be used to configure JVM settings for clients like <code class="docutils literal notranslate"><span class="pre">nodetool</span></code> and the <code class="docutils literal notranslate"><span class="pre">sstable</span></code> tools.</p>
<p>See each file for examples of settings.</p>
<div class="admonition note">
<p class="first admonition-title">Note</p>
<p class="last">The <code class="docutils literal notranslate"><span class="pre">jvm-*</span></code> files replace the <a class="reference internal" href="cass_env_sh_file.html#cassandra-envsh"><span class="std std-ref">cassandra-env.sh file</span></a> file used in Cassandra versions prior to Cassandra 3.0. The <code class="docutils literal notranslate"><span class="pre">cassandra-env.sh</span></code> bash script file is still useful if JVM settings must be dynamically calculated based on system settings. The <code class="docutils literal notranslate"><span class="pre">jvm-*</span></code> files only store static JVM settings.</p>
</div>
</div>
<div class="doc-prev-next-links" role="navigation" aria-label="footer navigation">
<a href="../operating/index.html" class="btn btn-default pull-right " role="button" title="Operating Cassandra" accesskey="n">Next <span class="glyphicon glyphicon-circle-arrow-right" aria-hidden="true"></span></a>
<a href="cass_logback_xml_file.html" class="btn btn-default" role="button" title="logback.xml file" accesskey="p"><span class="glyphicon glyphicon-circle-arrow-left" aria-hidden="true"></span> Previous</a>
</div>
</div>
</div>
</div>
</div>
</div>