workload_mgmt_resgroups.xml 59.5 KB
Newer Older
1 2 3 4 5 6
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE topic
  PUBLIC "-//OASIS//DTD DITA Composite//EN" "ditabase.dtd">
<topic id="topic1" xml:lang="en">
  <title id="iz173472">Using Resource Groups</title>
  <body>
7 8 9 10 11 12 13 14 15 16 17 18 19 20
    <p>You use resource groups to set and enforce CPU, memory, and concurrent transaction limits in
      Greenplum Database. After you define a resource group, you can then assign the group to one or
      more Greenplum Database roles, or to an external component such as PL/Container, in order to
      control the resources used by those roles or components.</p>
    <p>When you assign a resource group to a role (a role-based resource group), the resource limits
      that you define for the group apply to all of the roles to which you assign the group. For
      example, the memory limit for a resource group identifies the maximum memory usage for all
      running transactions submitted by Greenplum Database users in all roles to which you assign
      the group.</p>
    <p>Similarly, when you assign a resource group to an external component, the group limits apply
      to all running instances of the component. For example, if you create a resource group for a
      PL/Container external component, the memory limit that you define for the group specifies the
      maximum memory usage for all running instances of each PL/Container runtime to which you
      assign the group.</p>
21

22 23 24 25 26
    <p>This topic includes the following subtopics:</p>
    <ul id="ul_wjf_1wy_sp">
      <li id="im168064">
        <xref href="#topic8339intro" type="topic" format="dita"/>
      </li>
27 28
      <li id="im168064x">
        <xref href="#topic8339introattrlim" type="topic" format="dita"/><ul>
29 30 31 32 33 34 35 36 37 38 39 40 41
          <li id="im16806az">
            <xref href="#topic8339777" type="topic" format="dita"/>
          </li>
          <li id="im16806a">
            <xref href="#topic8339717179" type="topic" format="dita"/>
          </li>
          <li id="im16806b">
            <xref href="#topic833971717" type="topic" format="dita"/>
          </li>
          <li id="im16806c">
            <xref href="#topic8339717" type="topic" format="dita"/>
          </li>
        </ul></li>
42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58
      <li id="im16806d">
        <xref href="#topic71717999" type="topic" format="dita"/>
        <ul id="ul_wjf_1wy_spXX">
          <li id="im16806e">
            <xref href="#topic8" type="topic" format="dita"/>
          </li>
          <li id="im16806f">
            <xref href="#topic10" type="topic" format="dita"/>
          </li>
          <li id="im16806g">
            <xref href="#topic17" type="topic" format="dita"/>
          </li>
          <li id="im16806h">
            <xref href="#topic22" type="topic" format="dita"/>
          </li>
        </ul>
      </li>
59
      <li>
60 61
        <xref href="#topic777999" type="topic" format="dita"/>
      </li>
62 63 64
    </ul>
  </body>
  <topic id="topic8339intro" xml:lang="en">
65
    <title>Understanding Role and Component Resource Groups</title>
66
    <body>
67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90
      <p>Greenplum Database supports two types of resource groups: groups that manage resources for
        roles, and groups that manage resources for external components such as PL/Container.</p>
      <p>The most common application for resource groups is to manage the number of active queries
        that different roles may execute concurrently in your Greenplum Database cluster. You can
        also manage the amount of CPU and memory resources that Greenplum allocates to each
        query.</p>
      <p>Resource groups for roles use Linux control groups (cgroups) for CPU resource management.
        Greenplum Database tracks virtual memory internally for these resource groups using a memory
        auditor referred to as <codeph>vmtracker</codeph>.</p>
      <p>When the user executes a query, Greenplum Database evaluates the query against a set of
        limits defined for the resource group. Greenplum Database executes the query immediately if
        the group's resource limits have not yet been reached and the query does not cause the group
        to exceed the concurrent transaction limit. If these conditions are not met, Greenplum
        Database queues the query. For example, if the maximum number of concurrent transactions for
        the resource group has already been reached, a subsequent query is queued and must wait
        until other queries complete before it runs. Greenplum Database may also execute a pending
        query when the resource group's concurrency and memory limits are altered to large enough
        values.</p>
      <p>Within a resource group for roles, transactions are evaluated on a first in, first out
        basis. Greenplum Database periodically assesses the active workload of the system,
        reallocating resources and starting/queuing jobs as necessary.</p>
      <p>You can also use resource groups to manage the CPU and memory resources of external
        components such as PL/Container. Resource groups for external components use Linux cgroups
        to manage both the total CPU and total memory resources for the component.</p>
91 92 93 94 95 96
    </body>
  </topic>

  <topic id="topic8339introattrlim" xml:lang="en">
    <title>Resource Group Attributes and Limits</title>
    <body>
97 98 99 100 101 102 103
      <p>When you create a resource group, you:</p>
      <ul>
        <li>Specify the type of resource group by identifying how memory for the group is
          audited.</li>
        <li>Provide a set of limits that determine the amount of CPU and memory resources available
          to the group.</li>
      </ul>
104

105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157
      <p>Resource group attributes and limits:</p>
      <table id="resgroup_limit_descriptions">
        <tgroup cols="3">
          <colspec colnum="1" colname="col1" colwidth="1*"/>
          <colspec colnum="2" colname="col2" colwidth="1*"/>
          <thead>
            <row>
              <entry colname="col1">Limit Type</entry>
              <entry colname="col2">Description</entry>
            </row>
          </thead>
          <tbody>
            <row>
              <entry colname="col1">MEMORY_AUDITOR</entry>
              <entry colname="col2">The memory auditor in use for the resource group.
                  <codeph>vmtracker</codeph> (the default) is required if you want to assign the
                resource group to roles. Specify <codeph>cgroup</codeph> to assign the resource
                group to an external component.</entry>
            </row>
            <row>
              <entry colname="col1">CONCURRENCY</entry>
              <entry colname="col2">The maximum number of concurrent transactions, including active
                and idle transactions, that are permitted in the resource group.</entry>
            </row>
            <row>
              <entry colname="col1">CPU_RATE_LIMIT</entry>
              <entry colname="col2">The percentage of CPU resources available to this resource
                group.</entry>
            </row>
            <row>
              <entry colname="col1">CPUSET</entry>
              <entry colname="col2">The CPU cores to reserve for this resource group.</entry>
            </row>
            <row>
              <entry colname="col1">MEMORY_LIMIT</entry>
              <entry colname="col2">The percentage of memory resources available to this resource
                group.</entry>
            </row>
            <row>
              <entry colname="col1">MEMORY_SHARED_QUOTA</entry>
              <entry colname="col2">The percentage of memory to share across transactions submitted
                in this resource group.</entry>
            </row>
            <row>
              <entry colname="col1">MEMORY_SPILL_RATIO</entry>
              <entry colname="col2">The memory usage threshold for memory-intensive transactions.
                When a transaction reaches this threshold, it spills to disk.</entry>
            </row>
          </tbody>
        </tgroup>
      </table>
      <note>Resource limits are not enforced on <codeph>SET</codeph>, <codeph>RESET</codeph>, and
          <codeph>SHOW</codeph> commands.</note>
158 159
    </body>
  </topic>
160

161 162 163
  <topic id="topic8339777" xml:lang="en">
    <title>Memory Auditor</title>
    <body>
