You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@geode.apache.org by karensmolermiller <gi...@git.apache.org> on 2017/03/08 22:05:04 UTC

[GitHub] geode-native pull request #49: GEODE-2513 Unbrand docs section on Preserving...

GitHub user karensmolermiller opened a pull request:

    https://github.com/apache/geode-native/pull/49

    GEODE-2513 Unbrand docs section on Preserving Data

    - Remove references to GemFire
    - Fix typos
    - Clarify links that leave the native-manual
    
    @davebarnes97 @joeymcallister @echobravopapa @mmartell @PivotalSarge @dgkimura Please review this PR containing changes to the user manual.

You can merge this pull request into a Git repository by running:

    $ git pull https://github.com/karensmolermiller/geode-native feature/GEODE-2513-5

Alternatively you can review and apply these changes as the patch at:

    https://github.com/apache/geode-native/pull/49.patch

To close this pull request, make a commit to your master/trunk branch
with (at least) the following in the commit message:

    This closes #49
    
----
commit 34c92b08df3696cef4a4b3a4c6c5857e14da4d08
Author: Karen Miller <km...@pivotal.io>
Date:   2017-03-08T20:11:02Z

    GEODE-2513 Unbrand docs section on Preserving Data
    
    - Remove references to GemFire
    - Fix typos
    - Clarify links that leave the native-manual

----


---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastructure@apache.org or file a JIRA ticket
with INFRA.
---

[GitHub] geode-native pull request #49: GEODE-2513 Unbrand docs section on Preserving...

Posted by karensmolermiller <gi...@git.apache.org>.
Github user karensmolermiller commented on a diff in the pull request:

    https://github.com/apache/geode-native/pull/49#discussion_r105231666
  
    --- Diff: docs/geode-native-docs/preserving-data/configuring-durable-nc.html.md.erb ---
    @@ -19,19 +19,19 @@ See the License for the specific language governing permissions and
     limitations under the License.
     -->
     
    -The durable native client can be configured in the `gfcpp.properties` file, or in the `CacheFactory::set(name,             value)` call.
    +The durable client can be configured in the `gfcpp.properties` file, or in the `CacheFactory::set(name,             value)` call.
     
    --   **Durable client ID**\u2014You indicate that the client is durable by giving it a `durable-client-ID`. The servers use this ID to identify the client. For a non-durable client, the `durable-client-ID` is an empty string. The ID can be any number that is unique among the clients attached to servers in the same distributed system.
    +-   **Durable client ID**\u2014Indicate that the client is durable by giving it a `durable-client-ID`. The servers use this ID to identify the client. For a non-durable client, the `durable-client-ID` is an empty string. The ID can be any number that is unique among the clients attached to servers in the same distributed system.
     
     -   **Durable timeout**\u2014The `durable-timeout` setting specifies how long this client\u2019s servers should wait after the client disconnects before terminating its message queue. During that time, the servers consider the client alive and continue to accumulate messages for it. The default is 300 seconds.
     
     The `durable-timeout` setting is a tuning parameter. When setting the timeout, take into account the normal activity of your application, the average size of your messages, and the level of risk you can handle. Assuming that no messages are being removed from the queue, how long can the application run before the queue reaches the maximum message count? In addition, how long can it run before the queued messages consume all the memory on the client host? How serious is each of those failures to your operation?
     
    -To assist with tuning, Geode provides statistics that track message queues for durable clients through the disconnect and reconnect cycles. For statistics documentation, see [Statistics](geodeman/managing/statistics/chapter_overview.html).
    +To assist with tuning, Geode statistics track message queues for durable clients through the disconnect and reconnect cycles.
     
    -When the queue is full, it blocks further operations that add messages until the queue size drops to an acceptable level. The action to take is specified on the server. For details on configuring the queue, see [Implementing Durable Client/Server Messaging](geodeman/developing/events/implementing_durable_client_server_messaging.html).
    +When the queue is full, it blocks further operations that add messages until the queue size drops to an acceptable level. Server configuration sets the action to take. See details on server configuration of the queue in the server documentation section [Implementing Durable Client/Server Messaging](geodeman/developing/events/implementing_durable_client_server_messaging.html).
     
    -## Configuring a Durable Native Client Using gfcpp.properties
    +## Configuring a Durable Client Using gfcpp.properties
    --- End diff --
    
    I propose that we find all instances of this property file name within the docs and update them all in a separate PR.


