• /
  • EnglishEspañolFrançais日本語한국어Português
  • EntrarComeçar agora

Esta tradução de máquina é fornecida para sua comodidade.

Caso haja alguma divergência entre a versão em inglês e a traduzida, a versão em inglês prevalece. Acesse esta página para mais informações.

Criar um problema

Ações do New Relic Synthetics

|View as Markdown (English)

Esta página fornece uma referência para as ações do New Relic Synthetics disponíveis no catálogo de ações de automação de fluxo de trabalho. Essas ações permitem que você acione execuções de teste sob demanda para monitores existentes, gerencie o período de inatividade de janelas de manutenção e leia detalhes do monitor diretamente de uma definição de fluxo de trabalho.

Pré-requisitos

Antes de usar as ações do New Relic Synthetics na automação de fluxo de trabalho, é necessário ter:

  • Uma conta New Relic com as permissões apropriadas para acessar os monitores Sintéticos.
  • O GUID da entidade de cada monitor que você deseja definir como destino. Você pode encontrar o GUID de um monitor no New Relic em Synthetics > [nome do monitor] > Settings.

Inicie um teste automatizado

O identificador da ação é newrelic.synthetics.startAutomatedTest.

Aciona uma execução de teste automatizado de Sintéticos sob demanda para um ou mais monitores e retorna um batchId para consultar os resultados usando newrelic.synthetics.getAutomatedTestResult.

Importante

São suportados apenas os tipos de monitor de API com script, navegador com script, etapa e navegador simples. Os monitores SIMPLE (ping) são rejeitados pela API com um erro de tipo de monitor incompatível.

A tabela a seguir descreve todos os campos de entrada disponíveis para esta ação.

Entrada

Tipo

Descrição

Exemplo

testes

Lista

Obrigatório. Lista de monitores para testar. Cada entrada requer um monitorGuid e aceita um objeto config opcional com substituições por monitor. Veja os campos abaixo.

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

tests[].monitorGuid

Corda

Obrigatório. GUID da entidade do monitor a ser executado. Deve ser um tipo de monitor com script ou baseado em navegador.

"MTE5MzMzNDd8U1lOVEh8..."

tests[].config.isBlocking

Boleano

Opcional. Se true, um teste com falha é tratado como bloqueador — útil para barrar um pipeline de CI/CD com base no resultado.

true

tests[].config.overrides.location

Corda

Opcional. Execute o teste a partir deste local em vez dos locais configurados do monitor.

"US_EAST_1"

tests[].config.overrides.startingUrl

Corda

Opcional. Substituir a URL a partir da qual o monitor é iniciado — por exemplo, para apontar um monitor de produção para um ambiente de preparação nesta execução.

"https://staging.example.com"

tests[].config.overrides.domain

Lista

Opcional. Redirecione requests de um domínio para outro apenas para esta execução. Cada entrada requer domain e override.

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

tests[].config.overrides.secureCredential

Lista

Opcional. Substitua para qual credencial segura armazenada a referência $secure.KEY de um script é resolvida para esta execução. Cada entrada requer key e overrideKey.

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

configuração

Mapa

Opcional. Metadados em nível de lote anexados à execução do teste. Todos os campos são apenas descritivos e não afetam como o teste é executado. Campos compatíveis: batchName, branch, commit, deepLink, platform, repository.

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

selectors

Lista

Opcional. Seletores JQ para extrair campos específicos da saída da ação.

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

A tabela a seguir descreve todos os campos de saída retornados por esta ação.

Saída

Tipo

Exemplo

success

Boleano

true quando a etapa foi executada sem erro.

errorMessage

Corda

Preenchido apenas se a chamada falhar no nível de HTTP/transporte. null em caso de sucesso.

data

Objeto

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

Passe o batchId para newrelic.synthetics.getAutomatedTestResult para consultar o resultado.

Exemplo de fluxo de trabalho

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

Obter resultado de teste automatizado

O identificador da ação é newrelic.synthetics.getAutomatedTestResult.

Busca o status e os resultados por monitor de um lote de testes automatizados do Sintéticos pelo seu batchId. A sondagem imediatamente após startAutomatedTest pode retornar um erro transitório "No automated test results found" — adicione uma curta etapa de espera antes da sondagem.

A tabela a seguir descreve todos os campos de entrada disponíveis para esta ação.

Entrada

Tipo

Descrição