164 165 166 167 168 169
      <p>The <codeph>MEMORY_AUDITOR</codeph> attribute specifies the type of resource group by
        identifying the memory auditor for the group. A resource group that specifies the
          <codeph>vmtracker</codeph>
        <codeph>MEMORY_AUDITOR</codeph> identifies a resource group for roles. A resource group
        specifying the <codeph>cgroup</codeph>
        <codeph>MEMORY_AUDITOR</codeph> identifies a resource group for external components.</p>
170
      <p>The default <codeph>MEMORY_AUDITOR</codeph> is <codeph>vmtracker</codeph>.</p>
171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218
      <p>The <codeph>MEMORY_AUDITOR</codeph> that you specify for a resource group determines if and
        how Greenplum Database uses the limit attributes to manage CPU and memory resources:</p>
      <table id="resgroup_limit_descriptions">
        <tgroup cols="3">
          <colspec colnum="1" colname="col1" colwidth="1*"/>
          <colspec colnum="2" colname="col2" colwidth="1*"/>
          <colspec colnum="3" colname="col3" colwidth="1*"/>
          <thead>
            <row>
              <entry colname="col1">Limit Type</entry>
              <entry colname="col2">Resource Group for Roles</entry>
              <entry colname="col3">Resource Group for External Components</entry>
            </row>
          </thead>
          <tbody>
            <row>
              <entry colname="col1">CONCURRENCY</entry>
              <entry colname="col2">Yes</entry>
              <entry colname="col3">No; must be zero (0)</entry>
            </row>
            <row>
              <entry colname="col1">CPU_RATE_LIMIT</entry>
              <entry colname="col2">Yes</entry>
              <entry colname="col3">Yes</entry>
            </row>
            <row>
              <entry colname="col1">CPUSET</entry>
              <entry colname="col2">Yes</entry>
              <entry colname="col3">Yes</entry>
            </row>
            <row>
              <entry colname="col1">MEMORY_LIMIT</entry>
              <entry colname="col2">Yes</entry>
              <entry colname="col3">Yes</entry>
            </row>
            <row>
              <entry colname="col1">MEMORY_SHARED_QUOTA</entry>
              <entry colname="col2">Yes</entry>
              <entry colname="col2">Component-specific</entry>
            </row>
            <row>
              <entry colname="col1">MEMORY_SPILL_RATIO</entry>
              <entry colname="col2">Yes</entry>
              <entry colname="col2">Component-specific</entry>
            </row>
          </tbody>
        </tgroup>
      </table>
219 220 221
    </body>
  </topic>

222 223 224
  <topic id="topic8339717179" xml:lang="en">
    <title>Transaction Concurrency Limit</title>
    <body>
225
      <p>The <codeph>CONCURRENCY</codeph> limit controls the maximum number of concurrent
226 227 228 229 230 231 232 233
        transactions permitted for a resource group for roles. <note>The
            <codeph>CONCURRENCY</codeph> limit is not applicable to resource groups for external
          components and must be set to zero (0) for such groups.</note></p>
      <p>Each resource group for roles is logically divided into a fixed number of slots equal to
        the <codeph>CONCURRENCY</codeph> limit. Greenplum Database allocates these slots an equal,
        fixed percentage of memory resources.</p>
      <p>The default <codeph>CONCURRENCY</codeph> limit value for a resource group for roles is
        20.</p>
234 235 236 237
      <p>Greenplum Database queues any transactions submitted after the resource group reaches its
          <codeph>CONCURRENCY</codeph> limit. When a running transaction completes, Greenplum
        Database un-queues and executes the earliest queued transaction if sufficient memory
        resources exist.</p>
238 239 240 241
    </body>
  </topic>

  <topic id="topic833971717" xml:lang="en">
242
    <title>CPU Limits</title>
243
    <body>
244 245 246 247 248 249 250 251 252
      <p>You configure the share of CPU resources to reserve for a resource group on a segment host
        by assigning specific CPU core(s) to the group, or by identifying the percentage of segment
        CPU resources to allocate to the group. Greenplum Database uses the <codeph>CPUSET</codeph>
        and <codeph>CPU_RATE_LIMIT</codeph> resource group limits to identify the CPU resource
        allocation mode. You must specify only one of these limits when you configure a resource
        group.</p>
      <p>You may employ both modes of CPU resource allocation simultaneously in your Greenplum
        Database cluster. You may also change the CPU resource allocation mode for a resource group
        at runtime.</p>
253
      <p>The <codeph><xref
254 255 256 257 258 259 260
            href="../ref_guide/config_params/guc-list.xml#gp_resource_group_cpu_limit" type="topic"
          /></codeph> server configuration parameter identifies the maximum percentage of system CPU
        resources to allocate to resource groups on each Greenplum Database segment host. This limit
        governs the maximum CPU usage of all resource groups on a segment host regardless of the CPU
        allocation mode configured for the group. The remaining unreserved CPU resources are used
        for the OS kernel and the Greenplum Database auxiliary daemon processes. The default
          <codeph>gp_resource_group_cpu_limit</codeph> value is .9 (90%).</p>
261 262 263
      <note>The default <codeph>gp_resource_group_cpu_limit</codeph> value may not leave sufficient
        CPU resources if you are running other workloads on your Greenplum Database cluster nodes,
        so be sure to adjust this server configuration parameter accordingly.</note>
264
      <note type="warning">Avoid setting <codeph>gp_resource_group_cpu_limit</codeph> to a value
265 266
        higher than .9. Doing so may result in high workload queries taking near all CPU resources,
        potentially starving Greenplum Database auxiliary processes.</note>
267 268 269 270 271

    </body>
    <topic id="cpuset" xml:lang="en">
      <title>Assigning CPU Resources by Core</title>
      <body>
272 273 274 275 276 277 278 279 280
        <p>You identify the CPU cores that you want to reserve for a resource group with the
            <codeph>CPUSET</codeph> property. The CPU cores that you specify must be available in
          the system and cannot overlap with any CPU cores that you reserved for other resource
          groups. (Although Greenplum Database uses the cores that you assign to a resource group
          exclusively for that group, note that those CPU cores may also be used by non-Greenplum
          processes in the system.)</p>
        <p>Specify a comma-separated list of single core numbers or number intervals when you
          configure <codeph>CPUSET</codeph>. You must enclose the core numbers/intervals in single
          quotes, for example, '1,3-4'.</p>
281
        <p>When you assign CPU cores to <codeph>CPUSET</codeph> groups, consider the following:<ul>
