• /
  • EnglishEspañolFrançais日本語한국어Português
  • ログイン今すぐ開始

この機械翻訳は、参考として提供されています。

英語版と翻訳版に矛盾がある場合は、英語版が優先されます。詳細については、このページを参照してください。

問題を作成する

New Relic Syntheticsアクション

|View as Markdown (English)

このページでは、ワークフロー自動化アクション・カタログで利用可能なNew Relic Syntheticsアクションのリファレンスを提供します。これらのアクションを使用すると、既存のモニターに対するオンデマンド・テストの実行をトリガーし、メンテナンス・ウィンドウのダウンタイムを管理し、ワークフロー定義から直接モニターの詳細を読み取ることができます。

前提条件

ワークフロー自動化でNew Relic Syntheticsアクションを使用する前に、以下の準備が整っていることを確認してください：

  • 外形監視モニターにアクセスするための適切な権限を持つNew Relicアカウント。
  • ターゲットにする各モニターのエンティティGUID。モニターのGUIDは、New RelicのSynthetics > [モニター名] > Settingsで確認できます。

自動テストを開始します

アクション識別子はnewrelic.synthetics.startAutomatedTestです。

1つ以上のモニターに対してオンデマンドの外形監視自動テスト実行をトリガーし、newrelic.synthetics.getAutomatedTestResultを使用して結果をポーリングするためのbatchIdを返します。

重要

スクリプトAPI、スクリプトブラウザ、ステップ、およびシンプルブラウザのモニタータイプのみがサポートされています。SIMPLE（ping）モニターは、互換性のないモニタータイプエラーにより、APIによって拒否されます。

次の表は、このアクションで利用可能なすべての入力フィールドについて説明しています。

入力

タイプ

説明

例

テスト

リスト

必須。テストするモニターのリスト。各エントリにはmonitorGuidが必要であり、モニターごとのオーバーライドを含むオプションのconfigオブジェクトを受け入れます。以下のフィールドを参照してください。

[{"monitorGuid": "MTE5Mz..."}]

tests[].monitorGuid

弦

必須。実行するモニターのエンティティGUIDです。スクリプト化またはブラウザベースのモニタータイプである必要があります。

"MTE5MzMzNDd8U1lOVEh8..."

tests[].config.isBlocking

ブール値

オプション。trueの場合、失敗したテストはブロッキングとして扱われます — これは、結果に基づいてCI/CDパイプラインをゲート制御するのに役立ちます。

true

tests[].config.overrides.location

弦

オプション。モニターに設定されたロケーションではなく、このロケーションからテストを実行します。

"US_EAST_1"

tests[].config.overrides.startingUrl

弦

オプション。モニターが開始するURLをオーバーライドします — たとえば、今回の実行で本番環境のモニターをステージング環境に向ける場合などです。

"https://staging.example.com"

tests[].config.overrides.domain

リスト

オプション。この実行に限り、あるドメインから別のドメインへrequestsをリダイレクトします。各エントリにはdomainとoverrideが必要です。

[{"domain": "example.com", "override": "staging.example.com"}]

tests[].config.overrides.secureCredential

リスト

オプション。今回の実行用に、スクリプトの$secure.KEY参照が解決する保存済みのセキュアな認証情報を入れ替えます。各エントリにはkeyとoverrideKeyが必要です。

[{"key": "API_KEY", "overrideKey": "STAGING_API_KEY"}]

コンフィグ

地図

オプション。テスト実行に付加されたバッチレベルのメタデータ。すべてのフィールドは分かりやすい説明のみを目的としており、テストの実行方法には影響しません。サポートされているフィールド：batchName、branch、commit、deepLink、platform、repository。

{"batchName": "release-1.2.3", "branch": "main", "commit": "a1b2c3d"}

selectors

リスト

オプション。アクションの出力から特定のフィールドを抽出するためのJQセレクター。

[{"name": "batchId", "expression": ".data.syntheticsStartAutomatedTest.batchId"}]

次の表は、このアクションによって返されるすべての出力フィールドについて説明しています。

出力

タイプ

例

success

ブール値

true ステップがエラーなしで実行された場合。

errorMessage

弦

呼び出しがHTTP/トランスポート・レベルで失敗した場合にのみ値が設定されます。成功時はnullです。

data

オブジェクト

{
  "data": {
    "syntheticsStartAutomatedTest": {
      "batchId": "bdf77c8d-1987-4488-ac7d-112836e5f610"
    }
  }
}

