Conector de integración MetricBase de ServiceNow - AWS IoT Greengrass
RequisitosParámetrosDatos de entradaDatos de salidaEjemplo de usoLicenciasRegistro de cambiosVéase también

AWS IoT Greengrass Version 1 entró en la fase de vida útil prolongada el 30 de junio de 2023. Para obtener más información, consulte la política de mantenimiento de AWS IoT Greengrass V1 Después de esta fecha, AWS IoT Greengrass V1 no se publicarán actualizaciones que proporcionen funciones, mejoras, correcciones de errores o parches de seguridad. Los dispositivos que se ejecuten AWS IoT Greengrass V1 no se verán afectados y seguirán funcionando y conectándose a la nube. Le recomendamos encarecidamente que migre a AWS IoT Greengrass Version 2, ya que añade importantes funciones nuevas y es compatible con plataformas adicionales.

Las traducciones son generadas a través de traducción automática. En caso de conflicto entre la traducción y la version original de inglés, prevalecerá la version en inglés.

Conector de integración MetricBase de ServiceNow

aviso

Este conector ha pasado a la fase de vida útil prolongada y AWS IoT Greengrass no lanzará actualizaciones que proporcionen funciones, mejoras de las funciones existentes, parches de seguridad o correcciones de errores. Para obtener más información, consulte AWS IoT Greengrass Version 1política de mantenimiento.

El conector de Integración ServiceNow MetricBase publica las métricas de serie temporal desde dispositivos Greengrass a ServiceNow MetricBase. Esto permite almacenar, analizar y visualizar datos de serie temporal desde el entorno del núcleo de Greengrass y actuar en eventos locales.

Este conector recibe datos de serie temporal en un tema de MQTT y los publica en la API de ServiceNow de forma periódica.

Puede utilizar este conector para admitir situaciones como:

  • Crear alertas basadas en umbrales y alarmas en función de los datos de serie temporal recogidos mediante dispositivos Greengrass.

  • Utilizar datos de servicios de tiempo desde dispositivos Greengrass con aplicaciones personalizadas integradas en la plataforma ServiceNow.

Este conector tiene las siguientes versiones.

Versión

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 obtener información sobre los cambios de versión, consulte el Registro de cambios.

Requisitos

Este conector exige los siguientes requisitos:

Version 3 - 4

  • El Software de AWS IoT Greengrass Core versión 1.9.3 o posterior AWS IoT Greengrass debe configurarse para admitir secretos locales, tal y como se describe en los requisitos de secretos.

    nota

    Este requisito incluye permitir el acceso a sus secretos de Secret Manager. Si utiliza el rol de servicio predeterminado de Greengrass, Greengrass tiene permiso para obtener los valores de los secretos cuyos nombres empiecen por greengrass-.

  • Python versión 3.7 o 3.8 instalado en el dispositivo principal y añadido a la variable de entorno PATH.

    nota

    Para usar Python 3.8, ejecute el siguiente comando para crear un enlace simbólico desde la carpeta de instalación predeterminada de Python 3.7 a los binarios de Python 3.8 instalados.

    sudo ln -s path-to-python-3.8/python3.8 /usr/bin/python3.7

    Esto configura su dispositivo para que cumpla con el requisito de Python para AWS IoT Greengrass.

  • Una cuenta de ServiceNow con la suscripción activada en MetricBase. Además, se deben crear una métrica y una tabla de métricas en la cuenta. Para obtener más información, consulte MetricBase en la documentación de ServiceNow.

  • Un secreto de tipo de texto en AWS Secrets Manager que almacena el nombre de usuario y la contraseña para iniciar sesión en la instancia de ServiceNow con la autenticación básica. El secreto debe contener las claves "user" and "password" con los valores correspondientes. Para obtener más información, consulte Creación de un secreto básico en la Guía del usuario de AWS Secrets Manager.

  • Se crea un recurso de secretos en el grupo de Greengrass que hace referencia al secreto de Secrets Manager. Para obtener más información, consulte Implementación de secretos en el núcleo de AWS IoT Greengrass.