282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315
            <li>A resource group that you create with <codeph>CPUSET</codeph> uses the specified
              cores exclusively. If there are no running queries in the group, the reserved cores
              are idle and cannot be used by queries in other resource groups. Consider minimizing
              the number of <codeph>CPUSET</codeph> groups to avoid wasting system CPU
              resources.</li>
            <li>Consider keeping CPU core 0 unassigned. CPU core 0 is used as a fallback mechanism
              in the following cases:<ul>
                <li><codeph>admin_group</codeph> and <codeph>default_group</codeph> require at least
                  one CPU core. When all CPU cores are reserved, Greenplum Database assigns CPU core
                  0 to these default groups. In this situation, the resource group to which you
                  assigned CPU core 0 shares the core with <codeph>admin_group</codeph> and
                    <codeph>default_group</codeph>.</li>
                <li>If you restart your Greenplum Database cluster with one node replacement and the
                  node does not have enough cores to service all <codeph>CPUSET</codeph> resource
                  groups, the groups are automatically assigned CPU core 0 to avoid system start
                  failure.</li>
              </ul></li>
            <li>Use the lowest possible core numbers when you assign cores to resource groups. If
              you replace a Greenplum Database node and the new node has fewer CPU cores than the
              original, or if you back up the database and want to restore it on a cluster with
              nodes with fewer CPU cores, the operation may fail. For example, if your Greenplum
              Database cluster has 16 cores, assigning cores 1-7 is optimal. If you create a
              resource group and assign CPU core 9 to this group, database restore to an 8 core node
              will fail.</li>
          </ul></p>
        <p>Resource groups that you configure with <codeph>CPUSET</codeph> have a higher priority on
          CPU resources. The maximum CPU resource usage percentage for all resource groups
          configured with <codeph>CPUSET</codeph> on a segment host is the number of CPU cores
          reserved divided by the number of all CPU cores, multiplied by 100.</p>
        <p>When you configure <codeph>CPUSET</codeph> for a resource group, Greenplum Database
          disables <codeph>CPU_RATE_LIMIT</codeph> for the group and sets the value to -1.</p>
        <note>You must configure <codeph>CPUSET</codeph> for a resource group <i>after</i> you have
          enabled resource group-based resource management for your Greenplum Database
          cluster.</note>
316 317 318 319 320
      </body>
    </topic>
    <topic id="cpu_rate_limit" xml:lang="en">
      <title>Assigning CPU Resources by Percentage</title>
      <body>
321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345
        <p>The Greenplum Database node CPU percentage is divided equally among each segment on the
          Greenplum node. Each resource group that you configure with a
            <codeph>CPU_RATE_LIMIT</codeph> reserves the specified percentage of the segment CPU for
          resource management.</p>
        <p>The minimum <codeph>CPU_RATE_LIMIT</codeph> percentage you can specify for a resource
          group is 1, the maximum is 100.</p>
        <p>The sum of <codeph>CPU_RATE_LIMIT</codeph>s specified for all resource groups that you
          define in your Greenplum Database cluster must not exceed 100.</p>
        <p>The maximum CPU resource usage for all resource groups configured with a
            <codeph>CPU_RATE_LIMIT</codeph> on a segment host is the minimum of:<ul>
            <li>The number of non-reserved CPU cores divided by the number of all CPU cores,
              multiplied by 100, and</li>
            <li>The <codeph>gp_resource_group_cpu_limit</codeph> value.</li>
          </ul></p>
        <p>CPU resource assignment for resource groups configured with a
            <codeph>CPU_RATE_LIMIT</codeph> is elastic in that Greenplum Database may allocate the
          CPU resources of an idle resource group to a busier one(s). In such situations, CPU
          resources are re-allocated to the previously idle resource group when that resource group
          next becomes active. If multiple resource groups are busy, they are allocated the CPU
          resources of any idle resource groups based on the ratio of their
            <codeph>CPU_RATE_LIMIT</codeph>s. For example, a resource group created with a
            <codeph>CPU_RATE_LIMIT</codeph> of 40 will be allocated twice as much extra CPU resource
          as a resource group that you create with a <codeph>CPU_RATE_LIMIT</codeph> of 20.</p>
        <p>When you configure <codeph>CPU_RATE_LIMIT</codeph> for a resource group, Greenplum
          Database disables <codeph>CPUSET</codeph> for the group and sets the value to -1.</p>
346 347
      </body>
    </topic>
348 349 350 351
  </topic>
  <topic id="topic8339717" xml:lang="en">
    <title>Memory Limits</title>
    <body>
352
      <p>When resource groups are enabled, memory usage is managed at the Greenplum Database node,
353 354
        segment, and resource group levels. You can also manage memory at the transaction level with
        a resource group for roles.</p>
355

356 357
      <p>The <codeph><xref
            href="../ref_guide/config_params/guc-list.xml#gp_resource_group_memory_limit"
358 359 360
            type="topic"/></codeph> server configuration parameter identifies the maximum percentage
        of system memory resources to allocate to resource groups on each Greenplum Database segment
        host. The default <codeph>gp_resource_group_memory_limit</codeph> value is .7 (70%).</p>
361
      <p>The memory resource available on a Greenplum Database node is further divided equally among
362 363 364 365 366 367
        each segment on the node. When resource group-based resource management is active, the
        amount of memory allocated to each segment on a segment host is the memory available to
        Greenplum Database multiplied by the <codeph>gp_resource_group_memory_limit</codeph> server
        configuration parameter and divided by the number of active primary segments on the
        host:</p>
      <p><codeblock>
368
rg_perseg_mem = ((RAM * (vm.overcommit_ratio / 100) + SWAP) * gp_resource_group_memory_limit) / num_active_primary_segments</codeblock></p>
369 370 371 372 373 374
      <p>Each resource group reserves a percentage of the segment memory for resource management.
        You identify this percentage via the <codeph>MEMORY_LIMIT</codeph> value that you specify
        when you create the resource group. The minimum <codeph>MEMORY_LIMIT</codeph> percentage you
        can specify for a resource group is 1, the maximum is 100.</p>
      <p>The sum of <codeph>MEMORY_LIMIT</codeph>s specified for all resource groups that you define
        in your Greenplum Database cluster must not exceed 100.</p>
375 376 377 378
    </body>
    <topic id="mem_roles" xml:lang="en">
      <title>Additional Memory Limits for Role-based Resource Groups</title>
      <body>
379 380 381 382 383 384
        <p>The memory reserved by a resource group for roles is further divided into fixed and
          shared components. The <codeph>MEMORY_SHARED_QUOTA</codeph> value that you specify when
          you create the resource group identifies the percentage of reserved resource group memory
          that may be shared among the currently running transactions. This memory is allotted on a
          first-come, first-served basis. A running transaction may use none, some, or all of the
            <codeph>MEMORY_SHARED_QUOTA</codeph>.</p>
385

386 387
        <p>The minimum <codeph>MEMORY_SHARED_QUOTA</codeph> that you can specify is 0, the maximum
          is 100. The default <codeph>MEMORY_SHARED_QUOTA</codeph> is 20.</p>
388

389 390 391 392 393 394 395 396 397 398 399 400 401 402 403
        <p>As mentioned previously, <codeph>CONCURRENCY</codeph> identifies the maximum number of
          concurrently running transactions permitted in a resource group for roles. The fixed
          memory reserved by a resource group is divided into <codeph>CONCURRENCY</codeph> number of
          transaction slots. Each slot is allocated a fixed, equal amount of resource group memory.
          Greenplum Database guarantees this fixed memory to each transaction. <fig
            id="fig_py5_1sl_wlrg">
            <title>Resource Group Memory Allotments</title>
            <image href="graphics/resgroupmem.png" id="image_iqn_dsl_wlrg" align="left" scale="72"
              placement="break"/>
          </fig></p>
        <p>When a query's memory usage exceeds the fixed per-transaction memory usage amount,
          Greenplum Database allocates available resource group shared memory to the query. The
          maximum amount of resource group memory available to a specific transaction slot is the
          sum of the transaction's fixed memory and the full resource group shared memory
          allotment.</p>