---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastructure@apache.org or file a JIRA ticket
with INFRA.
---

[GitHub] geode-native issue #49: GEODE-2513 Unbrand docs section on Preserving Data

Posted by karensmolermiller <gi...@git.apache.org>.
Github user karensmolermiller commented on the issue:

    https://github.com/apache/geode-native/pull/49
  
    Merged in. Closing.


---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastructure@apache.org or file a JIRA ticket
with INFRA.
---

[GitHub] geode-native pull request #49: GEODE-2513 Unbrand docs section on Preserving...

Posted by echobravopapa <gi...@git.apache.org>.
Github user echobravopapa commented on a diff in the pull request:

    https://github.com/apache/geode-native/pull/49#discussion_r105222610
  
    --- Diff: docs/geode-native-docs/preserving-data/configuring-durable-nc.html.md.erb ---
    @@ -19,19 +19,19 @@ See the License for the specific language governing permissions and
     limitations under the License.
     -->
     
    -The durable native client can be configured in the `gfcpp.properties` file, or in the `CacheFactory::set(name,             value)` call.
    +The durable client can be configured in the `gfcpp.properties` file, or in the `CacheFactory::set(name,             value)` call.
     
    --   **Durable client ID**\u2014You indicate that the client is durable by giving it a `durable-client-ID`. The servers use this ID to identify the client. For a non-durable client, the `durable-client-ID` is an empty string. The ID can be any number that is unique among the clients attached to servers in the same distributed system.
    +-   **Durable client ID**\u2014Indicate that the client is durable by giving it a `durable-client-ID`. The servers use this ID to identify the client. For a non-durable client, the `durable-client-ID` is an empty string. The ID can be any number that is unique among the clients attached to servers in the same distributed system.
     
     -   **Durable timeout**\u2014The `durable-timeout` setting specifies how long this client\u2019s servers should wait after the client disconnects before terminating its message queue. During that time, the servers consider the client alive and continue to accumulate messages for it. The default is 300 seconds.
     
     The `durable-timeout` setting is a tuning parameter. When setting the timeout, take into account the normal activity of your application, the average size of your messages, and the level of risk you can handle. Assuming that no messages are being removed from the queue, how long can the application run before the queue reaches the maximum message count? In addition, how long can it run before the queued messages consume all the memory on the client host? How serious is each of those failures to your operation?
     
    -To assist with tuning, Geode provides statistics that track message queues for durable clients through the disconnect and reconnect cycles. For statistics documentation, see [Statistics](geodeman/managing/statistics/chapter_overview.html).
    +To assist with tuning, Geode statistics track message queues for durable clients through the disconnect and reconnect cycles.
     
    -When the queue is full, it blocks further operations that add messages until the queue size drops to an acceptable level. The action to take is specified on the server. For details on configuring the queue, see [Implementing Durable Client/Server Messaging](geodeman/developing/events/implementing_durable_client_server_messaging.html).
    +When the queue is full, it blocks further operations that add messages until the queue size drops to an acceptable level. Server configuration sets the action to take. See details on server configuration of the queue in the server documentation section [Implementing Durable Client/Server Messaging](geodeman/developing/events/implementing_durable_client_server_messaging.html).
     
    -## Configuring a Durable Native Client Using gfcpp.properties
    +## Configuring a Durable Client Using gfcpp.properties
    --- End diff --
    
    I think this file is called "geode.properities" now


---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastructure@apache.org or file a JIRA ticket
with INFRA.
---

[GitHub] geode-native pull request #49: GEODE-2513 Unbrand docs section on Preserving...

