GetMetricWidgetImage: 지표 위젯 구조 및 구문

전체 구조 지표 배열의 각 지표에 대한 형식 주석 속성 형식 yAxis 속성 형식

MetricWidget은 https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_GetMetricWidgetImage.html API의 입력 파라미터입니다. JSON 형식의 문자열입니다.

내용

전체 구조
지표 배열의 각 지표에 대한 형식
주석 속성 형식
yAxis 속성 형식

MetricWidget 문자열에는 다음과 같은 파라미터가 포함될 수 있습니다.

지표

metrics 배열로 그래프에 포함할 지표입니다. 여기에는 원시 지표와 지표 수학 표현식이 모두 포함될 수 있습니다. 하나의 metrics 배열에는 1~100개의 지표와 표현식이 포함될 수 있습니다. metrics의 형식에 대한 자세한 내용은 지표 배열의 각 지표에 대한 형식 섹션을 참조하세요.

유형: 배열의 배열

필수 여부: 예

주석

주석 배열로 그래프에 추가할 가로 및 세로 주석입니다. 형식에 대한 자세한 내용은 주석 속성 형식 섹션을 참조하세요.

필수 여부: 아니요

최종

그래프에 표시된 지표의 종료 날짜 및 시간입니다. 이는 2018-04-25T12:00:00.000Z 등의 절대 값이나 -PID 등의 상대 값으로 표현할 수 있습니다.

end를 지정하지 않으면 기본값인 -PT0H(현재 시간)가 사용됩니다.

유형: 문자열

필수 여부: 아니요

height

위젯의 높이(픽셀) 기본값은 400입니다.

유효한 값: 1~2,000

유형: 정수

필수: 아니요. 하지만 width 값도 설정하는 경우 이 파라미터를 설정해야 합니다.

legend

그래프 범례의 위치와 가시성을 지정합니다. legend에는 position이라는 하나의 필드가 포함되어 있습니다. position의 값은 bottom, right 또는 hidden일 수 있습니다. 기본값은 bottom입니다.

유형: 문자열

필수 여부: 아니요

liveData

위젯에 라이브 데이터를 표시하려면 true를 지정합니다. 라이브 데이터는 마지막 1분 이내에 게시된 완전히 집계되지 않은 데이터입니다. 자세한 내용은 라이브 데이터 사용을 참조하세요.

유형: 부울

필수 여부: 아니요

기간

이 위젯의 모든 지표에 대한 기본 기간(초)입니다. 이 기본값은 각 지표 정의 내에서 재정의할 수 있습니다. 기본값은 300입니다.

유효한 값: 1, 5, 10, 30, 60, 60의 배수. 1, 5, 10, 30은 고해상도 지표 전용입니다.

유형: 정수

필수 여부: 아니요

리전

이 파라미터는 선택 사항입니다. 이를 포함하는 경우 로컬 리전을 지정해야 합니다.

유형: 문자열

필수 여부: 아니요

누적

그래프를 누적 선으로 표시하려면 true를 지정하고, 별도의 선으로 표시하려면 false를 지정합니다. 기본값은 false입니다.

유형: 부울

필수 여부: 아니요

시작

그래프에 표시된 지표의 시작 날짜 및 시간입니다. 이는 2018-04-25T12:00:00.000Z 등의 절대 값이나 -PID 등의 상대 값으로 표현할 수 있습니다.

start를 지정하지 않으면 기본값 -PT3H(3시간 전)가 사용됩니다.

유형: 문자열

필수 여부: 아니요

stat

배열의 각 지표에 표시할 기본 통계입니다. 이 기본값은 metrics 배열의 각 개별 지표 정의 내에서 재정의할 수 있습니다.

이를 누락하는 경우 기본값인 Average가 사용됩니다.

유효한 값: SampleCount | Average | Sum | Minimum | Maximum | p?? | TM(??:??), TC(??:??) | TS(??:??) | WM(??:??) | PR(??:??) | IQM

유형: 유효한 CloudWatch 통계인 문자열

필수 여부: 아니요

theme

그래프 스타일을 지정하는 데 사용되는 색상 팔레트입니다. 기본값은 light입니다.

유효한 값: light | dark

유형: 문자열

필수 여부: 아니요

timezone