404
      </body>
405

406 407
      <topic id="topic833glob" xml:lang="en">
        <title>Global Shared Memory</title>
408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431
        <body>
          <p>The sum of the <codeph>MEMORY_LIMIT</codeph>s configured for all resource groups
            (including the default <codeph>admin_group</codeph> and <codeph>default_group</codeph>
            groups) identifies the percentage of reserved resource group memory. If this sum is less
            than 100, Greenplum Database allocates any unreserved memory to a resource group global
            shared memory pool.</p>
          <p>Resource group global shared memory is available only to resource groups that you
            configure with the <codeph>vmtracker</codeph> memory auditor.</p>
          <p>When available, Greenplum Database allocates global shared memory to a transaction
            after first allocating slot and resource group shared memory. Greenplum Database
            allocates resource group global shared memory to transactions on a first-come
            first-served basis.</p>
          <note>Greenplum Database tracks, but does not actively monitor, transaction memory usage
            in resource groups. If the memory usage for a resource group exceeds its fixed memory
            allotment, a transaction in the resource group fails when <i>all</i> of these conditions
            are met:<ul>
              <li>No available resource group shared memory exists.</li>
              <li>No available global shared memory exists.</li>
              <li>The transaction requests additional memory.</li>
            </ul></note>
          <p>Greenplum Database uses resource group memory more efficiently when you leave some
            memory (for example, 10-20%) unallocated for the global shared memory pool. The
            availability of global shared memory also helps to mitigate the failure of
            memory-consuming or unpredicted queries.</p>
432 433
        </body>
      </topic>
434

435
      <topic id="topic833sp" xml:lang="en">
436
        <title>Query Operator Memory</title>
437
        <body>
438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465
          <p>Most query operators are non-memory-intensive; that is, during processing, Greenplum
            Database can hold their data in allocated memory. When memory-intensive query operators
            such as join and sort process more data than can be held in memory, data is spilled to
            disk.</p>
          <p>The <codeph><xref
                href="../ref_guide/config_params/guc-list.xml#gp_resgroup_memory_policy"
                type="topic"/></codeph> server configuration parameter governs the memory allocation
            and distribution algorithm for all query operators. Greenplum Database supports
              <codeph>eager-free</codeph> (the default) and <codeph>auto</codeph> memory policies
            for resource groups. When you specify the <codeph>auto</codeph> policy, Greenplum
            Database uses resource group memory limits to distribute memory across query operators,
            allocating a fixed size of memory to non-memory-intensive operators and the rest to
            memory-intensive operators. When the <codeph>eager_free</codeph> policy is in place,
            Greenplum Database distributes memory among operators more optimally by re-allocating
            memory released by operators that have completed their processing to operators in a
            later query stage.</p>
          <p><codeph>MEMORY_SPILL_RATIO</codeph> identifies the memory usage threshold for
            memory-intensive operators in a transaction. When this threshold is reached, a
            transaction spills to disk. Greenplum Database uses the
              <codeph>MEMORY_SPILL_RATIO</codeph> to determine the initial memory to allocate to a
            transaction.</p>
          <p> The minimum <codeph>MEMORY_SPILL_RATIO</codeph> percentage that you can specify for a
            resource group is 0. The maximum is 100. The default <codeph>MEMORY_SPILL_RATIO</codeph>
            is 20.</p>
          <p>You define the <codeph>MEMORY_SPILL_RATIO</codeph> when you create a resource group for
            roles. You can selectively set this limit on a per-query basis at the session level with
            the <codeph><xref href="../ref_guide/config_params/guc-list.xml#memory_spill_ratio"
                type="topic"/></codeph> server configuration parameter.</p>
466

467 468 469 470 471 472
          <section id="topic833low" xml:lang="en">
            <title>memory_spill_ratio and Low Memory Queries </title>
            <p>A low <codeph>memory_spill_ratio</codeph> setting (for example, in the 0-2% range)
              has been shown to increase the performance of queries with low memory requirements.
              Use the <codeph>memory_spill_ratio</codeph> server configuration parameter to override
              the setting on a per-query basis. For example:
473
              <codeblock>SET memory_spill_ratio=0;</codeblock></p>
474
          </section>
475 476
        </body>
      </topic>
477 478 479 480 481 482 483 484 485 486 487 488 489
    </topic>

    <topic id="topic833cons" xml:lang="en">
      <title>Other Memory Considerations</title>
      <body>
        <p>Resource groups for roles track all Greenplum Database memory allocated via the
            <codeph>palloc()</codeph> function. Memory that you allocate using the Linux
            <codeph>malloc()</codeph> function is not managed by these resource groups. To ensure
          that resource groups for roles are accurately tracking memory usage, avoid using
            <codeph>malloc()</codeph> to allocate large amounts of memory in custom Greenplum
          Database user-defined functions.</p>
      </body>
    </topic>
490 491 492
  </topic>

  <topic id="topic71717999" xml:lang="en">
493
    <title>Using Resource Groups</title>
494
    <body>
D
David Yozie 已提交
495 496 497
      <note type="important">Significant Greenplum Database performance degradation has been
        observed when enabling resource group-based workload management on RedHat 6.x, CentOS 6.x,
        and SuSE 11 systems. This issue is caused by a Linux cgroup kernel bug. This kernel bug has
498 499 500 501 502 503 504
        been fixed in CentOS 7.x and Red Hat 7.x systems, and on SuSE 12 SP2/SP3 systems with kernel
        version 4.4.73-5.1 or newer. <p>If you use RedHat 6 and the performance with resource groups
          is acceptable for your use case, upgrade your kernel to version 2.6.32-696 or higher to
          benefit from other fixes to the cgroups implementation. </p><p>SuSE 11 does not have a
          kernel version that resolves this issue; resource groups are still considered to be an
          experimental feature on this platform. <ph otherprops="pivotal">Resource groups are not
            supported on SuSE 11 for production use.</ph></p></note>
505 506 507
      <section id="topic833" xml:lang="en">
        <title>Prerequisite</title>
        <p>Greenplum Database resource groups use Linux Control Groups (cgroups) to manage CPU
508 509 510 511
          resources. Greenplum Database also uses cgroups to manage memory for resource groups for
          external components. With cgroups, Greenplum isolates the CPU and external component
          memory usage of your Greenplum processes from other processes on the node. This allows
          Greenplum to support CPU and external component memory usage restrictions on a
512 513 514 515 516
          per-resource-group basis.</p>
        <p>For detailed information about cgroups, refer to the Control Groups documentation for
          your Linux distribution.</p>
        <p>Complete the following tasks on each node in your Greenplum Database cluster to set up
          cgroups for use with resource groups:</p>
517
        <ol>
518
          <li>If you are running the SuSE 11+ operating system on your Greenplum Database cluster
519 520
            nodes, you must enable swap accounting on each node and restart your Greenplum Database
            cluster. The <codeph>swapaccount</codeph> kernel boot parameter governs the swap
521
            accounting setting on SuSE 11+ systems. After setting this boot parameter, you must
522 523
            reboot your systems. For details, refer to the <xref
              href="https://www.suse.com/releasenotes/x86_64/SUSE-SLES/11-SP2/#fate-310471"
524
              format="html" scope="external">Cgroup Swap Control</xref> discussion in the SuSE 11
