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.
CloudWatch métricas
El componente de CloudWatch métricas de Amazon (aws.greengrass.Cloudwatch) publica métricas personalizadas de los dispositivos principales de Greengrass en Amazon. CloudWatch El componente permite a los componentes publicar CloudWatch métricas, que puede utilizar para supervisar y analizar el entorno del dispositivo principal de Greengrass. Para obtener más información, consulta Uso de CloudWatch las métricas de Amazon en la Guía del CloudWatch usuario de Amazon.
Para publicar una CloudWatch métrica con este componente, publica un mensaje en un tema al que esté suscrito este componente. De forma predeterminada, este componente se suscribe al tema cloudwatch/metric/put local de publicación/suscripción. Puede especificar otros temas, incluidos los temas de AWS IoT Core MQTT, al implementar este componente.
Este componente agrupa las métricas que se encuentran en el mismo espacio de nombres y las publica a CloudWatch intervalos regulares.
Este componente proporciona una funcionalidad similar a la del conector de CloudWatch métricas de la versión 1. AWS IoT Greengrass Para obtener más información, consulte el conector de CloudWatch métricas en la Guía para AWS IoT Greengrass desarrolladores de la versión 1.
Versiones
Este componente tiene las siguientes versiones:
Para obtener información sobre los cambios en cada versión del componente, consulte el registro de cambios.
Tipo
- v3.x
-
Este componente es un componente genérico () aws.greengrass.generic. El núcleo de Greengrass ejecuta los scripts del ciclo de vida del componente.
- v2.x
-
Este componente es un componente Lambda () aws.greengrass.lambda. El núcleo de Greengrass ejecuta la función Lambda de este componente mediante el componente Lambda launcher.
Para obtener más información, consulte Tipos de componentes.
Sistema operativo
- v3.x
-
Este componente se puede instalar en los dispositivos principales que ejecutan los siguientes sistemas operativos:
- v2.x
-
Este componente solo se puede instalar en los dispositivos principales de Linux.
Requisitos
Este componente tiene los siguientes requisitos:
- 3.x
-
-
Versión 3.7 de Python instalada en el dispositivo principal y añadida a la variable de entorno PATH.
-
El rol de dispositivo de Greengrass debe permitir la cloudwatch:PutMetricData acción, como se muestra en el siguiente ejemplo de política de IAM.
{
"Version": "2012-10-17",
"Statement": [
{
"Action": [
"cloudwatch:PutMetricData"
],
"Effect": "Allow",
"Resource": "*"
}
]
}
Para obtener más información, consulta la referencia de CloudWatch permisos de Amazon en la Guía del CloudWatch usuario de Amazon.
- 2.x
-
-
El dispositivo principal debe cumplir los requisitos para ejecutar las funciones de Lambda. Si desea que el dispositivo principal ejecute funciones Lambda en contenedores, el dispositivo debe cumplir los requisitos para hacerlo. Para obtener más información, consulte Requisitos de la función de Lambda.
-
Versión 3.7 de Python instalada en el dispositivo principal y añadida a la variable de entorno PATH.
-
El rol de dispositivo de Greengrass debe permitir la cloudwatch:PutMetricData acción, como se muestra en el siguiente ejemplo de política de IAM.
{
"Version": "2012-10-17",
"Statement": [
{
"Action": [
"cloudwatch:PutMetricData"
],
"Effect": "Allow",
"Resource": "*"
}
]
}
Para obtener más información, consulta la referencia de CloudWatch permisos de Amazon en la Guía del CloudWatch usuario de Amazon.
-
Para recibir los datos de salida de este componente, debe combinar la siguiente actualización de configuración para el componente antiguo del router de suscripciones (aws.greengrass.LegacySubscriptionRouter) al implementar este componente. Esta configuración especifica el tema en el que este componente publica las respuestas.
Legacy subscription router v2.1.xLegacy subscription router v2.0.x
- Legacy subscription router v2.1.x
{
"subscriptions": {
"aws-greengrass-cloudwatch": {
"id": "aws-greengrass-cloudwatch",
"source": "component:aws.greengrass.Cloudwatch",
"subject": "cloudwatch/metric/put/status",
"target": "cloud"
}
}
}
- Legacy subscription router v2.0.x
{
"subscriptions": {
"aws-greengrass-cloudwatch": {
"id": "aws-greengrass-cloudwatch",
"source": "arn:aws:lambda:region:aws:function:aws-greengrass-cloudwatch:version",
"subject": "cloudwatch/metric/put/status",
"target": "cloud"
}
}
}
-
Sustituya la región por la Región de AWS que utilice.
-
Sustituya la versión por la versión de la función Lambda que ejecuta este componente. Para encontrar la versión de la función Lambda, debe ver la receta de la versión de este componente que desee implementar. Abra la página de detalles de este componente en la AWS IoT Greengrass consola y busque el par clave-valor de la función Lambda. Este par clave-valor contiene el nombre y la versión de la función Lambda.
Debe actualizar la versión de la función Lambda en el router de suscripción anterior cada vez que implemente este componente. Esto garantiza que utilice la versión correcta de la función Lambda para la versión del componente que implemente.
Para obtener más información, consulte Crear implementaciones.
Puntos finales y puertos
Este componente debe poder realizar solicitudes salientes a los siguientes puntos finales y puertos, además de a los puntos finales y puertos necesarios para el funcionamiento básico. Para obtener más información, consulte Permitir el tráfico del dispositivo a través de un proxy o firewall.
| punto de enlace |
Puerto |
Obligatoria |
Descripción |
|
monitoring.region.amazonaws.com
|
443 |
Sí |
Cargue métricas. CloudWatch
|
Dependencias
Al implementar un componente, AWS IoT Greengrass también despliega versiones compatibles de sus dependencias. Esto significa que debe cumplir los requisitos del componente y de todas sus dependencias para poder implementarlo correctamente. En esta sección se enumeran las dependencias de las versiones publicadas de este componente y las restricciones de las versiones semánticas que definen las versiones de los componentes para cada dependencia. También puede ver las dependencias de cada versión del componente en la consola. AWS IoT Greengrass En la página de detalles del componente, busque la lista de dependencias.
- 3.0.0 - 3.1.0
-
La siguiente tabla muestra las dependencias de las versiones 3.0.0 a 3.1.0 de este componente.
- 2.1.2 and 2.1.3
-
La siguiente tabla muestra las dependencias de las versiones 2.1.2 y 2.1.3 de este componente.
- 2.1.1
-
La siguiente tabla muestra las dependencias de la versión 2.1.1 de este componente.
- 2.0.8 - 2.1.0
-
La siguiente tabla muestra las dependencias de las versiones 2.0.8 a 2.1.0 de este componente.
- 2.0.7
-
La siguiente tabla muestra las dependencias de la versión 2.0.7 de este componente.
- 2.0.6
-
La siguiente tabla muestra las dependencias de la versión 2.0.6 de este componente.
- 2.0.5
-
La siguiente tabla muestra las dependencias de la versión 2.0.5 de este componente.
- 2.0.4
-
La siguiente tabla muestra las dependencias de la versión 2.0.4 de este componente.
- 2.0.3
-
La siguiente tabla muestra las dependencias de la versión 2.0.3 de este componente.
Para obtener más información sobre las dependencias de los componentes, consulta la referencia de recetas de componentes.
Configuración
Este componente proporciona los siguientes parámetros de configuración que puede personalizar al implementar el componente.
- v3.x
-
-
PublishInterval
-
(Opcional) El número máximo de segundos que se deben esperar antes de que el componente publique métricas por lotes para un espacio de nombres determinado. Para configurar el componente para que publique las métricas a medida que las reciba, es decir, sin procesamiento por lotes, especifique. 0
El componente publica CloudWatch después de recibir 20 métricas en el mismo espacio de nombres o después del intervalo que especifique.
El componente no especifica el orden en el que se publican los eventos.
Este valor puede ser de 900 segundos como máximo.
Predeterminado: 10 segundos
-
MaxMetricsToRetain
-
(Opcional) El número máximo de métricas en todos los espacios de nombres que se deben guardar en la memoria antes de que el componente las sustituya por métricas más recientes.
Este límite se aplica cuando el dispositivo principal no tiene conexión a Internet, por lo que el componente almacena las métricas en un búfer para publicarlas más adelante. Cuando el búfer está lleno, el componente reemplaza las métricas más antiguas por otras más nuevas. Las métricas de un espacio de nombres determinado solo sustituyen a las métricas del mismo espacio de nombres.
Si el proceso anfitrión del componente se interrumpe, el componente no guarda las métricas. Esto puede ocurrir durante una implementación o cuando el dispositivo principal se reinicia, por ejemplo.
Este valor debe ser de al menos 2000 métricas.
Predeterminado: 5000 métricas
InputTopic-
(Opcional) El tema al que se suscribe el componente para recibir mensajes. Si lo especifica truePubSubToIoTCore, puede usar los comodines MQTT (+ y #) en este tema.
Predeterminado: cloudwatch/metric/put
OutputTopic-
(Opcional) El tema en el que el componente publica las respuestas de estado.
Predeterminado: cloudwatch/metric/put/status
PubSubToIoTCore-
(Opcional) Valor de cadena que define si se deben publicar o suscribirse a los temas de AWS IoT Core MQTT. Los valores admitidos son true y false.
Predeterminado: false
UseInstaller-
(Opcional) Valor booleano que define si se debe utilizar el script de instalación de este componente para instalar las dependencias del SDK de este componente.
Establezca este valor false si desea utilizar un script personalizado para instalar las dependencias o si desea incluir las dependencias en tiempo de ejecución en una imagen de Linux prediseñada. Para usar este componente, debe instalar las siguientes bibliotecas, incluidas las dependencias, y ponerlas a disposición del usuario predeterminado del sistema Greengrass.
Predeterminado: true
PublishRegion-
(Opcional) El lugar en el Región de AWS que se van a publicar CloudWatch las métricas. Este valor anula la región predeterminada del dispositivo principal. Este parámetro solo es necesario para las métricas entre regiones.
accessControl-
(Opcional) El objeto que contiene la política de autorización que permite al componente publicar y suscribirse a los temas especificados. Si especifica valores personalizados para InputTopic yOutputTopic, debe actualizar los valores de los recursos de este objeto.
Predeterminado:
{
"aws.greengrass.ipc.pubsub": {
"aws.greengrass.Cloudwatch:pubsub:1": {
"policyDescription": "Allows access to subscribe to input topics.",
"operations": [
"aws.greengrass#SubscribeToTopic"
],
"resources": [
"cloudwatch/metric/put"
]
},
"aws.greengrass.Cloudwatch:pubsub:2": {
"policyDescription": "Allows access to publish to output topics.",
"operations": [
"aws.greengrass#PublishToTopic"
],
"resources": [
"cloudwatch/metric/put/status"
]
}
},
"aws.greengrass.ipc.mqttproxy": {
"aws.greengrass.Cloudwatch:mqttproxy:1": {
"policyDescription": "Allows access to subscribe to input topics.",
"operations": [
"aws.greengrass#SubscribeToIoTCore"
],
"resources": [
"cloudwatch/metric/put"
]
},
"aws.greengrass.Cloudwatch:mqttproxy:2": {
"policyDescription": "Allows access to publish to output topics.",
"operations": [
"aws.greengrass#PublishToIoTCore"
],
"resources": [
"cloudwatch/metric/put/status"
]
}
}
}
ejemplo Ejemplo: actualización de combinación de configuraciones
{
"PublishInterval": 0,
"PubSubToIoTCore": true
}
- v2.x
-
La configuración predeterminada de este componente incluye los parámetros de la función Lambda. Le recomendamos que edite solo los siguientes parámetros para configurar este componente en sus dispositivos.
-
lambdaParams
-
Objeto que contiene los parámetros de la función Lambda de este componente. Este objeto contiene la siguiente información:
-
EnvironmentVariables
-
Objeto que contiene los parámetros de la función Lambda. Este objeto contiene la siguiente información:
-
PUBLISH_INTERVAL
-
(Opcional) El número máximo de segundos que se deben esperar antes de que el componente publique métricas por lotes para un espacio de nombres determinado. Para configurar el componente para que publique las métricas a medida que las reciba, es decir, sin procesamiento por lotes, especifique. 0
El componente publica CloudWatch después de recibir 20 métricas en el mismo espacio de nombres o después del intervalo que especifique.
El componente no garantiza el orden en el que se publican los eventos.
Este valor puede ser como máximo de 900 segundos.
Predeterminado: 10 segundos
-
MAX_METRICS_TO_RETAIN
-
(Opcional) El número máximo de métricas en todos los espacios de nombres que se deben guardar en la memoria antes de que el componente las sustituya por métricas más recientes.
Este límite se aplica cuando el dispositivo principal no tiene conexión a Internet, por lo que el componente almacena las métricas en un búfer para publicarlas más adelante. Cuando el búfer está lleno, el componente reemplaza las métricas más antiguas por otras más nuevas. Las métricas de un espacio de nombres determinado solo sustituyen a las métricas del mismo espacio de nombres.
Si el proceso anfitrión del componente se interrumpe, el componente no guarda las métricas. Esto puede ocurrir durante una implementación o cuando el dispositivo principal se reinicia, por ejemplo.
Este valor debe ser de al menos 2000 métricas.
Predeterminado: 5000 métricas
-
PUBLISH_REGION
-
(Opcional) El lugar en el Región de AWS que se van a publicar CloudWatch las métricas. Este valor anula la región predeterminada del dispositivo principal. Este parámetro solo es necesario para las métricas entre regiones.
containerMode-
(Opcional) El modo de contenedorización de este componente. Puede elegir entre las siguientes opciones:
Predeterminado: GreengrassContainer
-
containerParams
-
(Opcional) Un objeto que contiene los parámetros del contenedor de este componente. El componente utiliza estos parámetros si se especifica GreengrassContainer paracontainerMode.
Este objeto contiene la siguiente información:
-
memorySize
-
(Opcional) La cantidad de memoria (en kilobytes) que se va a asignar al componente.
El valor predeterminado es 64 MB (65.535 KB).
pubsubTopics-
(Opcional) Objeto que contiene los temas a los que el componente se suscribe para recibir mensajes. Puede especificar cada tema y si el componente se suscribe a los temas de MQTT AWS IoT Core o a los temas de publicación/suscripción locales.
Este objeto contiene la siguiente información:
0— Se trata de un índice matricial en forma de cadena.-
Objeto que contiene la siguiente información:
type-
(Opcional) El tipo de mensajes de publicación/suscripción que utiliza este componente para suscribirse a los mensajes. Puede elegir entre las siguientes opciones:
-
PUB_SUB — Suscribirse a mensajes locales de publicación/suscripción. Si elige esta opción, el tema no puede contener caracteres comodín de MQTT. Para obtener más información sobre cómo enviar mensajes desde un componente personalizado al especificar esta opción, consulte. Publicar/suscribir mensajes locales
-
IOT_CORE— Suscríbase a los mensajes AWS IoT Core MQTT. Si elige esta opción, el tema puede contener caracteres comodín de MQTT. Para obtener más información sobre cómo enviar mensajes desde componentes personalizados al especificar esta opción, consulte. Publicar/suscribir mensajes MQTT AWS IoT Core
Predeterminado: PUB_SUB
topic-
(Opcional) El tema al que se suscribe el componente para recibir mensajes. Si lo especifica IotCoretype, puede usar los comodines MQTT (+y#) en este tema.
ejemplo Ejemplo: actualización de la combinación de configuraciones (modo contenedor)
{
"containerMode": "GreengrassContainer"
}
ejemplo Ejemplo: actualización de la combinación de configuraciones (sin modo contenedor)
{
"containerMode": "NoContainer"
}
Este componente acepta métricas del tema siguiente y las publica en CloudWatch. De forma predeterminada, este componente se suscribe a los mensajes locales de publicación/suscripción. Para obtener más información sobre cómo publicar mensajes en este componente desde sus componentes personalizados, consulte. Publicar/suscribir mensajes locales
A partir de la versión 3.0.0 del componente, si lo desea, puede configurar este componente para que se suscriba a un tema de MQTT estableciendo el parámetro de PubSubToIoTCore configuración en. true Para obtener más información sobre la publicación de mensajes en un tema de MQTT en sus componentes personalizados, consulte. Publicar/suscribir mensajes MQTT AWS IoT Core
Tema predeterminado: cloudwatch/metric/put
El mensaje acepta las siguientes propiedades. Los mensajes de entrada deben tener un formato JSON válido.
-
request
-
La métrica de este mensaje.
El objeto de la solicitud contiene los datos de métricas que se publicarán en CloudWatch. Los valores métricos deben cumplir las especificaciones de la PutMetricDataoperación.
Tipo: object que contiene la siguiente información:
-
namespace
-
El espacio de nombres definido por el usuario para los datos de las métricas de esta solicitud. CloudWatch utiliza los espacios de nombres como contenedores para los puntos de datos métricos.
No se puede especificar un espacio de nombres que comience la cadena reservada por AWS/.
Tipo: string
Patrón válido: [^:].*
-
metricData
-
Los datos de la métrica.
Tipo: object que contiene la siguiente información:
-
metricName
-
El nombre de la métrica.
Tipo: string
-
value
-
El valor de la métrica.
CloudWatch rechaza los valores demasiado pequeños o demasiado grandes. El valor debe estar comprendido entre 8.515920e-109 y 1.174271e+108 (Base 10) o 2e-360 y 2e360 (Base 2). CloudWatch no admite valores especiales como NaN+Infinity, y-Infinity.
Tipo: double
-
dimensions
-
(Opcional) Las dimensiones de la métrica. Las dimensiones proporcionan información adicional acerca de la métrica y sus datos. Una métrica puede definir hasta 10 dimensiones.
Este componente incluye automáticamente una dimensión con un nombrecoreName, donde el valor es el nombre del dispositivo principal.
Tipo: array de objetos, cada uno de los cuales contiene la siguiente información:
-
name
-
(Opcional) El nombre de la dimensión.
Tipo: string
-
value
-
(Opcional) El valor de la dimensión.
Tipo: string
-
timestamp
-
(Opcional) La hora a la que se recibieron los datos de la métrica, expresada en segundos en el tiempo de época de Unix.
El valor predeterminado es la hora a la que el componente recibe el mensaje.
Tipo: double
Si utiliza las versiones 2.0.3 y 2.0.7 de este componente, le recomendamos que recupere la marca de tiempo por separado para cada métrica cuando envíe varias métricas desde una sola fuente. No utilice una variable para almacenar la marca de tiempo.
-
unit
-
(Opcional) La unidad de la métrica.
Tipo: string
Valores válidos:Seconds,Microseconds,Milliseconds,Bytes,Kilobytes,Megabytes,Gigabytes,Terabytes,Bits,Kilobits,Megabits,,Gigabits,Terabits,Percent,Count,Bytes/Second,Kilobytes/Second,Megabytes/Second,Gigabytes/Second,Terabytes/Second,Bits/Second,Kilobits/Second,Megabits/Second,Gigabits/Second,Terabits/Second,Count/Second, None
El valor predeterminado es None.
Todas las cuotas que se aplican a la CloudWatch PutMetricData API se aplican a las métricas que publiques con este componente. Las cuotas siguientes son especialmente importantes:
-
Límite de 40 KB en la carga útil de la API
-
20 métricas por solicitud de API
-
150 transacciones por segundo (TPS) para la API de PutMetricData
Para obtener más información, consulte las cuotas CloudWatch de servicio en la Guía del CloudWatch usuario.
ejemplo Ejemplo de entrada
{
"request": {
"namespace": "Greengrass",
"metricData": {
"metricName": "latency",
"dimensions": [
{
"name": "hostname",
"value": "test_hostname"
}
],
"timestamp": 1539027324,
"value": 123.0,
"unit": "Seconds"
}
}
}
Datos de salida
De forma predeterminada, este componente publica las respuestas como datos de salida sobre el siguiente tema local de publicación/suscripción. Para obtener más información sobre cómo suscribirse a los mensajes sobre este tema en sus componentes personalizados, consulte. Publicar/suscribir mensajes locales
Si lo desea, puede configurar este componente para que se publique en un tema de MQTT estableciendo el parámetro PubSubToIoTCore de configuración en. true Para obtener más información sobre cómo suscribirse a mensajes sobre un tema de MQTT en sus componentes personalizados, consulte. Publicar/suscribir mensajes MQTT AWS IoT Core
Las versiones 2.0.x de los componentes publican las respuestas como datos de salida sobre un tema de MQTT de forma predeterminada. Debe especificar el tema como parte de la subject configuración del componente del router de suscripciones antiguo.
Tema predeterminado: cloudwatch/metric/put/status
ejemplo Ejemplo de salida: Correcto
La respuesta incluye el espacio de nombres de los datos de la métrica y el RequestId campo de la CloudWatch respuesta.
{
"response": {
"cloudwatch_rid": "70573243-d723-11e8-b095-75ff2EXAMPLE",
"namespace": "Greengrass",
"status": "success"
}
}
ejemplo Ejemplo de salida: Error
{
"response" : {
"namespace": "Greengrass",
"error": "InvalidInputException",
"error_message": "cw metric is invalid",
"status": "fail"
}
}
Si el componente detecta un error que se puede volver a intentar, como un error de conexión, volverá a intentar la publicación en el siguiente lote.
Licencias
Este componente incluye el siguiente software o licencia de terceros:
Este componente se publica en virtud del contrato de licencia de software principal de Greengrass.
Archivo de registro local
Este componente utiliza el siguiente archivo de registro.
- Linux
-
/greengrass/v2
- Windows
-
C:\greengrass\v2\logs\aws.greengrass.Cloudwatch.log
Para ver los registros de este componente
Registros de cambios
En la siguiente tabla se describen los cambios en cada versión del componente.
- v3.x
-
|
Versión
|
Cambios
|
|
3.1.0
|
- Mejoras y correcciones de errores
-
|
|
3.0.0
|
Esta versión del componente de CloudWatch métricas espera parámetros de configuración diferentes a los de la versión 2.x. Si utiliza una configuración no predeterminada para la versión 2.x y desea actualizar de la v2.x a la v3.x, debe actualizar la configuración del componente. Para obtener más información, consulte la configuración de los componentes de métricas. CloudWatch
- Nuevas características
-
-
Añade compatibilidad con los dispositivos principales que ejecutan Windows.
-
Cambia el tipo de componente de componente Lambda a componente genérico. Este componente ya no depende del componente antiguo del router de suscripciones para crear suscripciones.
-
Agrega un nuevo parámetro de InputTopic configuración para especificar el tema al que se suscribe el componente para recibir mensajes.
-
Agrega un nuevo parámetro OutputTopic de configuración para especificar el tema en el que el componente publica las respuestas de estado.
-
Añade un nuevo parámetro PubSubToIoTCore de configuración para especificar si se deben publicar o suscribirse a los temas de AWS IoT Core MQTT.
-
Añade el nuevo parámetro UseInstaller de configuración que permite deshabilitar opcionalmente el script de instalación que instala las dependencias de los componentes.
- Mejoras y correcciones de errores
-
Añade compatibilidad con marcas de tiempo duplicadas en los datos de entrada.
|
- v2.x
-
|
Versión
|
Cambios
|
|
2.1.3
|
Versión actualizada para la versión 2.11.0 de Greengrass nucleus.
|
|
2.1.2
|
Versión actualizada para la versión 2.7.0 de Greengrass nucleus.
|
|
2.1.1
|
Versión actualizada para la versión 2.6.0 de Greengrass nucleus.
|
|
2.1.0
|
|
|
2.0.8
|
- Mejoras y correcciones de errores
-
|
|
2.0.7
|
Versión actualizada para la versión 2.4.0 de Greengrass nucleus.
|
|
2.0.6
|
Versión actualizada para la versión 2.3.0 de Greengrass nucleus.
|
|
2.0.5
|
Versión actualizada para la versión 2.2.0 de Greengrass nucleus.
|
|
2.0.4
|
Versión actualizada para la versión 2.1.0 de Greengrass nucleus.
|
|
2.0.3
|
Versión inicial.
|
Véase también