batchIdをnewrelic.synthetics.getAutomatedTestResultに渡して、結果をポーリングします。

ワークフローの例

name: start_synthetics_automated_test
description: Trigger an on-demand Synthetics test run after a deploy
steps:
  - name: startAutomatedTest
    type: action
    action: newrelic.synthetics.startAutomatedTest
    version: 1
    inputs:
      tests:
        - monitorGuid: "MTE5MzMzNDd8U1lOVEh8TU9OSVRPUnw1OGEwNmFjZC02MGRmLTQ4YWEtYTc4YS1jZDk5NjhmYTU4YmE"
      config:
        batchName: "release-1.2.3"
        branch: "main"
      selectors:
        - name: batchId
          expression: ".data.syntheticsStartAutomatedTest.batchId"
    next: end

自動テストの結果を取得します

アクション識別子はnewrelic.synthetics.getAutomatedTestResultです。

batchIdを使用して、外形監視の自動テスト・バッチのステータスおよびモニターごとの結果を取得します。startAutomatedTestの直後にポーリングを行うと、一時的に「No automated test results found」エラーが返される場合があります — ポーリングの前に短い待機ステップを追加してください。

次の表は、このアクションで利用可能なすべての入力フィールドについて説明しています。

入力

タイプ

説明

例

アカウントID

整数

必須。New RelicアカウントID。

11933347

batchId

弦

必須。newrelic.synthetics.startAutomatedTestによって返されるバッチID。

"bdf77c8d-1987-4488-ac7d-112836e5f610"

selectors

リスト

オプション。アクションの出力から特定のフィールドを抽出するためのJQセレクター。

[{"name": "status", "expression": ".data.actor.account.synthetics.automatedTestResult.status"}]

次の表は、このアクションによって返されるすべての出力フィールドについて説明しています。

出力

タイプ

例

success

ブール値

true ステップがエラーなしで実行された場合。

errorMessage

弦

呼び出しがHTTP/トランスポート・レベルで失敗した場合にのみ値が設定されます。成功時はnullです。

data

オブジェクト

{
  "data": {
    "actor": {
      "account": {
        "synthetics": {
          "automatedTestResult": {
            "status": "IN_PROGRESS",
            "startTimestamp": 1788519679406,
            "finishTimestamp": null,
            "tests": []
          }
        }
      }
    }
  }
}

status PASSED、FAILED、IN_PROGRESS、またはTIMEOUTのいずれかです。

ワークフローの例

name: get_synthetics_test_result
description: Poll a Synthetics automated test batch for its outcome
steps:
  - name: wait
    type: wait
    seconds: 15


  - name: getAutomatedTestResult
    type: action
    action: newrelic.synthetics.getAutomatedTestResult
    version: 1
    inputs:
      accountId: 11933347
      batchId: "bdf77c8d-1987-4488-ac7d-112836e5f610"
      selectors:
        - name: status
          expression: ".data.actor.account.synthetics.automatedTestResult.status"
        - name: tests
          expression: ".data.actor.account.synthetics.automatedTestResult.tests"
    next: end

モニターのダウンタイムを作成する

アクション識別子はnewrelic.synthetics.createMonitorDowntimeです。

1つ以上の特定のモニターに対して、1回限りの外形監視モニターのダウンタイム（メンテナンスウィンドウ）をスケジュールします。APIは、送信されたIANA名ではなく、解決されたタイムゾーンラベル（Pacific Standard Timeなど）を返します。

重要

monitorGuids GraphQLスキーマではnull許容ですが、実際には必須です — 省略するとサーバーエラーがスローされます。アカウント全体のダウンタイムモードはありません；ダウンタイムは常に特定のモニターをターゲットにします。

次の表は、このアクションで利用可能なすべての入力フィールドについて説明しています。

入力

タイプ

説明

例

アカウントID

整数

必須。New RelicアカウントID。

11933347

name

弦

必須。ダウンタイムの表示名です。

"Deploy maintenance window"

開始時間

弦

必須。timezoneの入力を使用して解釈される、NaiveDateTime（タイムゾーンオフセットなし）としての開始時刻です。形式：YYYY-MM-DDTHH:MM:SS。

"2026-09-10T02:00:00"

エンドタイム

弦

必須。timezone入力を使用して解釈される、NaiveDateTime（タイムゾーンオフセットなし）としての終了時刻です。

"2026-09-10T04:00:00"

タイムゾーン

弦

必須。startTimeおよびendTimeを解釈するために使用されるIANAタイムゾーン名です。

"America/Los_Angeles"

monitorGuids

リスト

必須。ダウンタイム中にミュートするモニターのエンティティGUIDです。少なくとも1つのGUIDを含める必要があります。

["MTE5MzMzNDd8U1lOVEh8..."]

selectors

リスト

オプション。アクションの出力から特定のフィールドを抽出するためのJQセレクター。

[{"name": "guid", "expression": ".data.syntheticsCreateOnceMonitorDowntime.guid"}]

次の表は、このアクションによって返されるすべての出力フィールドについて説明しています。

出力

タイプ

例

success

ブール値

true ステップがエラーなしで実行された場合。

errorMessage

弦

呼び出しがHTTP/トランスポート・レベルで失敗した場合にのみ値が設定されます。成功時はnullです。

data

オブジェクト

{
  "data": {
    "syntheticsCreateOnceMonitorDowntime": {
      "accountId": 11933347,
      "guid": "MTE5MzMzNDd8U1lOVEh8TU9OSVRPUl9ET1dOVElNRXxhZGZlYmRiOS0...",
      "monitorGuids": ["MTE5MzMzNDd8U1lOVEh8TU9OSVRPUnw1OGEwNmFjZC0..."],
      "name": "Deploy maintenance window",
      "startTime": "2026-09-10T02:00",
      "endTime": "2026-09-10T04:00",
      "timezone": "Pacific Standard Time"
    }
  }
}

ワークフローの例

name: create_monitor_downtime
description: Schedule a maintenance window for a Synthetics monitor
steps:
  - name: createMonitorDowntime
    type: action
    action: newrelic.synthetics.createMonitorDowntime
    version: 1
    inputs:
      accountId: 11933347
      name: "Deploy maintenance window"
      startTime: "2026-09-10T02:00:00"
      endTime: "2026-09-10T04:00:00"
      timezone: "America/Los_Angeles"
      monitorGuids:
        - "MTE5MzMzNDd8U1lOVEh8TU9OSVRPUnw1OGEwNmFjZC02MGRmLTQ4YWEtYTc4YS1jZDk5NjhmYTU4YmE"
      selectors:
        - name: guid
          expression: ".data.syntheticsCreateOnceMonitorDowntime.guid"
    next: end

モニターのダウンタイムの編集

アクション識別子はnewrelic.synthetics.editMonitorDowntimeです。

エンティティGUIDによって識別される既存の外形監視モニターのダウンタイムを編集します。

重要

monitorGuids すべての編集呼び出しで必須です。このフィールドが省略された場合、APIは既存のリストを保持しません — 代わりに空にクリアされます。常に必要なモニターGUIDの完全なセットを渡してください。

次の表は、このアクションで利用可能なすべての入力フィールドについて説明しています。

入力

タイプ

説明

例

guid

弦

必須。編集するダウンタイムのエンティティGUID。

"MTE5MzMzNDd8U1lOVEh8TU9OSVRPUl9ET1dOVElNRXwz..."

monitorGuids

リスト

必須。ダウンタイムを適用するモニターエンティティGUIDの完全なセットです。省略した場合、APIは既存の値を保持するのではなく、このリストをクリアして空にします。

["MTE5MzMzNDd8U1lOVEh8..."]

開始時間

弦

必須。timezoneの入力を使用して解釈される、NaiveDateTime（タイムゾーンオフセットなし）としての開始時刻。

"2026-09-10T02:00:00"

エンドタイム

弦

必須。timezone入力を使用して解釈される、NaiveDateTime（タイムゾーンオフセットなし）としての終了時刻です。

"2026-09-10T06:00:00"

タイムゾーン

弦

必須。startTimeおよびendTimeを解釈するために使用されるIANAタイムゾーン名です。

"America/Los_Angeles"

name

弦

オプション。ダウンタイムの新しい表示名です。変更しない場合は省略してください。

"Deploy maintenance window (extended)"

selectors

リスト

オプション。アクションの出力から特定のフィールドを抽出するためのJQセレクター。

[{"name": "guid", "expression": ".data.syntheticsEditMonitorDowntime.guid"}]

次の表は、このアクションによって返されるすべての出力フィールドについて説明しています。

出力

タイプ

例

success

ブール値

true ステップがエラーなしで実行された場合。

errorMessage

弦

呼び出しがHTTP/トランスポート・レベルで失敗した場合にのみ値が設定されます。成功時はnullです。

