4 プラットフォームMBeanサーバーとプラットフォームMXBeanの使用

アプリケーションは、自身のJava VMと同一Java VMで稼働するプラットフォームMXBeanのメソッドに対して直接呼出しを行うことができます。直接呼出しには、ManagementFactoryクラスのstaticメソッドを使用できます。ManagementFactoryには、getClassLoadingMXBean()、getGarbageCollectorMXBeans()、getRuntimeMXBean()などの様々なプラットフォームMXBeanにそれぞれ対応するaccessorメソッドが用意されています。プラットフォームMXBeanが複数存在する場合、そのメソッドは検出したプラットフォームMXBeanのリストを返します。

たとえば、例 4-1では、ManagementFactoryのstaticメソッドを使用してプラットフォームMXBeanのRuntimeMXBeanを取得し、さらにプラットフォームMXBeanからベンダー名を取得します。

例4-1 ManagementFactoryクラスを使用したプラットフォームMXBeanへのアクセス

RuntimeMXBean mxbean = ManagementFactory.getRuntimeMXBean();
String vendor = mxbean.getVmVendor(); 

アプリケーションでは、MXBeanプロキシを使用してプラットフォームMXBeanメソッドを呼び出すこともできます。これを行うには、staticメソッドManagementFactory.newPlatformMXBeanProxy()を呼び出して、指定されたMBeanサーバーにメソッドの呼出しを転送するMXBeanプロキシ・インスタンスの作成が必要となります。アプリケーションでは、通常別のJava VMのプラットフォームMXBeanに対するリモート・アクセスを可能とするプロキシを作成します。

たとえば、例4-2では、例4-1とまったく同じ処理を実行しますが、ここではMXBeanプロキシを使用します。

例4-2 MXBeanプロキシを使用したプラットフォームMXBeanへのアクセス

MBeanServerConnection mbs;
...
// Get a MBean proxy for RuntimeMXBean interface
RuntimeMXBean proxy =
    ManagementFactory.newPlatformMXBeanProxy(mbs,
                                             ManagementFactory.RUNTIME_MXBEAN_NAME,
                                             RuntimeMXBean.class);
// Get standard attribute "VmVendor"
String vendor = proxy.getVmVendor();

アプリケーションは、別の実行中のJava VMのプラットフォームMBeanサーバーに接続されているMBeanServerConnectionインタフェースを経由してプラットフォームMXBeanメソッドを間接的に呼び出すことができます。MBeanServerConnectionクラスのgetAttribute()メソッドを使用して、MBeanのObjectNameと属性名をパラメータとして指定することで、プラットフォームMXBeanの属性を取得します。

たとえば、例4-3では、例4-1および例4-2と同じジョブを実行しますが、MBeanServerConnectionを介した間接的な呼出しを使用します。

例4-3 MBeanServerConnectionクラスを使用したプラットフォームMXBeanへのアクセス

MBeanServerConnection mbs;
...
try {
  ObjectName oname = new ObjectName(ManagementFactory.RUNTIME_MXBEAN_NAME);
  // Get standard attribute "VmVendor"
  String vendor = (String) mbs.getAttribute(oname, "VmVendor");
} catch (....) {
  // Catch the exceptions thrown by ObjectName constructor
  // and MBeanServer.getAttribute method
  ...
}

例4-4では、Oracle JDKのMXBeanインタフェースの1つに対して直接アクセスを行っています。

例 4-4 MXBean属性に対する直接アクセス

com.sun.management.OperatingSystemMXBean mxbean =
  (com.sun.management.OperatingSystemMXBean) ManagementFactory.getOperatingSystemMXBean();

// Get the number of processors
int numProcessors = mxbean.getAvailableProcessors();

// Get the Oracle JDK-specific attribute Process CPU time
long cpuTime = mxbean.getProcessCpuTime();

例4-5では、MBeanServerConnectionクラスを使用して、Oracle JDKのMXBeanインタフェースの1つにアクセスします。

例4-5 MBeanServerConnectionを使用したMXBean属性へのアクセス

MBeanServerConnection mbs;

// Connect to a running Java VM (or itself) and get MBeanServerConnection
// that has the MXBeans registered in it
...

try {
    // Assuming the OperatingSystem MXBean has been registered in mbs
    ObjectName oname = new ObjectName(ManagementFactory.OPERATING_SYSTEM_MXBEAN_NAME);

    // Get standard attribute "Name"
    String vendor = (String) mbs.getAttribute(oname, "Name");

    // Check if this MXBean contains Oracle JDK's extension
    if (mbs.isInstanceOf(oname, "com.sun.management.OperatingSystemMXBean")) {
        // Get platform-specific attribute "ProcessCpuTime"
        long cpuTime = (Long) mbs.getAttribute(oname, "ProcessCpuTime");
    }
} catch (....) {
    // Catch the exceptions thrown by ObjectName constructor
    // and MBeanServer methods
    ...
}

