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 |
|
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. |
|
tests[].config.isBlocking | Boleano | Opcional. Se |
|
tests[].config.overrides.location | Corda | Opcional. Execute o teste a partir deste local em vez dos locais configurados do monitor. |
|
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. |
|
tests[].config.overrides.domain | Lista | Opcional. Redirecione requests de um domínio para outro apenas para esta execução. Cada entrada requer |
|
tests[].config.overrides.secureCredential | Lista | Opcional. Substitua para qual credencial segura armazenada a referência |
|
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: |
|
selectors | Lista | Opcional. Seletores JQ para extrair campos específicos da saída da ação. |
|
A tabela a seguir descreve todos os campos de saída retornados por esta ação.
Saída | Tipo | Exemplo |
|---|---|---|
| Boleano |
|
| Corda | Preenchido apenas se a chamada falhar no nível de HTTP/transporte. |
| Objeto | Passe o |
Exemplo de fluxo de trabalho |
|---|
|
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. |
|
batchId | Corda | Obrigatório. O ID de lote retornado por |
|
selectors | Lista | Opcional. Seletores JQ para extrair campos específicos da saída da ação. |
|
A tabela a seguir descreve todos os campos de saída retornados por esta ação.
Saída | Tipo | Exemplo |
|---|---|---|
| Boleano |
|
| Corda | Preenchido apenas se a chamada falhar no nível de HTTP/transporte. |
| Objeto |
|
Exemplo de fluxo de trabalho |
|---|
|
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. |
|
nome | Corda | Obrigatório. Nome de exibição para o período de inatividade. |
|
startTime | Corda | Obrigatório. Horário de início como NaiveDateTime (sem deslocamento de fuso horário), interpretado usando a entrada |
|
endTime | Corda | Obrigatório. Horário de término como um NaiveDateTime (sem deslocamento de fuso horário), interpretado usando a entrada |
|
fuso horário | Corda | Obrigatório. Nome do fuso horário da IANA usado para interpretar |
|
monitorGuids | Lista | Obrigatório. GUIDs de entidade dos monitores a serem silenciados durante o período de inatividade. Deve incluir pelo menos um GUID. |
|
selectors | Lista | Opcional. Seletores JQ para extrair campos específicos da saída da ação. |
|
A tabela a seguir descreve todos os campos de saída retornados por esta ação.
Saída | Tipo | Exemplo |
|---|---|---|
| Boleano |
|
| Corda | Preenchido apenas se a chamada falhar no nível de HTTP/transporte. |
| Objeto | |
Exemplo de fluxo de trabalho |
|---|
|
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. |
|
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. |
|
startTime | Corda | Obrigatório. Horário de início como um NaiveDateTime (sem deslocamento de fuso horário), interpretado usando a entrada |
|
endTime | Corda | Obrigatório. Horário de término como um NaiveDateTime (sem deslocamento de fuso horário), interpretado usando a entrada |
|
fuso horário | Corda | Obrigatório. Nome do fuso horário da IANA usado para interpretar |
|
nome | Corda | Opcional. Novo nome de exibição para o período de inatividade. Omita para deixar inalterado. |
|
selectors | Lista | Opcional. Seletores JQ para extrair campos específicos da saída da ação. |
|
A tabela a seguir descreve todos os campos de saída retornados por esta ação.
Saída | Tipo | Exemplo |
|---|---|---|
| Boleano |
|
| Corda | Preenchido apenas se a chamada falhar no nível de HTTP/transporte. |
| Objeto | |
Exemplo de fluxo de trabalho |
|---|
|
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. |
|
selectors | Lista | Opcional. Seletores JQ para extrair campos específicos da saída da ação. |
|
A tabela a seguir descreve todos os campos de saída retornados por esta ação.
Saída | Tipo | Exemplo |
|---|---|---|
| Boleano |
|
| Corda | Preenchido apenas se a chamada falhar no nível de HTTP/transporte. |
| Objeto | |
Exemplo de fluxo de trabalho |
|---|
|
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. |
|
selectors | Lista | Opcional. Seletores JQ para extrair campos específicos da saída da ação. |
|
A tabela a seguir descreve todos os campos de saída retornados por esta ação.
Saída | Tipo | Exemplo |
|---|---|---|
| Boleano |
|
| Corda | Preenchido apenas se a chamada falhar no nível de HTTP/transporte. |
| Objeto | |
Exemplo de fluxo de trabalho |
|---|
|
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. |
|
nome | Corda | Opcional. Correspondência de 'contém' sem distinção entre maiúsculas e minúsculas em relação ao nome do monitor. |
|
relatórios | Boleano | Opcional. Filtrar para monitores que estão ( |
|
cursor | Corda | Opcional. Cursor de paginação da saída |
|
selectors | Lista | Opcional. Seletores JQ para extrair campos específicos da saída da ação. |
|
A tabela a seguir descreve todos os campos de saída retornados por esta ação.
Saída | Tipo | Exemplo |
|---|---|---|
| Boleano |
|
| Corda | Preenchido apenas se a chamada falhar no nível de HTTP/transporte. |
| Objeto |
|
Exemplo de fluxo de trabalho |
|---|
|