525 526 527 528 529 530
            release notes. You must be the superuser or have <codeph>sudo</codeph> access to
            configure kernel boot parameters and reboot systems. </li>
          <li>Create the Greenplum Database cgroups configuration file
              <codeph>/etc/cgconfig.d/gpdb.conf</codeph>. You must be the superuser or have
              <codeph>sudo</codeph> access to create this file:
            <codeblock>sudo vi /etc/cgconfig.d/gpdb.conf</codeblock>
531
          </li>
532 533
          <li>Add the following configuration information to
              <codeph>/etc/cgconfig.d/gpdb.conf</codeph>: <codeblock>group gpdb {
534 535 536 537 538 539 540 541 542 543 544 545 546 547
     perm {
         task {
             uid = gpadmin;
             gid = gpadmin;
         }
         admin {
             uid = gpadmin;
             gid = gpadmin;
         }
     }
     cpu {
     }
     cpuacct {
     }
548 549 550 551 552 553 554 555
 } </codeblock>
            <p>This content configures CPU and CPU accounting control groups managed by the
                <codeph>gpadmin</codeph> user.</p>
          </li>
          <li>If you plan to use resource groups to manage PL/Container instances, you must add a
            memory block to the <codeph>gpdb.conf</codeph> file. Be sure to add the block before the
            closing curly-brace
            (<codeph>}</codeph>):<codeblock>     cpuacct {
556
     }
557 558 559 560 561 562 563 564
     <b>memory {
     }</b>
 }</codeblock>
          </li>
          <li>If you plan to assign specific CPU cores to resource groups, you must add a cpuset
            block to the <codeph>gpdb.conf</codeph> file. Be sure to add the block before the
            closing curly-brace
            (<codeph>}</codeph>):<codeblock>     cpuacct {
565
     }
566 567 568
     <b>cpuset {
     }</b>
 }</codeblock>
569
          </li>
570
          <li>If not already installed and running, install the Control Groups operating system
571 572 573
            package and start the cgroups service on each Greenplum Database node. The commands that
            you run to perform these tasks will differ based on the operating system installed on
            the node. You must be the superuser or have <codeph>sudo</codeph> access to run these
574 575 576 577 578 579 580
            commands: <ul>
              <li> Redhat/CentOS 7.x systems:
                <codeblock>sudo yum install libcgroup-tools
sudo cgconfigparser -l /etc/cgconfig.d/gpdb.conf </codeblock>
              </li>
              <li> Redhat/CentOS 6.x systems:
                <codeblock>sudo yum install libcgroup
581
sudo service cgconfig start </codeblock>
582
              </li>
583
              <li> SuSE 11+ systems:
584
                <codeblock>sudo zypper install libcgroup-tools
585
sudo cgconfigparser -l /etc/cgconfig.d/gpdb.conf </codeblock>
586 587
              </li>
            </ul>
588 589
          </li>
          <li>Identify the <codeph>cgroup</codeph> directory mount point for the node:
590 591
              <codeblock>grep cgroup /proc/mounts</codeblock><p>The first line of output identifies
              the <codeph>cgroup</codeph> mount point.</p>
592
          </li>
593
          <li>Verify that you set up the Greenplum Database cgroups configuration correctly by
594 595
            running the following commands. Replace &lt;cgroup_mount_point&gt; with the mount point
            that you identified in the previous step: <codeblock>ls -l &lt;cgroup_mount_point&gt;/cpu/gpdb
596
ls -l &lt;cgroup_mount_point&gt;/cpuacct/gpdb
597
ls -l &lt;cgroup_mount_point&gt;/cpuset/gpdb
598
ls -l &lt;cgroup_mount_point&gt;/memory/gpdb</codeblock>
599 600 601
            <p>If these directories exist and are owned by <codeph>gpadmin:gpadmin</codeph>, you
              have successfully configured cgroups for Greenplum Database CPU resource
              management.</p>
602
          </li>
603
          <li>To automatically recreate Greenplum Database required cgroup hierarchies and
604 605 606 607 608 609 610
            parameters when your system is restarted, configure your system to enable the Linux
            cgroup service daemon <codeph>cgconfig.service</codeph> (Redhat/CentOS 7.x and SuSE 11+)
            or <codeph>cgconfig</codeph> (Redhat/CentOS 6.x) at node start-up. For example,
            configure one of the following cgroup service commands in your preferred service
            auto-start tool: <ul>
              <li> Redhat/CentOS 7.x and SuSE11+ systems:
                <codeblock>sudo systemctl enable cgconfig.service</codeblock>
611
              </li>
612
              <li> Redhat/CentOS 6.x systems: <codeblock>sudo chkconfig cgconfig on</codeblock></li>
613 614 615 616
            </ul>
            <p>You may choose a different method to recreate the Greenplum Database resource group
              cgroup hierarchies.</p>
          </li>
617
        </ol>
618 619 620 621 622 623 624 625 626 627 628 629 630 631
      </section>
      <section id="topic8339191" xml:lang="en">
        <title>Procedure</title>
        <p>To use resource groups in your Greenplum Database cluster, you:</p>
        <ol>
          <li><xref href="#topic8" type="topic" format="dita">Enable resource groups for your
              Greenplum Database cluster</xref>.</li>
          <li><xref href="#topic10" type="topic" format="dita">Create resource groups</xref>.</li>
          <li><xref href="#topic17" type="topic" format="dita">Assign the resource groups to one or
              more roles</xref>.</li>
          <li><xref href="#topic22" type="topic" format="dita">Use resource management system views
              to monitor and manage the resource groups</xref>.</li>
        </ol>
      </section>
632 633 634 635
    </body>
  </topic>

  <topic id="topic8" xml:lang="en">
636
    <title id="iz153124">Enabling Resource Groups</title>
637
    <body>
638 639
      <p>When you install Greenplum Database, resource queues are enabled by default. To use
        resource groups instead of resource queues, you must set the <codeph><xref
640
            href="../ref_guide/config_params/guc-list.xml#gp_resource_manager" type="topic"
641
          /></codeph> server configuration parameter.</p>
642
      <ol id="ol_ec5_4dy_wq">
643 644
        <li>Set the <codeph>gp_resource_manager</codeph> server configuration parameter to the value
            <codeph>"group"</codeph>:
645 646 647 648
          <codeblock>gpconfig -s gp_resource_manager
gpconfig -c gp_resource_manager -v "group"
</codeblock>
        </li>
649
        <li>Restart Greenplum Database: <codeblock>gpstop
650 651 652 653
gpstart
</codeblock>
        </li>
      </ol>
654 655
      <p>Once enabled, any transaction submitted by a role is directed to the resource group
        assigned to the role, and is governed by that resource group's concurrency, memory, and CPU
656 657 658 659 660 661 662 663
        limits. Similarly, CPU and memory usage by an external component is governed by the CPU and
        memory limits configured for the resource group assigned to the component.</p>
      <p>Greenplum Database creates two default resource groups for roles named
          <codeph>admin_group</codeph> and <codeph>default_group</codeph>. When you enable resources
        groups, any role that was not explicitly assigned a resource group is assigned the default
        group for the role's capability. <codeph>SUPERUSER</codeph> roles are assigned the
          <codeph>admin_group</codeph>, non-admin roles are assigned the group named
          <codeph>default_group</codeph>.</p>