data

オブジェクト

{
  "data": {
    "syntheticsEditMonitorDowntime": {
      "accountId": 11933347,
      "guid": "MTE5MzMzNDd8U1lOVEh8TU9OSVRPUl9ET1dOVElNRXwz...",
      "name": "Deploy maintenance window (extended)",
      "startTime": "2026-09-10T02:00",
      "endTime": "2026-09-10T06:00",
      "timezone": "Pacific Standard Time",
      "monitorGuids": ["MTE5MzMzNDd8U1lOVEh8TU9OSVRPUnw1OGEwNmFjZC0..."]
    }
  }
}

ワークフローの例

name: edit_monitor_downtime
description: Extend a Synthetics monitor downtime's end time
steps:
  - name: editMonitorDowntime
    type: action
    action: newrelic.synthetics.editMonitorDowntime
    version: 1
    inputs:
      guid: "MTE5MzMzNDd8U1lOVEh8TU9OSVRPUl9ET1dOVElNRXwz..."
      name: "Deploy maintenance window (extended)"
      monitorGuids:
        - "MTE5MzMzNDd8U1lOVEh8TU9OSVRPUnw1OGEwNmFjZC02MGRmLTQ4YWEtYTc4YS1jZDk5NjhmYTU4YmE"
      startTime: "2026-09-10T02:00:00"
      endTime: "2026-09-10T06:00:00"
      timezone: "America/Los_Angeles"
      selectors:
        - name: guid
          expression: ".data.syntheticsEditMonitorDowntime.guid"
    next: end

モニターダウンタイムの削除

アクション識別子はnewrelic.synthetics.deleteMonitorDowntimeです。

エンティティGUIDによって識別される外形監視モニターのダウンタイムを削除します。

次の表は、このアクションで利用可能なすべての入力フィールドについて説明しています。

入力

タイプ

説明

例

guid

弦

必須。削除するダウンタイムのエンティティGUIDです。

"MTE5MzMzNDd8U1lOVEh8TU9OSVRPUl9ET1dOVElNRXxhZGZlYmRiOS0..."

selectors

リスト

オプション。アクションの出力から特定のフィールドを抽出するためのJQセレクター。

[{"name": "deletedGuid", "expression": ".data.syntheticsDeleteMonitorDowntime.guid"}]

次の表は、このアクションによって返されるすべての出力フィールドについて説明しています。

出力

タイプ

例

success

ブール値

true ステップがエラーなしで実行された場合。

errorMessage

弦

呼び出しがHTTP/トランスポート・レベルで失敗した場合にのみ値が設定されます。成功時はnullです。

data

オブジェクト

{
  "data": {
    "syntheticsDeleteMonitorDowntime": {
      "guid": "MTE5MzMzNDd8U1lOVEh8TU9OSVRPUl9ET1dOVElNRXxhZGZlYmRiOS0..."
    }
  }
}

ワークフローの例

name: delete_monitor_downtime
description: Remove a Synthetics monitor downtime
steps:
  - name: deleteMonitorDowntime
    type: action
    action: newrelic.synthetics.deleteMonitorDowntime
    version: 1
    inputs:
      guid: "MTE5MzMzNDd8U1lOVEh8TU9OSVRPUl9ET1dOVElNRXxhZGZlYmRiOS0..."
      selectors:
        - name: deletedGuid
          expression: ".data.syntheticsDeleteMonitorDowntime.guid"
    next: end

モニターを取得する

アクション識別子はnewrelic.synthetics.getMonitorです。

エンティティGUIDを使用して、現在のステータス、ロード時間のパーセンタイル、およびモニターの設定を含む、外形監視モニターの完全な詳細を取得します。

次の表は、このアクションで利用可能なすべての入力フィールドについて説明しています。

入力

タイプ

説明

例

guid

弦

必須。取得するモニターのエンティティGUID。

"MTE5MzMzNDd8U1lOVEh8TU9OSVRPUnwxMDMyODk5YS1kMmU2..."

selectors

リスト

オプション。アクションの出力から特定のフィールドを抽出するためのJQセレクター。

[{"name": "status", "expression": ".data.actor.entity.monitorSummary.status"}]

次の表は、このアクションによって返されるすべての出力フィールドについて説明しています。

出力

タイプ

例

success

ブール値

true ステップがエラーなしで実行された場合。

errorMessage

弦