Exemplo

ID da conta

Inteiro

Obrigatório. ID da conta New Relic.

11933347

batchId

Corda

Obrigatório. O ID de lote retornado por newrelic.synthetics.startAutomatedTest.

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

selectors

Lista

Opcional. Seletores JQ para extrair campos específicos da saída da ação.

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

A tabela a seguir descreve todos os campos de saída retornados por esta ação.

Saída

Tipo

Exemplo

success

Boleano

true quando a etapa foi executada sem erro.

errorMessage

Corda

Preenchido apenas se a chamada falhar no nível de HTTP/transporte. null em caso de sucesso.

data

Objeto

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

status é um de PASSED, FAILED, IN_PROGRESS ou TIMEOUT.

Exemplo de fluxo de trabalho

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

Criar um período de inatividade de monitor

O identificador da ação é newrelic.synthetics.createMonitorDowntime.

Agenda um período de inatividade único (janela de manutenção) de monitor do Sintéticos para um ou mais monitores específicos. A API retorna um rótulo de fuso horário resolvido (como Pacific Standard Time) em vez do nome da IANA enviado.

Importante

monitorGuids pode ser nulo no esquema do GraphQL, mas é obrigatório na prática — omiti-lo gera um erro de servidor. Não há modo de período de inatividade para toda a conta; os períodos de inatividade sempre têm como destino monitores específicos.

A tabela a seguir descreve todos os campos de entrada disponíveis para esta ação.

Entrada

Tipo

Descrição

Exemplo

ID da conta

Inteiro

Obrigatório. ID da conta New Relic.

11933347

nome

Corda

Obrigatório. Nome de exibição para o período de inatividade.

"Deploy maintenance window"

startTime

Corda

Obrigatório. Horário de início como NaiveDateTime (sem deslocamento de fuso horário), interpretado usando a entrada timezone. Formato: YYYY-MM-DDTHH:MM:SS.

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

endTime

Corda

Obrigatório. Horário de término como um NaiveDateTime (sem deslocamento de fuso horário), interpretado usando a entrada timezone.

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

fuso horário

Corda

Obrigatório. Nome do fuso horário da IANA usado para interpretar startTime e endTime.

"America/Los_Angeles"

monitorGuids

Lista

Obrigatório. GUIDs de entidade dos monitores a serem silenciados durante o período de inatividade. Deve incluir pelo menos um GUID.

["MTE5MzMzNDd8U1lOVEh8..."]

selectors

Lista

Opcional. Seletores JQ para extrair campos específicos da saída da ação.

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

A tabela a seguir descreve todos os campos de saída retornados por esta ação.

Saída

Tipo

Exemplo

success

Boleano

true quando a etapa foi executada sem erro.

errorMessage

Corda

Preenchido apenas se a chamada falhar no nível de HTTP/transporte. null em caso de sucesso.

data

Objeto

{
"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"
}
}
}

Exemplo de fluxo de trabalho

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

Editar um período de inatividade do monitor

O identificador da ação é newrelic.synthetics.editMonitorDowntime.

Edita um período de inatividade de monitor Sintéticos existente identificado pelo GUID da sua entidade.

Importante

monitorGuids é obrigatório em cada chamada de edição. A API não preserva a lista existente quando este campo é omitido — em vez disso, ela a esvazia. Sempre passe o conjunto completo desejado de GUIDs de monitores.

A tabela a seguir descreve todos os campos de entrada disponíveis para esta ação.

Entrada

Tipo

Descrição

Exemplo

guid

Corda

Obrigatório. GUID da entidade do período de inatividade a ser editado.

"MTE5MzMzNDd8U1lOVEh8TU9OSVRPUl9ET1dOVElNRXwz..."

monitorGuids

Lista

Obrigatório. Conjunto completo de GUIDs de entidade de monitor aos quais o período de inatividade deve se aplicar. A API esvazia esta lista se for omitida, em vez de preservar o valor existente.

["MTE5MzMzNDd8U1lOVEh8..."]

startTime

Corda

Obrigatório. Horário de início como um NaiveDateTime (sem deslocamento de fuso horário), interpretado usando a entrada timezone.

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

endTime

Corda

Obrigatório. Horário de término como um NaiveDateTime (sem deslocamento de fuso horário), interpretado usando a entrada timezone.

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

fuso horário

Corda

