[
https://issues.apache.org/jira/browse/GEODE-3788?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16298799#comment-16298799
]
ASF GitHub Bot commented on GEODE-3788:
---------------------------------------
davebarnes97 closed pull request #1191: GEODE-3788 alter async event queue
attributes (document this feature)
URL: https://github.com/apache/geode/pull/1191
This is a PR merged from a forked repository.
As GitHub hides the original diff on merge, it is displayed below for
the sake of provenance:
As this is a foreign pull request (from a fork), the diff is supplied
below (as it won't show otherwise due to GitHub magic):
diff --git a/geode-book/master_middleman/source/subnavs/geode-subnav.erb
b/geode-book/master_middleman/source/subnavs/geode-subnav.erb
index 0c672793bb..42115d5e7c 100644
--- a/geode-book/master_middleman/source/subnavs/geode-subnav.erb
+++ b/geode-book/master_middleman/source/subnavs/geode-subnav.erb
@@ -1794,6 +1794,9 @@ gfsh</a>
<li class="has_submenu">
<a
href="/docs/guide/<%=vars.product_version_nodot%>/tools_modules/gfsh/command-pages/alter.html">alter</a>
<ul>
+ <li>
+ <a
href="/docs/guide/<%=vars.product_version_nodot%>/tools_modules/gfsh/command-pages/alter.html#topic_alter_async_event_queue">alter
async-event-queue</a>
+ </li>
<li>
<a
href="/docs/guide/<%=vars.product_version_nodot%>/tools_modules/gfsh/command-pages/alter.html#topic_99BCAD98BDB5470189662D2F308B68EB">alter
disk-store</a>
</li>
diff --git a/geode-docs/tools_modules/gfsh/command-pages/alter.html.md.erb
b/geode-docs/tools_modules/gfsh/command-pages/alter.html.md.erb
index e2780e9bab..e2f778389f 100644
--- a/geode-docs/tools_modules/gfsh/command-pages/alter.html.md.erb
+++ b/geode-docs/tools_modules/gfsh/command-pages/alter.html.md.erb
@@ -23,18 +23,54 @@ limitations under the License.
Modify an existing <%=vars.product_name%> resource.
-- **[alter
disk-store](../../../tools_modules/gfsh/command-pages/alter.html#topic_99BCAD98BDB5470189662D2F308B68EB)**
+- **[alter async-event-queue](#topic_alter_async_event_queue)**
- Modify or remove a region from an offline disk-store.
+ Modifies attributes of an async event queue
-- **[alter
region](../../../tools_modules/gfsh/command-pages/alter.html#topic_E74ED23CB60342538B2175C326E7D758)**
+- **[alter disk-store](#topic_99BCAD98BDB5470189662D2F308B68EB)**
+
+ Modifies or removes a region from an offline disk-store.
+
+- **[alter region](#topic_E74ED23CB60342538B2175C326E7D758)**
Alters the configuration of a region.
-- **[alter
runtime](../../../tools_modules/gfsh/command-pages/alter.html#topic_7E6B7E1B972D4F418CB45354D1089C2B)**
+- **[alter runtime](#topic_7E6B7E1B972D4F418CB45354D1089C2B)**
Alters configuration properties for all members or a subset of members
while the member or members are running.
+## <a id="topic_alter_async_event_queue" class="no-quick-link"></a>alter
async-event-queue
+
+Alter attributes of a specified asynchronous event queue. Each server hosting
the specified async event queue must be restarted for the new attribute
+settings to take effect on that server.
+
+**Availability:** Online. You must be connected in <span class="keyword
parmname">gfsh</span> to a JMX Manager member to use this command.
+
+**Syntax:**
+
+``` pre
+alter async-event-queue --id=value [--batch-size=value]
[--batch-time-interval=value]
+ [--max-queue-memory=value] [--if-exists(=value)]
+```
+
+The required option, `--id`, identifies the async event queue to be altered.
+
+**Parameters, alter async-event-queue**
+
+| Name | Description |
+|------|-------------|
+| ‑‑id | _Required._ ID of the async event queue to be changed |
+| ‑‑batch‑size | Maximum number of events that a batch can
contain |
+| ‑‑batch‑time‑interval | Maximum amount of time, in
ms, that can elapse before a batch is delivered |
+| ‑‑max‑queue‑memory | Maximum amount of memory, in
megabytes, that the queue can consume before overflowing to disk |
+| ‑‑if‑exists | If the specified async event queue does not
exist, gfsh responds with a message to that effect. If this parameter is true,
the response is prefixed with the label "Skipping: ". Useful for scripted
tests. Default (if the parameter is not specified): false. Default (if the
parameter is specified without value): true. |
+
+**Example Commands:**
+
+``` pre
+alter async-event-queue --id=myAsyncEventQueue --batch-size=50 --if-exists
+```
+
## <a id="topic_99BCAD98BDB5470189662D2F308B68EB"
class="no-quick-link"></a>alter disk-store
Modify or remove a region from an offline disk-store.
@@ -55,6 +91,8 @@ alter disk-store --name=value --region=value
--disk-dirs=value(,value)*
The three required options, `--name`, `--region`, and `--disk-dirs`, identify
the disk store and region to be altered. If no additional options are
specified, `gfsh` displays the current configuration without making any changes.
+**Parameters, alter disk-store**
+
<table>
<colgroup>
<col width="50%" />
@@ -164,10 +202,9 @@ alter region --name=value [--groups=value(,value)*]
[--eviction-max(=value)?]
```
-<a
id="topic_E74ED23CB60342538B2175C326E7D758__table_2277A2CE8F6E4731B45FEFA2B1366DB6"></a>
+**Parameters, alter region**
<table>
-<caption><span class="tablecap">Table 1. Alter Region
Parameters</span></caption>
<colgroup>
<col width="25%" />
<col width="60%" />
@@ -361,8 +398,6 @@ Select one of the following expiration actions:
</tbody>
</table>
-<span class="tablecap">Table 1. Alter Region Parameters</span>
-
**Example Commands:**
``` pre
@@ -398,10 +433,8 @@ alter runtime [--members=value(,value)*]
[--groups=value(,value)*]
[--lock-timeout=value] [--message-sync-interval=value]
[--search-timeout=value]
```
-<a
id="topic_7E6B7E1B972D4F418CB45354D1089C2B__table_09BEBCECA4A44286A2A56C3714A4F6A3"></a>
-
+**Parameters, alter runtime**
<table>
-<caption><span class="tablecap">Table 2. Alter Runtime
Parameters</span></caption>
<colgroup>
<col width="25%" />
<col width="50%" />
@@ -494,8 +527,6 @@ Valid values are: `ALL`, `TRACE`, `DEBUG`, `INFO`, `WARN`,
`ERROR`, `FATAL`, `OF
</tbody>
</table>
-<span class="tablecap">Table 2. Alter Runtime Parameters</span>
-
**Example Commands:**
``` pre
diff --git a/geode-docs/tools_modules/gfsh/command-pages/create.html.md.erb
b/geode-docs/tools_modules/gfsh/command-pages/create.html.md.erb
index d987a10047..b07968445c 100644
--- a/geode-docs/tools_modules/gfsh/command-pages/create.html.md.erb
+++ b/geode-docs/tools_modules/gfsh/command-pages/create.html.md.erb
@@ -633,7 +633,7 @@ create index --name=value --expression=value --region=value
[--members=value(,value)*] [--type=value] [--groups=value(,value)*]
```
-**Parameters: create index:**
+**Parameters, create index:**
| Name | Description
| Default |
|----------------------------------------------------|----------------------------------------------------------------------------------------|---------|
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
[email protected]
> alter async event queue attributes
> ----------------------------------
>
> Key: GEODE-3788
> URL: https://issues.apache.org/jira/browse/GEODE-3788
> Project: Geode
> Issue Type: Sub-task
> Components: docs, gfsh
> Reporter: Swapnil Bawaskar
> Fix For: 1.4.0
>
>
> We should add a new {{alter async-event-queue}} gfsh command that will allow
> users to change the following attributes on the AsyncEventQueue:
> - batch size
> - batch time interval
> - maximum queue memory
> Attributes changed with this command should only be reflected in cluster
> configuration. We will require users to do a rolling re-start of the servers
> for the new settings to take effect.
--
This message was sent by Atlassian JIRA
(v6.4.14#64029)
