Gerenciar monitores de API com scripts

O New Relic permite que você use o NerdGraph para criar monitores de API com scripts. Os monitores API com script executam código JavaScript personalizado para testar APIs e serviços backend sem um navegador, fazendo requests HTTP e validando respostas programaticamente. Este tutorial fornece exemplos de como usar a API do NerdGraph para automatizar a criação de monitores de API com scripts.

Crie um monitor de API com script

Você pode criar um monitor de API com script usando a mutação syntheticsCreateScriptApiMonitor. Essa mutação permite configurar testes API personalizados que executam seu código JavaScript para validar os endpoints da API.

Parâmetro de entrada

Parâmetro	Tipo de dados	É obrigatório?	Descrição
`accountId`	Inteiro	Sim	Seu ID de conta New Relic onde o monitor será criado.
`monitor.locations.public`	Matriz	Sim	matriz de localização pública identificadar onde o monitor executará verificações (por exemplo, `["US_EAST_1", "US_WEST_1"]` ).
`monitor.name`	Corda	Sim	O nome de exibição para o seu monitor de API com script.
`monitor.period`	Enum	Sim	Com que frequência o monitor é executado? Opções: `EVERY_MINUTE` , `EVERY_5_MINUTES` , `EVERY_10_MINUTES` , `EVERY_15_MINUTES` , `EVERY_30_MINUTES` , `EVERY_HOUR` , `EVERY_6_HOURS` , `EVERY_12_HOURS` , `EVERY_DAY` .
`monitor.runtime.runtimeType`	Corda	Sim	O tipo de tempo de execução usado pelo seu monitor. `NODE_API` é o único valor aceito.
`monitor.runtime.runtimeTypeVersion`	Corda	Sim	A versão do tipo de tempo de execução usada pelo seu monitor. `16.10` é o único valor aceito.
`monitor.runtime.scriptLanguage`	Corda	Sim	O idioma utilizado no seu monitor. `JAVASCRIPT` é o único valor aceito.
`monitor.script`	Corda	Sim	O código JavaScript que o monitor executa. Este texto deve ser em formato simples, não codificado em base64. O script pode usar o objeto $http para fazer requests HTTP e realizar testes API.
`monitor.status`	Enum	Sim	O estado do monitor. Opções: `ENABLED` (monitor ativo e realizando verificações), `DISABLED` (monitor inativo).
`monitor.apdexTarget`	Float	Não	O monitor Apdex destino em segundos, usado para preencher relatórios SLA. O valor padrão é de 7,0 segundos.

Solicitação de amostra

mutation {
  syntheticsCreateScriptApiMonitor(
    accountId: ACCOUNT_ID
    monitor: {
      locations: { public: ["LOCATION_1", "LOCATION_2"] }
      name: "YOUR_MONITOR_NAME"
      period: PERIOD
      runtime: {
        runtimeType: "RUNTIME_TYPE"
        runtimeTypeVersion: "RUNTIME_TYPE_VERSION"
        scriptLanguage: "SCRIPT_LANGUAGE"
      }
      script: "SCRIPT_CONTENT"
      status: STATUS
      apdexTarget: APDEX_TARGET
    }
  ) {
    errors {
      description
      type
    }
  }
}

Resposta de amostra

Uma resposta bem-sucedida retorna null para erros:

{
  "data": {
    "syntheticsCreateScriptApiMonitor": {
      "errors": null
    }
  }
}

Se houver algum problema ao criar o monitor, a matriz errors conterá objetos com campos description e type explicando o que deu errado.

Atualizar um monitor de API com script

Você pode atualizar um monitor de API com script existente usando a mutação syntheticsUpdateScriptApiMonitor. Isso permite modificar a configuração de um monitor de API com script que já foi criado.

Parâmetro de entrada