664 665 666
      <p>The default resource groups <codeph>admin_group</codeph> and <codeph>default_group</codeph>
        are created with the following resource limits:</p>
      <table id="default_resgroup_limits">
667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688
        <tgroup cols="3">
          <colspec colnum="1" colname="col1" colwidth="1*"/>
          <colspec colnum="2" colname="col2" colwidth="1*"/>
          <colspec colnum="3" colname="col3" colwidth="1*"/>
          <thead>
            <row>
              <entry colname="col1">Limit Type</entry>
              <entry colname="col2">admin_group</entry>
              <entry colname="col3">default_group</entry>
            </row>
          </thead>
          <tbody>
            <row>
              <entry colname="col1">CONCURRENCY</entry>
              <entry colname="col2">10</entry>
              <entry colname="col3">20</entry>
            </row>
            <row>
              <entry colname="col1">CPU_RATE_LIMIT</entry>
              <entry colname="col2">10</entry>
              <entry colname="col3">30</entry>
            </row>
689 690 691 692 693
            <row>
              <entry colname="col1">CPUSET</entry>
              <entry colname="col2">-1</entry>
              <entry colname="col3">-1</entry>
            </row>
694 695 696 697 698 699 700 701 702 703 704 705 706 707 708
            <row>
              <entry colname="col1">MEMORY_LIMIT</entry>
              <entry colname="col2">10</entry>
              <entry colname="col3">30</entry>
            </row>
            <row>
              <entry colname="col1">MEMORY_SHARED_QUOTA</entry>
              <entry colname="col2">50</entry>
              <entry colname="col3">50</entry>
            </row>
            <row>
              <entry colname="col1">MEMORY_SPILL_RATIO</entry>
              <entry colname="col2">20</entry>
              <entry colname="col3">20</entry>
            </row>
709 710 711 712 713
            <row>
              <entry colname="col1">MEMORY_AUDITOR</entry>
              <entry colname="col2">vmtracker</entry>
              <entry colname="col3">vmtracker</entry>
            </row>
714 715
          </tbody>
        </tgroup>
716
      </table>
717 718
      <p>Keep in mind that the <codeph>CPU_RATE_LIMIT</codeph> and <codeph>MEMORY_LIMIT</codeph>
        values for the default resource groups <codeph>admin_group</codeph> and
719 720 721 722
          <codeph>default_group</codeph> contribute to the total percentages on a segment host. You
        may find that you need to adjust these limits for <codeph>admin_group</codeph> and/or
          <codeph>default_group</codeph> as you create and add new resource groups to your Greenplum
        Database deployment.</p>
723 724 725 726 727 728
    </body>
  </topic>

  <topic id="topic10" xml:lang="en">
    <title id="iz139857">Creating Resource Groups</title>
    <body>
729 730 731 732 733
      <p><i>When you create a resource group for a role</i>, you provide a name, a CPU resource
        allocation mode, and a memory limit. You can optionally provide a concurrent transaction
        limit and memory shared quota and spill ratio. Use the <codeph><xref
            href="../ref_guide/sql_commands/CREATE_RESOURCE_GROUP.xml#topic1" type="topic"
            format="dita"/></codeph> command to create a new resource group. </p>
734
      <p id="iz152723">When you create a resource group for a role, you must provide
735 736 737 738
          <codeph>CPU_RATE_LIMIT</codeph> or <codeph>CPUSET</codeph> and
          <codeph>MEMORY_LIMIT</codeph> limit values. These limits identify the percentage of
        Greenplum Database resources to allocate to this resource group. For example, to create a
        resource group named <i>rgroup1</i> with a CPU limit of 20 and a memory limit of 25:</p>
739 740
      <p>
        <codeblock>=# CREATE RESOURCE GROUP <i>rgroup1</i> WITH (CPU_RATE_LIMIT=20, MEMORY_LIMIT=25);
741
</codeblock>
742 743 744
      </p>
      <p>The CPU limit of 20 is shared by every role to which <codeph>rgroup1</codeph> is assigned.
        Similarly, the memory limit of 25 is shared by every role to which <codeph>rgroup1</codeph>
745 746 747 748 749 750 751 752
        is assigned. <codeph>rgroup1</codeph> utilizes the default <codeph>MEMORY_AUDITOR</codeph>
        <codeph>vmtracker</codeph> and the default <codeph>CONCURRENCY</codeph> setting of 20.</p>
      <p id="iz1527231"><i>When you create a resource group for an external component</i>, you must
        provide <codeph>CPU_RATE_LIMIT</codeph> or <codeph>CPUSET</codeph> and
          <codeph>MEMORY_LIMIT</codeph> limit values. You must also provide the
          <codeph>MEMORY_AUDITOR</codeph> and explicitly set <codeph>CONCURRENCY</codeph> to zero
        (0). For example, to create a resource group named <i>rgroup_extcomp</i> for which you
        reserve CPU core 1 and assign a memory limit of 15:</p>
753
      <p>
754 755
        <codeblock>=# CREATE RESOURCE GROUP <i>rgroup_extcomp</i> WITH (MEMORY_AUDITOR=cgroup, CONCURRENCY=0,
     CPUSET='1', MEMORY_LIMIT=15);
756 757
</codeblock>
      </p>
758 759
      <p>The <codeph><xref href="../ref_guide/sql_commands/ALTER_RESOURCE_GROUP.xml#topic1"
            type="topic" format="dita"/></codeph> command updates the limits of a resource group. To
760 761
        change the limits of a resource group, specify the new values that you want for the group.
        For example:</p>
762
      <p>
763
        <codeblock>=# ALTER RESOURCE GROUP <i>rg_role_light</i> SET CONCURRENCY 7;
764
=# ALTER RESOURCE GROUP <i>exec</i> SET MEMORY_LIMIT 25;
765
=# ALTER RESOURCE GROUP <i>rgroup1</i> SET CPUSET '2,4';
766
</codeblock>
767 768 769 770 771
      </p>
      <note>You cannot set or alter the <codeph>CONCURRENCY</codeph> value for the
          <codeph>admin_group</codeph> to zero (0).</note>
      <p>The <codeph><xref href="../ref_guide/sql_commands/DROP_RESOURCE_GROUP.xml#topic1"
            type="topic" format="dita"/></codeph> command drops a resource group. To drop a resource
772 773 774
        group for a role, the group cannot be assigned to any role, nor can there be any
        transactions active or waiting in the resource group. Dropping a resource group for an
        external component in which there are running instances kills the running instances.</p>
775
      <p>To drop a resource group:</p>
776 777 778
      <p>
        <codeblock>=# DROP RESOURCE GROUP <i>exec</i>; </codeblock>
      </p>
779 780 781 782 783 784
    </body>
  </topic>

  <topic id="topic17" xml:lang="en">
    <title id="iz172210">Assigning a Resource Group to a Role</title>
    <body>
785 786 787 788 789
      <p id="iz172211">When you create a resource group with the default
          <codeph>MEMORY_AUDITOR</codeph>
        <codeph>vmtracker</codeph>, the group is available for assignment to one or more roles
        (users). You assign a resource group to a database role using the <codeph>RESOURCE
          GROUP</codeph> clause of the <codeph><xref