그래프에 시간을 표시하는 데 사용할 시간대입니다. 형식은 + 또는 - 뒤에 4자리 숫자가 오는 형태입니다. 처음 두 자리는 UTC보다 몇 시간 앞선지 또는 뒤처지는지를 나타내고, 마지막 두 자리는 분입니다. 예를 들어, +0130은 UTC보다 1시간 30분 앞선 시간을 나타냅니다. 기본값은 +0000입니다.

유형: 문자열

필수 여부: 아니요

제목

그래프에 표시할 제목입니다.

유형: 문자열

필수 여부: 아니요

보기

표시 형식입니다. 이 지표를 선형 그래프로 표시하려면 timeSeries를 지정합니다. 지표를 막대 그래프로 표시하려면 bar를 지정합니다. 지표를 원형 그래프로 표시하려면 pie를 지정합니다. 기본값은 timeSeries입니다.

유효한 값: timeSeries | bar | pie

유형: 문자열

필수 여부: 아니요

width

위젯의 너비(픽셀)입니다. 기본값은 600입니다.

유효한 값: 1~2,000

유형: 정수

필수: 아니요. 하지만 width 값도 설정하는 경우 이 파라미터를 설정해야 합니다.

yAxis

y축의 최솟값 및 최댓값에 대한 제한입니다. 특정 지표가 이를 재정의하지 않는 한 이는 그래프로 표시되는 모든 지표에 적용됩니다. 형식에 대한 자세한 내용은 yAxis 속성 형식 섹션을 참조하세요.

유형: YAxis 객체

필수 여부: 아니요

metrics 배열의 각 항목은 그래프에 표시하거나 그래프에 표시된 수학 표현식의 일부로 사용할 CloudWatch 지표입니다. 수학 표현식에 대한 자세한 내용은 Amazon CloudWatch 사용 설명서에서 지표 수학 사용을 참조하세요.

배열의 각 지표는 다음과 같은 형식을 갖습니다.


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

네임스페이스

지표가 포함된 AWS 네임스페이스입니다. 배열의 이전 지표와 동일한 네임스페이스를 사용하려면 첫 번째 항목 이후의 각 항목에 대해 "."를 지정합니다.

유형: 문자열

필수 항목 여부: 예

MetricName

CloudWatch 지표의 이름입니다. 배열의 이전 지표와 동일한 이름을 사용하려면 첫 번째 항목 이후의 각 항목에 대해 "."를 지정합니다.

유형: 문자열

필수 항목 여부: 예

DimensionName

표시되는 데이터를 더 구체화하기 위한 차원의 이름입니다. 배열의 이전 지표와 동일한 차원 이름을 사용하려면 첫 번째 항목 이후의 각 항목에 대해 "."를 지정합니다. 지표에 대해 차원을 전혀 지정하지 않거나, 해당 지표가 지원하는 만큼 차원을 지정할 수 있습니다.

유형: 문자열

필수 여부: 아니요

DimensionValue

지표의 해당 차원에 사용할 값입니다. 해당 차원 이름이 있는 경우 필수입니다.

유형: 문자열

필수: 아니요(해당 차원 이름이 없는 경우)

Options 객체

지정된 CloudWatch 지표에 사용할 사용자 지정 렌더링 속성을 지정하거나 그래프에 표시할 수학 표현식을 지정합니다. 형식에 대한 자세한 내용은 Options 객체 형식 섹션을 참조하세요.

유형: Options 객체

필수 여부: 아니요

예제


// 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" ]

지정된 CloudWatch 지표에 사용할 사용자 지정 렌더링 속성을 지정하거나 그래프에 표시할 수학 표현식을 지정합니다.

이 객체가 metrics 배열에 CloudWatch 지표의 일부로 지정되면 이 지표에 대한 사용자 지정 렌더링 속성이 설정되고 전체 그래프에 사용되는 기본값이 재정의됩니다.

이 객체를 지정하여 그래프에 수학 표현식을 추가할 수도 있습니다. 이 경우 이 객체의 다른 설정은 수학 표현식의 결과에 대한 표시 옵션을 지정합니다.

이 섹션에서는 이러한 Options 객체의 형식을 설명합니다.

color

이 지표나 표현식에 사용할 6자리 HTML 16진수 색상 코드입니다.

유형: 문자열

필수 여부: 아니요

expression

표시할 수학 표현식입니다. 지원되는 수학 표현식 함수 및 형식에 대한 자세한 내용은 Amazon CloudWatch 사용 설명서의 지표 수학 구문 및 함수를 참조하세요.

유형: 유효한 CloudWatch 지표 수학 표현식인 문자열

필수: 예(표현식인 경우)