Posted by echobravopapa <gi...@git.apache.org>.
Github user echobravopapa commented on a diff in the pull request:

    https://github.com/apache/geode-native/pull/49#discussion_r105257135
  
    --- Diff: docs/geode-native-docs/preserving-data/configuring-durable-nc.html.md.erb ---
    @@ -19,19 +19,19 @@ See the License for the specific language governing permissions and
     limitations under the License.
     -->
     
    -The durable native client can be configured in the `gfcpp.properties` file, or in the `CacheFactory::set(name,             value)` call.
    +The durable client can be configured in the `gfcpp.properties` file, or in the `CacheFactory::set(name,             value)` call.
     
    --   **Durable client ID**\u2014You indicate that the client is durable by giving it a `durable-client-ID`. The servers use this ID to identify the client. For a non-durable client, the `durable-client-ID` is an empty string. The ID can be any number that is unique among the clients attached to servers in the same distributed system.
    +-   **Durable client ID**\u2014Indicate that the client is durable by giving it a `durable-client-ID`. The servers use this ID to identify the client. For a non-durable client, the `durable-client-ID` is an empty string. The ID can be any number that is unique among the clients attached to servers in the same distributed system.
     
     -   **Durable timeout**\u2014The `durable-timeout` setting specifies how long this client\u2019s servers should wait after the client disconnects before terminating its message queue. During that time, the servers consider the client alive and continue to accumulate messages for it. The default is 300 seconds.
     
     The `durable-timeout` setting is a tuning parameter. When setting the timeout, take into account the normal activity of your application, the average size of your messages, and the level of risk you can handle. Assuming that no messages are being removed from the queue, how long can the application run before the queue reaches the maximum message count? In addition, how long can it run before the queued messages consume all the memory on the client host? How serious is each of those failures to your operation?
     
    -To assist with tuning, Geode provides statistics that track message queues for durable clients through the disconnect and reconnect cycles. For statistics documentation, see [Statistics](geodeman/managing/statistics/chapter_overview.html).
    +To assist with tuning, Geode statistics track message queues for durable clients through the disconnect and reconnect cycles.
     
    -When the queue is full, it blocks further operations that add messages until the queue size drops to an acceptable level. The action to take is specified on the server. For details on configuring the queue, see [Implementing Durable Client/Server Messaging](geodeman/developing/events/implementing_durable_client_server_messaging.html).
    +When the queue is full, it blocks further operations that add messages until the queue size drops to an acceptable level. Server configuration sets the action to take. See details on server configuration of the queue in the server documentation section [Implementing Durable Client/Server Messaging](geodeman/developing/events/implementing_durable_client_server_messaging.html).
     
    -## Configuring a Durable Native Client Using gfcpp.properties
    +## Configuring a Durable Client Using gfcpp.properties
    --- End diff --
    
    works for me


---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastructure@apache.org or file a JIRA ticket
with INFRA.
---

[GitHub] geode-native pull request #49: GEODE-2513 Unbrand docs section on Preserving...

Posted by joeymcallister <gi...@git.apache.org>.
Github user joeymcallister commented on a diff in the pull request:

    https://github.com/apache/geode-native/pull/49#discussion_r105233328
  
    --- Diff: docs/geode-native-docs/preserving-data/configuring-durable-nc.html.md.erb ---
    @@ -19,19 +19,19 @@ See the License for the specific language governing permissions and
     limitations under the License.
     -->
     
    -The durable native client can be configured in the `gfcpp.properties` file, or in the `CacheFactory::set(name,             value)` call.
    +The durable client can be configured in the `gfcpp.properties` file, or in the `CacheFactory::set(name,             value)` call.
     
    --   **Durable client ID**\u2014You indicate that the client is durable by giving it a `durable-client-ID`. The servers use this ID to identify the client. For a non-durable client, the `durable-client-ID` is an empty string. The ID can be any number that is unique among the clients attached to servers in the same distributed system.
    +-   **Durable client ID**\u2014Indicate that the client is durable by giving it a `durable-client-ID`. The servers use this ID to identify the client. For a non-durable client, the `durable-client-ID` is an empty string. The ID can be any number that is unique among the clients attached to servers in the same distributed system.
     
     -   **Durable timeout**\u2014The `durable-timeout` setting specifies how long this client\u2019s servers should wait after the client disconnects before terminating its message queue. During that time, the servers consider the client alive and continue to accumulate messages for it. The default is 300 seconds.
     
     The `durable-timeout` setting is a tuning parameter. When setting the timeout, take into account the normal activity of your application, the average size of your messages, and the level of risk you can handle. Assuming that no messages are being removed from the queue, how long can the application run before the queue reaches the maximum message count? In addition, how long can it run before the queued messages consume all the memory on the client host? How serious is each of those failures to your operation?
     
    -To assist with tuning, Geode provides statistics that track message queues for durable clients through the disconnect and reconnect cycles. For statistics documentation, see [Statistics](geodeman/managing/statistics/chapter_overview.html).
    +To assist with tuning, Geode statistics track message queues for durable clients through the disconnect and reconnect cycles.
     
    -When the queue is full, it blocks further operations that add messages until the queue size drops to an acceptable level. The action to take is specified on the server. For details on configuring the queue, see [Implementing Durable Client/Server Messaging](geodeman/developing/events/implementing_durable_client_server_messaging.html).
    +When the queue is full, it blocks further operations that add messages until the queue size drops to an acceptable level. Server configuration sets the action to take. See details on server configuration of the queue in the server documentation section [Implementing Durable Client/Server Messaging](geodeman/developing/events/implementing_durable_client_server_messaging.html).
     
    -## Configuring a Durable Native Client Using gfcpp.properties
    +## Configuring a Durable Client Using gfcpp.properties
    --- End diff --
    
    +1


---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastructure@apache.org or file a JIRA ticket
with INFRA.
---

[GitHub] geode-native issue #49: GEODE-2513 Unbrand docs section on Preserving Data

