New Relic では、NerdGraph を使用してping モニター(シンプル モニターとも呼ばれます) を作成できます。Ping 監視は、定期的に HTTP requests発行して、URL またはエンドポイントにアクセスできるかどうかを確認します。 このチュートリアルでは、NerdGraph API を使用して ping モニターの作成を自動化する方法の例を示します。
pingモニターを作成する
syntheticsCreateSimpleMonitorミューテーションを使用して ping モニターを作成できます。このミューテーションにより、パブリックにアクセス可能な URL またはエンドポイントの監視を構成できます。
入力
パラメータ | データタイプ | 必須ですか? | 説明 |
|---|---|---|---|
| 整数 | はい | モニターが作成される New Relic 。 |
| 配列 | はい | モニターがチェックを実行する 識別子の配列 (例:
)。 |
| 弦 | はい | ping モニターの表示名。 |
| イナム | はい | モニターが実行される頻度。オプション:
、
、
、
、
、
、
、
、
。 |
| イナム | はい | モニターのステータス。オプション:
(モニターはアクティブでチェックを実行中)、
(モニターは非アクティブ)。 |
| 弦 | はい | モニターする URL またはエンドポイント (例:
)。 |
| 弦 | いいえ | チェックに合格するために応答に表示される必要があるテキスト。指定すると、応答本文にこのテキストが見つからない場合にモニターは失敗します。 |
| ブール値 | いいえ | TLS/SSL証明書を検証するかどうか。 SSL 証明書チェーンの有効性を検証するには、
に設定します。 |
| 浮く | いいえ | SLA レポートの入力に使用される、モニターの Apdex ターゲット (秒単位)。デフォルトは 7.0 秒です。 |
サンプルリクエスト
mutation { syntheticsCreateSimpleMonitor( accountId: ACCOUNT_ID monitor: { locations: { public: ["LOCATION_1", "LOCATION_2"] } name: "YOUR_MONITOR_NAME" period: PERIOD status: STATUS uri: "MONITORED_URI" advancedOptions: { customHeaders: { name: "HEADER_NAME", value: "HEADER_VALUE" } redirectIsFailure: REDIRECT_IS_FAILURE responseValidationText: "VALIDATION_TEXT" shouldBypassHeadRequest: BYPASS_HEAD_REQUEST useTlsValidation: TLS_VALIDATION } apdexTarget: APDEX_TARGET } ) { errors { description type } }}サンプル回答
成功した応答はエラーに対してnullを返します:
{ "data": { "syntheticsCreateSimpleMonitor": { "errors": null } }}モニターの作成中に問題が発生した場合、 errors配列には、何が問題であったかを説明するdescriptionとtypeフィールドを持つオブジェクトが含まれます。
pingモニターを更新します
syntheticsUpdateSimpleMonitorミューテーションを使用して既存の ping モニターを更新できます。これにより、すでに作成されている ping モニターの設定を変更できます。
入力
パラメータ | データタイプ | 必須ですか? | 説明 |
|---|---|---|---|
| 弦 | はい | 更新するモニターの一意のエンティティ 。 |
| 配列 | いいえ | モニターがチェックを実行する 識別子の配列 (例:
)。 |
| 弦 | いいえ | ping モニターの更新された表示名。 |
| イナム | いいえ | モニターが実行される頻度。オプション:
、
、
、
、
、
、
、
、
。 |
| イナム | いいえ | モニターのステータス。オプション:
(モニターはアクティブでチェックを実行中)、
(モニターは非アクティブ)。 |
| 弦 | いいえ | モニターする URL またはエンドポイント (例:
)。 |
| オブジェクト | いいえ | リクエストに含めるカスタム HTTP ヘッダー。各ヘッダーには
プロパティと
プロパティがあります。 |
| ブール値 | いいえ |
の場合、モニターは HTTP リダイレクト (3xx ステータス コード) を失敗として扱います。 |
| 弦 | いいえ | チェックに合格するために応答に表示される必要があるテキスト。指定すると、応答本文にこのテキストが見つからない場合にモニターは失敗します。 |
| ブール値 | いいえ |
の場合、モニターは最初の HEAD リクエストをスキップし、 GETリクエストのみを作成します。 |
| ブール値 | いいえ | TLS/SSL証明書を検証するかどうか。 SSL 証明書チェーンの有効性を検証するには、
に設定します。 |
| 浮く | いいえ | SLA レポートの入力に使用される、モニターの Apdex ターゲット (秒単位)。デフォルトは 7.0 秒です。 |
サンプルリクエスト
mutation { syntheticsUpdateSimpleMonitor( guid: "ENTITY_GUID" monitor: { locations: { public: ["LOCATION_1", "LOCATION_2"] } name: "YOUR_MONITOR_NAME" period: PERIOD status: STATUS uri: "MONITORED_URI" advancedOptions: { customHeaders: { name: "HEADER_NAME", value: "HEADER_VALUE" } redirectIsFailure: REDIRECT_IS_FAILURE responseValidationText: "VALIDATION_TEXT" shouldBypassHeadRequest: BYPASS_HEAD_REQUEST useTlsValidation: TLS_VALIDATION } apdexTarget: APDEX_TARGET } ) { errors { description type } }}サンプル回答
成功した応答はエラーに対してnullを返します:
{ "data": { "syntheticsUpdateSimpleMonitor": { "errors": null } }}モニターの更新中に問題が発生した場合、 errors配列には、何が問題であったかを説明するdescriptionとtypeフィールドを持つオブジェクトが含まれます。
合成モニターを削除する
このAPI使用すると、guid でsyntheticsDeleteMonitorミューテーションを使用して既存のモニターを削除できます。
入力
パラメータ | データタイプ | 必須ですか? | 説明 |
|---|---|---|---|
| 弦 | はい | 削除するモニターの一意のエンティティ 。 |
サンプルリクエスト
mutation { syntheticsDeleteMonitor(guid: "ENTITY_GUID") { deletedGuid }}サンプル回答
削除が成功すると、削除されたモニターの GUID が返されます。
{ "data": { "syntheticsDeleteMonitor": { "deletedGuid": "ENTITY_GUID" } }}モニターの削除中に問題が発生した場合は、問題の詳細とともにエラーが返されます。