blob: 57547e9322de0bb478161b0dcdef6724b600cb6d [file] [log] [blame]
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width,initial-scale=1.0">
<title>Apache Cassandra | Apache Cassandra Documentation</title>
<link rel="stylesheet" href="../../assets/css/site.css">
<meta name="description" content="A guide to asking good questions to get better answers.">
<link rel="schema.dcterms" href="https://purl.org/dc/terms/">
<meta name="dcterms.subject" content="_">
<meta name="dcterms.identifier" content="master">
<meta name="generator" content="Antora 2.3.4">
<link rel="icon" href="../../assets/img/favicon.ico" type="image/x-icon">
<script>
const script = document.createElement("script");
const domain = window.location.hostname;
script.type = "text/javascript";
script.src = "https://plausible.cassandra.apache.org/js/plausible.js";
script.setAttribute("data-domain",domain);
script.setAttribute("defer",'true');
script.setAttribute("async",'true');
document.getElementsByTagName("head")[0].appendChild(script);
</script> </head>
<body class="basic ">
<div class="container mx-auto relative">
<script src="https://ajax.googleapis.com/ajax/libs/jquery/3.6.0/jquery.min.js"></script>
<meta property="og:type" content="website" />
<meta property="og:description" content="" />
<meta property="og:url" content="/" />
<meta property="og:site_name" content="Apache Cassandra" />
<header id="top-nav">
<div class="inner relative">
<div class="header-social-icons text-right">
<a href="https://twitter.com/cassandra?lang=en" target="_blank" styles="margin-left: 20px;"><img src="../../assets/img/twitter-icon-circle-white.svg" alt="twitter icon" width="24"></a>
<a href="https://www.linkedin.com/company/apache-cassandra/" target="_blank" styles="margin-left: 20px;"><img src="../../assets/img/LI-In-Bug.png" alt="linked-in icon" width="24"></a>
<a href="https://www.youtube.com/c/PlanetCassandra" target="_blank" styles="margin-left: 20px;"><img src="../../assets/img/youtube-icon.png" alt="youtube icon" width="24"></a>
</div>
<div class="cf">
<div class="logo left"><a href="/"><img src="../../assets/img/logo-white-r.png" alt="cassandra logo"></a></div>
<div class="mobile-nav-icon right">
<img class="toggle-icon" src="../../assets/img/hamburger-nav.svg">
</div>
<ul class="main-nav nav-links right flex flex-vert-center flex-space-between">
<li>
<a class="nav-link hide-mobile">Get Started</a>
<ul class="sub-menu bg-white">
<li class="pa-micro">
<a href="/_/cassandra-basics.html">
<div class="sub-nav-icon">
<img src="../../assets/img/sub-menu-basics.png" alt="cassandra basics icon">
</div>
<div class="sub-nav-text teal py-small">
Cassandra Basics
</div>
</a>
</li>
<li class="pa-micro">
<a href="/_/quickstart.html">
<div class="sub-nav-icon">
<img src="../../assets/img/sub-menu-rocket.png" alt="cassandra basics icon">
</div>
<div class="sub-nav-text teal py-small">
Quickstart
</div>
</a>
</li>
<li class="pa-micro">
<a href="/_/ecosystem.html">
<div class="sub-nav-icon">
<img src="../../assets/img/sub-menu-ecosystem.png" alt="cassandra basics icon">
</div>
<div class="sub-nav-text teal py-small">
Ecosystem
</div>
</a>
</li>
</ul>
</li>
<li><a class="nav-link" href="/doc/latest/">Documentation</a></li>
<li>
<a class="nav-link" href="/_/community.html">Community</a>
<ul class="sub-menu bg-white">
<li class="pa-micro">
<a href="/_/community.html#code-of-conduct">
<div class="sub-nav-icon">
<img src="../../assets/img/sub-menu-welcome.png" alt="welcome icon">
</div>
<div class="sub-nav-text teal py-small">
Welcome
</div>
</a>
</li>
<li class="pa-micro hide-mobile">
<a href="/_/community.html#discussions">
<div class="sub-nav-icon">
<img src="../../assets/img/sub-menu-discussions.png" alt="discussions icon">
</div>
<div class="sub-nav-text teal py-small">
Discussions
</div>
</a>
</li>
<li class="pa-micro hide-mobile">
<a href="/_/community.html#project-governance">
<div class="sub-nav-icon">
<img src="../../assets/img/sub-menu-governance.png" alt="Governance icon">
</div>
<div class="sub-nav-text teal py-small">
Governance
</div>
</a>
</li>
<li class="pa-micro hide-mobile">
<a href="/_/community.html#how-to-contribute">
<div class="sub-nav-icon">
<img src="../../assets/img/sub-menu-contribute.png" alt="Contribute icon">
</div>
<div class="sub-nav-text teal py-small">
Contribute
</div>
</a>
</li>
<li class="pa-micro hide-mobile">
<a href="/_/community.html#meet-the-community">
<div class="sub-nav-icon">
<img src="../../assets/img/sub-menu-community.png" alt="Meet the Community icon">
</div>
<div class="sub-nav-text teal py-small">
Meet the Community
</div>
</a>
</li>
<li class="pa-micro hide-mobile">
<a href="/_/cassandra-catalyst-program.html">
<div class="sub-nav-icon">
<img src="../../assets/img/sub-menu-catalyst.png" alt="Catalyst icon">
</div>
<div class="sub-nav-text teal py-small">
Catalyst Program
</div>
</a>
</li>
<li class="pa-micro hide-mobile">
<a href="/_/events.html">
<div class="sub-nav-icon">
<img src="../../assets/img/sub-menu-events.png" alt="Events icon">
</div>
<div class="sub-nav-text teal py-small">
Events
</div>
</a>
</li>
</ul>
</li>
<li>
<a class="nav-link hide-mobile">Learn</a>
<ul class="sub-menu bg-white">
<li class="pa-micro">
<a href="/_/Apache-Cassandra-5.0-Moving-Toward-an-AI-Driven-Future.html">
<div class="sub-nav-icon">
<img src="../../assets/img/sub-menu-basics.png" alt="Basics icon">
</div>
<div class="sub-nav-text teal py-small">
Cassandra 5.0
</div>
</a>
</li>
<li class="pa-micro">
<a href="/_/case-studies.html">
<div class="sub-nav-icon">
<img src="../../assets/img/sub-menu-case-study.png" alt="Case Studies icon">
</div>
<div class="sub-nav-text teal py-small">
Case Studies
</div>
</a>
</li>
<li class="pa-micro">
<a href="/_/resources.html">
<div class="sub-nav-icon">
<img src="../../assets/img/sub-menu-resources.png" alt="Resources icon">
</div>
<div class="sub-nav-text teal py-small">
Resources
</div>
</a>
</li>
<li class="pa-micro">
<a href="/_/blog.html">
<div class="sub-nav-icon">
<img src="../../assets/img/sub-menu-blog.png" alt="Blog icon">
</div>
<div class="sub-nav-text teal py-small">
Blog
</div>
</a>
</li>
</ul>
</li>
<li><a class="nav-link btn btn--filled" href="/_/download.html">Download Now</a></li>
</ul>
</div>
</div>
</header>
<div class="hero hero--home grad">
<div class="eye"></div>
<div id="home-content" class="text-center flex flex-center flex-column relative z2 ma-xlarge">
<h1>Asking Good Questions in Community Forums</h1>
</div>
</div>
<div class="flex-center py-large arrow">
<div class="inner inner--narrow">
<div class="sect1">
<h2>Welcome and thank you for being part of the Apache Cassandra community!</h2>
<div class="sectionbody">
<div class="imageblock">
<div class="content">
<img src="../_images/community/community-ask_good_questions.jpg" alt="Supporting each other">
</div>
<div class="title">Image credit: <a href="https://www.pexels.com/@diohasbi/" target="_blank" rel="noopener">Dio Hasbi Saniskoro on Pexels</a></div>
</div>
<div class="paragraph">
<p>&nbsp;</p>
</div>
<div class="paragraph">
<p>Asking good questions will often get you a faster response and even better answers. So what makes a good question? This guide should help you draft a well-asked question.</p>
</div>
<hr>
<div class="sect3">
<h4>Before asking a question</h4>
<div class="paragraph">
<p>We encourage you to do a bit of research first. See if your question has already been answered in various channels:</p>
</div>
<div class="ulist">
<ul>
<li>
<p>For <strong>developer questions</strong> including coding or driver issues, <a href="https://stackoverflow.com/questions/tagged/cassandra" target="_blank" rel="noopener">search on Stack Overflow</a>.</p>
</li>
<li>
<p>For <strong>admin or ops questions</strong> including installation or maintenance issues, <a href="https://dba.stackexchange.com/questions/tagged/cassandra" target="_blank" rel="noopener">search on DBA Stack Exchange</a>.</p>
</li>
<li>
<p>Search the user mailing list archives.</p>
</li>
<li>
<p>Search in the <a href="https://the-asf.slack.com/archives/CJZLTM05A" target="_blank" rel="noopener">#cassandra channels on ASF Slack</a> (requires <a href="https://s.apache.org/slack-invite" target="_blank" rel="noopener">account signup</a>).</p>
</li>
</ul>
</div>
<div class="paragraph">
<p>Make sure you check the Cassandra logs, application logs and operating system logs because the log entries often give clues.</p>
</div>
<div class="paragraph">
<p>If you still need help, here are some things to consider when posting your question.</p>
</div>
</div>
<div class="sect3">
<h4>Use a meaningful title or subject line</h4>
<div class="paragraph">
<p>Good: “Cassandra failed to start after upgrading from 3.11.9 to 4.0.1”</p>
</div>
<div class="paragraph">
<p>Bad: “HELP!!! Cassandra doesn’t start”</p>
</div>
</div>
<div class="sect3">
<h4>Explain the problem you&#8217;re trying to solve</h4>
<div class="paragraph">
<p>Often users ask if it&#8217;s good to change parameter X or if they should run command Y but this often isn&#8217;t helpful. Instead, explain the issue you ran into and what outcome you&#8217;re after so you&#8217;ll be more likely to achieve it.</p>
</div>
<div class="paragraph">
<p>Provide background information. For example, a node went down because of a hardware failure or you were patching the OS. Knowing how you ran into a problem makes it easier to help you.</p>
</div>
<div class="paragraph">
<p>If you&#8217;ve tried some workarounds based on what you&#8217;ve researched on the internet, include the details in your question. It shows that you have made an effort to look for answers on your own.</p>
</div>
</div>
<div class="sect3">
<h4>List software versions</h4>
<div class="paragraph">
<p>In many cases, the answer depends on the version you&#8217;re running. Include things like Cassandra version, Java version, driver/framework version (for example, or Java driver 4.11 or Spring Boot 3.3.1).</p>
</div>
</div>
<div class="sect3">
<h4>Provide details of the error</h4>
<div class="paragraph">
<p>Don&#8217;t just post the error and expect an answer. We often need the full error message and the full stack trace. And in order to decipher the stack trace, make sure you provide the version as above.</p>
</div>
</div>
<div class="sect3">
<h4>Provide configuration details</h4>
<div class="paragraph">
<p>Note how you have configured cassandra.yaml (for example). It isn&#8217;t necessary to post entire configuration files, just include the properties/items relevant to your question.</p>
</div>
<div class="paragraph">
<p>Depending on your question, it might be relevant to describe your cluster&#8217;s topology; number of nodes; whether the nodes are on-premise or in a public cloud; whether they are VMs, pods or bare-metal.</p>
</div>
</div>
<div class="sect3">
<h4>Data or app issues</h4>
<div class="paragraph">
<p>For problematic queries, include the table schema and the full CQL query.</p>
</div>
<div class="paragraph">
<p>For app-related problems, provide some minimal code that reproduces the issue. It would also help to provide sample data that illustrates the problem.</p>
</div>
<div class="paragraph">
<p>List the expected result/output versus the actual result/output you got.</p>
</div>
<hr>
</div>
<div class="sect3">
<h4>Are you ready?</h4>
<div class="paragraph">
<p>For questions about developing apps or need help operating Cassandra, post on the Stack network. Please do not cross-post the same question to other channels such as Slack or the mailing lists.</p>
</div>
<div class="ulist">
<ul>
<li>
<p>For <strong>developer questions</strong> including data modeling, coding, drivers, <a href="https://stackoverflow.com/questions/ask?tags=cassandra" target="_blank" rel="noopener">please ask on Stack Overflow</a>.</p>
</li>
<li>
<p>For <strong>admin or ops questions</strong> including installation, upgrades, repairs, please ask on <a href="https://dba.stackexchange.com/questions/ask?tags=cassandra" target="_blank" rel="noopener">DBA Stack Exchange</a>.</p>
</li>
</ul>
</div>
<div class="paragraph">
<p>Show your support for the community and follow the <code>cassandra</code> tag by clicking on the blue <strong>Watch tag</strong> button on <a href="https://stackoverflow.com/questions/tagged/cassandra" target="_blank" rel="noopener">Stack Overflow</a> and <a href="https://dba.stackexchange.com/questions/tagged/cassandra" target="_blank" rel="noopener">Stack Exchange</a>!</p>
</div>
<div class="paragraph">
<p>For broad, opinion-based questions, general discussions, ask how to get help, or receive announcements, <a href="mailto:user-subscribe@cassandra.apache.org" target="_blank" rel="noopener">please subscribe to the user mailing list</a>. Security issues need to be reported to the <a href="https://www.apache.org/security/projects.html" target="_blank" rel="noopener">Apache Security Team</a>.</p>
</div>
<hr>
<div class="paragraph">
<p>Hopefully you found this guide helpful. But it is just a guide – there are no strict rules for asking questions. The community is here to help for everyone&#8217;s benefit. So go ahead, how we can help you today?</p>
</div>
</div>
</div>
</div>
</div>
</div>
<footer class="grad grad--two flex-center pb-xlarge">
<div class="inner text-center z2 relative">
<h2 class="white py-small">Get started with Cassandra, fast.</h2>
<a id="footer-cta" href="/_/quickstart.html" class="btn btn--filled ma-medium">Quickstart Guide</a>
</div>
<div class="inner flex flex-distribute-items mt-xlarge z2 relative">
<div class="col-2">
<div id="footer-logo" class="logo logo--footer mb-medium"><img src="../../assets/img/logo-white-r.png" alt="Cassandra Logo"></div>
<p>Apache Cassandra<img src="../../assets/img/registered.svg" alt="®" style="width:18px;"> powers mission-critical deployments with improved performance and unparalleled levels of scale in the cloud.</p>
<div class="footer-social-icons">
<a href="https://twitter.com/cassandra?lang=en" target="_blank"><img src="../../assets/img/twitter-icon-circle-white.svg" alt="twitter icon" width="24"></a>
<a href="https://www.linkedin.com/company/apache-cassandra/" target="_blank"><img src="../../assets/img/LI-In-Bug.png" alt="linked-in icon" width="24"></a>
<a href="https://www.youtube.com/c/PlanetCassandra" target="_blank"><img src="../../assets/img/youtube-icon.png" alt="youtube icon" width="24"></a>
</div>
</div>
<div class="col-2 flex flex-center">
<ul class="columns-2">
<li class="mb-small"><a href="/">Home</a></li>
<li class="mb-small"><a href="/_/cassandra-basics.html">Cassandra Basics</a></li>
<li class="mb-small"><a href="/_/quickstart.html">Quickstart</a></li>
<li class="mb-small"><a href="/_/ecosystem.html">Ecosystem</a></li>
<li class="mb-small"><a href="/doc/latest/">Documentation</a></li>
<li class="mb-small"><a href="/_/community.html">Community</a></li>
<li class="mb-small"><a href="/_/case-studies.html">Case Studies</a></li>
<li class="mb-small"><a href="/_/resources.html">Resources</a></li>
<li class="mb-small"><a href="/_/blog.html">Blog</a></li>
</ul>
</div>
</div>
</footer>
<div class="lower-footer bg-white pa-medium">
<div class="flex flex-row flex-vert-center">
<div class="pr-medium"><img src="../../assets/img//feather-small.png" alt="ASF" width="20"></div>
<div class="pr-medium"><a href="http://www.apache.org/" target="_blank">Foundation</a></div>
<div class="pr-medium"><a href="https://www.apache.org/events/current-event.html" target="_blank">Events</a></div>
<div class="pr-medium"><a href="https://www.apache.org/licenses/" target="_blank">License</a></div>
<div class="pr-medium"><a href="https://www.apache.org/foundation/thanks" target="_blank">Thanks</a></div>
<div class="pr-medium"><a href="https://www.apache.org/security" target="_blank">Security</a></div>
<div class="pr-medium"><a href="https://privacy.apache.org/policies/privacy-policy-public.html" target="_blank">Privacy</a></div>
<div class="pr-medium"><a href="https://www.apache.org/foundation/sponsorship" target="_blank">Sponsorship</a></div>
</div>
<p class="my-medium">© 2009-<script>document.write(new Date().getFullYear())</script> <a href="https://apache.org" target="_blank">The Apache Software Foundation</a> under the terms of the Apache License 2.0. Apache, the Apache feather logo, Apache Cassandra, Cassandra, and the Cassandra logo, are either registered trademarks or trademarks of The Apache Software Foundation.</p>
</div>
<div id="fade" class="hidden"></div>
<div id="modal" class="hidden">
<div id="close-modal" class="cursor-pointer"><svg viewBox="0 0 24 24" width="24" height="24" stroke="currentColor" stroke-width="2" fill="none" stroke-linecap="round" stroke-linejoin="round" class="css-i6dzq1"><line x1="18" y1="6" x2="6" y2="18"></line><line x1="6" y1="6" x2="18" y2="18"></line></svg></div>
<div id="mod-content" class="vid-mod-content resp-container"></div>
</div>
<script>
jQuery(function(){
var windowW = $(window).width();
$(document)
.on('click','.mobile-nav-icon',function(){
$('.main-nav').fadeIn();
})
.on('click','.main-nav',function(){
if(windowW <= 1000){
$(this).fadeOut();
}
})
.on('click','#version-toggle',function(){
$(this).toggleClass('active');
$(this).next().fadeToggle();
})
.on('click','#mobile-docs-nav-burger', function(){
$(this).toggleClass('active');
$('.docs-nav').toggleClass('active');
});
var url = window.location.pathname;
var isQuickstart = url.includes('quickstart.html');
if(isQuickstart){
var footerCTA = document.getElementById('footer-cta');
footerCTA.innerHTML = 'Get latest updates';
footerCTA.setAttribute('href', '/_/blog.html');
}
});
</script>
</div>
</body>
<script>
jQuery(function(){
jQuery(document)
.on('click','.cassandra-cloud h3',function(){
var el = jQuery(this);
el.toggleClass('active');
el.next().slideToggle();
})
.on('click','.image-expand img', function(){
$(this).clone().appendTo('#mod-content');
$('#fade,#modal,#close-modal').fadeIn();
$('body,html').addClass('no-scroll');
})
.on('click','#fade,#close-modal', function(){
$('#fade,#modal,#close-modal').fadeOut();
$('body,html').removeClass('no-scroll');
$('#mod-content').html('');
});
});
</script>
</html>