nablarch.integration.micrometer

Class MeterRegistryFactory<T extends io.micrometer.core.instrument.MeterRegistry>

java.lang.Object

nablarch.integration.micrometer.MeterRegistryFactory<T>

Type Parameters:

T - サブクラスで生成する具体的なMeterRegistryの型

All Implemented Interfaces:

ComponentFactory<T>

Direct Known Subclasses:

CloudWatchMeterRegistryFactory, DatadogMeterRegistryFactory, GlobalMeterRegistryFactory, LoggingMeterRegistryFactory, OtlpMeterRegistryFactory, SimpleMeterRegistryFactory, StatsdMeterRegistryFactory

public abstract class MeterRegistryFactory<T extends io.micrometer.core.instrument.MeterRegistry>
extends java.lang.Object
implements ComponentFactory<T>

MeterRegistryのコンポーネント生成に共通する処理をまとめた抽象クラス。

Field Summary

Fields

Modifier and Type	Field and Description
protected ApplicationDisposer	applicationDisposer 廃棄処理を行うインタフェース。
protected MeterBinderListProvider	meterBinderListProvider 生成したMeterRegistryに適用するMeterBinderリストのプロバイダ。
protected java.lang.String	prefix 設定値のプレフィックス。
protected java.util.Map<java.lang.String,java.lang.String>	tags すべてのメトリクスに共通で設定するタグ。
protected java.lang.String	xmlConfigPath 設定ファイルのパス。

Constructor Summary

Constructors

Constructor and Description
MeterRegistryFactory()

Method Summary

Modifier and Type	Method and Description
protected abstract T	createMeterRegistry(MicrometerConfiguration micrometerConfiguration) MeterRegistryのインスタンスを生成する。
protected T	doCreateObject() ComponentFactory.createObject() の実処理を行うメソッド。
void	setApplicationDisposer(ApplicationDisposer applicationDisposer) ApplicationDisposerを設定する。
void	setMeterBinderListProvider(MeterBinderListProvider meterBinderListProvider) MeterBinderListProviderを設定する。
void	setPrefix(java.lang.String prefix) プレフィックスを設定する。
void	setTags(java.util.Map<java.lang.String,java.lang.String> tags) すべてのメトリクスに共通で設定するタグを指定する。
void	setXmlConfigPath(java.lang.String xmlConfigPath) XML設定ファイルのパスを設定する。

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface nablarch.core.repository.di.ComponentFactory

createObject

Field Detail

prefix

protected java.lang.String prefix

設定値のプレフィックス。

xmlConfigPath

protected java.lang.String xmlConfigPath

設定ファイルのパス。

未設定の場合に読み込まれるデフォルトのパスについてはMicrometerConfigurationを参照。

meterBinderListProvider

protected MeterBinderListProvider meterBinderListProvider

生成したMeterRegistryに適用するMeterBinderリストのプロバイダ。

tags

protected java.util.Map<java.lang.String,java.lang.String> tags

すべてのメトリクスに共通で設定するタグ。

applicationDisposer

protected ApplicationDisposer applicationDisposer

廃棄処理を行うインタフェース。

Constructor Detail

MeterRegistryFactory

public MeterRegistryFactory()

Method Detail

doCreateObject

protected T doCreateObject()

ComponentFactory.createObject() の実処理を行うメソッド。

サブクラスは、本メソッドを使って createObject() を次のように実装する。

 @Override
 public SimpleMeterRegistry createObject() {
     return doCreateObject();
 }

これは、 createObject() の戻り値の型が総称型だった場合、 DIコンテナがコンポーネントの具象型を特定できないことに起因する。
この問題は、上述のようにサブクラスで createObject() の戻り値の型を具象型として宣言することで回避できる。
一方で、コンポーネントを作成するロジック自体はどの MeterRegistry でも共通なので、 コンポーネント作成処理を共通化するために、このメソッドが用意されている。

Returns:

作成された MeterRegistry オブジェクト

createMeterRegistry

protected abstract T createMeterRegistry(MicrometerConfiguration micrometerConfiguration)

MeterRegistryのインスタンスを生成する。

Parameters:

micrometerConfiguration - Micrometerの設定

Returns:

生成した MeterRegistryのインスタンス

setPrefix

public void setPrefix(java.lang.String prefix)

プレフィックスを設定する。

Parameters:

prefix - プレフィックス

setXmlConfigPath

public void setXmlConfigPath(java.lang.String xmlConfigPath)

XML設定ファイルのパスを設定する。

Parameters:

xmlConfigPath - XML設定ファイルのパス

setMeterBinderListProvider

public void setMeterBinderListProvider(MeterBinderListProvider meterBinderListProvider)

MeterBinderListProviderを設定する。

Parameters:

meterBinderListProvider - MeterBinderListProvider

setTags

public void setTags(java.util.Map<java.lang.String,java.lang.String> tags)

すべてのメトリクスに共通で設定するタグを指定する。

Parameters:

tags - すべてのメトリクスに共通で設定するタグ

setApplicationDisposer

public void setApplicationDisposer(ApplicationDisposer applicationDisposer)

ApplicationDisposerを設定する。

Parameters:

applicationDisposer - ApplicationDisposer