Versions 1 - 2

  • AWS IoT Greengrass Software Core versión 1.7 o posterior. AWS IoT Greengrass debe configurarse para admitir secretos locales, como se describe en los Requisitos de secretos.

    nota

    Este requisito incluye permitir el acceso a sus secretos de Secret Manager. Si utiliza el rol de servicio predeterminado de Greengrass, Greengrass tiene permiso para obtener los valores de los secretos cuyos nombres empiecen por greengrass-.

  • Versión 2.7 de Python instalada en el dispositivo principal y añadida a la variable de entorno PATH.

  • Una cuenta de ServiceNow con la suscripción activada en MetricBase. Además, se deben crear una métrica y una tabla de métricas en la cuenta. Para obtener más información, consulte MetricBase en la documentación de ServiceNow.

  • Un secreto de tipo de texto en AWS Secrets Manager que almacena el nombre de usuario y la contraseña para iniciar sesión en la instancia de ServiceNow con la autenticación básica. El secreto debe contener las claves "user" and "password" con los valores correspondientes. Para obtener más información, consulte Creación de un secreto básico en la Guía del usuario de AWS Secrets Manager.

  • Se crea un recurso de secretos en el grupo de Greengrass que hace referencia al secreto de Secrets Manager. Para obtener más información, consulte Implementación de secretos en el núcleo de AWS IoT Greengrass.

Parámetros de conector

Este conector proporciona los siguientes parámetros:

Version 4
PublishInterval

El número máximo de segundos que se debe esperar para la publicación de eventos en ServiceNow. El valor máximo es 900.

El conector se publica en ServiceNow cuando se alcanza PublishBatchSize o PublishInterval caduca.

Nombre para mostrar en la consola AWS IoT: Publicar intervalo en segundos

Obligatorio: true

Escriba: string

Valores válidos: 1 - 900

Patrón válido: [1-9]|[1-9]\d|[1-9]\d\d|900

PublishBatchSize

El número máximo de valores de métricas que se pueden procesar por lotes antes de que se publiquen en ServiceNow.

El conector se publica en ServiceNow cuando se alcanza PublishBatchSize o PublishInterval caduca.

Nombre para mostrar en la consola AWS IoT: Publicar tamaño del lote

Obligatorio: true

Escriba: string

Patrón válido: ^[0-9]+$

InstanceName

El nombre de la instancia que se utiliza para conectarse con ServiceNow.

Nombre para mostrar en la consola AWS IoT: Nombre de la instancia de ServiceNow

Obligatorio: true

Escriba: string

Patrón válido: .+

DefaultTableName

El nombre de la tabla que contiene el parámetro GlideRecord asociado a la base de datos de MetricBase de serie temporal. La propiedad table de la carga de mensajes de entrada se puede utilizar para anular este valor.

Nombre para mostrar en la consola AWS IoT: Nombre de la tabla que contiene la métrica

Obligatorio: true

Escriba: string

Patrón válido: .+

MaxMetricsToRetain

El número máximo de métricas para guardar en la memoria antes de que se sustituyen por nuevas métricas.

Este límite se aplica cuando no hay conexión a Internet y el conector comienza a almacenar en búfer las métricas que se van a publicar más adelante. Cuando el búfer está lleno, la métricas más antiguas se sustituyen por nuevas.

nota

Las métricas no se guardan si el proceso de host para el conector se interrumpe. Por ejemplo, este grupo puede ocurrir durante la implementación de grupos o cuando el dispositivo se reinicia.

Este valor debe ser mayor que el tamaño del lote y lo suficientemente grande como para almacenar mensajes en función de la velocidad de entrada de los mensajes de MQTT.

Nombre para mostrar en la consola AWS IoT: Máximo de métricas que se deben retener en la memoria

Obligatorio: true

Escriba: string

Patrón válido: ^[0-9]+$

AuthSecretArn

El secreto en AWS Secrets Manager que almacena la contraseña y el nombre de usuario de ServiceNow. Esto debe ser un secreto de tipo de texto. El secreto debe contener las claves "user" and "password" con los valores correspondientes.

Nombre para mostrar en la consola AWS IoT: ARN del secreto aut.

Obligatorio: true

Escriba: string

Patrón 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

El recurso de secretos del grupo que hace referencia al secreto del Secrets Manager para las credenciales de ServiceNow.

Nombre para mostrar en la consola AWS IoT: Recurso de token de autenticación

Obligatorio: true

Escriba: string

Patrón válido: .+

IsolationMode

El modo de creación de contenedores para este conector. El valor predeterminado es GreengrassContainer, lo que significa que el conector se ejecuta en un entorno de tiempo de ejecución aislado dentro del contenedor de AWS IoT Greengrass.

