Aviso de fim do suporte: em 7 de outubro de 2026, AWS o suporte para o. AWS IoT Greengrass Version 1 Depois de 7 de outubro de 2026, você não poderá mais acessar os AWS IoT Greengrass V1 recursos. Para obter mais informações, visite [Migrar de AWS IoT Greengrass Version 1](https://docs.aws.amazon.com/greengrass/v2/developerguide/migrate-from-v1.html). As traduções são geradas por tradução automática. Em caso de conflito entre o conteúdo da tradução e da versão original em inglês, a versão em inglês prevalecerá. # ServiceNow MetricBase Conector de integração **Atenção** Esse conector passou para a * fase de vida útil estendida* e AWS IoT Greengrass não lançará atualizações que forneçam atributos, aprimoramentos para atributos existentes, patches de segurança ou correções de erros. Para obter mais informações, consulte [AWS IoT Greengrass Version 1 política de manutenção](maintenance-policy.md). O [conector](connectors.md) de ServiceNow MetricBase integração publica métricas de séries temporais dos dispositivos Greengrass para. ServiceNow MetricBase Isso permite que você armazene, analise e visualize dados de séries temporais do ambiente do núcleo do Greengrass e atue em eventos locais. Esse conector recebe dados de séries temporais sobre um tópico do MQTT e publica os dados na ServiceNow API em intervalos regulares. Você pode usar esse conector para oferecer suporte a cenários, como: + Crie alertas baseados em limites e alarmes baseados em dados de séries temporais coletados em Dispositivos Greengrass. + Use dados de serviços de horário dos dispositivos Greengrass com aplicativos personalizados criados na ServiceNow plataforma. Esse conector tem as seguintes versões. | Versão | ARN | | --- | --- | | 4 | `arn:aws:greengrass:region::/connectors/ServiceNowMetricBaseIntegration/versions/4` | | 3 | `arn:aws:greengrass:region::/connectors/ServiceNowMetricBaseIntegration/versions/3` | | 2 | `arn:aws:greengrass:region::/connectors/ServiceNowMetricBaseIntegration/versions/2` | | 1 | `arn:aws:greengrass:region::/connectors/ServiceNowMetricBaseIntegration/versions/1` | Para obter informações sobre alterações de versão, consulte o [Changelog](#servicenow-connector-changelog). ## Requisitos Esse conector tem os seguintes requisitos: ------ #### [ Version 3 - 4 ] + AWS IoT Greengrass Software principal v1.9.3 ou posterior. AWS IoT Greengrass deve ser configurado para oferecer suporte a segredos locais, conforme descrito em [Requisitos de segredos](secrets.md#secrets-reqs). **nota** Este requisito inclui permitir o acesso aos seus segredos do Secrets Manager. Se você estiver usando a função de serviço padrão do Greengrass, o Greengrass terá permissão para obter os valores de segredos com nomes que começam com *greengrass-*. + [Python](https://www.python.org/), versão 3.7 ou 3.8, instalado no dispositivo de núcleo e adicionado à variável de ambiente PATH. **nota** Para usar o Python 3.8, execute o comando a seguir para criar um symblink da pasta de instalação padrão do Python 3.7 para os binários instalados do Python 3.8. ``` sudo ln -s path-to-python-3.8/python3.8 /usr/bin/python3.7 ``` Isso configura seu dispositivo para atender ao requisito Python para AWS IoT Greengrass. + Uma ServiceNow conta com uma assinatura ativada do MetricBase. Além disso, uma métrica e tabela de métrica devem ser criadas na conta. Para obter mais informações, consulte [MetricBase](https://docs.servicenow.com/bundle/london-servicenow-platform/page/administer/metricbase/concept/metricbase.html)a ServiceNow documentação. + Um tipo de texto secreto AWS Secrets Manager que armazena o nome de usuário e a senha para fazer login na sua ServiceNow instância com autenticação básica. O segredo deve conter chaves "user" e "password" com valores correspondentes. Para obter mais informações, consulte [Criar um segredo básico](https://docs.aws.amazon.com/secretsmanager/latest/userguide/manage_create-basic-secret.html) no *Guia do usuário do AWS Secrets Manager *. + Um recurso de segredo no grupo do Greengrass que faz referência ao segredo do Secrets Manager. Para obter mais informações, consulte [Implante segredos até o AWS IoT Greengrass âmago](secrets.md). ------ #### [ Versions 1 - 2 ] + AWS IoT Greengrass Software principal v1.7 ou posterior. AWS IoT Greengrass deve ser configurado para oferecer suporte a segredos locais, conforme descrito em [Requisitos de segredos](secrets.md#secrets-reqs). **nota** Este requisito inclui permitir o acesso aos seus segredos do Secrets Manager. Se você estiver usando a função de serviço padrão do Greengrass, o Greengrass terá permissão para obter os valores de segredos com nomes que começam com *greengrass-*. + [Python](https://www.python.org/) versão 2.7 instalado no dispositivo de núcleo e adicionado à variável de ambiente PATH. + Uma ServiceNow conta com uma assinatura ativada do MetricBase. Além disso, uma métrica e tabela de métrica devem ser criadas na conta. Para obter mais informações, consulte [MetricBase](https://docs.servicenow.com/bundle/london-servicenow-platform/page/administer/metricbase/concept/metricbase.html)a ServiceNow documentação. + Um tipo de texto secreto AWS Secrets Manager que armazena o nome de usuário e a senha para fazer login na sua ServiceNow instância com autenticação básica. O segredo deve conter chaves "user" e "password" com valores correspondentes. Para obter mais informações, consulte [Criar um segredo básico](https://docs.aws.amazon.com/secretsmanager/latest/userguide/manage_create-basic-secret.html) no *Guia do usuário do AWS Secrets Manager *. + Um recurso de segredo no grupo do Greengrass que faz referência ao segredo do Secrets Manager. Para obter mais informações, consulte [Implante segredos até o AWS IoT Greengrass âmago](secrets.md). ------ ## Parâmetros do conector Esse conector oferece os seguintes parâmetros: ------ #### [ Version 4 ] `PublishInterval` O número máximo de segundos de espera entre os eventos de publicação ServiceNow. O valor máximo é 900. O conector publica até ServiceNow quando `PublishBatchSize` é atingido ou `PublishInterval` expira. Nome de exibição no AWS IoT console: **intervalo de publicação em segundos** Obrigatório: `true` Digite: `string` Valores válidos: `1 - 900` Padrão válido: `[1-9]|[1-9]\d|[1-9]\d\d|900` `PublishBatchSize` O número máximo de valores métricos que podem ser agrupados antes de serem ServiceNow publicados no. O conector publica até ServiceNow quando `PublishBatchSize` é atingido ou `PublishInterval` expira. Nome de exibição no AWS IoT console: **tamanho do lote de publicação** Obrigatório: `true` Digite: `string` Padrão válido: `^[0-9]+$` `InstanceName` O nome da instância usada para se conectar ServiceNow. Nome de exibição no AWS IoT console: **Nome da ServiceNow instância** Obrigatório: `true` Digite: `string` Padrão válido: `.+` `DefaultTableName` O nome da tabela que contém o `GlideRecord` associado ao MetricBase banco de dados de séries temporais. A propriedade `table` na carga da mensagem de entrada pode ser usada para substituir esse valor. Nome de exibição no AWS IoT console: **nome da tabela para conter a métrica** Obrigatório: `true` Digite: `string` Padrão válido: `.+` `MaxMetricsToRetain` O número máximo de métricas a serem salvas na memória antes de serem substituídas por novas métricas. Esse limite aplica-se quando não há conexão com a Internet, e o conector começa a armazenar as métricas em buffer para publicar posteriormente. Quando o buffer está cheio, as métricas mais antigas são substituídas por novas métricas. As métricas não são salvas se o processo de host do conector é interrompido. Por exemplo, isso pode ocorrer durante a implantação do grupo ou quando o dispositivo é reiniciado. Esse valor deve ser maior do que o tamanho do lote e grande o suficiente para armazenar mensagens com base na taxa de entrada de mensagens MQTT. Nome de exibição no AWS IoT console: **Métricas máximas a serem retidas na memória** Obrigatório: `true` Digite: `string` Padrão válido: `^[0-9]+$` `AuthSecretArn` O segredo AWS Secrets Manager é que armazena o nome de ServiceNow usuário e a senha. Ele deve ser um segredo de tipo de texto. O segredo deve conter chaves "user" e "password" com valores correspondentes. Nome de exibição no AWS IoT console: **ARN do segredo de autenticação** Obrigatório: `true` Digite: `string` Padrão válido: `arn:aws:secretsmanager:[a-z0-9\-]+:[0-9]{12}:secret:([a-zA-Z0-9\\]+/)*[a-zA-Z0-9/_+=,.@\-]+-[a-zA-Z0-9]+` `AuthSecretArn-ResourceId` O recurso secreto no grupo que faz referência ao segredo do Secrets Manager para as ServiceNow credenciais. Nome de exibição no AWS IoT console: recurso de **token de autenticação** Obrigatório: `true` Digite: `string` Padrão válido: `.+` `IsolationMode` O modo de [conteinerização](connectors.md#connector-containerization) para este conector. O padrão é`GreengrassContainer`, o que significa que o conector é executado em um ambiente de execução isolado dentro do AWS IoT Greengrass contêiner. A configuração padrão de conteinerização para o grupo não se aplica aos conectores. Nome de exibição no AWS IoT console: **modo de isolamento de contêiner** Obrigatório: `false` Digite: `string` Valores válidos: `GreengrassContainer` ou `NoContainer` Padrão válido: `^NoContainer$|^GreengrassContainer$` ------ #### [ Version 1 - 3 ] `PublishInterval` O número máximo de segundos de espera entre os eventos de publicação ServiceNow. O valor máximo é 900. O conector publica até ServiceNow quando `PublishBatchSize` é atingido ou `PublishInterval` expira. Nome de exibição no AWS IoT console: **intervalo de publicação em segundos** Obrigatório: `true` Digite: `string` Valores válidos: `1 - 900` Padrão válido: `[1-9]|[1-9]\d|[1-9]\d\d|900` `PublishBatchSize` O número máximo de valores métricos que podem ser agrupados antes de serem ServiceNow publicados no. O conector publica até ServiceNow quando `PublishBatchSize` é atingido ou `PublishInterval` expira. Nome de exibição no AWS IoT console: **tamanho do lote de publicação** Obrigatório: `true` Digite: `string` Padrão válido: `^[0-9]+$` `InstanceName` O nome da instância usada para se conectar ServiceNow. Nome de exibição no AWS IoT console: **Nome da ServiceNow instância** Obrigatório: `true` Digite: `string` Padrão válido: `.+` `DefaultTableName` O nome da tabela que contém o `GlideRecord` associado ao MetricBase banco de dados de séries temporais. A propriedade `table` na carga da mensagem de entrada pode ser usada para substituir esse valor. Nome de exibição no AWS IoT console: **nome da tabela para conter a métrica** Obrigatório: `true` Digite: `string` Padrão válido: `.+` `MaxMetricsToRetain` O número máximo de métricas a serem salvas na memória antes de serem substituídas por novas métricas. Esse limite aplica-se quando não há conexão com a Internet, e o conector começa a armazenar as métricas em buffer para publicar posteriormente. Quando o buffer está cheio, as métricas mais antigas são substituídas por novas métricas. As métricas não são salvas se o processo de host do conector é interrompido. Por exemplo, isso pode ocorrer durante a implantação do grupo ou quando o dispositivo é reiniciado. Esse valor deve ser maior do que o tamanho do lote e grande o suficiente para armazenar mensagens com base na taxa de entrada de mensagens MQTT. Nome de exibição no AWS IoT console: **Métricas máximas a serem retidas na memória** Obrigatório: `true` Digite: `string` Padrão válido: `^[0-9]+$` `AuthSecretArn` O segredo AWS Secrets Manager é que armazena o nome de ServiceNow usuário e a senha. Ele deve ser um segredo de tipo de texto. O segredo deve conter chaves "user" e "password" com valores correspondentes. Nome de exibição no AWS IoT console: **ARN do segredo de autenticação** Obrigatório: `true` Digite: `string` Padrão válido: `arn:aws:secretsmanager:[a-z0-9\-]+:[0-9]{12}:secret:([a-zA-Z0-9\\]+/)*[a-zA-Z0-9/_+=,.@\-]+-[a-zA-Z0-9]+` `AuthSecretArn-ResourceId` O recurso secreto no grupo que faz referência ao segredo do Secrets Manager para as ServiceNow credenciais. Nome de exibição no AWS IoT console: recurso de **token de autenticação** Obrigatório: `true` Digite: `string` Padrão válido: `.+` ------ ### Exemplo de criação de conector (AWS CLI) O comando CLI a seguir cria um `ConnectorDefinition` com uma versão inicial que contém o conector de ServiceNow MetricBase integração. ``` aws greengrass create-connector-definition --name MyGreengrassConnectors --initial-version '{ "Connectors": [ { "Id": "MyServiceNowMetricBaseIntegrationConnector", "ConnectorArn": "arn:aws:greengrass:region::/connectors/ServiceNowMetricBaseIntegration/versions/4", "Parameters": { "PublishInterval" : "10", "PublishBatchSize" : "50", "InstanceName" : "myinstance", "DefaultTableName" : "u_greengrass_app", "MaxMetricsToRetain" : "20000", "AuthSecretArn" : "arn:aws:secretsmanager:region:account-id:secret:greengrass-secret-hash", "AuthSecretArn-ResourceId" : "MySecretResource", "IsolationMode" : "GreengrassContainer" } } ] }' ``` **nota** A função do Lambda nesse conector tem um ciclo de vida [longo](lambda-functions.md#lambda-lifecycle). No AWS IoT Greengrass console, você pode adicionar um conector na página **Conectores** do grupo. Para obter mais informações, consulte [Conceitos básicos de conectores do Greengrass (console)](connectors-console.md). ## Dados de entrada Esse conector aceita métricas de séries temporais em um tópico do MQTT e publica as métricas em. ServiceNow As mensagens de entrada devem estar no formato JSON. **Filtro de tópico na assinatura** `servicenow/metricbase/metric` **Propriedades de mensagens** `request` As informações sobre a tabela, o registro e a métrica. Essa solicitação representa o objeto `seriesRef` em uma solicitação POST de séries temporais. Para obter mais informações, consulte [ API - POST de séries temporais Clotho](https://docs.servicenow.com/bundle/london-application-development/page/integrate/inbound-rest/concept/Clotho-Time-Series-API.html#clotho-POST-put). Obrigatório: `true` Tipo: `object` que inclui as seguintes propriedades: `subject` O `sys_id` do registro específico na tabela. Obrigatório: `true` Digite: `string` `metric_name` O nome do campo da métrica. Obrigatório: `true` Digite: `string` `table` O nome da tabela na qual armazenar o registro. Especifique esse valor para substituir o parâmetro `DefaultTableName`. Obrigatório: `false` Digite: `string` `value` O valor do ponto de dados individual. Obrigatório: `true` Digite: `float` `timestamp` O timestamp do ponto de dados individual. O valor padrão é o horário atual. Obrigatório: `false` Digite: `string` **Exemplo de entrada** ``` { "request": { "subject":"ef43c6d40a0a0b5700c77f9bf387afe3", "metric_name":"u_count", "table": "u_greengrass_app" "value": 1.0, "timestamp": "2018-10-14T10:30:00" } } ``` ## Dados de saída O conector publica informações de status como dados de saída em um tópico MQTT. **Filtro de tópico na assinatura** `servicenow/metricbase/metric/status` **Exemplo de resultado: sucesso** ``` { "response": { "metric_name": "Errors", "table_name": "GliderProd", "processed_on": "2018-10-14T10:35:00", "response_id": "khjKSkj132qwr23fcba", "status": "success", "values": [ { "timestamp": "2016-10-14T10:30:00", "value": 1.0 }, { "timestamp": "2016-10-14T10:31:00", "value": 1.1 } ] } } ``` **Exemplo de resultado: falha** ``` { "response": { "error": "InvalidInputException", "error_message": "metric value is invalid", "status": "fail" } } ``` Se o conector detectar um erro que pode ser repetido (por exemplo, erros de conexão), ele tentará publicar novamente no próximo lote. ## Exemplo de uso Use as seguintes etapas de alto nível para configurar um exemplo de função do Lambda Python 3.7 que pode ser usado para testar o conector. **nota** Se você usar outros runtimes do Python, poderá criar um symblink do Python3.x para o Python 3.7. Os tópicos [Conceitos básicos de conectores (console)](connectors-console.md) e [Conceitos básicos de conectores (CLI)](connectors-cli.md) contêm etapas detalhadas que mostram como configurar e implantar um exemplo do conector de notificações do Twilio. 1. Certifique-se de cumprir os [requisitos](#servicenow-connector-req) para o conector. 1. Crie e publique uma função do Lambda que envie dados de entrada para o conector. Salve o [código de exemplo](#servicenow-connector-usage-example) como arquivo PY. Baixe e descompacte o [SDK do AWS IoT Greengrass Core para Python](lambda-functions.md#lambda-sdks-core). Crie então um pacote zip que contenha o arquivo PY e a pasta `greengrasssdk` no nível raiz. Este pacote zip é o pacote de implantação que você transfere por upload para o AWS Lambda. Depois de criar a função do Lambda Python 3.7, publique uma versão de função e crie um alias. 1. Configure o grupo do Greengrass. 1. Adicione a função do Lambda pelo seu alias (recomendado). Configure o ciclo de vida do Lambda como de longa duração (ou `"Pinned": true` na CLI). 1. Adicione o recurso de segredode segredo necessário e conceda acesso de leitura à função do Lambda. 1. Adicione o conector e configure seus [parâmetros](#servicenow-connector-param). 1. Adicione assinaturas que permitam que o conector receba [dados de entrada](#servicenow-connector-data-input) e envie [dados de saída](#servicenow-connector-data-output) em filtros de tópico compatíveis. + Defina a função do Lambda como origem, o conector como destino e use um filtro de tópico de entrada compatível. + Defina o conector como origem, o AWS IoT Core como destino, e use um filtro de tópico de saída compatível. Você usa essa assinatura para visualizar mensagens de status no AWS IoT console. 1. Implante o grupo. 1. No AWS IoT console, na página **Teste**, inscreva-se no tópico de dados de saída para ver as mensagens de status do conector. A função de exemplo do Lambda é de longa duração e começa a enviar mensagens imediatamente após o grupo ser implantado. Ao finalizar o teste, você pode definir o ciclo de vida do Lambda como sob demanda (ou `"Pinned": false` na CLI) e implantar o grupo. Isso impede o envio de mensagens pela função. ### Exemplo O exemplo a seguir da função do Lambda envia uma mensagem de entrada para o conector. ``` import greengrasssdk import json iot_client = greengrasssdk.client('iot-data') SEND_TOPIC = 'servicenow/metricbase/metric' def create_request_with_all_fields(): return { "request": { "subject": '2efdf6badbd523803acfae441b961961', "metric_name": 'u_count', "value": 1234, "timestamp": '2018-10-20T20:22:20', "table": 'u_greengrass_metricbase_test' } } def publish_basic_message(): messageToPublish = create_request_with_all_fields() print("Message To Publish: ", messageToPublish) iot_client.publish(topic=SEND_TOPIC, payload=json.dumps(messageToPublish)) publish_basic_message() def lambda_handler(event, context): return ``` ## Licenças O conector de ServiceNow MetricBase integração inclui o seguinte software/licenciamento de terceiros: + [pysnow](https://github.com/rbw/pysnow)/MIT Esse conector é liberado de acordo com o [Contrato de licença de software do Greengrass Core](https://greengrass-release-license.s3.us-west-2.amazonaws.com/greengrass-license-v1.pdf). ## Changelog A tabela a seguir descreve as alterações em cada versão do conector. | Versão | Alterações | | --- | --- | | 4 | Adicionado o parâmetro `IsolationMode` para configurar o modo de conteinerização para o conector. | | 3 | Atualização do runtime do Lambda para Python 3.7, o que altera o requisito de runtime. | | 2 | Corrija para reduzir o registro excessivo. | | 1 | Versão inicial. | Um grupo do Greengrass só pode conter uma versão do conector por vez. Para obter informações sobre como fazer upgrade de uma versão do conector, consulte [Atualizar a versões do conector](connectors.md#upgrade-connector-versions). ## Consulte também + [Integrar a serviços e protocolos usando conectores do Greengrass](connectors.md) + [Conceitos básicos de conectores do Greengrass (console)](connectors-console.md) + [Conceitos básicos de conectores do Greengrass (CLI)](connectors-cli.md)