Ilya Shishkov created IGNITE-29235:
--------------------------------------
Summary: Docs: add the METRICS system view and fix column types
and descriptions of system views
Key: IGNITE-29235
URL: https://issues.apache.org/jira/browse/IGNITE-29235
Project: Ignite
Issue Type: Task
Reporter: Ilya Shishkov
Assignee: Ilya Shishkov
Attachments: docs-sync-2-system-views.patch
Summary: Docs: add the METRICS system view and fix column types and
descriptions of system views
Type: Improvement
Component: documentation
Attachment: docs-sync-2-system-views.patch
----
h3. Problem
The [System
Views|https://ignite.apache.org/docs/ignite2/latest/monitoring-metrics/system-views]
page
({{docs/_docs/monitoring-metrics/system-views.adoc}}) mostly matches the views
published by a node. It has the
following gaps:
* The {{METRICS}} view ({{SYS.METRICS}}, created by the SQL view metric
exporter, enabled by default) is published
through SQL, JMX and {{control.sh --system-view}}, but the page doesn't
describe it. It is mentioned only on the
Metrics System page.
* {{METASTORAGE}} exists only on server nodes with persistence enabled, and
{{SNAPSHOT}} exists only on server nodes.
On other nodes a query fails with "table not found". The page doesn't mention
this.
* Wrong column types:
** {{CACHES.REBALANCE_BATCHES_PREFETCH_COUNT}} is {{long}}, not {{int}}.
** 13 columns are documented as {{UUID}}, but they are {{IgniteUuid}}: their
value isn't a UUID string, and
{{SYS.VIEW_COLUMNS}} also reports {{IgniteUuid}}:
*** {{TASKS.ID}}, {{TASKS.SESSION_ID}}, {{TASKS.JOB_ID}};
*** {{JOBS.ID}}, {{JOBS.SESSION_ID}};
*** {{SERVICES.SERVICE_ID}};
*** {{TRANSACTIONS.XID}}, {{TRANSACTIONS.ORIGINATING_XID}};
*** {{CACHE_EXPLICIT_LOCKS.XID}};
*** {{CACHE_LOCKS.XID}}, {{CACHE_LOCKS.ORIGINATING_XID}};
*** {{DS_QUEUES.ID}}, {{DS_SETS.ID}}.
** {{SERVICES.TOPOLOGY_SNAPSHOT}} is {{Map<UUID, Integer>}}, not {{string}}.
* Empty descriptions: {{CACHES.IS_MANAGEMENT_ENABLED}},
{{CACHES.IS_STATISTICS_ENABLED}},
{{SCAN_QUERIES.TASK_NAME}}.
* Javadoc markup in the text: {{CACHES.IS_STORE_KEEP_BINARY}} contains
{{\{@link CacheStore\}}}.
* The {{CACHES}}, {{SERVICES}}, {{SQL_QUERIES_HISTORY}},
{{CACHE_GROUP_PAGE_LISTS}} and {{DATA_REGION_PAGE_LISTS}}
sections have no introductory sentence.
h3. Changes
Documentation only, {{system-views.adoc}}:
* The {{METRICS}} section is added, with links to the SQL View and Histograms
sections of the Metrics System page.
* Availability notes are added to {{METASTORAGE}} and {{SNAPSHOT}}.
* The column types listed above are fixed.
* The empty descriptions are filled in and the javadoc markup is removed.
* Introductory sentences are added to the 5 sections.
* A typo is fixed: "Ttransaction" in {{TRANSACTIONS.ORIGINATING_XID}}.
The column order and the mixed notation of types ({{string}}/{{long}} vs
{{VARCHAR}}/{{BIGINT}}) are unchanged and can
be unified separately.
h3. How it was verified
A cluster of 2 server nodes and 1 client node was started from the current
master with most optional features
enabled: persistence, encryption, SSL, services, H2 and Calcite, indexes, a
thin client, data structures, continuous
and scan queries, transactions, locks and snapshots.
On every node the following were dumped and compared with the tables of the
page:
* all system views, with the attributes of their walkers;
* {{SYS.VIEWS}} and {{SYS.VIEW_COLUMNS}} through both SQL engines;
* the JMX MBeans of the views.
Results:
* JMX export ({{JmxSystemViewExporterSpi}}) matches the registered views 1:1
(server: 53, client: 51).
* H2 and Calcite expose the same views and columns.
* Before the patch: 1 view is missing from the page, plus 19 column-level
discrepancies (types, empty descriptions,
markup).
* After the patch: no discrepancies. All 53 views and their columns match the
page.
--
This message was sent by Atlassian Jira
(v10.3.26#10030026)
