GetMetricWidgetImage: estrutura e sintaxe do widget de métricas

Estrutura geral Formato para cada métrica na matriz de métricas Formato de propriedades de anotação yAxis Properties Format

MetricWidget é um parâmetro de entrada da API https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_GetMetricWidgetImage.html. Ele é uma string no formato JSON.

Conteúdo

Estrutura geral
Formato para cada métrica na matriz de métricas
Formato de propriedades de anotação
yAxis Properties Format

A string MetricWidget pode incluir os seguintes parâmetros:

métricas

As métricas a serem incluídas no gráfico, como uma matriz metrics. Ele pode incluir tanto métricas brutas quanto expressões matemáticas de métricas. Uma matriz metrics pode incluir de 1 a 100 métricas e expressões. Para obter mais informações sobre o formato das metrics, consulte Formato para cada métrica na matriz de métricas.

Tipo: matriz de matrizes

Exigido: sim.

anotações

Anotações horizontais e verticais a serem adicionadas ao gráfico, como matrizes de anotações. Para obter mais informações sobre o formato, consulte Formato de propriedades de anotação.

Obrigatório: não

end

A data e a hora do término das métricas exibidas no gráfico. Isso pode ser expresso como um valor absoluto, como 2018-04-25T 12:00:00.000 Z ou um valor relativo, como -PID.

Se você não especificar end, o padrão de -PT0H (a hora atual) será usado.

Tipo: string

Obrigatório: não

height

A altura do widget em pixels. O padrão é 400.

Valores válidos: 1 a 2000

Tipo: inteiro

Exigido: não, mas você deve definir isso se também definir um valor para a width.

legend

Especifica a localização e a visibilidade da legenda do gráfico. A legend contém um campo, position. O valor de position pode ser bottom, right ou hidden. O padrão é bottom.

Tipo: string

Obrigatório: não

liveData

Especifique true para exibir dados em tempo real no widget. Os dados em tempo real são dados publicados no último minuto que não foram totalmente agregados. Para obter mais informações, consulte Uso de dados em tempo real.

Tipo: booliano

Obrigatório: não

período

O período padrão, em segundos, para todas as métricas desse widget. Esse padrão pode ser substituído em cada definição de métrica. O padrão é 300.

Valores válidos: 1, 5, 10, 30, 60 e qualquer múltiplo de 60. 1, 5, 10 e 30 servem apenas para métricas de alta resolução.

Tipo: inteiro

Obrigatório: não

region

Esse parâmetro é opcional. Se você incluí-lo, ele deverá especificar a região local.

Tipo: string

Obrigatório: não

de barras

Especifique true para exibir o gráfico como uma linha empilhada ou false para exibir como linhas separadas. O padrão é falso.

Tipo: booliano

Obrigatório: não

rápido

A data e a hora do início das métricas exibidas no gráfico. Isso pode ser expresso como um valor absoluto, como 2018-04-25T 12:00:00.000 Z ou um valor relativo, como -PID.

Se você não especificar start, o padrão de -PT3H (três horas atrás) será usado.

Tipo: string

Obrigatório: não

estatística

A estatística padrão a ser exibida para cada métrica na matriz. Esse padrão pode ser substituído na definição de cada métrica individual na matriz metrics.

Se você omitir isso, o padrão de Average será usado.

Valores válidos: SampleCount | Average | Sum | Minimum | Maximum | p?? | TM(??:??), TC(??:??) | TS(??:??) | WM(??:??) | PR(??:??) | IQM

Tipo: string que é uma estatística válida do CloudWatch.

Obrigatório: não

theme

A paleta de cores utilizada para estilizar o gráfico. O padrão é light.

Valores válidos: light | dark

Tipo: string

Obrigatório: não

timezone

O fuso horário a ser utilizado para exibir os horários no gráfico. O formato é + ou - seguido por quatro dígitos. Os dois primeiros dígitos indicam o número de horas antes ou depois do UTC, e os dois dígitos finais são o número de minutos. Por exemplo, +0130 indica um horário 1 hora e 30 minutos antes do UTC. O padrão é +0000.

Tipo: string

Obrigatório: não

título

O título a ser exibido para o gráfico.

Tipo: string

Obrigatório: não

visualizar

O formato de exibição. Especifique timeSeries para exibir essa métrica como um gráfico de linhas. Especifique bar para exibir a métrica como um gráfico de barras. Especifique pie para exibir a métrica como um gráfico de pizza. O padrão é timeSeries.

Valores válidos: timeSeries | bar | pie

Tipo: string

Obrigatório: não

width

A largura do widget em pixels. O padrão é 600.

Valores válidos: 1 a 2000

Tipo: inteiro

Exigido: não, mas você deve definir isso se também definir um valor para a width.

yAxis

Limites para os mínimos e máximos do eixo Y. Isso se aplica a cada métrica que está sendo representada graficamente, a menos que métricas específicas a substituam. Para obter mais informações sobre o formato, consulte yAxis Properties Format.

Type: YAxis object

Obrigatório: não

Cada item na matriz metrics é uma métrica do CloudWatch a ser exibida no gráfico ou usada como parte de uma expressão matemática exibida no gráfico. Para obter mais informações sobre expressões matemáticas, consulte Uso de matemática de métricas no Guia do usuário do Amazon CloudWatch.

Cada métrica na matriz tem o seguinte formato:


[Namespace, MetricName, Dimension1Name, Dimension1Value, Dimension2Name, Dimension2Value... 
            {Options Object}]

Namespace

O namespace AWS que contém a métrica. Para utilizar o mesmo namespace da métrica anterior na matriz, você pode especificar "." para cada entrada após a primeira.

Tipo: String

Exigido: sim

MetricName

O nome da métrica do CloudWatch. Para utilizar o mesmo nome da métrica anterior na matriz, você pode especificar "." para cada entrada após a primeira.

Tipo: String

Exigido: sim

DimensionName

O nome de uma dimensão para refinar ainda mais quais dados são exibidos. Para utilizar o mesmo nome de dimensão da métrica anterior na matriz, você pode especificar "." para cada entrada após a primeira. Você pode especificar zero dimensões para uma métrica ou até quantas dimensões a métrica suportar.

Tipo: string

Obrigatório: não

DimensionValue

O valor a usar naquela dimensão para a métrica. Necessário se houver um nome de dimensão correspondente.

Tipo: string

Obrigatório: não, a menos que haja um nome de dimensão correspondente.

Options Object

Especifica propriedades de renderização personalizadas a serem utilizadas para a métrica especificada do CloudWatch ou uma expressão matemática a ser exibida no gráfico. Para obter mais informações sobre o formato, consulte Options Object Format.

Type: Options Object

Obrigatório: não

Exemplos


// The simplest example, a metric with no dimensions
        [ "AWS/EC2", "CPUUtilization" ]
        
 // A metric with a single dimension
        [ "AWS/EC2", "CPUUtilization", "InstanceId", "i-01234567890123456" ]
        
 // A metric with a single dimension and rendering properties
        [ "AWS/EC2", "DiskReadBytes", "InstanceId", "i-01234567890123456", { yAxis: "right"} ]
       
 // The following example graphs the DiskReadBytes metric for three instances.
        [ "AWS/EC2", "DiskReadBytes", "InstanceId", "i-01234567890123456" ],
        [ ".", ".", ".", "i-abc" ],
        [ ".", ".", ".", "i-123" ]

Especifica propriedades de renderização personalizadas a serem usadas para a métrica especificada do CloudWatch ou uma expressão matemática a ser exibida no gráfico.

Se esse objeto for especificado como parte de uma métrica do CloudWatch na matriz metrics, ele definirá propriedades de renderização personalizadas para essa métrica e substituirá os padrões usados para todo o gráfico.

Você também pode especificar esse objeto para adicionar uma expressão matemática ao gráfico. Nesse caso, as outras configurações desse objeto especificam as opções de exibição para o resultado da expressão matemática.

Esta seção descreve o formato desses objetos de opção.

color

O código de cor hexadecimal HTML de seis dígitos a ser utilizado para essa métrica ou expressão.

Tipo: string

Obrigatório: não

expressão

Uma expressão matemática a ser exibida. Para obter mais informações sobre funções e formato de expressões matemáticas compatíveis, consulte Sintaxe e funções da matemática de métricas no Guia do usuário do Amazon CloudWatch.

Tipo: string que é uma expressão matemática de métricas válida do CloudWatch.

Obrigatório: sim, se for uma expressão.

rótulo

O rótulo a ser exibido para essa métrica ou expressão na legenda do gráfico. Se isso não for especificado, a métrica receberá um rótulo gerado automaticamente que a distingue das outras métricas no widget.

Tipo: string

Obrigatório: não

id

Um identificador para essa métrica ou expressão, que deve ser exclusivo nesse widget. O ID pode ser usado como uma variável para representar essa métrica ou expressão em expressões matemáticas. Os caracteres válidos são letras, números e sublinhados. O primeiro caractere deve ser uma letra minúscula.

Tipo: string

Obrigatório: não

período

O período dessa métrica, em segundos. Se especificado, isso substitui o período padrão usado para outras métricas nesse gráfico. Esse parâmetro não se aplica para expressões matemáticas.

Valores válidos: 1, 5, 10, 30, 60 e qualquer múltiplo de 60. 1, 5, 10 e 30 servem apenas para métricas de alta resolução.

