DataBot Metric Reference: Difference between revisions

From NovaOrdis Knowledge Base
Jump to navigation Jump to search
Line 3: Line 3:
* [[DataBot_User_Manual#Metric_Reference|DataBot User Manual]]
* [[DataBot_User_Manual#Metric_Reference|DataBot User Manual]]


=Metrics=
=Overview=


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


{{Internal|Events-api_Concepts#Metric_Definition|events-api Metric Definition}}
=Platform Metrics=


==Platform Metrics==
{{Internal|events OS Metrics|events OS Metrics}}


{{Internal|events OS Metrics|events OS Metrics}}
=JMX Metrics=


==JBoss CLI Metrics==
=JBoss CLI Metrics=


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.
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.
Line 32: Line 32:
</pre>
</pre>


===Types===
==Types==


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


===Classpath===
==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:
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:

Revision as of 14:25, 22 September 2017

Internal

Overview

Metric definition fundamentals are addressed in

events-api Metric Definition

Platform Metrics

events OS Metrics

JMX Metrics

JBoss CLI Metrics

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
...