레이블

그래프 범례에서 이 지표 또는 표현식에 표시할 레이블입니다. 지정하지 않으면 위젯의 다른 지표와 구분하기 위해 자동으로 생성된 레이블이 지표에 부여됩니다.

유형: 문자열

필수 여부: 아니요

id

이 지표 또는 표현식의 식별자로, 이 위젯 내에서 고유해야 합니다. 수학 표현식 내에서 이 지표나 표현식을 나타내는 변수로 id를 사용할 수 있습니다. 유효한 문자는 문자, 숫자 및 밑줄입니다. 첫 번째 문자는 소문자여야 합니다.

유형: 문자열

필수 여부: 아니요

기간

이 지표의 기간(초)입니다. 지정된 경우 이 그래프의 다른 지표에 사용되는 기본 기간을 재정의합니다. 이 파라미터는 수학 표현식에는 적용되지 않습니다.

유효한 값: 1, 5, 10, 30, 60, 60의 배수. 1, 5, 10, 30은 고해상도 지표 전용입니다.

유형: 정수

필수 여부: 아니요

stat

그래프의 다른 지표에 사용되는 통계와 다를 경우 이 지표에 표시할 통계입니다. 이 파라미터는 수학 표현식에는 적용되지 않습니다.

유형: 유효한 CloudWatch 통계인 문자열

필수 여부: 아니요

visible

이 지표나 표현식이 그래프에 표시되는지 여부를 지정합니다. 기본값은 true입니다.

visible을 false로 설정하면 수학 표현식에 사용되는 원시 지표를 숨기고 그래프에 표현식 결과만 표시하려는 경우에 유용합니다.

유형: 부울

필수 여부: 아니요

yAxis

그래프에서 이 지표나 표현식에 대한 y축을 표시할 위치입니다. 기본값은 left입니다.

유효한 값: left | right

유형: 문자열

필수 여부: 아니요

예제

다음 예제에서 CloudWatch는 사용자 지정 apiLatency 지표를 검색합니다. 상단에 p50 통계가 중간값을 표시하도록 지정되어 있습니다. 다음으로, 동일한 인스턴스의 동일한 지표(마침표로만 구성된 4개의 필드로 지정됨)에 대해 평균값이 그래프로 표시됩니다. 다음은 두 지표의 중간값을 보여주는 수학 표현식이 포함된 Options 객체입니다. 마지막으로 다른 표현식은 변경 속도를 보여줍니다.

그래프에 두 표현식의 결과만 표시하고 원시 지표를 숨기려면 visible의 처음 두 인스턴스를 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"
                }
            ]
        ]
    }

단일 그래프에 가로 및 세로 주석이 여러 개 있을 수 있습니다. 모든 가로 주석은 하나의 horizontal 필드에 지정되고 모든 세로 주석은 하나의 vertical 필드에 지정됩니다.

horizontal

가로 주석의 배열입니다. 가로 주석에는 채우기 셰이딩에 대한 여러 옵션이 있습니다. 주석 라인 위의 셰이딩, 주석 라인 아래의 셰이딩, 단일 주석의 일부로 연결된 두 주석 라인 사이에 나타나는 ‘밴드’ 셰이딩 등이 여기에 해당합니다. 밴드 셰이딩이 없는 배열의 각 가로 주석은 다음과 같은 형식을 갖습니다.


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

밴드 셰이딩이 있는 각 가로 주석은 다음과 같은 형식을 갖습니다.


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

vertical

세로 주석의 배열입니다. 세로 주석에는 채우기 셰이딩에 대한 여러 옵션이 있습니다. 주석 라인 앞의 셰이딩, 주석 라인 뒤의 셰이딩, 단일 밴드 주석의 일부로 연결된 두 주석 라인 사이에 나타나는 ‘밴드’ 셰이딩 등이 여기에 해당합니다. 밴드 셰이딩이 없는 배열의 각 세로 주석은 다음과 같은 형식을 갖습니다.


{value, label, color, fill, visible}

밴드 셰이딩이 있는 각 세로 주석은 다음과 같은 형식을 갖습니다.


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

horizontal 배열에는 다음 필드가 포함될 수 있습니다.

값

그래프에서 가로 주석 라인이 나타날 지표 값입니다. 밴드 셰이딩 주석에서 Value의 두 값은 밴드의 위쪽 가장자리와 아래쪽 가장자리를 정의합니다.

