Uploaded image for project: 'JBoss Enterprise Application Platform'
  1. JBoss Enterprise Application Platform
  2. JBEAP-9140

Improve buffer-pool model description

    XMLWordPrintable

    Details

    • Type: Bug
    • Status: Resolved (View Workflow)
    • Priority: Minor
    • Resolution: Deferred
    • Affects Version/s: 7.1.0.DR12
    • Fix Version/s: None
    • Component/s: IO, User Experience
    • Labels:
      None

      Description

      Current state of buffer-pool model description:

      [standalone@localhost:9990 /] /subsystem=io/buffer-pool=foo:read-resource-description
      {             
          "outcome" => "success",
          "result" => {
              "description" => "Defines buffer pool",
              "capabilities" => [{
                  "name" => "org.wildfly.io.buffer-pool",
                  "dynamic" => true
              }],
              "attributes" => {
                  "buffer-size" => {
                      "type" => INT,
                      "description" => "The size of each buffer slice in bytes, if not set optimal value is calculated based on available RAM resources in your system.",
                      "expressions-allowed" => true,
                      "required" => false,
                      "nillable" => true,
                      "access-type" => "read-write",
                      "storage" => "configuration",
                      "restart-required" => "all-services"
                  },
                  "buffers-per-slice" => {
                      "type" => INT,
                      "description" => "How many buffers per slice, if not set optimal value is calculated based on available RAM resources in your system.",
                      "expressions-allowed" => true,
                      "required" => false,
                      "nillable" => true,
                      "access-type" => "read-write",
                      "storage" => "configuration",
                      "restart-required" => "all-services"
                  },
                  "direct-buffers" => {
                      "type" => BOOLEAN,
                      "description" => "Does the buffer pool use direct buffers, some platforms don't support direct buffers",
                      "expressions-allowed" => true,
                      "required" => false,
                      "nillable" => true,
                      "access-type" => "read-write",
                      "storage" => "configuration",
                      "restart-required" => "all-services"
                  }
              },
              "operations" => undefined,
              "notifications" => undefined,
              "children" => {}
          }
      }
      

      Following improvements should be done to it:

      • In buffer-size and buffers-per-slice description there is mentioned something called 'slice'. Nowhere is described what it is. Suggested improvement: Explain what slice is, preferably in buffer-pool model description.
      • In buffer-size and buffers-per-slice description there is this sentence: ''...if not set optimal value is calculated based on available RAM resources in your system" - how it is calculated? Is there any default fixed value? User would like to know this. Suggestion: Add explanation about default value.
      • In direct-buffers description there is mentioned that some platforms don't support direct buffers? Is there mentioned which one or what determines whether direct buffers are supported on given platform? Suggested improvement: Explain what element determines whether direct buffers are supported.

        Attachments

          Issue Links

            Activity

              People

              Assignee:
              rpelisse Romain Pelisse
              Reporter:
              jkasik Jan Kasik
              Tester:
              Jan Kasik Jan Kasik
              Votes:
              0 Vote for this issue
              Watchers:
              3 Start watching this issue

                Dates

                Created:
                Updated:
                Resolved: