Return-Path: X-Original-To: archive-asf-public-internal@cust-asf2.ponee.io Delivered-To: archive-asf-public-internal@cust-asf2.ponee.io Received: from cust-asf.ponee.io (cust-asf.ponee.io [163.172.22.183]) by cust-asf2.ponee.io (Postfix) with ESMTP id E2BB6200C88 for ; Thu, 27 Apr 2017 10:05:42 +0200 (CEST) Received: by cust-asf.ponee.io (Postfix) id E16A0160BB2; Thu, 27 Apr 2017 08:05:42 +0000 (UTC) Delivered-To: archive-asf-public@cust-asf.ponee.io Received: from mail.apache.org (hermes.apache.org [140.211.11.3]) by cust-asf.ponee.io (Postfix) with SMTP id 1EF0A160BBC for ; Thu, 27 Apr 2017 10:05:41 +0200 (CEST) Received: (qmail 71701 invoked by uid 500); 27 Apr 2017 08:05:41 -0000 Mailing-List: contact commits-help@ignite.apache.org; run by ezmlm Precedence: bulk List-Help: List-Unsubscribe: List-Post: List-Id: Reply-To: dev@ignite.apache.org Delivered-To: mailing list commits@ignite.apache.org Received: (qmail 71570 invoked by uid 99); 27 Apr 2017 08:05:41 -0000 Received: from git1-us-west.apache.org (HELO git1-us-west.apache.org) (140.211.11.23) by apache.org (qpsmtpd/0.29) with ESMTP; Thu, 27 Apr 2017 08:05:41 +0000 Received: by git1-us-west.apache.org (ASF Mail Server at git1-us-west.apache.org, from userid 33) id EAFDEE01BC; Thu, 27 Apr 2017 08:05:40 +0000 (UTC) Content-Type: text/plain; charset="us-ascii" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit From: agoncharuk@apache.org To: commits@ignite.apache.org Date: Thu, 27 Apr 2017 08:05:44 -0000 Message-Id: <347cfaab72c74b1db85360edbfc55ceb@git.apache.org> In-Reply-To: <14c6587cf59d44a3a04bd063da306064@git.apache.org> References: <14c6587cf59d44a3a04bd063da306064@git.apache.org> X-Mailer: ASF-Git Admin Mailer Subject: [5/9] ignite git commit: IGNITE-5072 javadoc for MemoryMetrics was improved archived-at: Thu, 27 Apr 2017 08:05:43 -0000 IGNITE-5072 javadoc for MemoryMetrics was improved Project: http://git-wip-us.apache.org/repos/asf/ignite/repo Commit: http://git-wip-us.apache.org/repos/asf/ignite/commit/cee78f47 Tree: http://git-wip-us.apache.org/repos/asf/ignite/tree/cee78f47 Diff: http://git-wip-us.apache.org/repos/asf/ignite/diff/cee78f47 Branch: refs/heads/ignite-5072-merge Commit: cee78f47d132001f56c749103f2d8ff7e6c56aa2 Parents: f1018bf Author: Sergey Chugunov Authored: Wed Apr 26 18:32:13 2017 +0300 Committer: Sergey Chugunov Committed: Wed Apr 26 18:32:13 2017 +0300 ---------------------------------------------------------------------- .../java/org/apache/ignite/MemoryMetrics.java | 33 ++++++++++++++++++-- .../configuration/MemoryConfiguration.java | 6 ++-- 2 files changed, 34 insertions(+), 5 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/ignite/blob/cee78f47/modules/core/src/main/java/org/apache/ignite/MemoryMetrics.java ---------------------------------------------------------------------- diff --git a/modules/core/src/main/java/org/apache/ignite/MemoryMetrics.java b/modules/core/src/main/java/org/apache/ignite/MemoryMetrics.java index c652249..96eedfe 100644 --- a/modules/core/src/main/java/org/apache/ignite/MemoryMetrics.java +++ b/modules/core/src/main/java/org/apache/ignite/MemoryMetrics.java @@ -17,12 +17,41 @@ package org.apache.ignite; +import org.apache.ignite.configuration.MemoryConfiguration; +import org.apache.ignite.configuration.MemoryPolicyConfiguration; +import org.apache.ignite.mxbean.MemoryMetricsMXBean; + /** - * Interface provides methods to access metrics of memory usage on local instance of Ignite. + * An interface to collect metrics about page memory usage on Ignite node. Overall page memory architecture + * is described in {@link MemoryConfiguration} javadoc. + *

+ * As multiple page memories may be configured on a single Ignite node; memory metrics will be collected + * for each page memory separately. + *

+ *

+ * There are two ways to access metrics on local node. + *

    + *
  1. + * Firstly, collection of metrics can be obtained through {@link Ignite#memoryMetrics()} call.
    + * Please pay attention that this call returns snapshots of memory metrics and not live objects. + *
    2. + *
  2. + * Secondly, all {@link MemoryMetrics} on local node are exposed through JMX interface.
    + * See {@link MemoryMetricsMXBean} interface describing information provided about metrics + * and page memory configuration. + *
    3. + *
+ *

+ *

+ * Also users must be aware that using memory metrics has some overhead and for performance reasons is turned off + * by default. + * For turning them on both {@link MemoryPolicyConfiguration#setMetricsEnabled(boolean)} configuration property + * or {@link MemoryMetricsMXBean#enableMetrics()} method of JMX bean can be used. + *

*/ public interface MemoryMetrics { /** - * @return Memory policy name. + * @return Name of memory region metrics are collected for. */ public String getName(); http://git-wip-us.apache.org/repos/asf/ignite/blob/cee78f47/modules/core/src/main/java/org/apache/ignite/configuration/MemoryConfiguration.java ---------------------------------------------------------------------- diff --git a/modules/core/src/main/java/org/apache/ignite/configuration/MemoryConfiguration.java b/modules/core/src/main/java/org/apache/ignite/configuration/MemoryConfiguration.java index 307e2d3..1561f30 100644 --- a/modules/core/src/main/java/org/apache/ignite/configuration/MemoryConfiguration.java +++ b/modules/core/src/main/java/org/apache/ignite/configuration/MemoryConfiguration.java @@ -33,7 +33,7 @@ import org.apache.ignite.internal.util.typedef.internal.U; *

* If initial size of the default memory region doesn't satisfy requirements or it's required to have multiple memory * regions with different properties then {@link MemoryPolicyConfiguration} can be used for both scenarios. - * For instance, Using memory policies you can define memory regions of different maximum size, eviction policies, + * For instance, using memory policies you can define memory regions of different maximum size, eviction policies, * swapping options, etc. Once you define a new memory region you can bind particular Ignite caches to it. *

* To learn more about memory policies refer to {@link MemoryPolicyConfiguration} documentation. @@ -42,14 +42,14 @@ import org.apache.ignite.internal.util.typedef.internal.U; * {@code * * - * + * * * * * * * - * + * * * *