Áú»¢¶Ä²©

Esta es una traducci¨®n de la p¨¢gina de documentaci¨®n original en espa?ol. Ay¨²danos a mejorarla.

4 Protocolo del plugin Áú»¢¶Ä²© Agent 2

El protocolo Áú»¢¶Ä²© Agent 2 se basa en c¨®digo, tama?o y modelo de datos.

°ä¨®»å¾±²µ´Ç

Tipo Tama?o Comentarios
Byte 4 Tipo de carga ¨²til, actualmente solo se admite JSON.

Tama?o

Tipo Tama?o Comentarios
Byte 4 Tama?o de la carga ¨²til actual en bytes.

Datos de carga ¨²til

Tipo Tama?o Comentarios
Byte Definido por el campo size datos en formato JSON.
Definici¨®n de datos de carga ¨²til
Datos com¨²n

Estos par¨¢metros est¨¢n presentes en todas las solicitudes/respuestas:

Nombre Tipo Comentarios
id uint32 Para solicitudes: el identificador incremental utilizado para vincular solicitudes con respuestas. ?nico dentro de una »å¾±°ù±ð³¦³¦¾±¨®²Ô de solicitud (es decir, de agente a complemento o de complemento a agente).
Para respuestas: ID de la solicitud correspondiente.
type uint32 El tipo de solicitud.
Solicitud de registro

Una solicitud enviada por un complemento para escribir un mensaje de registro en el archivo de registro del agente.

direction complemento ¡ú agente
response no

Par¨¢metros espec¨ªficos de las solicitudes de registro:

Nombre Tipo Comentarios
severity uint32 La gravedad del mensaje (nivel de registro).
message cadena El mensaje a registrar.

Ejemplo:

{"id":0,"tipo":1,"gravedad":3,"mensaje":"mensaje"}
Solicitud de registro

Una solicitud enviada por el agente durante la fase de inicio del agente para obtener las m¨¦tricas proporcionadas para registrar un complemento.

direction agente ¡ú plugin
response ²õ¨ª

Par¨¢metros espec¨ªficos para registrar solicitudes:

Nombre Tipo Comentarios
version cadena La versi¨®n del protocolo <principal>.<menor>

Ejemplo:

{"id":1,"type":2,"version":"1.0"}
Registrar respuesta

Respuesta del complemento a la solicitud de registro.

direction complemento ¡ú agente
response n/a

Par¨¢metros espec¨ªficos para registrar respuestas:

Nombre Tipo Comentarios
name cadena El nombre del complemento.
metrics matriz de cadenas (opcional) Las m¨¦tricas con descripciones tal como se utilizan en el complemento. Devuelve RegisterMetrics(). Ausente si se devuelve un error.
interfaces uint32 (opcional) La m¨¢scara de bits de las interfaces admitidas por el complemento. Ausente si se devuelve un error.
error cadena (opcional) Se devuelve un mensaje de error si no se puede iniciar un complemento. Ausente, si se devuelven m¨¦tricas.

Ejemplos:

{"id":2,"type":3,"metrics":["external.test", "External exporter Test."], "interfaces": 4}

o

{"id":2,"type":3,"error":"error message"}
Solicitud de inicio

Una solicitud para ejecutar la funci¨®n Inicio de la interfaz Runner.

»å¾±°ù±ð³¦³¦¾±¨®²Ô agente ¡ú complemento
respuesta no

La solicitud no tiene par¨¢metros espec¨ªficos, solo contiene par¨¢metros de datos comunes.

Ejemplo:

{"id":3,"type":4}
Solicitud de finalizaci¨®n

Una solicitud enviada por el agente para cerrar un complemento.

direction agente ¡ú complemento
response no

La solicitud no tiene par¨¢metros espec¨ªficos, solo contiene par¨¢metros de datos comunes.

Ejemplo:

{"id":3,"type":5}
Solicitud de exportaci¨®n

Una solicitud para ejecutar la funci¨®n Exportar de la interfaz Exporter.

direction agente ¡ú complemento
response no

Par¨¢metros espec¨ªficos de las solicitudes de exportaci¨®n:

Nombre Tipo Comentarios
key cadena La clave del complemento.
parameters matriz de cadenas (opcional) Los par¨¢metros para la funci¨®n Export.

Ejemplo:

{"id":4,"type":6,"key":"test.key","parameters":["foo","bar"]}
Respuesta de exportar

Respuesta de la funci¨®n Exportar de la interfaz Exporter.

direction complemento ¡ú agente
response n/a

Par¨¢metros espec¨ªficos para exportar respuestas:

Nombre Tipo Comentarios
value cadena (opcional) Valor de respuesta de la funci¨®n Exportar. Ausente, si se devuelve un error.
error cadena (opcional) Mensaje de error si la funci¨®n Exportar no se ha ejecutado correctamente. Ausente, si se devuelve valor.

Ejemplos:

{"id":5,"type":7,"value":"response"}

o

{"id":5,"type":7,"error":"error message"}
Solicitud de configuraci¨®n

Una solicitud para ejecutar la funci¨®n Configurar de la interfaz Configurator.

direction agente ¡ú complemento
response n/a

Par¨¢metros espec¨ªficos de las solicitudes Configurar:

Nombre Tipo Comentarios
global_options Objeto JSON Objeto JSON que contiene opciones de configuraci¨®n del agente global.
private_options Objeto JSON (opcional) Objeto JSON que contiene opciones de configuraci¨®n de complementos privados, si se proporcionan.

Ejemplo:

{"id":6,"type":8,"global_options":{...},"private_options":{...}}
Solicitud de validaci¨®n

Una solicitud para ejecutar la funci¨®n Validar de la interfaz Configurator.

direction agente ¡ú complemento
response ²õ¨ª

Par¨¢metros espec¨ªficos de las solicitudes Validar:

Nombre Tipo Comentarios
private_options Objeto JSON (opcional) Objeto JSON que contiene opciones de configuraci¨®n de complementos privados, si se proporcionan.

Ejemplo:

{"id":7,"type":9,"private_options":{...}}
Respuesta de validaci¨®n

Respuesta de la funci¨®n Validar de la interfaz Configurator.

direction complemento ¡ú agente
response n/a

Par¨¢metros espec¨ªficos de las respuestas Validar:

Nombre Tipo Comentarios
error cadena (opcional) Se devuelve un mensaje de error si la funci¨®n Validar no se ejecuta correctamente. Ausente si se ejecuta exitosamente.

Ejemplo:

{"id":8,"type":10}

o

{"id":8,"type":10,"error":"error message"}