External Sensors Plugin API (ExtSensorsType)

Overview

This document describe. Slurm external sensors plugins and the API that defines them. It is intended as a resource to programmers wishing to write their own Slurm external sensors plugins.
このドキュメントで説明します。Slurm外部センサープラグインとそれらを定義するAPI。独自のSlurm外部センサープラグインを作成したいプログラマーへのリソースとして意図されています。

Slurm external sensors plugins must conform to the Slurm Plugin API with the following specifications:
Slurm外部センサープラグインは、次の仕様のSlurm Plugin APIに準拠する必要があります。

const char plugin_name[]="full text name"

A free-formatted ASCII text string that identifies the plugin.
プラグインを識別する自由形式のASCIIテキスト文字列。

const char plugin_type[]="major/minor"

The major type must be "ext_sensors." The minor type can be any suitable name for the type of external sensors. We currently use
主なタイプは「ext_sensors」である必要があります。マイナータイプは、外部センサーのタイプに適した任意の名前にすることができます。現在使用しています

• none — No external sensors data is collected.
  none —外部センサーデータは収集されません。
  
• rrd — Gets external sensors data from the
  rrd —から外部センサーデータを取得します
  RRD database.

const uint32_t plugin_version
If specified, identifies the version of Slurm used to build this plugin and any attempt to load the plugin from a different version of Slurm will result in an error. If not specified, then the plugin may be loaded by Slurm commands and daemons from any version, however this may result in difficult to diagnose failures due to changes in the arguments to plugin functions or changes in other Slurm functions used by the plugin.
指定した場合、このプラグインのビルドに使用されたSlurmのバージョンを識別し、異なるバージョンのSlurmからプラグインをロードしようとすると、エラーが発生します。指定されていない場合、プラグインはSlurmコマンドとデーモンによって任意のバージョンから読み込まれる可能性がありますが、プラグイン関数の引数の変更やプラグインで使用される他のSlurm関数の変更が原因で、障害の診断が困難になる可能性があります。

The programmer is urged to study src/plugins/ext_sensors/rrd and src/common/slurm_ext_sensors.c for a sample implementation of a Slurm external sensors plugin.
プログラマーは、Slurm外部センサープラグインのサンプル実装について、src / plugins / ext_sensors / rrdおよびsrc / common / slurm_ext_sensors.cを調査することを強くお勧めします。

API Functions

All of the following functions are required. Functions which are not implemented must be stubbed.
以下の機能がすべて必要です。実装されていない関数はスタブする必要があります。

int init (void)

Description:
Called when the plugin is loaded, before any other functions are called. Put global initialization here.
プラグインがロードされたとき、他の関数が呼び出される前に呼び出されます。ここにグローバル初期化を配置します。

Returns:
SLURM_SUCCESS on success, or
SLURM_ERROR on failure.

void fini (void)

Description:
Called when the plugin is removed. Clear any allocated storage here.
プラグインが削除されたときに呼び出されます。ここで割り当て済みのストレージをすべてクリアします。

Returns: None.

Note: These init and fini functions are not the same as those described in the dlopen (3) system library. The C run-time system co-opts those symbols for its own initialization. The system _init() is called before the Slurm init(), and the Slurm fini() is called before the system's _fini().
注：これらのinitおよびfini関数は、dlopen（3）システムライブラリで説明されているものと同じではありません。Cランタイムシステムは、これらのシンボルを独自の初期化用にco-optします。システムの_init（）はSlurm init（）の前に呼び出され、Slurm fini（）はシステムの_fini（）の前に呼び出されます。

extern int ext_sensors_read_conf(void)

Description:
Reads the external sensors plugin configuration file (ext_sensors.conf) and populates the configuration structure. Called by the slurmctld daemon.
外部センサープラグイン構成ファイル（ext_sensors.conf）を読み取り、構成構造を設定します。slurmctldデーモンによって呼び出されます。

Arguments:
None

Returns:
SLURM_SUCCESS on success, or
SLURM_ERROR on failure.

extern int ext_sensors_free_conf(void)

Description:
Frees the memory allocated for the external sensors configuration. Called by the slurmctld daemon.
外部センサー構成に割り当てられたメモリを解放します。slurmctldデーモンによって呼び出されます。

Arguments:
None

Returns:
SLURM_SUCCESS on success, or
SLURM_ERROR on failure.

extern int ext_sensors_p_update_component_data(void)

Description:
Updates external sensors data for data types and component types as configured in ext_sensors.conf. Called by the slurmctld daemon.
ext_sensors.confで設定されているように、データタイプとコンポーネントタイプの外部センサーデータを更新します。slurmctldデーモンによって呼び出されます。

Arguments:
None

Returns:
SLURM_SUCCESS on success, or
SLURM_ERROR on failure.

extern int ext_sensors_p_get_stepstartdata(step_record_t *step_rec)

Description:
Sets external sensors data in the step record when a job step starts. Called by slurmctld.
ジョブステップの開始時に、ステップレコードに外部センサーデータを設定します。slurmctldによって呼び出されます。

Arguments:
step_rec (input) pointer to step record.
step_rec（入力）ステップレコードへのポインター。

Returns:
SLURM_SUCCESS on success, or
SLURM_ERROR on failure.

extern int ext_sensors_p_get_stependdata(step_record_t *step_rec)

Description:
Sets external sensors data in the step record when a job step ends. Called by slurmctld.
ジョブステップの終了時に、ステップレコードに外部センサーデータを設定します。slurmctldによって呼び出されます。

Arguments:
step_rec (input) pointer to step record.
step_rec（入力）ステップレコードへのポインター。

Returns:
SLURM_SUCCESS on success, or
SLURM_ERROR on failure.

Parameters

These parameters can be used in the slurm.conf to configure the plugin and the frequency at which to gather external sensors data.
これらのパラメーターをslurm.confで使用して、外部センサーデータを収集するプラグインと頻度を構成できます。

ExtSensorsType

Specifies which external sensors plugin should be used.
使用する外部センサープラグインを指定します。

ExtSensorsFreq

Time interval between pollings in seconds.
秒単位のポーリング間の時間間隔。

Last modified 23 October 2019