790 791 792 793 794 795 796 797
            href="../ref_guide/sql_commands/CREATE_ROLE.xml#topic1" type="topic" format="dita"
          /></codeph> or <codeph><xref href="../ref_guide/sql_commands/ALTER_ROLE.xml#topic1"
            type="topic" format="dita"/></codeph> commands. If you do not specify a resource group
        for a role, the role is assigned the default group for the role's capability.
          <codeph>SUPERUSER</codeph> roles are assigned the <codeph>admin_group</codeph>, non-admin
        roles are assigned the group named <codeph>default_group</codeph>.</p>
      <p>Use the <codeph>ALTER ROLE</codeph> or <codeph>CREATE ROLE</codeph> commands to assign a
        resource group to a role. For example:</p>
798 799 800 801 802
      <p>
        <codeblock>=# ALTER ROLE <i>bill</i> RESOURCE GROUP <i>rg_light</i>;
=# CREATE ROLE <i>mary</i> RESOURCE GROUP <i>exec</i>;
</codeblock>
      </p>
803 804 805
      <p>You can assign a resource group to one or more roles. If you have defined a role hierarchy,
        assigning a resource group to a parent role does not propagate down to the members of that
        role group.</p>
806 807
      <note>You cannot assign a resource group that you create for an external component to a
        role.</note>
808 809 810 811 812
      <p>If you wish to remove a resource group assignment from a role and assign the role the
        default group, change the role's group name assignment to <codeph>NONE</codeph>. For
        example:</p>
      <p>
        <codeblock>=# ALTER ROLE <i>mary</i> RESOURCE GROUP NONE;
813
</codeblock>
814 815 816
      </p>
    </body>
  </topic>
817 818 819


  <topic id="topic22" xml:lang="en">
820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842
    <title id="iz152239">Monitoring Resource Group Status</title>
    <body>
      <p>Monitoring the status of your resource groups and queries may involve the following
        tasks:</p>
      <ul>
        <li id="iz153669">
          <xref href="#topic221" type="topic" format="dita"/>
        </li>
        <li id="iz153670">
          <xref href="#topic23" type="topic" format="dita"/>
        </li>
        <li id="iz153671">
          <xref href="#topic25" type="topic" format="dita"/>
        </li>
        <li id="iz15367125">
          <xref href="#topic252525" type="topic" format="dita"/>
        </li>
        <li id="iz153679">
          <xref href="#topic27" type="topic" format="dita"/>
        </li>
      </ul>

    </body>
843 844 845 846

    <topic id="topic221" xml:lang="en">
      <title id="iz152239">Viewing Resource Group Limits</title>
      <body>
847 848 849 850 851 852
        <p>The <codeph><xref href="../ref_guide/system_catalogs/gp_resgroup_config.xml" type="topic"
              format="dita"/></codeph>
          <codeph>gp_toolkit</codeph> system view displays the current and proposed limits for a
          resource group. The proposed limit differs from the current limit when you alter the limit
          but the new value can not be immediately applied. To view the limits of all resource
          groups:</p>
853 854 855 856
        <p>
          <codeblock>=# SELECT * FROM gp_toolkit.gp_resgroup_config;
</codeblock>
        </p>
857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883
        <p> The <codeph>gp_toolkit.gp_resgroup_config</codeph> view does not display the resource
          group memory auditor or CPU core assignment attributes. To view the these attributes along
          with the other resource group limits, run the following
          query:<codeblock>=# SELECT g.oid AS groupid, g.rsgname AS groupname,
     t1.value AS concurrency, t1.proposed AS proposed_concurrency,
     t2.value AS cpu_rate_limit, t3.value AS memory_limit,
     t3.proposed AS proposed_memory_limit,
     t4.value AS memory_shared_quota,
     t4.proposed AS proposed_memory_shared_quota,
     t5.value AS memory_spill_ratio,
     t5.proposed AS proposed_memory_spill_ratio,
     CASE
       WHEN t6.value IS NULL THEN 'vmtracker'::text
       WHEN t6.value = '0'::text THEN 'vmtracker'::text
       WHEN t6.value = '1'::text THEN 'cgroup'::text
       ELSE 'unknown'::text
     END AS memory_auditor,
     t7.value AS cpuset
   FROM pg_resgroup g
     JOIN pg_resgroupcapability t1 ON g.oid = t1.resgroupid AND t1.reslimittype = 1
     JOIN pg_resgroupcapability t2 ON g.oid = t2.resgroupid AND t2.reslimittype = 2
     JOIN pg_resgroupcapability t3 ON g.oid = t3.resgroupid AND t3.reslimittype = 3
     JOIN pg_resgroupcapability t4 ON g.oid = t4.resgroupid AND t4.reslimittype = 4
     JOIN pg_resgroupcapability t5 ON g.oid = t5.resgroupid AND t5.reslimittype = 5
     LEFT JOIN pg_resgroupcapability t6 ON g.oid = t6.resgroupid AND t6.reslimittype = 6
     LEFT JOIN pg_resgroupcapability t7 ON g.oid = t7.resgroupid AND t7.reslimittype = 7;</codeblock>
        </p>
884 885 886 887 888 889
      </body>
    </topic>

    <topic id="topic23" xml:lang="en">
      <title id="iz152239">Viewing Resource Group Query Status and CPU/Memory Usage</title>
      <body>
890 891
        <p>The <codeph><xref href="../ref_guide/gp_toolkit.xml#topic31x" type="topic" format="dita"
            /></codeph>
892 893 894 895
          <codeph>gp_toolkit</codeph> system view enables you to view the status and activity of a
          resource group. The view displays the number of running and queued transactions. It also
          displays the real-time CPU and memory usage of the resource group. To view this
          information:</p>
896 897 898 899 900 901 902 903 904 905 906
        <p>
          <codeblock>=# SELECT * FROM gp_toolkit.gp_resgroup_status;
</codeblock>
        </p>
      </body>
    </topic>

    <topic id="topic25" xml:lang="en">
      <title id="iz152239">Viewing the Resource Group Assigned to a Role</title>
      <body>
        <p>To view the resource group-to-role assignments, perform the following query on the
907 908 909 910
              <codeph><xref href="../ref_guide/system_catalogs/pg_roles.xml" type="topic"
              format="dita"/></codeph> and <codeph><xref
              href="../ref_guide/system_catalogs/pg_resgroup.xml" type="topic" format="dita"
            /></codeph> system catalog tables:</p>
911 912 913 914 915 916 917 918 919 920 921
        <p>
          <codeblock>=# SELECT rolname, rsgname FROM pg_roles, pg_resgroup
     WHERE pg_roles.rolresgroup=pg_resgroup.oid;
</codeblock>
        </p>
      </body>
    </topic>

    <topic id="topic252525" xml:lang="en">
      <title id="iz15223925">Viewing a Resource Group's Running and Pending Queries</title>
      <body>
922 923 924 925
        <p>To view a resource group's running queries, pending queries, and how long the pending
          queries have been queued, examine the <codeph><xref
              href="../ref_guide/system_catalogs/pg_stat_activity.xml" type="topic" format="dita"
            /></codeph> system catalog table:</p>
926 927 928 929 930
        <p>
          <codeblock>=# SELECT current_query, waiting, rsgname, rsgqueueduration 
     FROM pg_stat_activity;
</codeblock>
        </p>
931
        <p>
