JmxImporter (Cinnamon API 2.20.3)

java.lang.Object
- com.lightbend.cinnamon.producer.Producer
- - com.lightbend.cinnamon.jmximporter.JmxImporter

public class JmxImporter
extends Producer

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description
`static class`	`JmxImporter.AdditionalIdentityInfo`
`static class`	`JmxImporter.AttributeInfo`
`static class`	`JmxImporter.BeanInfo`
`static class`	`JmxImporter.MetricType`
`static class`	`JmxImporter.TrueQueryExp`

Constructor Summary

Constructors
Constructor Description

JmxImporter(Backends backends)

JmxImporter(javax.management.MBeanServer mBeanServer, Backends backends)

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`void`	`addBeanInfos(com.typesafe.config.Config config)`	Parses the configuration looking for bean definitions and adds these to the internal set of beans to monitor.
`protected java.lang.String`	`getProperty(java.lang.String key, javax.management.ObjectName objectName)`
`protected boolean`	`isMatchingBeans(javax.management.ObjectName configBean, javax.management.ObjectName addedBean)`
`void`	`start()`
`void`	`stop()`	Lifecycle method called when the Cinnamon `Backends` are stopped, to enable cleanup of any resources acquired by the producer.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - JmxImporter
```
public JmxImporter(Backends backends)
```
  - JmxImporter
```
public JmxImporter(javax.management.MBeanServer mBeanServer,
                   Backends backends)
```
- Method Detail
  - start
```
public void start()
```
  - addBeanInfos
```
public void addBeanInfos(com.typesafe.config.Config config)
```
    Parses the configuration looking for bean definitions and adds these to the internal set of beans to monitor. This method is called during start-up of the JMXImporter, but beans can be added in runtime should one like to add beans dynamically.
    For beans to be added the configuration must follow the layout described in the Cinnamon documentation.
    
    Parameters:
    
    config - the configuration to parse.
    
    See Also:
    
    JMX Importer configuration
  - isMatchingBeans
```
protected boolean isMatchingBeans(javax.management.ObjectName configBean,
                                  javax.management.ObjectName addedBean)
```
  - getProperty
```
protected java.lang.String getProperty(java.lang.String key,
                                       javax.management.ObjectName objectName)
```
  - stop
```
public void stop()
```
    Description copied from class: Producer
    
    Lifecycle method called when the Cinnamon Backends are stopped, to enable cleanup of any resources acquired by the producer.
    
    Specified by:
    
    stop in class Producer