Posted by joeymcallister <gi...@git.apache.org>.
Github user joeymcallister commented on the issue:

    https://github.com/apache/geode-native/pull/49
  
    +1 (after @echobravopapa's suggested change of "gfcpp.properties" to "geode.properties," if that file name has changed)


---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastructure@apache.org or file a JIRA ticket
with INFRA.
---

[GitHub] geode-native pull request #49: GEODE-2513 Unbrand docs section on Preserving...

Posted by karensmolermiller <gi...@git.apache.org>.
Github user karensmolermiller closed the pull request at:

    https://github.com/apache/geode-native/pull/49


---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastructure@apache.org or file a JIRA ticket
with INFRA.
---

[GitHub] geode-native pull request #49: GEODE-2513 Unbrand docs section on Preserving...

Posted by echobravopapa <gi...@git.apache.org>.
Github user echobravopapa commented on a diff in the pull request:

    https://github.com/apache/geode-native/pull/49#discussion_r105222443
  
    --- Diff: docs/geode-native-docs/preserving-data/configuring-durable-nc.html.md.erb ---
    @@ -19,19 +19,19 @@ See the License for the specific language governing permissions and
     limitations under the License.
     -->
     
    -The durable native client can be configured in the `gfcpp.properties` file, or in the `CacheFactory::set(name,             value)` call.
    +The durable client can be configured in the `gfcpp.properties` file, or in the `CacheFactory::set(name,             value)` call.
     
    --   **Durable client ID**\u2014You indicate that the client is durable by giving it a `durable-client-ID`. The servers use this ID to identify the client. For a non-durable client, the `durable-client-ID` is an empty string. The ID can be any number that is unique among the clients attached to servers in the same distributed system.
    +-   **Durable client ID**\u2014Indicate that the client is durable by giving it a `durable-client-ID`. The servers use this ID to identify the client. For a non-durable client, the `durable-client-ID` is an empty string. The ID can be any number that is unique among the clients attached to servers in the same distributed system.
     
     -   **Durable timeout**\u2014The `durable-timeout` setting specifies how long this client\u2019s servers should wait after the client disconnects before terminating its message queue. During that time, the servers consider the client alive and continue to accumulate messages for it. The default is 300 seconds.
     
     The `durable-timeout` setting is a tuning parameter. When setting the timeout, take into account the normal activity of your application, the average size of your messages, and the level of risk you can handle. Assuming that no messages are being removed from the queue, how long can the application run before the queue reaches the maximum message count? In addition, how long can it run before the queued messages consume all the memory on the client host? How serious is each of those failures to your operation?
     
    -To assist with tuning, Geode provides statistics that track message queues for durable clients through the disconnect and reconnect cycles. For statistics documentation, see [Statistics](geodeman/managing/statistics/chapter_overview.html).
    +To assist with tuning, Geode statistics track message queues for durable clients through the disconnect and reconnect cycles.
     
    -When the queue is full, it blocks further operations that add messages until the queue size drops to an acceptable level. The action to take is specified on the server. For details on configuring the queue, see [Implementing Durable Client/Server Messaging](geodeman/developing/events/implementing_durable_client_server_messaging.html).
    +When the queue is full, it blocks further operations that add messages until the queue size drops to an acceptable level. Server configuration sets the action to take. See details on server configuration of the queue in the server documentation section [Implementing Durable Client/Server Messaging](geodeman/developing/events/implementing_durable_client_server_messaging.html).
    --- End diff --
    
    That is much clearer instruction than before


---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastructure@apache.org or file a JIRA ticket
with INFRA.
---

[GitHub] geode-native pull request #49: GEODE-2513 Unbrand docs section on Preserving...

Posted by davebarnes97 <gi...@git.apache.org>.
Github user davebarnes97 commented on a diff in the pull request:

    https://github.com/apache/geode-native/pull/49#discussion_r105226885
  
    --- Diff: docs/geode-native-docs/preserving-data/configuring-durable-nc.html.md.erb ---
    @@ -19,19 +19,19 @@ See the License for the specific language governing permissions and
     limitations under the License.
     -->
     
    -The durable native client can be configured in the `gfcpp.properties` file, or in the `CacheFactory::set(name,             value)` call.
    +The durable client can be configured in the `gfcpp.properties` file, or in the `CacheFactory::set(name,             value)` call.
     
    --   **Durable client ID**\u2014You indicate that the client is durable by giving it a `durable-client-ID`. The servers use this ID to identify the client. For a non-durable client, the `durable-client-ID` is an empty string. The ID can be any number that is unique among the clients attached to servers in the same distributed system.
    +-   **Durable client ID**\u2014Indicate that the client is durable by giving it a `durable-client-ID`. The servers use this ID to identify the client. For a non-durable client, the `durable-client-ID` is an empty string. The ID can be any number that is unique among the clients attached to servers in the same distributed system.
     
     -   **Durable timeout**\u2014The `durable-timeout` setting specifies how long this client\u2019s servers should wait after the client disconnects before terminating its message queue. During that time, the servers consider the client alive and continue to accumulate messages for it. The default is 300 seconds.
     
     The `durable-timeout` setting is a tuning parameter. When setting the timeout, take into account the normal activity of your application, the average size of your messages, and the level of risk you can handle. Assuming that no messages are being removed from the queue, how long can the application run before the queue reaches the maximum message count? In addition, how long can it run before the queued messages consume all the memory on the client host? How serious is each of those failures to your operation?
     
    -To assist with tuning, Geode provides statistics that track message queues for durable clients through the disconnect and reconnect cycles. For statistics documentation, see [Statistics](geodeman/managing/statistics/chapter_overview.html).
    +To assist with tuning, Geode statistics track message queues for durable clients through the disconnect and reconnect cycles.
     
    -When the queue is full, it blocks further operations that add messages until the queue size drops to an acceptable level. The action to take is specified on the server. For details on configuring the queue, see [Implementing Durable Client/Server Messaging](geodeman/developing/events/implementing_durable_client_server_messaging.html).
    +When the queue is full, it blocks further operations that add messages until the queue size drops to an acceptable level. Server configuration sets the action to take. See details on server configuration of the queue in the server documentation section [Implementing Durable Client/Server Messaging](geodeman/developing/events/implementing_durable_client_server_messaging.html).
     
    -## Configuring a Durable Native Client Using gfcpp.properties
    +## Configuring a Durable Client Using gfcpp.properties
    --- End diff --
    
    True. gfcpp.properties was changed to geode.properties with PR #13.


---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastructure@apache.org or file a JIRA ticket
with INFRA.
---