| <div role="region" aria-label="Skip to main content"><a class="skipToContent_fXgn" href="#docusaurus_skipToContent_fallback">Skip to main content</a></div><nav aria-label="Main" class="navbar navbar--fixed-top"><div class="navbar__inner"><div class="navbar__items"><button aria-label="Toggle navigation bar" aria-expanded="false" class="navbar__toggle clean-btn" type="button"><svg width="30" height="30" viewBox="0 0 30 30" aria-hidden="true"><path stroke="currentColor" stroke-linecap="round" stroke-miterlimit="10" stroke-width="2" d="M4 7h22M4 15h22M4 23h22"></path></svg></button><a class="navbar__brand" href="/"><div class="navbar__logo"><img src="/img/bk-logo.svg" alt="Apache Bookkeeper" class="themedImage_ToTc themedImage--light_HNdA"><img src="/img/bk-logo.svg" alt="Apache Bookkeeper" class="themedImage_ToTc themedImage--dark_i4oU"></div><b class="navbar__title text--truncate">Apache BookKeeper</b></a><a class="navbar__item navbar__link" href="/docs/overview/">Documentation</a><div class="navbar__item dropdown dropdown--hoverable"><a href="#" aria-haspopup="true" aria-expanded="false" role="button" class="navbar__link">Community</a><ul class="dropdown__menu"><li><a class="dropdown__link" href="/community/mailing-lists">Mailing lists</a></li><li><a class="dropdown__link" href="/community/slack">Slack</a></li><li><a href="https://github.com/apache/bookkeeper/issues" target="_blank" rel="noopener noreferrer" class="dropdown__link">Github issues<svg width="12" height="12" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_nPIU"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg></a></li><li><a class="dropdown__link" href="/community/releases">Release management</a></li><li><a class="dropdown__link" href="/community/meeting">Community meetings</a></li><li><a class="dropdown__link" href="/community/contributing">Contribution guide</a></li><li><a class="dropdown__link" href="/community/coding-guide">Coding guide</a></li><li><a class="dropdown__link" href="/community/testing">Testing guide</a></li><li><a aria-current="page" class="dropdown__link dropdown__link--active" href="/community/issue-report">Issue report guide</a></li><li><a class="dropdown__link" href="/community/release-guide">Release guide</a></li><li><a class="dropdown__link" href="/community/presentations">Presentations</a></li><li><a class="dropdown__link" href="/community/bookkeeper-proposals">BookKeeper proposals (BP)</a></li></ul></div><div class="navbar__item dropdown dropdown--hoverable"><a href="#" aria-haspopup="true" aria-expanded="false" role="button" class="navbar__link">Project</a><ul class="dropdown__menu"><li><a class="dropdown__link" href="/project/who">Who are we?</a></li><li><a class="dropdown__link" href="/project/bylaws">Bylaws</a></li><li><a href="https://apache.org/licenses" target="_blank" rel="noopener noreferrer" class="dropdown__link">License<svg width="12" height="12" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_nPIU"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg></a></li><li><a class="dropdown__link" href="/project/privacy">Privacy policy</a></li><li><a href="https://www.apache.org/foundation/sponsorship.html" target="_blank" rel="noopener noreferrer" class="dropdown__link">Sponsorship<svg width="12" height="12" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_nPIU"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg></a></li><li><a href="https://www.apache.org/foundation/thanks.html" target="_blank" rel="noopener noreferrer" class="dropdown__link">Thanks<svg width="12" height="12" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_nPIU"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg></a></li></ul></div></div><div class="navbar__items navbar__items--right"><div class="navbar__item dropdown dropdown--hoverable dropdown--right"><a class="navbar__link" aria-haspopup="true" aria-expanded="false" role="button" href="/docs/overview/">4.16.5</a><ul class="dropdown__menu"><li><a class="dropdown__link" href="/docs/next/overview/">Next</a></li><li><a class="dropdown__link" href="/docs/overview/">4.16.5</a></li><li><a class="dropdown__link" href="/docs/4.15.5/overview/">4.15.5</a></li><li><a class="dropdown__link" href="/docs/4.14.8/overview/">4.14.8</a></li><li><a class="dropdown__link" href="/docs/4.13.0/overview/">4.13.0</a></li><li><a class="dropdown__link" href="/docs/4.12.1/overview/">4.12.1</a></li><li><a class="dropdown__link" href="/docs/4.11.1/overview/">4.11.1</a></li><li><a class="dropdown__link" href="/docs/4.10.0/overview/">4.10.0</a></li><li><a class="dropdown__link" href="/docs/4.9.2/overview/">4.9.2</a></li><li><a class="dropdown__link" href="/docs/4.8.2/overview/">4.8.2</a></li><li><a class="dropdown__link" href="/docs/4.7.3/overview/">4.7.3</a></li><li><a class="dropdown__link" href="/docs/4.6.2/overview/">4.6.2</a></li><li><a class="dropdown__link" href="/docs/4.5.1/overview/">4.5.1</a></li></ul></div><a class="navbar__item navbar__link" href="/releases">Download</a><div class="toggle_vylO colorModeToggle_DEke"><button class="clean-btn toggleButton_gllP toggleButtonDisabled_aARS" type="button" disabled="" title="Switch between dark and light mode (currently light mode)" aria-label="Switch between dark and light mode (currently light mode)" aria-live="polite"><svg viewBox="0 0 24 24" width="24" height="24" class="lightToggleIcon_pyhR"><path fill="currentColor" d="M12,9c1.65,0,3,1.35,3,3s-1.35,3-3,3s-3-1.35-3-3S10.35,9,12,9 M12,7c-2.76,0-5,2.24-5,5s2.24,5,5,5s5-2.24,5-5 S14.76,7,12,7L12,7z M2,13l2,0c0.55,0,1-0.45,1-1s-0.45-1-1-1l-2,0c-0.55,0-1,0.45-1,1S1.45,13,2,13z M20,13l2,0c0.55,0,1-0.45,1-1 s-0.45-1-1-1l-2,0c-0.55,0-1,0.45-1,1S19.45,13,20,13z M11,2v2c0,0.55,0.45,1,1,1s1-0.45,1-1V2c0-0.55-0.45-1-1-1S11,1.45,11,2z M11,20v2c0,0.55,0.45,1,1,1s1-0.45,1-1v-2c0-0.55-0.45-1-1-1C11.45,19,11,19.45,11,20z M5.99,4.58c-0.39-0.39-1.03-0.39-1.41,0 c-0.39,0.39-0.39,1.03,0,1.41l1.06,1.06c0.39,0.39,1.03,0.39,1.41,0s0.39-1.03,0-1.41L5.99,4.58z M18.36,16.95 c-0.39-0.39-1.03-0.39-1.41,0c-0.39,0.39-0.39,1.03,0,1.41l1.06,1.06c0.39,0.39,1.03,0.39,1.41,0c0.39-0.39,0.39-1.03,0-1.41 L18.36,16.95z M19.42,5.99c0.39-0.39,0.39-1.03,0-1.41c-0.39-0.39-1.03-0.39-1.41,0l-1.06,1.06c-0.39,0.39-0.39,1.03,0,1.41 s1.03,0.39,1.41,0L19.42,5.99z M7.05,18.36c0.39-0.39,0.39-1.03,0-1.41c-0.39-0.39-1.03-0.39-1.41,0l-1.06,1.06 c-0.39,0.39-0.39,1.03,0,1.41s1.03,0.39,1.41,0L7.05,18.36z"></path></svg><svg viewBox="0 0 24 24" width="24" height="24" class="darkToggleIcon_wfgR"><path fill="currentColor" d="M9.37,5.51C9.19,6.15,9.1,6.82,9.1,7.5c0,4.08,3.32,7.4,7.4,7.4c0.68,0,1.35-0.09,1.99-0.27C17.45,17.19,14.93,19,12,19 c-3.86,0-7-3.14-7-7C5,9.07,6.81,6.55,9.37,5.51z M12,3c-4.97,0-9,4.03-9,9s4.03,9,9,9s9-4.03,9-9c0-0.46-0.04-0.92-0.1-1.36 c-0.98,1.37-2.58,2.26-4.4,2.26c-2.98,0-5.4-2.42-5.4-5.4c0-1.81,0.89-3.42,2.26-4.4C12.92,3.04,12.46,3,12,3L12,3z"></path></svg></button></div><div class="searchBox_ZlJk"></div></div></div><div role="presentation" class="navbar-sidebar__backdrop"></div></nav><div id="docusaurus_skipToContent_fallback" class="main-wrapper mainWrapper_z2l0"><main class="container container--fluid margin-vert--lg"><div class="row mdxPageWrapper_j9I6"><div class="col col--8"><article><h1>Issue report</h1><p>To report an issue, you will need to create a <strong><a href="https://github.com/apache/bookkeeper/issues/new" target="_blank" rel="noopener noreferrer">New Issue</a></strong>. |
| Be aware that resolving your issue may require <strong>your participation</strong>. Please be willing and prepared to aid the developers in finding the actual cause of the issue so that they can develop a comprehensive solution.</p><h2 class="anchor anchorWithStickyNavbar_LWe7" id="before-creating-a-new-issue">Before creating a new Issue:<a href="#before-creating-a-new-issue" class="hash-link" aria-label="Direct link to Before creating a new Issue:" title="Direct link to Before creating a new Issue:"></a></h2><ul><li>Search for the issue you want to report, it may already have been reported.</li><li>If you find a similar issue, add any new information you might have as a comment on the existing issue. If it's different enough, you might decide it needs to be reported in a new issue.</li><li>If an issue you recently reported was closed, and you don't agree with the reasoning for it being closed, you will need to reopen it to let us re-investigate the issue.</li><li>Do not reopen the tickets that are in a previously completed milestone. Instead, open a new issue.</li></ul><h2 class="anchor anchorWithStickyNavbar_LWe7" id="creating-a-issue">Creating a Issue:<a href="#creating-a-issue" class="hash-link" aria-label="Direct link to Creating a Issue:" title="Direct link to Creating a Issue:"></a></h2><p>Here is an very useful artical <a href="http://www.chiark.greenend.org.uk/%7Esgtatham/bugs.html" target="_blank" rel="noopener noreferrer">How to report bugs effectively</a></p><h3 class="anchor anchorWithStickyNavbar_LWe7" id="provide-useful-and-required-information">Provide useful and required information<a href="#provide-useful-and-required-information" class="hash-link" aria-label="Direct link to Provide useful and required information" title="Direct link to Provide useful and required information"></a></h3><h4 class="anchor anchorWithStickyNavbar_LWe7" id="if-it-is-a-question">If it is a question<a href="#if-it-is-a-question" class="hash-link" aria-label="Direct link to If it is a question" title="Direct link to If it is a question"></a></h4><ul><li>Please check our <a href="https://bookkeeper.apache.org/docs/next/overview/" target="_blank" rel="noopener noreferrer">documentation</a> first. </li><li>If you could not find an answer there, please consider asking your question in our community mailing list at <a href="mailto:dev@bookkeeper.apache.org" target="_blank" rel="noopener noreferrer">dev@bookkeeper.apache.org</a>, or reach out us on our <a href="/community/slack">Slack channel</a>. It would benefit other members of our community.</li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="if-it-is-a-feature-request">If it is a <strong>FEATURE REQUEST</strong><a href="#if-it-is-a-feature-request" class="hash-link" aria-label="Direct link to if-it-is-a-feature-request" title="Direct link to if-it-is-a-feature-request"></a></h4><ul><li>Please describe the feature you are requesting.</li><li>Indicate the importance of this issue to you (<em>blocker</em>, <em>must-have</em>, <em>should-have</em>, <em>nice-to-have</em>). Are you currently using any workarounds to address this issue?</li><li>Provide any additional detail on your proposed use case for this feature.</li><li>If it is a <a href="https://bookkeeper.apache.org/community/bookkeeper-proposals/" target="_blank" rel="noopener noreferrer">BookKeeper Proposal</a>, please label this issue as <code>BP</code>.</li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="if-it-is-a-bug-report">If it is a <strong>BUG REPORT</strong><a href="#if-it-is-a-bug-report" class="hash-link" aria-label="Direct link to if-it-is-a-bug-report" title="Direct link to if-it-is-a-bug-report"></a></h4><p>Please describe the issue you observed:</p><ul><li>What did you do?</li><li>What did you expect to see?</li><li>What did you see instead?</li></ul><h3 class="anchor anchorWithStickyNavbar_LWe7" id="use-labels">Use Labels<a href="#use-labels" class="hash-link" aria-label="Direct link to Use Labels" title="Direct link to Use Labels"></a></h3><p>Issue labels help to find issue reports and recognize the status of where an issue is in the lifecycle. An issue typically has the following 2 types of labels:</p><ol><li><strong>type</strong> identifying its type.</li><li><strong>area</strong> identifying the areas it belongs to.</li></ol><h4 class="anchor anchorWithStickyNavbar_LWe7" id="type">Type<a href="#type" class="hash-link" aria-label="Direct link to Type" title="Direct link to Type"></a></h4><ul><li><strong>type/bug</strong>: The issue describes a product defect.</li><li><strong>type/feature</strong>: The issue describes a new feature, which requires extensive design and testing.</li><li><strong>type/question</strong>: The issue contains a user or contributor question requiring a response.</li><li><strong>type/task</strong>: The issue describes a new task, which requires extensive design and testing.</li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="area">Area<a href="#area" class="hash-link" aria-label="Direct link to Area" title="Direct link to Area"></a></h4><ul><li><strong>area/bookie</strong>: Code changes related to bookie storage.</li><li><strong>area/build</strong>: Code changes related to project build.</li><li><strong>area/client</strong>: Code changes related to clients.</li><li><strong>area/docker</strong>: Code changes related to docker builds.</li><li><strong>area/documentation</strong>: Code changes related to documentation (including website changes).</li><li><strong>area/metadata</strong>: Code changes related to metadata management.</li><li><strong>area/protocol</strong>: Protocol changes.</li><li><strong>area/release</strong>: Release related tasks.</li><li><strong>area/security</strong>: Security related changes.</li><li><strong>area/tests</strong>: Tests related changes.</li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="priority">Priority<a href="#priority" class="hash-link" aria-label="Direct link to Priority" title="Direct link to Priority"></a></h4><p>At most of the time, it is hard to find a right <code>priority</code> for issues. Currently we only have one label <code>priority/blocker</code> for marking an issue as a blocker |
