DataBot Metric Reference: Difference between revisions

From NovaOrdis Knowledge Base
Jump to navigation Jump to search
 
(25 intermediate revisions by the same user not shown)
Line 1: Line 1:
=Internal=
=Internal=


* [[Os-stats#os-stats_Metric_Reference|os-stats]]
* [[DataBot_User_Manual#Metric_Reference|DataBot User Manual]]


=Metrics=
=Overview=


==Platform Metrics==
Metric definition fundamentals are available in: <span id='events-api_Metric_Definitions'></span>{{Internal|Events-api_Concepts#Metric_Definition|events-api Metric Definitions}}


* <span id="PhysicalMemoryTotal">[[Proc-meminfo#MemTotal|PhysicalMemoryTotal]]</span> ([https://github.com/NovaOrdis/events/blob/master/src/main/java/io/novaordis/events/metric/memory/PhysicalMemoryTotal.java GitHub])
Metric source fundamentals are available in: {{Internal|Events-api_Concepts#Metric_Source|events-api Metric Sources}}
* <span id="PhysicalMemoryFree">[[Proc-meminfo#MemFree|PhysicalMemoryFree]]</span> ([https://github.com/NovaOrdis/events/blob/master/src/main/java/io/novaordis/events/metric/memory/PhysicalMemoryFree.java GitHub])
* <span id="PhysicalMemoryUsed">[[Proc-meminfo#Physical_Memory_Used_by_Processes|PhysicalMemoryUsed]]</span> ([https://github.com/NovaOrdis/events/blob/master/src/main/java/io/novaordis/events/metric/memory/PhysicalMemoryUsed.java GitHub])


==JBoss CLI Metrics==
=Platform Metrics=


<tt>os-stats</tt> can be configured to read CLI metrics from JBoss controllers. The controller is identified by its host, port and username controller components. If none of these are explicitly specified, the localhost:9999 and local authentication are assumed, which means the <tt>os-stats</tt> process has to be collocated with the JBoss controller on the same host.
{{Internal|events OS Metrics|events OS Metrics}}


=JMX Metrics=
<font color=red>TODO</font>
The order in which the key/value pairs are specified in the JMX ObjectName is not relevant.
=JBoss CLI Metrics=
<font color=red>TODO REVIEW</font>
DataBot can be configured to read CLI metrics from JBoss controllers. The controller is identified by its host, port and username controller components. If none of these are explicitly specified, the localhost:9999 and local authentication are assumed, which means the DataBot process has to be collocated with the JBoss controller on the same host. Support for [[DataBot#n3jHG32|password externalization]] will be implemented in the future.


Syntax:
Syntax:


<pre>
<pre>
jboss:[[username@]host[:port]]/path-element-1/path-element-2/attribute-name
jboss:[[username:password@]host[:port]]/path-element-1/path-element-2/attribute-name
</pre>
</pre>


Line 26: Line 35:
<pre>
<pre>
jboss:/subsystem=infinispan/cache-container=clustered/distributed-cache=web/number-of-entries
jboss:/subsystem=infinispan/cache-container=clustered/distributed-cache=web/number-of-entries
jboss:localhost/subsystem=infinispan/cache-container=clustered/distributed-cache=web/number-of-entries
jboss:localhost:9999/subsystem=infinispan/cache-container=clustered/distributed-cache=web/number-of-entries
jboss:test:test123@localhost:9999/subsystem=infinispan/cache-container=clustered/distributed-cache=web/number-of-entries
</pre>
</pre>


<pre>
==Types==
jboss:localhost/subsystem=infinispan/cache-container=clustered/distributed-cache=web/number-of-entries
 
</pre>
JBoss CLI attributes are typed, the controller knows and sends the correct type back. DataBot uses the type to build typed Property instances.
 
==Classpath==
 
The JBoss CLI client requires specific libraries added to the DataBot classpath, and instead of shipping those libraries with the installation bundle, DataBot must be configured to detect and use the libraries from a JBoss instance it has access to. In order to enable DataBot to build the classpath fragment, <tt>jboss_home</tt> must be specified in the  configuration file. Example:


<pre>
<pre>
jboss:localhost:9999/subsystem=infinispan/cache-container=clustered/distributed-cache=web/number-of-entries
...
jboss_home=/usr/jboss
...
</pre>
</pre>

Latest revision as of 15:10, 22 September 2017

Internal

Overview

Metric definition fundamentals are available in:

events-api Metric Definitions

Metric source fundamentals are available in:

events-api Metric Sources

Platform Metrics

events OS Metrics

JMX Metrics

TODO

The order in which the key/value pairs are specified in the JMX ObjectName is not relevant.

JBoss CLI Metrics

TODO REVIEW

DataBot can be configured to read CLI metrics from JBoss controllers. The controller is identified by its host, port and username controller components. If none of these are explicitly specified, the localhost:9999 and local authentication are assumed, which means the DataBot process has to be collocated with the JBoss controller on the same host. Support for password externalization will be implemented in the future.

Syntax: 

jboss:[[username:password@]host[:port]]/path-element-1/path-element-2/attribute-name

Example: 

jboss:/subsystem=infinispan/cache-container=clustered/distributed-cache=web/number-of-entries
jboss:localhost/subsystem=infinispan/cache-container=clustered/distributed-cache=web/number-of-entries
jboss:localhost:9999/subsystem=infinispan/cache-container=clustered/distributed-cache=web/number-of-entries
jboss:test:test123@localhost:9999/subsystem=infinispan/cache-container=clustered/distributed-cache=web/number-of-entries

Types

JBoss CLI attributes are typed, the controller knows and sends the correct type back. DataBot uses the type to build typed Property instances.

Classpath

The JBoss CLI client requires specific libraries added to the DataBot classpath, and instead of shipping those libraries with the installation bundle, DataBot must be configured to detect and use the libraries from a JBoss instance it has access to. In order to enable DataBot to build the classpath fragment, jboss_home must be specified in the configuration file. Example: 

...
jboss_home=/usr/jboss
...
Retrieved from "https://kb.novaordis.com/index.php?title=DataBot_Metric_Reference&oldid=28728"