製品マニュアル

アプリケーションの定義

このカテゴリは、任意のアプリケーションモジュールスクリプトの開始点となる、「new」API で構成されます。これ以外にも、アプリケーションの検出レベルの定義や、アプリケーション上で実行できる操作の定義が行える API なども含まれます。

説明: この API は MSSQL、Oracle、SAP などのアプリケーションの種類を Resiliency Platform に渡します。このインターフェースは、アプリケーションモジュールスクリプトの開始点であり、必須です。これは、ロガーとともにアプリケーションを開始します。デフォルトでは、ログレベルは［情報 (Info)］に設定されています。

ログレベルを変更するには、reset_log API を使用します。

ログ記録を参照してください。

必須: はい

入力パラメータ: 文字列: アプリケーションの種類。

戻り値: アプリケーションオブジェクト、それ以外の場合は未定義のオブジェクト。

構文:

new VRTS::AppSDK::AppEnablementSDK::Application("<Application Type>");

例:

my $appObj = new VRTS::AppSDK::AppEnablementSDK::Application("TestApp");

説明: このインターフェースを使用して、アプリケーションのスクリプトがサポートしている検出の種類を宣言します。アプリケーションを検出する Resiliency Platform では、DEEP や PROBE などの検出のタイプを定義する必要があります。1 つ以上の検出のレベルを定義する場合は区切り文字としてカンマを使用します。

DEEP および PROBE の検出のタイプは必須です。

必須: はい

入力パラメータ: 文字列: 検出のレベルのタイプで、値は「DEEP」または「PROBE」である必要があります。

戻り値: 成功した場合は 0、それ以外の場合は正の数です。

例:

my $appObj = new VRTS::AppSDK::AppEnablementSDK::Application("TestApp");
$appObj->set_discovery_types("DEEP", "PROBE"); 

説明: このインターフェースを使用して、特定のアプリケーションモジュールスクリプトがサポートしている操作のリストを指定します。たとえば、アプリケーションの開始や停止などです。1 つ以上の操作の種類を定義する場合は区切り文字としてカンマを使用します。このインターフェースは、Resiliency Platform で検出スクリプトを実行し、アプリケーションの操作を実行するのに必須です。

開始および停止操作は必須です。

必須: はい

入力パラメータ: 文字列: 操作の種類で、値は「START」および「STOP」である必要があります。

戻り値: 成功した場合は 0、それ以外の場合は正の数です。

例:

my $appObj = new VRTS::AppSDK::AppEnablementSDK::Application("TestApp");
$appObj->set_operation_types("START", "STOP"); 

説明: このインターフェースを使用して、set_discovery_types API を使用して定義した検出操作の種類に対して検出操作のコールバック関数を登録します。前述の検出操作でアプリケーションモジュールスクリプトが呼び出されたときにのみ、登録されたコールバック関数が呼び出されます。これは、Resiliency Platform に、操作を実行し、適切なリターンコードとメッセージを返すことができるサブルーチンを伝える必須インターフェースです。

検出スクリプトがオフラインモードでアプリケーションを検出し続けるようにします。そうしないと、アプリケーションがオフラインのときは検出されないので、インスタンスは Resiliency Platform コンソールから削除されます。インスタンスを使用して作成された Resiliency Group は無効になります。

コールバック関数は、アプリケーションモジュールスクリプトで定義され、前述の検出操作を正常に実行できるサブルーチンです。前述の操作が正常に実行された場合、コールバック関数は 0 を返し、それ以外の場合は失敗したことを示す正の数を返します。戻りコードとともに、成功または失敗のメッセージのいずれかを含む文字列を返すこともできます。戻りコードの入力は必須で、それ以外の場合、操作は失敗とみなされます。応答メッセージの入力は省略可能です。

必須: はい

入力パラメータ: 文字列: 検出操作 - set_discovery_types API を使用して事前に設定された検出操作の名前です。

入力パラメータ: コールバック関数の参照 - アプリケーションモジュールスクリプトで定義されたサブルーチンへの参照です。

戻り値: 成功した場合は 0、それ以外の場合は正の数です。

例:

my $appObj = new VRTS::AppSDK::AppEnablementSDK::Application("TestApp");
if(defined $appObj)
{
	$appObj->set_discovery_types("DEEP, PROBE");
	$ret=$appObj->register_discovery_callback("PROBE",\&probe);
	$ret=$appObj->register_discovery_callback("DEEP",\&deep);
}

sub probe
{

	# Write the code here to discover all application instances

	my $inst_name = "app_inst";
	$appObj->log(LOGLEVEL_DEBUG,"Application instance name: [$inst_name]");
	
	# Write the code here to discover state of each application instance
	
	# Report the state of the discovered application instance 
	# on the Resiliency Platform.
	my $inst = $appObj->add_application_inst($inst_name);
	if (defined $inst)
	{
		# The state must be reported either 'online' or 'offline'
		$inst->set_property(APP_INST_STATE, "Online");
	}

	# return 0 for successful and 1 for failure
	return 0,"probe is successful";
}

説明: このインターフェースを使用して、set_operation_types API を使用して定義した操作の種類に対してコールバック関数を登録します。前述の操作でアプリケーションモジュールスクリプトが呼び出されたときのみ、登録されたコールバック関数が呼び出されます。これは、Resiliency Platform に、操作を実行し、適切なリターンコードとメッセージを返すことができるサブルーチンを伝える必須インターフェースです。

コールバック関数は、アプリケーションモジュールスクリプトで定義され、前述の操作を正常に実行できるサブルーチンです。前述の操作が正常に実行された場合、コールバック関数は 0 を返し、それ以外の場合は失敗したことを示す正の数を返します。戻りコードとともに、成功または失敗のメッセージのいずれかを含む文字列を入力することもできます。戻りコードの入力は必須で、それ以外の場合、操作は失敗とみなされます。応答メッセージの入力は省略可能です。

前述の API のいずれかを使用して AppEnablementSDK に登録されている場合のコールバック関数は、パラメータとして hashref を受信します。hashref パラメータには、キーとしての INSTANCE_NAME と値としてのアプリケーションインスタンス名が含まれます。

必須: はい

入力パラメータ: 文字列: 操作 - set_operation_types API を使用して事前に定義された操作の名前です。

コールバック関数の参照 - アプリケーションモジュールスクリプトで定義されたサブルーチンへの参照です。

戻り値: 成功した場合は 0、それ以外の場合は正の数です。

例:

my $appObj=new VRTS::AppSDK::AppEnablementSDK::Application("TestApp");
if(defined $appObj)
{
	$appObj->set_operation_types("START,STOP");
	$ret = $appObj->register_operation_callback("START",\&start);
	$ret = $appObj->register_operation_callback("STOP",\&stop);
}

sub start
{
	my ($arg) = @_;
	
	my $FuncName = ( caller 0 )[3];
	$appObj->log(LOGLEVEL_DEBUG,"Inside $FuncName");
	
	my $inst_name = $arg->{INSTANCE_NAME};
	$appObj->log(LOGLEVEL_DEBUG,"Application instance name: [$inst_name]");
	
	# Write the code here to start an application instance
	# and return appropriate status code and message.
	# Return 0 for successful and 1 for failure
	
	return 0, "Start is successful";
}