Parâmetro	Tipo de dados	É obrigatório?	Descrição
`guid`	Corda	Sim	O GUID exclusivo da entidade do monitor que você deseja atualizar.
`monitor.locations.public`	Matriz	Não	matriz de localização pública identificadar onde o monitor executará verificações (por exemplo, `["US_EAST_1", "US_WEST_1"]` ).
`monitor.name`	Corda	Não	O nome de exibição atualizado para o seu monitor de API com script.
`monitor.period`	Enum	Não	Com que frequência o monitor é executado? Opções: `EVERY_MINUTE` , `EVERY_5_MINUTES` , `EVERY_10_MINUTES` , `EVERY_15_MINUTES` , `EVERY_30_MINUTES` , `EVERY_HOUR` , `EVERY_6_HOURS` , `EVERY_12_HOURS` , `EVERY_DAY` .
`monitor.runtime.runtimeType`	Corda	Não	O tipo de tempo de execução usado pelo seu monitor. `NODE_API` é o único valor aceito.
`monitor.runtime.runtimeTypeVersion`	Corda	Não	A versão do tipo de tempo de execução usada pelo seu monitor. `16.10` é o único valor aceito.
`monitor.runtime.scriptLanguage`	Corda	Não	O idioma utilizado no seu monitor. `JAVASCRIPT` é o único valor aceito.
`monitor.script`	Corda	Não	O código JavaScript que o monitor executa. Este texto deve ser em formato simples, não codificado em base64.
`monitor.status`	Enum	Não	O estado do monitor. Opções: `ENABLED` (monitor ativo e realizando verificações), `DISABLED` (monitor inativo).
`monitor.apdexTarget`	Float	Não	O monitor Apdex destino em segundos, usado para preencher relatórios SLA. O valor padrão é de 7,0 segundos.

Solicitação de amostra

mutation {
  syntheticsUpdateScriptApiMonitor(
    guid: ENTITY_GUID
    monitor: {
      locations: { public: ["LOCATION_1", "LOCATION_2"] }
      name: "YOUR_MONITOR_NAME"
      period: PERIOD
      runtime: {
        runtimeType: "RUNTIME_TYPE"
        runtimeTypeVersion: "RUNTIME_TYPE_VERSION"
        scriptLanguage: "SCRIPT_LANGUAGE"
      }
      script: "SCRIPT_CONTENT"
      status: STATUS
      apdexTarget: APDEX_TARGET
    }
  ) {
    errors {
      description
      type
    }
  }
}

Resposta de amostra

Uma resposta bem-sucedida retorna null para erros:

{
  "data": {
    "syntheticsUpdateScriptApiMonitor": {
      "errors": null
    }
  }
}

Se houver algum problema ao atualizar o monitor, a matriz errors conterá objetos com campos description e type explicando o que deu errado.

Atualize o ambiente de execução de um monitor de API baseado em script.

Você pode atualizar um monitor de API baseado em script para usar o ambiente de execução Node.js 16.10 mais recente. Isso garante que seu monitor utilize as atualizações mais recentes de recursos e segurança Node.js

Parâmetro de entrada

Parâmetro	Tipo de dados	É obrigatório?	Descrição
`guid`	Corda	Sim	O GUID exclusivo da entidade do monitor que você deseja atualizar.
`monitor.runtime.runtimeType`	Corda	Sim	O tipo de tempo de execução. `NODE_API` é o único valor aceito.
`monitor.runtime.runtimeTypeVersion`	Corda	Sim	A versão de tempo de execução. `16.10` é o único valor aceito.
`monitor.runtime.scriptLanguage`	Corda	Sim	A linguagem de script. `JAVASCRIPT` é o único valor aceito.

Solicitação de amostra

mutation {
  syntheticsUpdateScriptApiMonitor(
    guid: "ENTITY_GUID"
    monitor: {
      runtime: {
        runtimeType: "NODE_API"
        runtimeTypeVersion: "16.10"
        scriptLanguage: "JAVASCRIPT"
      }
    }
  ) {
    errors {
      description
      type
    }
  }
}

Resposta de amostra

Uma resposta bem-sucedida retorna null para erros:

{
  "data": {
    "syntheticsUpdateScriptApiMonitor": {
      "errors": null
    }
  }
}

Se houver algum problema ao atualizar o tempo de execução do monitor, a matriz errors conterá objetos com campos description e type explicando o que deu errado.

Fazer downgrade do runtime de um monitor de API baseado em script

Você pode fazer o downgrade de um monitor de API baseado em script para usar um ambiente de execução legado. Isso pode ser necessário por motivos de compatibilidade, mas observe que os runtimes legados chegarão ao fim de sua vida útil em 22 de outubro de 2024.

Importante

