Skip to main content

Parámetros

Parámetros

--creds Base 64 de las credenciales 

Las credenciales antes de pasarlas a base 64 tienen el siguiente formato :

{
  "access_key_id": "KEY",
  "secret_access_key": "PASSWORD"
}
--query_confRuta al archivo de configuración de consultas AWS personalizadas

En el fichero de queries, se pueden especificar una o mas consultas de Metrics Insights. Estas siguen la estructura que esta documentada en el siguiente enlace: https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_GetMetricData.html

La estructura para poder ejecutar una o mas consultas de Metrics insights es la siguiente :

{   
    "time_frame": "<Ventana de tiempo en la que recoger los datos, opciones posibles : 5m, 10m, 15m, 30m, 1h>",
    "region_name": "< region en la que ejecutar la consulta> ",
    "MetricDataQueries": [
        < Operaciones de metrics insights >
    ]
}

Estas consultas deben ir definidas dentro de una lista y separadas por comas, por lo que la estructura, de dos consultas, sería la siguiente:

[
{   
    "time_frame": "<Ventana de tiempo en la que recoger los datos, opciones posibles : 5m, 10m, 15m, 30m, 1h>",
    "region_name": "< region en la que ejecutar la consulta> ",
    "MetricDataQueries": [
        < Operaciones de metrics insights >
    ]
}
,
{   
    "time_frame": "<Ventana de tiempo en la que recoger los datos, opciones posibles : 5m, 10m, 15m, 30m, 1h>",
    "region_name": "< region en la que ejecutar la consulta> ",
    "MetricDataQueries": [
        < Operaciones de metrics insights >
    ]
}
]

Un ejemplo de una configuración de consultas, sería el siguiente :

[
{   
    "time_frame": "5m",
    "region_name": "us-east-1",
    "MetricDataQueries": [
        {
            "Expression": "SELECT AVG(CPUUtilization) FROM SCHEMA(\"AWS/EC2\", InstanceId) WHERE InstanceId = 'i-01e5fbcd406596f84' GROUP BY InstanceId",
            "Id": "q1",
            "Period": 300,
            "Label": "avg_cpu"
        },
        {
            "Id": "q2",
            "Expression": "(100 - q1)",
            "Label": "free space"
        }
    ]
},
{
    "time_frame": "5m",
    "region_name": "us-east-1",
    "MetricDataQueries": [
      {
        "Id": "ebs_write_time",
        "Expression": "SELECT AVG(VolumeTotalWriteTime) FROM SCHEMA(\"AWS/EBS\", VolumeId)",
        "Label": "Average EBS Volume Total Write Time",
        "Period":300,
        "ReturnData": true
      }
    ]
},
{
    "time_frame": "5m",
    "region_name": "us-east-1",
    "MetricDataQueries": [
      {
        "Id": "ec2_cpu",
        "Expression": "SELECT MAX(CPUUtilization) FROM SCHEMA(\"AWS/EC2\", InstanceId) GROUP BY InstanceId ORDER BY MAX() DESC LIMIT 10",
        "Label": "top_10",
        "Period":300,
        "ReturnData": true
      }
    ]
}
]

 

 

--conf Ruta al archivo de configuración

Archivo de configuración (--conf)

[CONF]
agents_group       = < Grupo para los agentes creados por el plugin >
agent_name         = < Nombre del agente por defecto >
threads            = < Número de hilos utilizados por el plugin >
interval           = < Intervalo en segundos para los agentes  >
transfer_mode      = < Modo de transferencia, tentacle o local > 
tentacle_ip        = < IP de la máquina destino para los agentes creados >
tentacle_port      = < Puerto de tentacle, por defecto : 41121 >
tentacle_opts      = < Opciones adicionales de tentacle client >
use_proxy          = < Activar para poder utilizar modo proxy >
proxy_url          = < url de la direccion proxy a utilizar >
ssl_check          = < Activar para activar chequeo SSL >


## Configuración de módulos

Ejemplo

[CONF]
agents_group       = Applications
agent_name         = AWS 
threads            = 4
interval           = 300
transfer_mode      = tentacle
tentacle_ip        = 127.0.0.1
tentacle_port      = 41121
tentacle_opts      = 
use_proxy          = 0
proxy_url          = 
ssl_check          = 1



Back to top