New Relic では、NerdGraph を使用してステップ モニターを作成できます。ステップ モニターは、コードレスでマルチステップのブラウザーベースの監視を提供し、コードを記述せずに複雑なユーザー ワークフローを構成できます。このチュートリアルでは、NerdGraph API を使用してステップ モニターの作成を自動化する方法の例を示します。
ステップモニターを作成する
syntheticsCreateStepMonitorミューテーションを使用してステップ モニターを作成できます。このミューテーションにより、一連の定義済みアクションを使用して、マルチステップのブラウザ監視を設定できます。
入力
パラメータ | データタイプ | 必須ですか? | 説明 |
|---|---|---|---|
| 整数 | はい | モニターが作成される New Relic 。 |
| 配列 | はい | モニターがジョブを実行するために使用するBrowser 。 サポートされているブラウザ:
、
、
。 |
| 配列 | はい | モニターがジョブを実行するために使用するデバイス。サポートされているデバイス:
、
、
、
、
。 |
| 配列 | はい | モニターがチェックを実行する 識別子の配列 (例:
)。 |
| 弦 | はい | 歩数モニターの表示名。 |
| イナム | はい | モニターが実行される頻度。オプション:
、
、
、
、
、
、
、
、
。 |
| 弦 | はい | モニターで使用されるランタイム タイプ。受け入れられる値は
のみです。 |
| 弦 | はい | モニターで使用されるランタイム タイプのバージョン。受け入れられる値は
のみです。 |
| 弦 | はい | モニターで使用される言語。受け入れられる値は
のみです。 |
| イナム | はい | モニターのステータス。オプション:
(モニターはアクティブでチェックを実行中)、
(モニターは非アクティブ)。 |
| 配列 | はい | モニターが実行する一連の手順。各ステップ オブジェクトには、
(ステップの位置、0 ～ 99)、
(
、
、
、
、
などのステップ タイプ)、および
(ステップ タイプに固有の値の配列) が含まれます。 |
| ブール値 | いいえ | 障害が発生したときやスクリプトが実行されたときのジョブ実行中にスクリーンショットをキャプチャします。 |
| 浮く | いいえ | SLA レポートの入力に使用される、モニターの Apdex ターゲット (秒単位)。デフォルトは 7.0 秒です。 |
サンプルリクエスト
mutation { syntheticsCreateStepMonitor( accountId: ACCOUNT_ID monitor: { browsers: [BROWSERS] devices: [DEVICES] locations: { public: ["LOCATION_1", "LOCATION_2"] } name: "MONITOR_NAME" period: PERIOD runtime: { runtimeType: "RUNTIME_TYPE" runtimeTypeVersion: "RUNTIME_TYPE_VERSION" scriptLanguage: "SCRIPT_LANGUAGE" } status: STATUS steps: [ { ordinal: 0, type: NAVIGATE, values: ["MONITORED_URI", "USER_AGENT"] } { ordinal: STEP_NUMBER type: STEP_TYPE values: ["CONDITIONAL_TYPE", "VALUE"] } ] advancedOptions: { enableScreenshotOnFailureAndScript: ENABLE_SCREENSHOT } apdexTarget: APDEX_TARGET } ) { errors { description type } }}サンプル回答
成功した応答はエラーに対してnullを返します:
{ "data": { "syntheticsCreateStepMonitor": { "errors": null } }}モニターの作成中に問題が発生した場合、 errors配列には、何が問題であったかを説明するdescriptionとtypeフィールドを持つオブジェクトが含まれます。
ステップモニターを更新する
syntheticsUpdateStepMonitorミューテーションを使用して既存のステップ モニターを更新できます。すでに作成されているステップモニターの設定を変更することができます。
入力
パラメータ | データタイプ | 必須ですか? | 説明 |
|---|---|---|---|
| 弦 | はい | 更新するモニターの一意のエンティティ 。 |
| 配列 | いいえ | モニターがジョブを実行するために使用するBrowser 。 サポートされているブラウザ:
、
、
。 |
| 配列 | いいえ | モニターがジョブを実行するために使用するデバイス。サポートされているデバイス:
、
、
、
、
。 |
| 配列 | いいえ | モニターがチェックを実行する 識別子の配列 (例:
)。 |
| 弦 | いいえ | 歩数モニターの更新された表示名。 |
| イナム | いいえ | モニターが実行される頻度。オプション:
、
、
、
、
、
、
、
、
。 |
| 弦 | いいえ | モニターで使用されるランタイム タイプ。受け入れられる値は
のみです。 |
| 弦 | いいえ | モニターで使用されるランタイム タイプのバージョン。受け入れられる値は
のみです。 |
| 弦 | いいえ | モニターで使用される言語。受け入れられる値は
のみです。 |
| イナム | いいえ | モニターのステータス。オプション:
(モニターはアクティブでチェックを実行中)、
(モニターは非アクティブ)。 |
| 配列 | いいえ | モニターが実行する一連の手順。各ステップ オブジェクトには、
(ステップの位置、0 ～ 99)、
(
、
、
、
、
などのステップ タイプ)、および
(ステップ タイプに固有の値の配列) が含まれます。 |
| ブール値 | いいえ | 障害が発生したときやスクリプトが実行されたときのジョブ実行中にスクリーンショットをキャプチャします。 |
| 浮く | いいえ | SLA レポートの入力に使用される、モニターの Apdex ターゲット (秒単位)。デフォルトは 7.0 秒です。 |
サンプルリクエスト
mutation { syntheticsUpdateStepMonitor( guid: ENTITY_GUID monitor: { browsers: [BROWSERS] devices: [DEVICES] locations: { public: ["LOCATION_1", "LOCATION_2"] } name: "MONITOR_NAME" period: PERIOD runtime: { runtimeType: "RUNTIME_TYPE" runtimeTypeVersion: "RUNTIME_TYPE_VERSION" scriptLanguage: "SCRIPT_LANGUAGE" } status: STATUS steps: [ { ordinal: 0, type: NAVIGATE, values: ["MONITORED_URI", "USER_AGENT"] } { ordinal: STEP_NUMBER type: STEP_TYPE values: ["VALUE_1", "VALUE_2"] } ] advancedOptions: { enableScreenshotOnFailureAndScript: ENABLE_SCREENSHOT } apdexTarget: APDEX_TARGET } ) { errors { description type } }}サンプル回答
成功した応答はエラーに対してnullを返します:
{ "data": { "syntheticsUpdateStepMonitor": { "errors": null } }}モニターの更新中に問題が発生した場合、 errors配列には、何が問題であったかを説明するdescriptionとtypeフィールドを持つオブジェクトが含まれます。
歩数モニターを削除する
ステップ モニターが不要になった場合は、 syntheticsDeleteMonitorミューテーションを使用してそれを完全に削除できます。
モニターを削除するには、 「合成モニターの削除」セクションを参照してください。