呼び出しがHTTP/トランスポート・レベルで失敗した場合にのみ値が設定されます。成功時はnullです。

data

オブジェクト

{
  "data": {
    "actor": {
      "entity": {
        "guid": "MTE5MzMzNDd8U1lOVEh8TU9OSVRPUnwxMDMyODk5YS1kMmU2...",
        "name": "Homepage ping check",
        "accountId": 123456,
        "domain": "SYNTH",
        "entityType": "SYNTHETIC_MONITOR_ENTITY",
        "type": "MONITOR",
        "alertSeverity": "NOT_ALERTING",
        "permalink": "https://onenr.io/...",
        "reporting": true,
        "monitorType": "SIMPLE",
        "monitorId": "1032899a-d2e6-4777-8b5f-5d3f7c9b6798",
        "period": 5,
        "monitoredUrl": "https://example.com",
        "monitorSummary": {
          "status": "SUCCESS",
          "successRate": 1,
          "locationsFailing": 0,
          "locationsRunning": 1,
          "loadTimeP50": 210,
          "loadTimeP95": 480
        }
      }
    }
  }
}

ワークフローの例

name: get_synthetics_monitor
description: Fetch a Synthetics monitor's current status and load time
steps:
  - name: getMonitor
    type: action
    action: newrelic.synthetics.getMonitor
    version: 1
    inputs:
      guid: "MTE5MzMzNDd8U1lOVEh8TU9OSVRPUnwxMDMyODk5YS1kMmU2LTQ3NzctOGI1Zi01ZDNmN2M5YjY3OTg"
      selectors:
        - name: status
          expression: ".data.actor.entity.monitorSummary.status"
        - name: successRate
          expression: ".data.actor.entity.monitorSummary.successRate"
    next: end

モニターの一覧

アクション識別子はnewrelic.synthetics.listMonitorsです。

オプションの名前およびレポートステータスフィルター、ならびにカーソルベースのページネーションを使用して、アカウントの外形監視モニターを検索します。

次の表は、このアクションで利用可能なすべての入力フィールドについて説明しています。

入力

タイプ

説明

例

アカウントID

整数

必須。モニターを検索するNew RelicアカウントID。

11933347

name

弦

オプション。モニター名に対する大文字と小文字を区別しない部分一致。

"Homepage"

報告

ブール値

オプション。現在レポートしている(true)、またはレポートしていない(false)モニターに絞り込みます。両方を返す場合は省略してください。

true

カーソル

弦

オプション。前回の呼び出しのnextCursor出力からのページネーションカーソルです。最初のページから開始する場合は省略します。

"${{ .steps.listMonitors.outputs.nextCursor }}"

selectors

リスト

オプション。アクションの出力から特定のフィールドを抽出するためのJQセレクター。

[{"name": "monitors", "expression": ".data.actor.entitySearch.results.entities"}]

次の表は、このアクションによって返されるすべての出力フィールドについて説明しています。

出力

タイプ

例

success

ブール値

true ステップがエラーなしで実行された場合。

errorMessage

弦

呼び出しがHTTP/トランスポート・レベルで失敗した場合にのみ値が設定されます。成功時はnullです。

data

オブジェクト

{
  "data": {
    "actor": {
      "entitySearch": {
        "count": 1,
        "results": {
          "nextCursor": null,
          "entities": [
            {
              "guid": "MTE5MzMzNDd8U1lOVEh8TU9OSVRPUnw1OGEwNmFjZC0...",
              "name": "Homepage ping check",
              "domain": "SYNTH",
              "type": "MONITOR",
              "reporting": true
            }
          ]
        }
      }
    }
  }
}

nextCursor さらにページが存在する場合に表示されます。次のページを取得するには、次回の呼び出しで cursor として渡してください。

ワークフローの例

name: list_synthetics_monitors
description: Search for Synthetics monitors by name
steps:
  - name: listMonitors
    type: action
    action: newrelic.synthetics.listMonitors
    version: 1
    inputs:
      accountId: 11933347
      name: "Homepage"
      reporting: true
      selectors:
        - name: monitors
          expression: ".data.actor.entitySearch.results.entities"
        - name: nextCursor
          expression: ".data.actor.entitySearch.results.nextCursor"
    next: end
Copyright © 2026 New Relic株式会社。
採用情報サービス利用規約DMCAポリシープライバシー通知Website Terms特許通知現代奴隷法

This site is protected by reCAPTCHA and the Google Privacy Policy and Terms of Service apply.