nota

La configuración de creación de contenedores predeterminada para el grupo no se aplica a los conectores.

Nombre para mostrar en la consola AWS IoT: Modo de aislamiento de contenedores

Obligatorio: false

Escriba: string

Valores válidos: GreengrassContainer o NoContainer

Patrón válido: ^NoContainer$|^GreengrassContainer$

Version 1 - 3
PublishInterval

El número máximo de segundos que se debe esperar para la publicación de eventos en ServiceNow. El valor máximo es 900.

El conector se publica en ServiceNow cuando se alcanza PublishBatchSize o PublishInterval caduca.

Nombre para mostrar en la consola AWS IoT: Publicar intervalo en segundos

Obligatorio: true

Escriba: string

Valores válidos: 1 - 900

Patrón válido: [1-9]|[1-9]\d|[1-9]\d\d|900

PublishBatchSize

El número máximo de valores de métricas que se pueden procesar por lotes antes de que se publiquen en ServiceNow.

El conector se publica en ServiceNow cuando se alcanza PublishBatchSize o PublishInterval caduca.

Nombre para mostrar en la consola AWS IoT: Publicar tamaño del lote

Obligatorio: true

Escriba: string

Patrón válido: ^[0-9]+$

InstanceName

El nombre de la instancia que se utiliza para conectarse con ServiceNow.

Nombre para mostrar en la consola AWS IoT: Nombre de la instancia de ServiceNow

Obligatorio: true

Escriba: string

Patrón válido: .+

DefaultTableName

El nombre de la tabla que contiene el parámetro GlideRecord asociado a la base de datos de MetricBase de serie temporal. La propiedad table de la carga de mensajes de entrada se puede utilizar para anular este valor.

Nombre para mostrar en la consola AWS IoT: Nombre de la tabla que contiene la métrica

Obligatorio: true

Escriba: string

Patrón válido: .+

MaxMetricsToRetain

El número máximo de métricas para guardar en la memoria antes de que se sustituyen por nuevas métricas.

Este límite se aplica cuando no hay conexión a Internet y el conector comienza a almacenar en búfer las métricas que se van a publicar más adelante. Cuando el búfer está lleno, la métricas más antiguas se sustituyen por nuevas.

nota

Las métricas no se guardan si el proceso de host para el conector se interrumpe. Por ejemplo, este grupo puede ocurrir durante la implementación de grupos o cuando el dispositivo se reinicia.

Este valor debe ser mayor que el tamaño del lote y lo suficientemente grande como para almacenar mensajes en función de la velocidad de entrada de los mensajes de MQTT.

Nombre para mostrar en la consola AWS IoT: Máximo de métricas que se deben retener en la memoria

Obligatorio: true

Escriba: string

Patrón válido: ^[0-9]+$

AuthSecretArn

El secreto en AWS Secrets Manager que almacena la contraseña y el nombre de usuario de ServiceNow. Esto debe ser un secreto de tipo de texto. El secreto debe contener las claves "user" and "password" con los valores correspondientes.

Nombre para mostrar en la consola AWS IoT: ARN del secreto aut.

Obligatorio: true

Escriba: string

Patrón 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

El recurso de secretos del grupo que hace referencia al secreto del Secrets Manager para las credenciales de ServiceNow.

Nombre para mostrar en la consola AWS IoT: Recurso de token de autenticación

Obligatorio: true

Escriba: string

Patrón válido: .+

Ejemplo de creación de conector (AWS CLI)

El siguiente comando de la CLI crea una ConnectorDefinition con una versión inicial que contiene el conector de integración ServiceNow MetricBase.

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

La función de Lambda de este conector tiene un ciclo de vida prolongado.

En la consola AWS IoT Greengrass, puede añadir un conector desde la página de Conectores del grupo. Para obtener más información, consulte Introducción a los conectores de Greengrass (consola).

Datos de entrada

Este conector acepta las métricas de serie temporal en un tema de MQTT y publica las métricas en ServiceNow. Los mensajes de entrada deben tener un formato JSON válido.

Filtro de temas en la suscripción

servicenow/metricbase/metric

Propiedades de mensajes
request

Información acerca de la tabla, el registro y la métrica. Esta solicitud representa el objeto seriesRef en una solicitud POST de serie temporal. Para obtener más información, consulte Clotho Time Series API - POST.