Obrigatório. Nome do fuso horário da IANA usado para interpretar startTime e endTime.

"America/Los_Angeles"

nome

Corda

Opcional. Novo nome de exibição para o período de inatividade. Omita para deixar inalterado.

"Deploy maintenance window (extended)"

selectors

Lista

Opcional. Seletores JQ para extrair campos específicos da saída da ação.

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

A tabela a seguir descreve todos os campos de saída retornados por esta ação.

Saída

Tipo

Exemplo

success

Boleano

true quando a etapa foi executada sem erro.

errorMessage

Corda

Preenchido apenas se a chamada falhar no nível de HTTP/transporte. null em caso de sucesso.

data

Objeto

{
"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..."]
}
}
}

Exemplo de fluxo de trabalho

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

Excluir um período de inatividade do monitor

O identificador da ação é newrelic.synthetics.deleteMonitorDowntime.

Exclui um período de inatividade de monitor do Sintéticos identificado por seu GUID de entidade.

A tabela a seguir descreve todos os campos de entrada disponíveis para esta ação.

Entrada

Tipo

Descrição

Exemplo

guid

Corda

Obrigatório. GUID da entidade do período de inatividade a ser excluído.

"MTE5MzMzNDd8U1lOVEh8TU9OSVRPUl9ET1dOVElNRXxhZGZlYmRiOS0..."

selectors

Lista

Opcional. Seletores JQ para extrair campos específicos da saída da ação.

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

A tabela a seguir descreve todos os campos de saída retornados por esta ação.

Saída

Tipo

Exemplo

success

Boleano

true quando a etapa foi executada sem erro.

errorMessage

Corda

Preenchido apenas se a chamada falhar no nível de HTTP/transporte. null em caso de sucesso.

data

Objeto

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

Exemplo de fluxo de trabalho

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

Obter um monitor

O identificador da ação é newrelic.synthetics.getMonitor.

Busca os detalhes completos de um monitor de Sintéticos pelo GUID da entidade, incluindo o status atual, os percentis de tempo de carregamento e a configuração do monitor.

A tabela a seguir descreve todos os campos de entrada disponíveis para esta ação.

Entrada

Tipo

Descrição

Exemplo

guid

Corda

Obrigatório. GUID da entidade do monitor a ser obtido.

"MTE5MzMzNDd8U1lOVEh8TU9OSVRPUnwxMDMyODk5YS1kMmU2..."

selectors

Lista

Opcional. Seletores JQ para extrair campos específicos da saída da ação.

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

A tabela a seguir descreve todos os campos de saída retornados por esta ação.

Saída

Tipo

Exemplo

success

Boleano

true quando a etapa foi executada sem erro.

errorMessage

Corda

Preenchido apenas se a chamada falhar no nível de HTTP/transporte. null em caso de sucesso.

data

Objeto

{
"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
}
}
}
}
}

Exemplo de fluxo de trabalho

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

Listar monitores

O identificador da ação é newrelic.synthetics.listMonitors.

Pesquisa monitores Sintéticos de uma conta com filtros opcionais de nome e status de relatório, e paginação baseada em cursor.

A tabela a seguir descreve todos os campos de entrada disponíveis para esta ação.

Entrada

Tipo

Descrição

Exemplo

ID da conta

Inteiro

Obrigatório. ID da conta New Relic na qual pesquisar monitores.

11933347

nome

Corda

Opcional. Correspondência de 'contém' sem distinção entre maiúsculas e minúsculas em relação ao nome do monitor.

"Homepage"

relatórios

Boleano

Opcional. Filtrar para monitores que estão (true) ou não estão (false) reportando no momento. Omitir para retornar ambos.

true

cursor

Corda

Opcional. Cursor de paginação da saída nextCursor de uma chamada anterior. Omitir para começar da primeira página.

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

selectors

Lista

Opcional. Seletores JQ para extrair campos específicos da saída da ação.

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

A tabela a seguir descreve todos os campos de saída retornados por esta ação.

Saída

Tipo

Exemplo

success

Boleano

true quando a etapa foi executada sem erro.

errorMessage

Corda

Preenchido apenas se a chamada falhar no nível de HTTP/transporte. null em caso de sucesso.

data

Objeto

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

nextCursor está presente quando existem mais páginas. Passe-o como cursor na próxima chamada para recuperar a página seguinte.

Exemplo de fluxo de trabalho

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 Inc.

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