Tipo: inteiro

Obrigatório: não

estatística

A estatística a ser exibida para essa métrica, caso seja diferente da estatística usada para as outras métricas no gráfico. Esse parâmetro não é aplicável para expressões matemáticas.

Tipo: string que é uma estatística válida do CloudWatch.

Obrigatório: não

visible

Especifica se essa métrica ou expressão é exibida no gráfico. O padrão é true.

Definir visible como false é útil se você quiser ocultar as métricas brutas usadas em expressões matemáticas e mostrar somente os resultados da expressão no gráfico.

Tipo: booliano

Obrigatório: não

yAxis

Onde no gráfico exibir o eixo Y dessa métrica ou expressão. O padrão é left.

Valores válidos: left | right

Tipo: string

Obrigatório: não

Exemplo

No exemplo a seguir, o CloudWatch recupera uma métrica apiLatency personalizada. Na parte superior, a estatística p50 é especificada para mostrar o valor mediano. Em seguida, para a mesma métrica na mesma instância (isso é especificado pelos quatro campos que são apenas períodos), o valor Médio é representado graficamente. Em seguida, há um objeto de opções com uma expressão matemática, exibindo o valor médio das duas métricas. Por fim, outra expressão mostra a taxa de mudança.

Para mostrar somente os resultados das duas expressões no gráfico e ocultar as métricas brutas, você pode alterar as duas primeiras instâncias de visible para false.


{
        "metrics": [
            [
                "MyNamespace", 
                "apiLatency", 
                "InstanceId", 
                "i-0987654321abcdef0", 
                {
                    "id": "m1",
                    "stat": "p50",
                    "label": "Median value",
                    "visible": true,
                    "color": "#dddddd",
                    "yAxis": "left",
                    "period": 300
                }
            ],
            [
                ".", 
                ".", 
                ".", 
                ".", 
                {
                    "id": "m2",
                    "stat": "Average",
                    "label": "Average value",
                    "visible": true,
                    "color": "#cccccc",
                    "yAxis": "left",
                    "period": 300
                }
            ],
            [
                {
                    "expression": "(m1+m2)/2",
                    "id": "e1",
                    "label": "Half way between average and median",
                    "visible": true,
                    "color": "#000000",
                    "yAxis": "left"
                }
            ],
            [
                {
                    "expression": "RATE(e1)",
                    "yAxis": "right",
                    "label": "rate of change of the half way point"
                }
            ]
        ]
    }

Um único gráfico pode possuir várias anotações horizontais e verticais. Todas as anotações horizontais são especificadas em um campo horizontal e todas as anotações verticais são especificadas em um campo vertical.

horizontal

Uma matriz de anotações horizontais. As anotações horizontais têm diversas opções para sombreamento de preenchimento, incluindo sombreamento acima da linha de anotação, sombreamento abaixo da linha de anotação e sombreamento em “faixa”, que aparece entre duas linhas de anotação vinculadas como parte de uma única anotação. Cada anotação horizontal na matriz que não tem sombreamento em faixa tem o seguinte formato:


{value, label, color, fill, yAxis, visible}

Cada anotação horizontal que tem sombreamento em faixa tem o seguinte formato:


[{value, label, color, yAxis, visible}, {value, label}]

vertical

Uma matriz de anotações verticais. As anotações verticais possuem várias opções para sombreamento de preenchimento, incluindo sombreamento antes da linha de anotação, sombreamento após a linha de anotação e sombreamento em “faixa” que aparece entre duas linhas de anotação vinculadas como parte de uma só anotação de faixa. Cada anotação vertical na matriz que não tem sombreamento em faixa tem o seguinte formato:


{value, label, color, fill, visible}

Cada anotação vertical que tem sombreamento em faixa tem o seguinte formato:


[{value, label, color, visible}, {value, label}]

A matriz horizontal pode incluir os campos a seguir.

valor

O valor métrico no gráfico em que a linha de anotação horizontal deve aparecer. Em uma anotação com sombreamento em faixa, os dois valores para Value definem as bordas superior e inferior da faixa.

Em um gráfico com anotações horizontais, o gráfico é redimensionado para que todas as anotações horizontais visíveis apareçam no gráfico.

Tipo: float

Obrigatório: sim, se forem usadas anotações horizontais.

rótulo

Uma string que aparece no gráfico ao lado da anotação.

Tipo: string

Obrigatório: não

color

O código de cor hexadecimal HTML de seis dígitos a ser utilizado para a anotação. Essa cor é utilizada tanto para a linha de anotação quanto para o sombreamento de preenchimento.

Tipo: string

Obrigatório: não

fill

