The inventory is based onto the component registry. It mainly adapt the registration objects graph (components, extension points, contributions) as an mbean tree. This gives you an access to what and how are the services deployed. Other informations about these services (metrics, status, usecases) will be is to be attached to the inventory. Using these information, you can check that your server is correctly deployed.

Inventory is being completed by metrics. It's the accounting information that they can easily provide to users with no costs overhead. As example, directory manager provide core sessions counters. These information are bound into the mbeans tree. Managers defines gauges that polls metric for treesholds or to gather historical data.

Services are tested periodically by running a typical use case. Results about are published in the service subtree by the management use case scheduler. These informations is to be polled by managers for issuing alerts. We already defined a use case checking that the repository is well working by creating and removing a document.

That module contains the management logic : the resource publisher and the use cases scheduelr. These services implements only behaviours and have to be contributed by other components for activation.

That module contains adapters for nuxeo services such as the runtime inventory or the http session metric. It also contains the use case scheduler and some typical use cases such as the directory one.

Nuxeo platform management provides you the basic monitoring resources. The following section describes how coding integrating newer monitoring resources suitable for your needs.

That module contains a web engine module for serializing in XML mbeans. You have to use it if your management platform is not JMX aware.

As a developper, I want to publish some informations suitable for monitoring services I'm in charge for.

Here is the typical use cases for : service publishing, resource publishing and mbeans aliasing.

                      ..
          <require>org.nuxeo.runtime.management.ResourcePublisher</require>
          <extension point="services"
            target="org.nuxeo.runtime.management.ResourcePublisher">
            <service class="mypackage.MyService"
              ifClass="myPackage.MyServiceMBean" name="myService" />
          </extension>
          ..
          

            package mypackage;

import org.nuxeo.runtime.management.ResourceFactory;
import org.nuxeo.runtime.management.ObjectNameFactory;

public class MyMetricFactory implements ResourceFactory {

  public void configure(ResourcePublisherService publisher, ResourceFactoryDescriptor descriptor) {
    this.publisher = publisher;
    this.service = (MyService)Framework.getLocalService(My.class);
  }

  protected final ComponentName myServiceName = MyService:NAME;

  protected MyService service;
  protected ResourcePublisher publisher;

  public void registerResources() {
    for (String name:myService.doGetMetricNames() {
      doRegisterMetric(name);
    }
  }

  protected void doRegisterMetric(String name) {
    MyMetricContext context = new MyMetricContext(String name, service);
    String shortName = ObjectNameFactorty.formatMetricShortName(name);
    ObjectName qualifiedName = ObjectNameFactory.formatMetricQualifiedName(myServiceName,name);
    publisher.registerResource(shortName, qualifiedName, MyMetricMBean.class, metric);
  }

}
          

            package mypackage;


public class MyMetricContext implements MyMetricMBean {

  public void MyMetricContext(String name, MyService service) {
    this.service = service;
    this.name = name;
  }
 
  protected final String name;
  protected final MyService service;
     
  int getCount() {
    return service.doGetCount(name);
  }


}
          

            package mypackage;


public class MyService implements Service {

   protected String doGetNames() {
     ..
     return ...
   }

   protected int doGetCount(String name) {
     ..
     return ...
   }
}
          

                      ..
          <require>org.nuxeo.runtime.management.ResourcePublisher</require>
          <extension point="factories"
            target="org.nuxeo.runtime.management.ResourcePublisher">
            <factory class="mypackage.MyMetricFactory"
              ifClass="myPackage.MyMetricMBean" name="myMetricFactory" />
          </extension>
          ..
          

As an administrator I want to monitor OperatingSystem attributes in my management system using the XML serializer. I will contribute to the resource publisher by defining the following extension point :

                    ..
          <require>org.nuxeo.runtime.management.ResourcePublisher</require>
          <extension point="shortcuts"
            target="org.nuxeo.runtime.management.ResourcePublisher">
            ..
            <shortcut name="operatingSystem" qualifiedName="java.lang:type=OperatingSystem"/>
            ..
          </extension>
          ..
        

As a developer, I want to provide a feature operational status.

Services quality are to be monitored by scheduling typical use cases. Use cases should throw an exception for indicating error condition. Use cases are registered under the service they belongs to.

                    ..
          <require>org.nuxeo.ecm.management.usecases.UsecaseScheduler</require>
          <extension point="usecases"
            target="org.nuxeo.runtime.management.ResourcePublisher">
            <usecase name="myUsecase" class="mypackage.MyUsecase"
              serviceClass="mypackage.My" />
          </extension>
          ..
        

          package mypackage;

import org.nuxeo.ecm.management.usecases.Usecase;

public class MyUsecase implements Usecase {

   void init(Object service) {
     this.service = (My)service;
   }
   
   MyService service;
   
   void runCase(CoreSession session) throws ClientException {
      service.doSomething();
   }

}