Obligatorio: true

Escriba: object que incluye las siguientes propiedades:

subject

El parámetro sys_id del registro específico en la tabla.

Obligatorio: true

Escriba: string

metric_name

El nombre del campo de métrica.

Obligatorio: true

Escriba: string

table

El nombre de la tabla en la que se almacenará el registro. Especifique este valor para anular el parámetro DefaultTableName.

Obligatorio: false

Escriba: string

value

El valor del punto de datos individual.

Obligatorio: true

Escriba: float

timestamp

La marca temporal del punto de datos individual. El valor predeterminado es la hora actual.

Obligatorio: false

Escriba: string

Ejemplo de entrada
{
    "request": {
        "subject":"ef43c6d40a0a0b5700c77f9bf387afe3",
        "metric_name":"u_count",
        "table": "u_greengrass_app"
        "value": 1.0,
        "timestamp": "2018-10-14T10:30:00"
    }
}

Datos de salida

Este conector publica información de estado como datos de salida en un tema MQTT.

Filtro de temas en la suscripción

servicenow/metricbase/metric/status

Ejemplo de salida: Correcto
{
    "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
            }
        ]
    }
}
Ejemplo de salida: Error
{
    "response": {
        "error": "InvalidInputException",
        "error_message": "metric value is invalid",
        "status": "fail"
    }
}
nota

Si el conector detecta un error que se puede volver a intentar (por ejemplo, errores de conexión), volverá a intentar la publicación en el siguiente lote.

Ejemplo de uso

Utilice los siguientes pasos de alto nivel para configurar una función de Lambda de Python 3.7 de ejemplo que puede utilizar para probar el conector.

nota

  1. Asegúrese de cumplir los requisitos para el conector.

  2. Cree y publique una función de Lambda que envíe datos de entrada al conector.

    Guarde el código de ejemplo como un archivo PY. Descargue y descomprima el SDK de AWS IoT Greengrass Core para Python. A continuación, cree un paquete zip que contenga el archivo PY y la carpeta greengrasssdk en el nivel raíz. Este paquete zip es el paquete de implementación que se carga en AWS Lambda.

    Después de crear la función de Lambda de Python 3.7, publique una versión de característica y cree un alias.

  3. Configuración del grupo de Greengrass.

    1. Agregue la función de Lambda por su alias (recomendado). Configure el ciclo de vida de Lambda como de larga duración (o "Pinned": true en la CLI).

    2. Agregue el recurso secreto requerido y conceda acceso de lectura a la función de Lambda.

    3. Agregue el conector y configure sus parámetros.

    4. Agregue suscripciones que permitan al conector recibir datos de entrada y enviar datos de salida en filtros de tema compatibles.

      • Establezca la función de Lambda como fuente, el conector como destino y utilice un filtro de tema de entrada compatible.

      • Establezca el conector como origen, AWS IoT Core como destino y utilice un filtro de tema de salida compatible. Utilice esta suscripción para ver los mensajes de estado en la consola de AWS IoT.

  4. Implemente el grupo.

  5. En la consola de AWS IoT, en la página Prueba, suscríbase al tema de datos de salida para ver los mensajes de estado del conector. La función de Lambda de ejemplo es de larga duración y comienza a enviar mensajes inmediatamente después de implementar el grupo.

    Cuando haya terminado de probar, puede establecer el ciclo de vida de Lambda en Bajo demanda (o "Pinned": false en la CLI) e implementar el grupo. Esto impide que la función envíe mensajes.

Ejemplo

El siguiente ejemplo de función de Lambda envía un mensaje de entrada al 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

Licencias

El conector de integración ServiceNow MetricBase incluye las siguientes licencias y software de terceros:

Este conector se publica bajo el contrato de licencia de software de Greengrass Core.

Registro de cambios

La siguiente tabla describe los cambios en cada versión del conector.

Versión

Cambios

4

Se ha agregado el parámetro IsolationMode para configurar el modo de creación de contenedores del conector.

3

Se actualizó el tiempo de ejecución de Lambda a Python 3.7, lo que cambia el requisito de tiempo de ejecución.

2

Se ha introducido una corrección para reducir el registro excesivo.

1

Versión inicial.

Un grupo de Greengrass solo puede contener una versión del conector a la vez. Para obtener información sobre cómo actualizar una versión de conector, consulte Actualización de versiones de los conectores.

Véase también