Como usar o sombreamento de preenchimento com a anotação. Os valores válidos são above para sombreamento acima da anotação, below para sombreamento abaixo da anotação e none para ausência de sombreamento. Se fill for omitido, não há sombreamento.

A exceção é uma anotação com sombreamento em faixa. Essas anotações sempre têm sombreamento entre os dois valores, e qualquer valor para fill é ignorado.

Tipo: string

Obrigatório: não

visible

Defina isso para true para que a anotação apareça no gráfico ou false para que fique oculta. O padrão é true.

Tipo: booliano

Obrigatório: não

yAxis

Se o gráfico incluir múltiplas métricas, especifique se os números em Value se referem à métrica associada ao eixo Y esquerdo ou ao eixo Y direito. Os valores válidos são right e left.

Tipo: sequência

Obrigatório: não

A matriz vertical pode incluir os campos a seguir.

valor

O carimbo de data/hora em que deve aparecer a linha de anotação vertical. Isso deve ser especificado como um carimbo de data/hora absoluto, como 2018-08-28T15:25:26Z. Em uma anotação com sombreamento em faixa, os dois valores para Value definem as bordas inicial e final da faixa.

Tipo: string

Obrigatório: sim, se forem usadas anotações verticais.

rótulo

Uma string descritiva que aparece no gráfico ao lado da anotação.

Tipo: string

Obrigatório: não

color

O código de cor hexadecimal HTML de seis dígitos a ser usado para a anotação. Essa cor é usada tanto para a linha de anotação quanto para o sombreamento de preenchimento.

Tipo: string

Obrigatório: não

fill

Como usar o sombreamento de preenchimento com a anotação. Os valores válidos são before para sombreamento antes da anotação, after para sombreamento após da anotação e none para ausência de sombreamento. Se fill for omitido, não há sombreamento.

A exceção é uma anotação com sombreamento em faixa. Essas anotações sempre têm sombreamento entre os dois valores, e qualquer valor para fill é ignorado.

Tipo: string

Obrigatório: não

visible

Defina isso para true para que a anotação apareça no gráfico ou false para que fique oculta. O padrão é true.

Tipo: booliano

Obrigatório: não

Exemplos


// A single horizontal annotation with fill shading above the annotation line, based on the metric associated with the right Y-axis
                    
"annotations": {
     "horizontal": [
         {
              "visible":true,
              "color":"#9467bd",
              "label":"Critical range",
              "value":20,
              "fill":"above",
              "yAxis":"right"
         }
    ]
}

// A horizontal band annotation. Each value has a label, but other parameters for the band need to be specified only with the first number

"annotations": {
    "horizontal": [
        [
             {
                  "label":"Band top",
                  "value":200,
                  "color":"#9467bd",
                  "visible":true,
                  "yAxis":"right"
              },
              {
                  "value":95.5,
                  "label":"Band bottom"
              }
         ]
     ]
}

// A single vertical annotation with fill shading after the annotation line

"annotations": {
    "vertical": [
        {
            "visible": true,
            "color": "#9467bd",
            "label": "Bug fix deployed",
            "value": "2018-08-28T15:25:26Z",
            "fill": "after"
        }
    ]
}	


// A vertical band annotation. Each annotation line has a label, but other parameters for the band are specified only with the first value

"annotations": {
    "vertical": [
        [
            {
                "label": "Band start",
                "value": "2018-08-27T15:25:26Z",
                "color": "#9467bd",
                "visible": true
            },
            {
                "value": "2018-08-28T15:25:26Z",
                "label": "Band end"
            }
        ]
    ]
}

Define os valores mínimo e máximo para o eixo Y do gráfico. Defina isso no objeto MetricWidget para afetar todas as métricas no widget. Para substituir as configurações do widget para uma métrica específica, defina-a no objeto de opções dessa métrica na matriz metrics.

esquerda

Configurações opcionais min e max para o eixo Y esquerdo.

Type: YAxis object

Obrigatório: não

direita

Configurações opcionais min e max para o eixo Y direito.

Type: YAxis object

Obrigatório: não

Cada um dos objetos left e right pode incluir os seguintes parâmetros:

min

O valor mínimo para esse eixo Y.

Tipo: float

Obrigatório: não

max

O valor máximo para esse eixo Y.

Tipo: float

Obrigatório: não

Exemplo


{
  left: {
    min: 0,
    max: 100
  },
  right: {
    min: 0
  }
}

Atenção O Javascript está desativado ou não está disponível no seu navegador.

Para usar a documentação da AWS, o Javascript deve estar ativado. Consulte as páginas de Ajuda do navegador para obter instruções.

Convenções do documento

Criar um alarme a partir de uma métrica em um gráfico

Usar a detecção de anomalias