Os ambientes de execução legados estão obsoletos e chegarão ao fim de sua vida útil em 22 de outubro de 2024. Não é recomendável fazer o downgrade para versões de tempo de execução legadas, exceto em casos de necessidade temporária de compatibilidade.

Parâmetro de entrada

Parâmetro	Tipo de dados	É obrigatório?	Descrição
`guid`	Corda	Sim	O GUID exclusivo da entidade do monitor para o qual você deseja fazer o downgrade.
`monitor.runtime.runtimeType`	Corda	Sim	Defina como string vazia `""` para usar o ambiente de execução legado.
`monitor.runtime.runtimeTypeVersion`	Corda	Sim	Defina como string vazia `""` para usar o ambiente de execução legado.
`monitor.runtime.scriptLanguage`	Corda	Sim	Defina como string vazia `""` para usar o ambiente de execução legado.

Solicitação de amostra

mutation {
  syntheticsUpdateScriptApiMonitor(
    guid: "ENTITY_GUID"
    monitor: {
      runtime: { runtimeType: "", runtimeTypeVersion: "", scriptLanguage: "" }
    }
  ) {
    errors {
      description
      type
    }
  }
}

Resposta de amostra

Uma resposta bem-sucedida retorna null para erros:

{
  "data": {
    "syntheticsUpdateScriptApiMonitor": {
      "errors": null
    }
  }
}

Se houver algum problema ao fazer o downgrade do tempo de execução do monitor, a matriz errors conterá objetos com campos description e type explicando o que deu errado.

Mova um monitor API com script entre localização privada habilitada para VSE

Você pode mover um monitor API com script entre localização privada habilitada para VSE. Ao mover monitores entre locais privados com a execução script verificada (VSE) ativada, você deve incluir o script para regenerar os HMACs para validação de segurança.

Parâmetro de entrada

Parâmetro	Tipo de dados	É obrigatório?	Descrição
`guid`	Corda	Sim	O GUID exclusivo da entidade do monitor que você deseja mover.
`monitor.locations.private`	Matriz	Sim	matriz de localização privada configuração. Cada local requer um `guid` e `vsePassword` para locais habilitados para VSE.
`monitor.locations.private.guid`	Corda	Sim	O GUID da entidade da localização privada de destino.
`monitor.locations.private.vsePassword`	Corda	Sim	A senha do VSE para o destino localização privada.
`monitor.script`	Corda	Sim	O código JavaScript que o monitor executa. Isso deve ser incluído para regenerar os HMACs ao migrar entre locais com VSE habilitado.

Solicitação de amostra

mutation {
  syntheticsUpdateScriptApiMonitor(
    guid: "ENTITY_GUID"
    monitor: {
      locations: {
        private: [{ guid: "LOCATION_GUID", vsePassword: "YOUR_VSE_PASSWORD" }]
      }
      script: "SCRIPT_CONTENT"
    }
  ) {
    errors {
      description
      type
    }
    monitor {
      status
    }
  }
}

Resposta de amostra

Uma resposta bem-sucedida retorna null para erros e inclui o status do monitor:

{
  "data": {
    "syntheticsUpdateScriptApiMonitor": {
      "errors": null,
      "monitor": {
        "status": "ENABLED"
      }
    }
  }
}

Se houver algum problema ao mover o monitor, a matriz errors conterá objetos com campos description e type explicando o que deu errado.

Excluir um monitor de API com script

Quando um monitor de API com script não for mais necessário, você poderá removê-lo permanentemente usando a mutação syntheticsDeleteMonitor.

Para excluir um monitor, consulte a seção Excluir monitor Sintético.

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

Crie um monitor de API com script .css-21sua1{background:none;border:none;width:0;padding:0;}

Parâmetro de entrada

Solicitação de amostra

Resposta de amostra

Atualizar um monitor de API com script

Parâmetro de entrada

Solicitação de amostra

Resposta de amostra

Atualize o ambiente de execução de um monitor de API baseado em script.

Parâmetro de entrada

Solicitação de amostra

Resposta de amostra

Fazer downgrade do runtime de um monitor de API baseado em script

Importante

Parâmetro de entrada

Solicitação de amostra

Resposta de amostra

Mova um monitor API com script entre localização privada habilitada para VSE

Parâmetro de entrada

Solicitação de amostra

Resposta de amostra

Excluir um monitor de API com script

Crie um monitor de API com script