メモリー・プールには、使用量しきい値およびコレクション使用量しきい値の2種類のメモリーしきい値を設定することができます。これらのしきい値のどちらか一方は、特定のメモリー・プールでサポートされない可能性があります。使用量しきい値とコレクション使用量しきい値の値は、JConsoleの「MBean」タブで設定できます。

アプリケーションでは、すべてのメモリー・プール用のgetUsage()メソッド、または使用量しきい値をサポートするメモリー・プール用のisUsageThresholdExceeded()メソッドを呼び出すことにより、アプリケーション自体のメモリー使用量を継続的にモニターできます。

例 4-6では、タスクの配置と処理のために設けられた専用のスレッドが使用されています。各間隔では、メモリーの使用量に基づき新しいタスクの受け取りや処理を行うかどうかを判断します。メモリーの使用量がその使用量しきい値を上回る場合、そのメモリーの使用量がしきい値を下回るまで、別のVMに未処理のタスクを再配置し、新しいタスクを受け取らないようにします。

例4-6 ポーリングの使用

pool.setUsageThreshold(myThreshold);
....
boolean lowMemory = false;
while (true) {
  if (pool.isUsageThresholdExceeded()) {
    lowMemory = true;
    redistributeTasks();  // redistribute tasks to other VMs
    stopReceivingTasks();  // stop receiving new tasks
  } else {
    if (lowMemory) { // resume receiving tasks
      lowMemory = false;
      resumeReceivingTasks();
    }
    // processing outstanding task
    ...
  }
  // sleep for sometime
  try {
    Thread.sleep(sometime);
  } catch (InterruptedException e) {
    ...
  }
}      

例 4-6では、メモリーの使用量がその使用量しきい値を一時的に下回る場合と、2つの繰返し間においてメモリーの使用量がしきい値を上回ったままの状態である場合の区別がありません。getUsageThresholdCount()メソッドから返される使用量しきい値の数を使用して、2つのポーリング間でメモリーの使用量がしきい値を下回る値を返すかどうかを判断します。

かわりにコレクション使用量しきい値をテストするには、例4-6と同じ方法で、isCollectionUsageThresholdSupported()、isCollectionThresholdExceeded()およびgetCollectionUsageThreshold()メソッドを使用します。

MemoryMXBeanインタフェースでメモリー・プールが使用量しきい値に到達しているか、上回っていることが検出されたときは、使用量しきい値超過通知が発行されます。使用量がしきい値を下回り、再び上回るまで、MemoryMXBeanインタフェースは、別の使用量しきい値超過通知を発行しません。同様に、ガベージ・コレクション後のメモリーの使用量が、コレクション使用量しきい値を上回ると、MemoryMXBeanインタフェースはコレクション使用量しきい値超過通知を発行します。

例 4-7は、例 4-6と同じロジックを実装していますが、ロー・メモリー状態を検出するために使用量しきい値通知を使用します。通知を受け取ると、リスナーは、未処理タスクの再配置、新タスクの受け入れ拒否、新タスクの再受け入れなどのアクションを実行するために別のスレッドの通知を行います。

一般に、以後の通知の遅れを回避するために、処理量を最小限にするhandleNotificationメソッドを設計する必要があります。時間を浪費するアクションは別のスレッドにおいて実行するようにしてください。複数のスレッドで同時に通知リスナーを呼び出すことができるため、リスナーは、実行するタスクを正しく同期させる必要があります。

例 4-7しきい値通知の使用

class MyListener implements javax.management.NotificationListener {
  public void handleNotification(Notification notification, Object handback)  {
    String notifType = notification.getType();
    if (notifType.equals(MemoryNotificationInfo.MEMORY_THRESHOLD_EXCEEDED)) {
      // potential low memory, redistribute tasks to other VMs & stop receiving new tasks.
      lowMemory = true;
      notifyAnotherThread(lowMemory);
    }
  }
}

// Register MyListener with MemoryMXBean
MemoryMXBean mbean = ManagementFactory.getMemoryMXBean();
NotificationEmitter emitter = (NotificationEmitter) mbean;
MyListener listener = new MyListener();
emitter.addNotificationListener(listener, null, null);

このメモリー・プールで使用量しきい値をサポートするものと仮定する場合、しきい値(値を上回るとアプリケーションで新タスクを受け入れなくなるしきい値)をある値(バイト数表記)に設定することができます。

pool.setUsageThreshold(myThreshold);

この後、使用量しきい値の検出が有効となり、MyListenerクラスによって通知が処理されます。