가로 주석이 있는 그래프에서는 표시되는 모든 가로 주석이 그래프에 나타나도록 그래프가 조정됩니다.

유형: Float

필수: 예(가로 주석이 사용되는 경우)

레이블

주석 옆의 그래프에 나타나는 문자열입니다.

유형: 문자열

필수 여부: 아니요

color

주석에 사용할 6자리 HTML 16진수 색상 코드입니다. 이 색상은 주석 라인과 채우기 셰이딩 모두에 사용됩니다.

유형: 문자열

필수 여부: 아니요

fill

주석과 함께 채우기 셰이딩을 사용하는 방법입니다. 유효한 값은 주석 위에 셰이딩을 적용하려는 경우 above, 주석 아래에 셰이딩을 적용하려는 경우 below, 셰이딩을 적용하지 않으려는 경우 none입니다. fill을 생략하면 셰이딩이 없습니다.

밴드 셰이딩이 적용된 주석은 예외입니다. 이러한 주석은 항상 두 값 사이에 셰이딩이 있으며 fill의 모든 값은 무시됩니다.

유형: 문자열

필수 여부: 아니요

visible

주석을 그래프에 표시하려면 이를 true로 설정하고, 숨기려면 false로 설정합니다. 기본값은 true입니다.

유형: 부울

필수 여부: 아니요

yAxis

그래프에 여러 지표가 포함된 경우 Value의 숫자가 왼쪽 Y축과 연결된 지표를 참조하는지 아니면 오른쪽 Y축과 연결된 지표를 참조하는지 지정합니다. 유효 값은 right및 left입니다.

유형: 문자열

필수 여부: 아니요

vertical 배열에는 다음 필드가 포함될 수 있습니다.

값

세로 주석 라인이 나타날 타임스탬프입니다. 2018-08-28T15:25:26Z와 같은 절대 타임스탬프로 지정해야 합니다. 밴드 셰이딩 주석에서 Value의 두 값은 밴드의 시작 가장자리와 끝 가장자리를 정의합니다.

유형: 문자열

필수: 예(세로 주석이 사용되는 경우)

레이블

주석 옆의 그래프에 나타나는 설명 문자열입니다.

유형: 문자열

필수 여부: 아니요

color

주석에 사용할 6자리 HTML 16진수 색상 코드입니다. 이 색상은 주석 라인과 채우기 셰이딩 모두에 사용됩니다.

유형: 문자열

필수 여부: 아니요

fill

주석과 함께 채우기 셰이딩을 사용하는 방법입니다. 유효한 값은 주석 앞에 셰이딩을 적용하려는 경우 before, 주석 뒤에 셰이딩을 적용하려는 경우 after, 셰이딩을 적용하지 않으려는 경우 none입니다. fill을 생략하면 셰이딩이 없습니다.

밴드 셰이딩이 적용된 주석은 예외입니다. 이러한 주석은 항상 두 값 사이에 셰이딩이 있으며 fill의 모든 값은 무시됩니다.

유형: 문자열

필수 여부: 아니요

visible

주석을 그래프에 표시하려면 이를 true로 설정하고, 숨기려면 false로 설정합니다. 기본값은 true입니다.

유형: 부울

필수 여부: 아니요

예제


// 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"
            }
        ]
    ]
}

그래프의 Y축에 대한 최솟값과 최댓값을 정의합니다. 위젯의 모든 지표에 영향을 미치려면 MetricWidget 객체 내에 이를 설정합니다. 특정 지표에 대한 위젯 설정을 재정의하려면 metrics 배열의 해당 지표에 대한 Options 객체에 이를 설정합니다.

왼쪽

왼쪽 Y축에 대한 선택적 min 및 max 설정입니다.

유형: YAxis 객체

필수 여부: 아니요

오른쪽

오른쪽 Y축에 대한 선택적 min 및 max 설정입니다.

유형: YAxis 객체

필수 여부: 아니요

각 left 및 right 객체에 다음 파라미터가 포함될 수 있습니다.

min

이 Y축의 최솟값입니다.

유형: Float

필수 여부: 아니요

최대

이 Y축의 최댓값입니다.

유형: Float

필수 여부: 아니요

예제


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

javascript가 브라우저에서 비활성화되거나 사용이 불가합니다.

AWS 설명서를 사용하려면 Javascript가 활성화되어야 합니다. 지침을 보려면 브라우저의 도움말 페이지를 참조하십시오.

문서 규칙

그래프의 지표에서 경보 생성

이상 탐지 사용