932 933 934 935 936 937 938 939 940
          <codeph>pg_stat_activity</codeph> displays information about the user/role that initiated
          a query. A query that uses an external component such as PL/Container is composed of two
          parts: the query operator that runs in Greenplum Database and the UDF that runs in a
          PL/Container instance. Greenplum Database processes the query operators under the resource
          group assigned to the role that initiated the query. A UDF running in a PL/Container
          instance runs under the resource group assigned to the PL/Container runtime. The latter is
          not represented in the <codeph>pg_stat_activity</codeph> view; Greenplum Database does not
          have any insight into how external components such as PL/Container manage memory in
          running instances. </p>
941 942 943 944
      </body>
    </topic>

    <topic id="topic27" xml:lang="en">
945
      <title id="iz153732">Cancelling a Running or Queued Transaction in a Resource Group</title>
946
      <body>
947 948 949 950 951 952 953
        <p>There may be cases when you want to cancel a running or queued transaction in a resource
          group. For example, you may want to remove a query that is waiting in the resource group
          queue but has not yet been executed. Or, you may want to stop a running query that is
          taking too long to execute, or one that is sitting idle in a transaction and taking up
          resource group transaction slots that are needed by other users.</p>
        <p>To cancel a running or queued transaction, you must first determine the process id (pid)
          associated with the transaction. Once you have obtained the process id, you can invoke
954
            <codeph>pg_cancel_backend()</codeph> to end that process, as shown below.</p>
955
        <p>For example, to view the process information associated with all statements currently
956 957
          active or waiting in all resource groups, run the following query. If the query returns no
          results, then there are no running or queued transactions in any resource group.</p>
958 959 960 961 962 963 964 965 966 967 968 969 970
        <p>
          <codeblock>=# SELECT rolname, g.rsgname, procpid, waiting, current_query, datname 
     FROM pg_roles, gp_toolkit.gp_resgroup_status g, pg_stat_activity 
     WHERE pg_roles.rolresgroup=g.groupid
        AND pg_stat_activity.usename=pg_roles.rolname;
</codeblock>
        </p>

        <p>Sample partial query output:</p>
        <codeblock> rolname | rsgname  | procpid | waiting |     current_query     | datname 
---------+----------+---------+---------+-----------------------+---------
  sammy  | rg_light |  31861  |    f    | &lt;IDLE&gt; in transaction | testdb
  billy  | rg_light |  31905  |    t    | SELECT * FROM topten; | testdb</codeblock>
971 972 973
        <p>Use this output to identify the process id (<codeph>procpid</codeph>) of the transaction
          you want to cancel, and then cancel the process. For example, to cancel the pending query
          identified in the sample output above:</p>
974 975 976
        <p>
          <codeblock>=# SELECT pg_cancel_backend(31905);</codeblock>
        </p>
977 978 979
        <p>You can provide an optional message in a second argument to
            <codeph>pg_cancel_backend()</codeph> to indicate to the user why the process was
          cancelled.</p>
980
        <note type="note">
981 982
          <p>Do not use an operating system <codeph>KILL</codeph> command to cancel any Greenplum
            Database process.</p>
983 984 985 986 987
        </note>
      </body>
    </topic>

  </topic>
988 989 990 991 992 993
  <topic id="topic777999" xml:lang="en">
    <title>Resource Group Frequently Asked Questions</title>
    <body>
      <section id="topic791" xml:lang="en">
        <title>CPU</title>
        <ul>
994 995 996 997 998 999 1000
          <li><b>Why is CPU usage lower than the <codeph>CPU_RATE_LIMIT</codeph> configured for the
              resource group?</b>
            <p>You may run into this situation when a low number of queries and slices are running
              in the resource group, and these processes are not utilizing all of the cores on the
              system.</p></li>
          <li><b>Why is CPU usage for the resource group higher than the configured
                <codeph>CPU_RATE_LIMIT</codeph>?</b>
1001
            <p>This situation can occur in the following circumstances:<ul>
1002 1003 1004 1005 1006 1007 1008 1009 1010
                <li>A resource group may utilize more CPU than its <codeph>CPU_RATE_LIMIT</codeph>
                  when other resource groups are idle. In this situation, Greenplum Database
                  allocates the CPU resource of an idle resource group to a busier one. This
                  resource group feature is called CPU burst.</li>
                <li>The operating system CPU scheduler may cause CPU usage to spike, then drop down.
                  If you believe this might be occurring, calculate the average CPU usage within a
                  given period of time (for example, 5 seconds) and use that average to determine if
                  CPU usage is higher than the configured limit.</li>
              </ul></p></li>
1011
        </ul>
1012
        <p/>
1013 1014 1015 1016 1017
      </section>
      <section id="topic795" xml:lang="en">
        <title>Memory</title>
        <ul>
          <li><b>Why did my query return an "out of memory" error?</b>
1018 1019 1020
            <p>A transaction submitted in a resource group fails and exits when memory usage exceeds
              its fixed memory allotment, no available resource group shared memory exists, and the
              transaction requests more memory.</p></li>
1021
          <li><b>Why did my query return a "memory limit reached" error?</b>
1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035
            <p>Greenplum Database automatically adjusts transaction and group memory to the new
              settings when you use <codeph>ALTER RESOURCE GROUP</codeph> to change a resource
              group's memory and/or concurrency limits. An "out of memory" error may occur if you
              recently altered resource group attributes and there is no longer a sufficient amount
              of memory available for a currently running query.</p></li>
          <li><b>Why does the actual memory usage of my resource group exceed the amount configured
              for the group?</b>
            <p>The actual memory usage of a resource group may exceed the configured amount when one
              or more queries running in the group is allocated memory from the global shared memory
              pool. (If no global shared memory is available, queries fail and do not impact the
              memory resources of other resource groups.)</p><p>When global shared memory is
              available, memory usage may exceed the configured amount when a transaction spills to
              disk. Greenplum Database statements continue to request memory when they start to
              spill to disk because:<ul>
1036 1037
                <li>Spilling to disk requires extra memory to work.</li>
                <li>Other operators may continue to request memory.</li>
1038 1039 1040
              </ul> Memory usage grows in spill situations; when global shared memory is available,
              the resource group may eventually use up to 200-300% of its configured group memory
              limit.</p></li>
1041 1042 1043 1044 1045
        </ul>
      </section>
      <section id="topic797" xml:lang="en">
        <title>Concurrency</title>
        <ul>
1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058
          <li><b>Why is the number of running transactions lower than the
                <codeph>CONCURRENCY</codeph> limit configured for the resource group?</b>
            <p>Greenplum Database considers memory availability before running a transaction, and
              will queue the transaction if there is not enough memory available to serve it. If you
              use <codeph>ALTER RESOURCE GROUP</codeph> to increase the <codeph>CONCURRENCY</codeph>
              limit for a resource group but do not also adjust memory limits, currently running
              transactions may be consuming all allotted memory resources for the group. When in
              this state, Greenplum Database queues subsequent transactions in the resource
              group.</p></li>
          <li><b>Why is the number of running transactions in the resource group higher than the
              configured <codeph>CONCURRENCY</codeph> limit?</b>
            <p>The resource group may be running <codeph>SET</codeph> and <codeph>SHOW</codeph>
              commands, which bypass resource group transaction checks.</p></li>
1059 1060 1061 1062
        </ul>
      </section>
    </body>
  </topic>
1063
</topic>