<!-- 
RSS generated by JIRA (9.7.1#970001-sha1:2222b88b221c4928ef0de3161136cc90c8356a66) at Thu Feb 08 08:04:06 UTC 2024

It is possible to restrict the fields that are returned in this document by specifying the 'field' parameter in your request.
For example, to request only the issue key and summary append 'field=key&field=summary' to the URL of your request.
-->
<rss version="0.92" >
<channel>
    <title>MongoDB Jira</title>
    <link>https://jira.mongodb.org</link>
    <description>This file is an XML representation of an issue</description>
    <language>en-us</language>    <build-info>
        <version>9.7.1</version>
        <build-number>970001</build-number>
        <build-date>13-04-2023</build-date>
    </build-info>


<item>
            <title>[DOCS-11982] Docs for SERVER-36528: Implement $planCacheStats aggregation metadata source</title>
                <link>https://jira.mongodb.org/browse/DOCS-11982</link>
                <project id="10380" key="DOCS">Documentation</project>
                    <description>&lt;p&gt;----------------------------&lt;/p&gt;
&lt;h2&gt;&lt;a name=&quot;OriginalDescription&quot;&gt;&lt;/a&gt;Original Description&lt;/h2&gt;

&lt;div class=&quot;panel&quot; style=&quot;background-color: #cccccc;border-style: dashed;border-width: 1px;&quot;&gt;&lt;/div&gt;
&lt;h3&gt;&lt;a name=&quot;Description%3A&quot;&gt;&lt;/a&gt;Description: &lt;/h3&gt;

&lt;p&gt;This is a new aggregation stage which needs to be documented in the manual.  The details are available in the scope for this project: &lt;a href=&quot;https://docs.google.com/document/d/1imZ9_BNJUEbBupGEg0JuMDSwHdGkCM8br85CDEkJYqU/edit&quot; class=&quot;external-link&quot; target=&quot;_blank&quot; rel=&quot;nofollow noopener&quot;&gt;https://docs.google.com/document/d/1imZ9_BNJUEbBupGEg0JuMDSwHdGkCM8br85CDEkJYqU/edit&lt;/a&gt;. Either Storch or Ian Boros are available for questions and to review any docs changes.&lt;/p&gt;

&lt;p&gt;{$planCacheStats: {}} can be added at the beginning of an aggregation pipeline. The resulting cursor will return one document per plan cache entry for the collection over which the aggregation is issued. The format in which the plan cache entry is represented differs from that of the &apos;planCacheListPlans&apos; command, but the information available is similar. This is useful for debugging/diagnosis when the plan cache is suspected as involved in a query performance issue.&lt;/p&gt;

&lt;p&gt;Users should typically prefer $planCacheStats over the &apos;planCacheListPlans&apos; and &apos;planCacheListQueryShapes&apos; commands. We may want to add a note about this on the docs pages for those commands.&lt;/p&gt;

&lt;p&gt;It may be valuable to show an example in which a $planCacheStats stage with a subsequent $match on &apos;queryHash&apos; is used to lookup information for a particular cache entry.&lt;/p&gt;

&lt;p&gt;If auth is enabled, reading the plan cache requires the &apos;planCacheRead&apos; action type on the collection.&lt;/p&gt;


&lt;p&gt;----------------------------&lt;/p&gt;
&lt;h2&gt;&lt;a name=&quot;Description&quot;&gt;&lt;/a&gt;Description&lt;/h2&gt;

&lt;h2&gt;&lt;a name=&quot;Scopeofchanges%28filesthatneedworkandhowmuch%29&quot;&gt;&lt;/a&gt;Scope of changes (files that need work and how much)&lt;/h2&gt;

&lt;ul&gt;
	&lt;li&gt;4.2.txt&lt;/li&gt;
	&lt;li&gt;planCacheStats&lt;/li&gt;
	&lt;li&gt;query-plans&lt;/li&gt;
	&lt;li&gt;Security: privilege-actions&lt;/li&gt;
	&lt;li&gt;restrictions:
	&lt;ul&gt;
		&lt;li&gt;facets&lt;/li&gt;
		&lt;li&gt;as part of txn operations (txn operations, aggregation command/method)&lt;/li&gt;
		&lt;li&gt;local read concern -&amp;gt; causal consistent session&lt;/li&gt;
	&lt;/ul&gt;
	&lt;/li&gt;
	&lt;li&gt;Preference over existing
	&lt;ul&gt;
		&lt;li&gt;planCacheListPlans/planCacheListQueryShapes/PlanCache.listQueryShapes/PlanCache.getPlansByQuery&lt;/li&gt;
	&lt;/ul&gt;
	&lt;/li&gt;
	&lt;li&gt;Add references to new stage
	&lt;ul&gt;
		&lt;li&gt;explain&lt;/li&gt;
		&lt;li&gt;index-partial&lt;/li&gt;
		&lt;li&gt;measure-index-use&lt;/li&gt;
	&lt;/ul&gt;
	&lt;/li&gt;
&lt;/ul&gt;


&lt;h2&gt;&lt;a name=&quot;Impacttootherdocsoutsideofthisproduct&quot;&gt;&lt;/a&gt;Impact to other docs outside of this product&lt;/h2&gt;

&lt;h2&gt;&lt;a name=&quot;MVP%28workanddate%3F%29&quot;&gt;&lt;/a&gt;MVP (work and date?)&lt;/h2&gt;

&lt;h2&gt;&lt;a name=&quot;Resources%28e.g.ScopeDocs%2CInvision%29&quot;&gt;&lt;/a&gt;Resources (e.g. Scope Docs, Invision)&lt;/h2&gt;</description>
                <environment></environment>
        <key id="592875">DOCS-11982</key>
            <summary>Docs for SERVER-36528: Implement $planCacheStats aggregation metadata source</summary>
                <type id="3" iconUrl="https://jira.mongodb.org/secure/viewavatar?size=xsmall&amp;avatarId=14718&amp;avatarType=issuetype">Task</type>
                                            <priority id="3" iconUrl="https://jira.mongodb.org/images/icons/priorities/major.svg">Major - P3</priority>
                        <status id="6" iconUrl="https://jira.mongodb.org/images/icons/statuses/closed.png" description="The issue is considered finished, the resolution is correct. Issues which are closed can be reopened.">Closed</status>
                    <statusCategory id="3" key="done" colorName="success"/>
                                    <resolution id="13201">Fixed</resolution>
                                        <assignee username="kay.kim@mongodb.com">Kay Kim</assignee>
                                    <reporter username="kay.kim@mongodb.com">Kay Kim</reporter>
                        <labels>
                    </labels>
                <created>Wed, 22 Aug 2018 20:29:30 +0000</created>
                <updated>Mon, 13 Nov 2023 18:32:41 +0000</updated>
                            <resolved>Mon, 11 Feb 2019 13:06:06 +0000</resolved>
                                                    <fixVersion>4.1.3</fixVersion>
                    <fixVersion>Server_Docs_20231030</fixVersion>
                    <fixVersion>Server_Docs_20231106</fixVersion>
                    <fixVersion>Server_Docs_20231105</fixVersion>
                    <fixVersion>Server_Docs_20231113</fixVersion>
                                    <component>manual</component>
                        <due></due>
                            <votes>0</votes>
                                    <watches>2</watches>
                                                                                                                <comments>
                            <comment id="2144032" author="xgen-internal-githook" created="Mon, 11 Feb 2019 13:05:35 +0000"  >&lt;p&gt;Author:&lt;/p&gt;
{&apos;name&apos;: &apos;Kay Kim&apos;, &apos;email&apos;: &apos;kay.kim@mongodb.com&apos;}
&lt;p&gt;Message: &lt;a href=&quot;https://jira.mongodb.org/browse/DOCS-11982&quot; title=&quot;Docs for SERVER-36528: Implement $planCacheStats aggregation metadata source&quot; class=&quot;issue-link&quot; data-issue-key=&quot;DOCS-11982&quot;&gt;&lt;del&gt;DOCS-11982&lt;/del&gt;&lt;/a&gt;: planCacheStats agg stage&lt;br/&gt;
Branch: master&lt;br/&gt;
&lt;a href=&quot;https://github.com/mongodb/docs/commit/5c21d4c0bd7a616d2ee739787f17533078818e15&quot; class=&quot;external-link&quot; target=&quot;_blank&quot; rel=&quot;nofollow noopener&quot;&gt;https://github.com/mongodb/docs/commit/5c21d4c0bd7a616d2ee739787f17533078818e15&lt;/a&gt;&lt;/p&gt;</comment>
                    </comments>
                <issuelinks>
                            <issuelinktype id="10320">
                    <name>Documented</name>
                                            <outwardlinks description="documents">
                                        <issuelink>
            <issuekey id="585520">SERVER-36528</issuekey>
        </issuelink>
                            </outwardlinks>
                                                        </issuelinktype>
                            <issuelinktype id="10010">
                    <name>Duplicate</name>
                                                                <inwardlinks description="is duplicated by">
                                                        </inwardlinks>
                                    </issuelinktype>
                            <issuelinktype id="10012">
                    <name>Related</name>
                                            <outwardlinks description="related to">
                                        <issuelink>
            <issuekey id="676738">DOCS-12387</issuekey>
        </issuelink>
                            </outwardlinks>
                                                                <inwardlinks description="is related to">
                                        <issuelink>
            <issuekey id="587606">DOCS-11959</issuekey>
        </issuelink>
            <issuelink>
            <issuekey id="587610">DOCS-11962</issuekey>
        </issuelink>
            <issuelink>
            <issuekey id="587613">DOCS-11965</issuekey>
        </issuelink>
                            </inwardlinks>
                                    </issuelinktype>
                    </issuelinks>
                <attachments>
                    </attachments>
                <subtasks>
                    </subtasks>
                <customfields>
                                                <customfield id="customfield_10050" key="com.atlassian.jira.toolkit:comments">
                        <customfieldname># Replies</customfieldname>
                        <customfieldvalues>
                            <customfieldvalue>1.0</customfieldvalue>
                        </customfieldvalues>
                    </customfield>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        <customfield id="customfield_10055" key="com.atlassian.jira.ext.charting:firstresponsedate">
                        <customfieldname>Date of 1st Reply</customfieldname>
                        <customfieldvalues>
                            <customfieldvalue>Mon, 11 Feb 2019 13:05:35 +0000</customfieldvalue>

                        </customfieldvalues>
                    </customfield>
                                                                <customfield id="customfield_10052" key="com.atlassian.jira.toolkit:dayslastcommented">
                        <customfieldname>Days since reply</customfieldname>
                        <customfieldvalues>
                                        5 years, 2 days ago
    
                        </customfieldvalues>
                    </customfield>
                                                                <customfield id="customfield_18254" key="com.onresolve.jira.groovy.groovyrunner:scripted-field">
                        <customfieldname>Dependencies</customfieldname>
                        <customfieldvalues>
                            <customfieldvalue><![CDATA[]]></customfieldvalue>


                        </customfieldvalues>
                    </customfield>
                                                                <customfield id="customfield_15850" key="com.atlassian.jira.plugins.jira-development-integration-plugin:devsummary">
                        <customfieldname>Development</customfieldname>
                        <customfieldvalues>
                            
                        </customfieldvalues>
                    </customfield>
                                                                                                                                                                                                            <customfield id="customfield_10857" key="com.pyxis.greenhopper.jira:gh-epic-link">
                        <customfieldname>Epic Link</customfieldname>
                        <customfieldvalues>
                            <customfieldvalue>DOCS-11762</customfieldvalue>
                        </customfieldvalues>
                    </customfield>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            <customfield id="customfield_10057" key="com.atlassian.jira.toolkit:lastusercommented">
                        <customfieldname>Last comment by Customer</customfieldname>
                        <customfieldvalues>
                            <customfieldvalue>true</customfieldvalue>
                        </customfieldvalues>
                    </customfield>
                                                                <customfield id="customfield_10056" key="com.atlassian.jira.toolkit:lastupdaterorcommenter">
                        <customfieldname>Last commenter</customfieldname>
                        <customfieldvalues>
                            <customfieldvalue>emet.ozar@mongodb.com</customfieldvalue>

                        </customfieldvalues>
                    </customfield>
                                                                <customfield id="customfield_11151" key="com.atlassian.jira.toolkit:LastCommentDate">
                        <customfieldname>Last public comment date</customfieldname>
                        <customfieldvalues>
                            5 years, 2 days ago
                        </customfieldvalues>
                    </customfield>
                                                                                                                                                                                                            <customfield id="customfield_10051" key="com.atlassian.jira.toolkit:participants">
                        <customfieldname>Participants</customfieldname>
                        <customfieldvalues>
                                        <customfieldvalue>xgen-internal-githook</customfieldvalue>
            <customfieldvalue>kay.kim@mongodb.com</customfieldvalue>
    
                        </customfieldvalues>
                    </customfield>
                                                                                                                                                                                                                                        <customfield id="customfield_14254" key="com.pyxis.greenhopper.jira:gh-lexo-rank">
                        <customfieldname>Product Rank</customfieldname>
                        <customfieldvalues>
                            <customfieldvalue>1|hu66o7:</customfieldvalue>

                        </customfieldvalues>
                    </customfield>
                                                                                                                                                                                <customfield id="customfield_12550" key="com.pyxis.greenhopper.jira:gh-lexo-rank">
                        <customfieldname>Rank</customfieldname>
                        <customfieldvalues>
                            <customfieldvalue>2|htwqw7:</customfieldvalue>

                        </customfieldvalues>
                    </customfield>
                                                                <customfield id="customfield_10558" key="com.pyxis.greenhopper.jira:gh-global-rank">
                        <customfieldname>Rank (Obsolete)</customfieldname>
                        <customfieldvalues>
                            <customfieldvalue>9223372036854775807</customfieldvalue>
                        </customfieldvalues>
                    </customfield>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    <customfield id="customfield_10053" key="com.atlassian.jira.ext.charting:timeinstatus">
                        <customfieldname>Time In Status</customfieldname>
                        <customfieldvalues>
                            
                        </customfieldvalues>
                    </customfield>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            <customfield id="customfield_14350" key="com.pyxis.greenhopper.jira:gh-lexo-rank">
                        <customfieldname>serverRank</customfieldname>
                        <customfieldvalues>
                            <customfieldvalue>1|hu5sxj:</customfieldvalue>

                        </customfieldvalues>
                    </customfield>
                                                                </customfields>
    </item>
</channel>
</rss>