You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@ignite.apache.org by ab...@apache.org on 2020/08/12 14:40:16 UTC
[ignite] branch IGNITE-7595 updated: update metrics pages
This is an automated email from the ASF dual-hosted git repository.
abudnikov pushed a commit to branch IGNITE-7595
in repository https://gitbox.apache.org/repos/asf/ignite.git
The following commit(s) were added to refs/heads/IGNITE-7595 by this push:
new 12fc8a2 update metrics pages
12fc8a2 is described below
commit 12fc8a2924d38cddf54ba7e75327757bdb97f7dd
Author: abudnikov <ab...@gridgain.com>
AuthorDate: Wed Aug 12 17:39:19 2020 +0300
update metrics pages
---
docs/_docs/code-snippets/java/pom.xml | 7 +++
.../main/java/org/apache/ignite/snippets/TDE.java | 2 +
docs/_docs/code-snippets/xml/metrics.xml | 11 +++--
docs/_docs/images/durable-memory-overview.png | Bin 197852 -> 0 bytes
.../monitoring-metrics/new-metrics-system.adoc | 51 ++++++++++++++++++---
docs/_docs/monitoring-metrics/new-metrics.adoc | 1 -
docs/_docs/monitoring-metrics/system-views.adoc | 4 +-
docs/_docs/thin-clients/python-thin-client.adoc | 2 +-
8 files changed, 63 insertions(+), 15 deletions(-)
diff --git a/docs/_docs/code-snippets/java/pom.xml b/docs/_docs/code-snippets/java/pom.xml
index 0832298..94065a7 100644
--- a/docs/_docs/code-snippets/java/pom.xml
+++ b/docs/_docs/code-snippets/java/pom.xml
@@ -56,6 +56,13 @@
<artifactId>ignite-zookeeper</artifactId>
<version>${ignite.version}</version>
</dependency>
+
+ <dependency>
+ <groupId>org.apache.ignite</groupId>
+ <artifactId>ignite-opencensus</artifactId>
+ <version>${ignite.version}</version>
+ </dependency>
+
<dependency>
<groupId>org.apache.ignite</groupId>
<artifactId>ignite-cloud</artifactId>
diff --git a/docs/_docs/code-snippets/java/src/main/java/org/apache/ignite/snippets/TDE.java b/docs/_docs/code-snippets/java/src/main/java/org/apache/ignite/snippets/TDE.java
index b362137..02b74f3 100644
--- a/docs/_docs/code-snippets/java/src/main/java/org/apache/ignite/snippets/TDE.java
+++ b/docs/_docs/code-snippets/java/src/main/java/org/apache/ignite/snippets/TDE.java
@@ -6,9 +6,11 @@ import org.apache.ignite.configuration.CacheConfiguration;
import org.apache.ignite.configuration.IgniteConfiguration;
import org.apache.ignite.lang.IgniteFuture;
import org.apache.ignite.spi.encryption.keystore.KeystoreEncryptionSpi;
+import org.junit.jupiter.api.Test;
public class TDE {
+ @Test
void configuration() {
//tag::config[]
IgniteConfiguration cfg = new IgniteConfiguration();
diff --git a/docs/_docs/code-snippets/xml/metrics.xml b/docs/_docs/code-snippets/xml/metrics.xml
index 4ac24b9..e43dd5a 100644
--- a/docs/_docs/code-snippets/xml/metrics.xml
+++ b/docs/_docs/code-snippets/xml/metrics.xml
@@ -7,12 +7,15 @@
<!-- tag::jmx-exporter[] -->
<bean class="org.apache.ignite.spi.metric.jmx.JmxMetricExporterSpi"/>
<!-- end::jmx-exporter[] -->
- <!-- tag::sql-exporter[] -->
+ <!-- tag::sql-exporter[] -->
<bean class="org.apache.ignite.spi.metric.sql.SqlViewMetricExporterSpi"/>
- <!-- end::sql-exporter[] -->
- <!-- tag::log-exporter[] -->
+ <!-- end::sql-exporter[] -->
+ <!-- tag::log-exporter[] -->
<bean class="org.apache.ignite.spi.metric.log.LogExporterSpi"/>
- <!-- end::log-exporter[] -->
+ <!-- end::log-exporter[] -->
+ <!-- tag::opencensus-exporter[] -->
+ <bean class="org.apache.ignite.spi.metric.opencensus.OpenCensusMetricExporterSpi"/>
+ <!-- end::opencensus-exporter[] -->
</list>
</property>
<!-- tag::discovery[] -->
diff --git a/docs/_docs/images/durable-memory-overview.png b/docs/_docs/images/durable-memory-overview.png
deleted file mode 100644
index e329e53..0000000
Binary files a/docs/_docs/images/durable-memory-overview.png and /dev/null differ
diff --git a/docs/_docs/monitoring-metrics/new-metrics-system.adoc b/docs/_docs/monitoring-metrics/new-metrics-system.adoc
index 6c542df..7c95cee 100644
--- a/docs/_docs/monitoring-metrics/new-metrics-system.adoc
+++ b/docs/_docs/monitoring-metrics/new-metrics-system.adoc
@@ -6,7 +6,7 @@
WARNING: Experimental
-Ignite 2.8 introduced a new mechanism for collecting metrics which is intended to replace the legacy metrics system.
+Ignite 2.8 introduced a new mechanism for collecting metrics, which is intended to replace the link:monitoring-metrics/metrics[legacy metrics system].
This section explains the new system and how you can use it to monitor your cluster.
//the types of metrics and how to export them, but first let's explore the basic concepts of the new metrics mechanism in Ignite.
@@ -18,8 +18,7 @@ Some metrics represent <<histograms>>.
And then there are different ways to export the metrics — what we call _exporters_.
To put it another way, the exporter are different ways you can access the metrics.
-Each exporter gives access to all available metrics.
-
+Each exporter always gives access to all available metrics.
Ignite includes the following exporters:
@@ -106,9 +105,6 @@ You can use any supported SQL tool to view the metrics:
| cache.myCache.EstimatedRebalancingKeys | 0 |
| cache.myCache.CacheEvictions | 0 |
| cache.myCache.CommitTime | [J@2eb66498 |
-| cache.myCache.OffHeapMisses | 0 |
-| cache.myCache.EntryProcessorMaxInvocationTime | 0 |
-| cache.myCache.OffHeapGets | 0 |
....
----
@@ -163,7 +159,48 @@ tab:C++[]
=== OpenCensus
-`org.apache.ignite.spi.metric.opencensus.OpenCensusMetricExporterSpi`
+`org.apache.ignite.spi.metric.opencensus.OpenCensusMetricExporterSpi` adds integration with the OpenCensus library.
+
+To use the OpenCensus exporter:
+
+. link:setup#enabling-modules[Enable the 'ignite-opencensus' module].
+. Add `org.apache.ignite.spi.metric.opencensus.OpenCensusMetricExporterSpi` to the list of exporters in the node configuration.
+. Configure OpenCensus StatsCollector to export to a specific system. See link:{githubUrl}/examples/src/main/java/org/apache/ignite/examples/opencensus/OpenCensusMetricsExporterExample.java[OpenCensusMetricsExporterExample.java] for an example and OpenCensus documentation for additional information.
+
+
+Configuration parameters:
+
+* `filter` - predicate that filters metrics.
+* `period` - export period.
+* `sendInstanceName` - if enabled, a tag with the Ignite instance name is added to each metric.
+* `sendNodeId` - if enabled, a tag with the Ignite node id is added to each metric.
+* `sendConsistentId` - if enabled, a tag with the Ignite node consistent id is added to each metric.
+
+
+
== Histograms
+The metrics that represent histograms are available in the JMX exporter only.
+Histogram metrics are exported as a set of values where each value corresponds to a specific bucket and is available through a separate JMX bean attribute.
+The attribute names of a histogram metric have the following format:
+
+```
+{metric_name}_{low_bound}_{high_bound}
+```
+
+where
+
+* `{metric_name}` - the name of the metric.
+* `{low_bound}` - start of the bound. `0` for the first bound.
+* `{high_bound}` - end of the bound. `inf` for the last bound.
+
+
+Example of the metric names if the bounds are [10,100]:
+
+* `histogram_0_10` - less than 10.
+* `histogram_10_100` - between 10 and 100.
+* `histogram_100_inf` - more than 100.
+
+
+
diff --git a/docs/_docs/monitoring-metrics/new-metrics.adoc b/docs/_docs/monitoring-metrics/new-metrics.adoc
index 09c5596..8fb4f82 100644
--- a/docs/_docs/monitoring-metrics/new-metrics.adoc
+++ b/docs/_docs/monitoring-metrics/new-metrics.adoc
@@ -26,7 +26,6 @@ Register name: `sys`
|UpTime| long | RuntimeMxBean.getUptime()
|memory.heap.committed| long| MemoryUsage.getHeapMemoryUsage().getCommitted()
|memory.heap.init | long| MemoryUsage.getHeapMemoryUsage().getInit()
-|memory.heap.max |long| MemoryUsage.getHeapMemoryUsage().getMax()
|memory.heap.used |long| MemoryUsage.getHeapMemoryUsage().getUsed()
|memory.nonheap.committed| long| MemoryUsage.getNonHeapMemoryUsage().getCommitted()
|memory.nonheap.init |long | MemoryUsage.getNonHeapMemoryUsage().getInit()
diff --git a/docs/_docs/monitoring-metrics/system-views.adoc b/docs/_docs/monitoring-metrics/system-views.adoc
index 0c445cb..940b98e 100644
--- a/docs/_docs/monitoring-metrics/system-views.adoc
+++ b/docs/_docs/monitoring-metrics/system-views.adoc
@@ -82,7 +82,7 @@ include::{javaCodeDir}/JavaThinClient.java[tag=system-views,indent=0]
|IS_MANAGEMENT_ENABLED | boolean|
|IS_NEAR_CACHE_ENABLED | boolean| True if near cache enabled
|IS_ONHEAP_CACHE_ENABLED | boolean | True if on heap cache enabled
-|IS_READ_FROM_BACKUP | boolean | True if read operation should be perfromed from backup node
+|IS_READ_FROM_BACKUP | boolean | True if read operation should be performed from backup node
|IS_READ_THROUGH | boolean | True if read from third party storage enabled
|IS_SQL_ESCAPE_ALL | boolean | If true all the SQL table and field names will be escaped with double quotes
|IS_SQL_ONHEAP_CACHE_ENABLED | boolean | If true SQL on-heap cache is enabled. When enabled, Ignite will cache SQL rows as they are accessed by query engine. Rows are invalidated and evicted from cache when relevant cache entry is either changed or evicted.
@@ -634,7 +634,7 @@ If persistence is enabled page lists are created for each partition of each cach
|IS_MANAGEMENT_ENABLED | boolean |
|IS_NEAR_CACHE_ENABLED | boolean | True if near cache enabled
|IS_ONHEAP_CACHE_ENABLED | boolean | True if on heap cache enabled
-|IS_READ_FROM_BACKUP | boolean | True if read operation should be perfromed from backup node
+|IS_READ_FROM_BACKUP | boolean | True if read operation should be performed from backup node
|IS_READ_THROUGH | boolean | True if read from third party storage enabled
|IS_SQL_ESCAPE_ALL | boolean | If true all the SQL table and field names will be escaped with double quotes
|IS_SQL_ONHEAP_CACHE_ENABLED | boolean | If true SQL on-heap cache is enabled. When enabled, Ignite will cache SQL rows as they are accessed by query engine. Rows are invalidated and evicted from cache when relevant cache entry is either changed or evicted.
diff --git a/docs/_docs/thin-clients/python-thin-client.adoc b/docs/_docs/thin-clients/python-thin-client.adoc
index 32fcb4f..094f5da 100644
--- a/docs/_docs/thin-clients/python-thin-client.adoc
+++ b/docs/_docs/thin-clients/python-thin-client.adoc
@@ -303,7 +303,7 @@ Field name aliases are used to give a convenient name for the full property name
- `alias`: alias (str).
===== Query Fields
-Query fields define the fields that are queriable.
+Query fields define the fields that are queryable.
- `name`: field name.
- `type_name`: name of Java type or complex object.