カスタム・メトリックを定義するには、oracle-apm-agent/config/<version>ディレクトリ内にMetricCollection.acmlという名前の新しい構成ファイルを作成します。

MetricCollection.acmlファイルは、カスタム・メトリック収集構成用のACMLフォーマット(YAMLのサブセット)のカスタム・ファイルです。

value_path属性の使用例を示します。

MyMetrics:
    jvm-used-heap:
        type: measurement
        scalar: long
        source:
          -
            type: mbean
            mbean_name: java.lang:type=Memory
            value_path: HeapMemoryUsage/used
    jvm-used-heap-after-old-gc:
        type: measurement
        scalar: long
        source:
          -
            type: mbeans
            mbean_name: java.lang:type=GarbageCollector,name=*Old*
            value_path: LastGcInfo/memoryUsageAfterGc/*/value/used
          -
            type: mbeans
            mbean_name: java.lang:type=GarbageCollector,name=*MarkSweep*
            value_path: LastGcInfo/memoryUsageAfterGc/*/value/used

前述の例では、メトリックは1分ごとに収集されます。収集されるメトリックは、jvm-heap-usedとjvm-used-heap-after-old-gcの2つです。

jvm-heap-usedの場合、ソースは1つのみ(mbean)です。mbeanオブジェクト名はjava.lang:type=Memoryです。このmbeanオブジェクトにはHeapMemoryUsageの属性があり、そのデータ型はCompositeDataSupportです。これは数値ではないため、メトリックとして使用できません。ただし、これはヒープの取得元として使用したメトリックのマップを表しています。そのため、使用したマップ・キーを含むオブジェクトへのドリルダウンが必要です。

jvm-used-heap-after-old-gcの場合、2つのソース(mbeans)があり、どちらも's'が付く複数形です。メトリックは定義ごとに順番に収集され、有効なメトリックを返す最初のソースが使用されます。ソースが2つある理由は、javaバージョンごとに異なるガベージ・コレクタ名があるためです。また、value_pathドリルダウンでもワイルドカードが使用され、すべてのメモリー領域のgc値の後にあるすべての使用済メモリーが単一のメトリック値として合計されます。値パスのデータ・ドリルダウンはLastGcInfo/memoryUsageAfterGc/*/value/usedで、これはLastGcInfo(CompositeData)/memoryUsageAfterGc(TabularData)/<index>(CompositeData)/value(MemoryUsage)/used(Long)を示します。

operationName属性を使用する例:

MyMetrics:
    CacheStatistics:
       type: measurement
       scalar: double
       skippable: false
       source:
        - type: mbean
          mbean_name:com.cache:type=CacheServiceMXBean
          operation_name: cacheStatistics
          params: SessionCache,JohnDoe
    DatabaseQueryTime:
       type: measurement
       scalar: long
       skippable: false    
       source:
        - type: mbean
          mbean_name: com.db:type=DbManagerMXBean
          operation_name: dbQueryTime

前述の例では、メトリックは毎分の最上部に収集されます。収集されるメトリックには、CacheStatisticsとDatabaseQueryTimeの2つがあります。このMBean構成のソースは、MBeanのみにできます。

CacheStatisticsの場合、MBeanオブジェクト名はcom.cache:type=CacheServiceMXBeanです。起動されるメソッドはcacheStatisticsです。この操作では、特定のユーザーによってフィルタされた、指定されたキャッシュ名のキャッシュ統計が取得されます。SessionCacheおよびJohnDoeは、それぞれCacheNameおよびUserNameのパラメータ値です。ユーザーは、ディメンションとしてAssociatedCacheName、CacheHits、CacheMisses、InMemoryHits、OnDiskHitsなどの有用な属性のマップを作成し、対応する値とともに後述するように、サポートされている戻り型の一部として返すことができます。

DatabaseQueryTimeの場合、MBeanオブジェクト名はcom.db:type=DbManagerMXBeanです。起動されるメソッドはdbQueryTimeです。このMBeanにはパラメータが構成されていません。