대시보드 본문 구조 및 구문

전체 구조

DashboardBody는 JSON 형식의 문자열입니다. 여기에는 0~500개의 위젯 객체 배열과 몇 개의 다른 파라미터가 포함될 수 있습니다. 대시보드에는 widgets 배열이 포함되어야 하지만 해당 배열은 비어 있을 수 있습니다.

다음은 지표 위젯 1개와 텍스트 위젯 1개를 포함하고, 현재 시간으로부터 6시간 전에 시작하는 시간 범위를 가지며, 각 그래프의 기간 설정이 항상 적용되는 이 구조의 예입니다.

{
   "start": "-PT6H",
   "periodOverride": "inherit",
   "widgets": [
      {
         "type":"metric",
         "x":0,
         "y":0,
         "width":12,
         "height":6,
         "properties":{
            "metrics":[
               [
                  "AWS/EC2",
                  "CPUUtilization",
                  "InstanceId",
                  "i-012345"
               ]
            ],
            "period":300,
            "stat":"Average",
            "region":"us-east-1",
            "title":"EC2 Instance CPU",
            "liveData": false,
            "legend": {
                "position": "right"
              }
         }
      },
      {
         "type":"text",
         "x":0,
         "y":7,
         "width":3,
         "height":3,
         "properties":{
            "markdown":"Hello world"
         }
      }
   ]
}

다음 예제에서는 Lambda 함수별 지표를 3개 표시하며, 대시보드 변수를 사용하여 대시보드 사용자가 서로 다른 Lambda 함수 이름을 전환하면서 각 함수에 대한 3개의 지표를 모두 볼 수 있도록 합니다. 이를 통해 다양한 리소스에 대한 주요 지표를 표시할 수 있는 유연한 단일 대시보드를 생성할 수 있습니다. 이 예제에서는 지표 검색 쿼리로 함수가 검색되므로 새로운 Lambda 함수가 생성되면 대시보드에서 이를 자동으로 검색합니다.

{
    "widgets": [{
            "height": 6,
            "width": 6,
            "y": 0,
            "x": 0,
            "type": "metric",
            "properties": {
                "view": "timeSeries",
                "stacked": false,
                "metrics": ["AWS/Lambda", "Invocations", "FunctionName", "my-function-name"],

                "region": "us-east-1",
                "liveData": true
            }
        },
        {
            "height": 12,
            "width": 12,
            "y": 0,
            "x": 6,
            "type": "metric",
            "properties": {
                "view": "timeSeries",
                "stacked": false,
                "metrics": ["AWS/Lambda", "Errors", "FunctionName", "my-function-name"],

                "region": "us-east-1",
                "liveData": true
            }
        },

        {
            "height": 3,
            "width": 6,
            "y": 0,
            "x": 18,
            "type": "metric",
            "properties": {
                "view": "timeSeries",
                "stacked": false,
                "metrics": ["AWS/Lambda", "Duration", "FunctionName", "my-function-name"],

                "region": "us-east-1",
                "liveData": true
            }
        }
    ],
    "variables": [{
        "type": "property",
        "property": "FunctionName",
        "inputType": "select",
        "id": "LambdaFunction_Variable",
        "label": "Function",
        "visible": true,
        "search": "{AWS/Lambda,FunctionName} MetricName=\"Duration\"",
        "populateFrom": "FunctionName"
    }]
}

다음 예제에는 2개의 위젯이 있습니다. 첫 번째 위젯에는 2개의 지표와 그 합계를 계산하는 수학 표현식이 포함됩니다. 두 번째 위젯은 리전의 모든 EC2 인스턴스에 대해 CPUUtilization을 표시하는 검색 표현식입니다.

{
   "start": "-PT9H",
   "periodOverride": "inherit",
   "widgets": [
      {
         "type":"metric",
         "x":0,
         "y":0,
         "width":12,
         "height":6,
         "properties":{
            "metrics":[
               [ "AWS/EC2", "DiskReadBytes", "InstanceId", "i-123",{ "id": "m1" } ],
               [ ".", ".", ".", "i-abc", { "id": "m2" } ],
               [ { "expression": "SUM(METRICS())", "label": "Sum of DiskReadbytes", "id": "e3" } ]
            ],
            "view": "timeSeries",
            "stacked": false,
            "period":300,
            "stat":"Average",
            "region":"us-east-1",
            "title":"EC2 Instance CPU"
         }
      },
      {
         "type":"metric",
         "x":0,
         "y":0,
         "width":18,
         "height":9,
         "properties":{
            "metrics":[
               [ { "expression": "SEARCH('{AWS/EC2,InstanceId} MetricName=\"CPUUtilization\"', 'Average', 300)", "id": "e1" } ]
            ],
            "view": "timeSeries",
            "stacked": false,
            "region":"us-east-1",
            "title":"EC2 Instance CPU"
         }
      }
   ]
}
    

이 섹션의 나머지 부분에서는 DashboardBody 구문의 각 부분을 설명하는 예제를 다룹니다. 전체 명령 구문을 보여주는 더 많은 예제는 Amazon CloudWatch API 참조의 PutDashboard를 참조하세요.

JSON 객체의 최상위 수준에는 다음 속성이 포함될 수 있습니다.

위젯 배열 구조

모든 유형의 위젯은 다음 속성을 가질 수 있습니다.

변수 배열 구조

배열의 각 대시보드 변수에는 다음과 같은 속성이 있을 수 있습니다.

변수 예제

다음 예제에서는 텍스트 입력 필드로 모든 위젯의 리전을 변경하는 데 속성 변수를 사용합니다. 대시보드가 처음 열릴 때 변수에 기본값인 us-east-1이 사용됩니다.

"variables": [
     {
        "type": "property", 
        "property": "region",
        "inputType": "input",
        "id": "region",
        "label": "Region",
        "defaultValue": "us-east-1",
        "visible": true
    } 
],

다음 예제에서는 ARN과 같은 문자열 중간에 리전이 설정되는 경우에 대비하여 모든 위젯의 리전을 변경하는 데 패턴 변수를 사용합니다.

"variables": [
    {
        "type": "pattern",
        "pattern": "us-east-1",
        "inputType": "input",
        "id": "region",
        "label": "Region",
        "defaultValue": "us-east-1",
        "visible": true
    }
],

다음 예제에서는 각 함수에 대한 라디오 버튼이 포함된 Lambda 함수 변수를 생성합니다. 함수는 지표 쿼리 검색으로 발견됩니다.

"variables": [
    {
        "type": "pattern",
        "pattern": "originalFuncNameInDashboard",
        "inputType": "radio",
        "id": "functionName",
        "label": "Function",
        "visible": true,
        "search": "{AWS/Lambda,FunctionName} MetricName=\"Duration\"",
        "populateFrom": "FunctionName",
        "defaultValue": "__FIRST"
    }
],

다음 샘플은 대시보드에서 여러 변수를 지정하는 방법과 여러 유형의 변수를 보여줍니다.

"variables": [{
        "type": "property",
        "property": "region",
        "inputType": "select",
        "id": "unique_id_1",
        "label": "Region",
        "defaultValue": "us-east-1",
        "visible": true,
        "values": [{
                "label": "IAD",
                "value": "us-east-1"
            },
            {
                "label": "CMH",
                "value": "us-east-2"
            },
            {
                "label": "NRT",
                "value": "ap-northeast-1"
            }
        ]
    },
    {
        "type": "property",
        "property": "FunctionName",
        "inputType": "select",
        "id": "unique_id_2",
        "label": "Function",
        "visible": true,
        "values": [{
                "value": "my-FunctionName-1"
            },
            {
                "value": "my-FunctionName-2"
            },
            {
                "value": "my-FunctionName-3"
            }
        ]
    },
    {
        "type": "property",
        "property": "accountId",
        "inputType": "radio",
        "id": "unique_id_3",
        "defaultValue": "111122223333",
        "visible": true,
        "values": [{
                "label": "IAD Account",
                "value": "111122223333"
            },
            {
                "label": "CMH Account",
                "value": "123456789012"
            },
            {
                "label": "NRT Account",
                "value": "000000000000"
            }
        ]
    }
]

텍스트 위젯 객체의 속성

text 유형의 위젯은 properties 섹션에 1~2개의 파라미터가 있을 수 있습니다. markdown 필드는 필수이고, transparent 필드는 선택 사항입니다.

CloudWatch 텍스트 위젯에서 지원되는 마크다운의 스타일에 대한 자세한 내용은 콘솔에서 마크다운 사용을 참조하세요.

{
   "widgets":[
      {
         "type":"text",
         "x":0,
         "y":7,
         "width":3,
         "height":3,
         "properties":{
            "markdown":"Hello world",
            "background": "transparent"
         }
      }
   ]
}

로그 위젯 객체의 속성

log 유형의 위젯은 CloudWatch Logs Insights 쿼리의 결과를 나타냅니다. 자세한 내용은 CloudWatch Logs Insights를 사용한 로그 데이터 분석을 참조하세요.

log 위젯의 properties 필드에 다음 필드가 포함될 수 있습니다.

{
    "widgets": [
        {
            "type": "log",
            "x": 12,
            "y": 24,
            "width": 12,
            "height": 6,
            "properties": {
                "region": "us-east-1",
                "title": "Errors (Application Log)",
                "query": "SOURCE 'application1.log' | SOURCE 'application2.log' | filter @message like \"[ERROR]\"\n| parse \"Error for [*] [*] due to: *\" canaryName1, canaryId1, cause1\n| parse \"Executor canary [*] *\" canaryName2, cause2\n| fields coalesce(cause1, cause2) as cause\n| fields coalesce(canaryName1, canaryName2) as canaryName\n| fields ispresent(cause) as isP\n| filter isP\n| stats count() as errCount by canaryName, substr(cause, 0, 130)\n| sort errCount DESC",
                "view": "table"
            }
        }
    ]
}

지표 위젯 객체의 속성

metric 유형의 위젯에는 properties 내에 다음 필드가 있을 수 있습니다.

예: 누적 영역 및 게이지 위젯

{
    "widgets": [
{
   "type":"metric",
   "x":0,
   "y":0,
   "width":12,
   "height":6,
   "properties":{
      "metrics":[
         [
            "AWS/EC2",
            "CPUUtilization",
            "InstanceId",
            "i-012345"
         ],
         [
            "AWS/EC2",
            "NetworkIn",
            "InstanceId",
            "i-012345",
            {
               "yAxis":"right",
               "label":"NetworkIn",
               "period":3600,
               "stat":"Maximum"
            }
         ]
      ],
      "period":300,
      "stat":"Average",
      "region":"us-east-1",
      "timezone":"+0300",
      "title":"EC2 Instance CPU",
      "stacked":true,
      "view":"timeSeries",
      "liveData":false,
      "yAxis":{
         "left":{
            "min":0,
            "max":100
         },
         "right":{
            "min":50
         }
      },
      "annotations":{
         "horizontal":[
            {
               "visible":true,
               "color":"#9467bd",
               "label":"Critical range",
               "value":20,
               "fill":"above",
               "yAxis":"right"
            }
         ]
      }
   },
{
   "type": metric, 
   "x": 18,
   "y"; 60,
   "width": 6, 
   "height": 6,
   "properties": {
      "metrics": [
         [ 
         "AWSLogsShrinkRay",
         "disk_inodes_used",
         "path", 
         "/dev/shm",
         "InstanceId",
         "i-012345",
         "AutoScalingGroupName",
         "ShrinkRayExecutorResourceStack-Gamma-us-east-1-ASGuseast1ac48xlargeASGB9B53974-VTYXJUZGUAHV",
         "InstanceType",
         "c4.8xlarge",
         "device",
         "tmpfs",
         "fstype",
         "tmpfs" 
         ]
         ],
      "view": "gauge", 
      "title": "Disk Inodes Used"
      "region": "us-east-1",
      "yAxis": {
         "left": {
            "min": 0, 
            "max": 100,
         }        
       }
     }
   }

지표 위젯: 배열의 각 지표에 대한 형식

metrics 배열의 각 항목은 단일 지표나 수학 표현식 또는 검색 표현식입니다. metrics 배열의 각 단일 지표는 다음과 같은 형식을 갖습니다.

[ Namespace, MetricName, [{DimensionName,DimensionValue}...] {Rendering Properties Object} ]

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

[ {"expression" : "expression", ["label" : "label"] , ["id" : "id"] } ]

// The simplest example, a metric with no dimensions
        [ "AWS/EC2", "CPUUtilization" ]
        
 // A metric with a single dimension
        [ "AWS/EC2", "CPUUtilization", "InstanceId", "i-012345" ]
        
 // A metric with a single dimension and rendering properties
        [ "AWS/EC2", "DiskReadBytes", "InstanceId", "i-xyz", { "yAxis": "right"} ]
       
 // The following example graphs the DiskReadBytes metric for three instances.
        [ "AWS/EC2", "DiskReadBytes", "InstanceId", "i-xyz" ],
        [ ".", ".", ".", "i-abc" ],
        [ ".", ".", ".", "i-123" ]
       
 // The following example includes two metrics and a math expression to sum them.
        [ "AWS/EC2", "DiskReadBytes", "InstanceId", "i-123",{ "id": "m1" } ],
        [ ".", ".", ".", "i-abc", { "id": "m2" } ],
        [ { "expression": "SUM(METRICS())", "label": "Sum of DiskReadbytes", "id": "e3" } ]
       
  // The following example is a search expression showing the EC2 CPUUtilization for each instance in the Region.
        [ { "expression": "SEARCH('{AWS/EC2,InstanceId} MetricName=\"CPUUtilization\"', 'Average', 300)", "id": "e1" } ],

대시보드 위젯 객체: 렌더링 속성 객체 형식

metrics 배열의 각 지표에는 선택적으로 widget 객체의 yAxis 파라미터에 지정된 기본 렌더링 속성을 재정의하는 사용자 지정 렌더링 속성이 있을 수 있습니다. 이 섹션에서는 지표별 사용자 지정 렌더링 속성의 형식을 설명합니다.

       
 // The third metric has its own rendering properties, overriding those of the rest of the widget.
        [ "AWS/EC2", "DiskReadBytes", "InstanceId", "i-xyz" ],
        [ ".", ".", ".", "i-abc" ],
        [ ".", ".", ".", "i-123", { "label":"Instance i-123", "yAxis": "right"}  ]

대시보드 위젯 객체: 주석 속성

주석에는 경보, 가로 주석 및 세로 주석이 포함됩니다. 단일 지표 위젯에는 최대 하나의 경보가 있거나 하나 이상의 가로 또는 세로 주석이 있을 수 있습니다. 단일 위젯에 경보와 가로 또는 세로 주석이 모두 있을 수는 없습니다.

경보 주석

경보 주석을 지정하는 경우 동일한 위젯에 metrics 배열을 지정할 수도 없습니다.

                
"annotations": {
   "alarms": [ "arn1" ]
}
            

가로 주석

// 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 band annotation. Each value has a label, but other parameters for the band are 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"
            }
        ]
    ]
}

// Three annotations on a graph. The first one is a band annotation. The final one is hidden.

"annotations": {
    "horizontal": [
        [
            {
                "label": "Band top",
                "value": 200,
                "color": "#9467bd",
                "visible": true,
                "yAxis": "right"
            },
            {
                "value": 95.5,
                "label": "Band bottom"
            }
        ],
        {
            "visible": true,
            "color": "#9467bd",
            "label": "Label for this annotation",
            "value": 20,
            "fill": "below",
            "yAxis": "right"
        },
        {
            "visible": false,
            "color": "#aaa",
            "label": "Hidden annotation",
            "value": 150
        }
    ]
}

세로 주석

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

대시보드 위젯 객체: yAxis 속성 형식

그래프의 Y축에 대한 설정을 정의합니다. 설정에는 최댓값과 최솟값, 축의 레이블, 축에 단위가 표시되는지 여부가 포함됩니다. 위젯의 모든 지표에 영향을 미치려면 widget 객체 내에 이를 설정합니다. 특정 지표에 대한 위젯 설정을 재정의하려면 metrics 배열의 지표에 대해 이를 설정합니다.

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

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

대시보드 위젯 객체: 테이블 속성

지표 위젯에 대해 table을 지정하는 경우 요약 열, 데이터 포인트 열 및 테이블 레이아웃의 가시성과 관련된 시각화를 포함할 수 있습니다. 이러한 속성은 위젯 보기 유형이 table인 경우에만 적용되며 포함된 경우 다른 보기 유형을 변경하지 않습니다. table 속성은 테이블 위젯을 사용하는 데 필요하지 않습니다.

예를 들어 다음 JSON은 테이블에 있는 각 지표의 최솟값과 최댓값을 표시하는 테이블을 생성합니다.

"table": {
    "summaryColumns": ["MIN", "MAX"],
    "layout": "vertical",
    "stickySummary": true,
    "showTimeSeriesData": false,
    },

Metrics Explorer 위젯 객체의 속성

explorer 유형의 위젯은 Metric Explorer 위젯을 나타냅니다. 자세한 내용은 Metric Explorer를 사용하여 태그 및 속성별 리소스 모니터링을 참조하세요.

CloudFormation을 사용하여 대시보드에 Metric Explorer 위젯을 추가할 수도 있습니다. 자세한 내용은 AWS::CloudWatch::Dashboard를 참조하세요.

이 위젯 유형에는 위젯 properties 내에 다음 필드가 있을 수 있습니다.

예제

다음 예제에서는 계정의 실행 중인 각 EC2 인스턴스에 대한 3개의 지표를 표시하며 위젯의 그래프는 가용 영역별로 구분되어 있습니다. 각 그래프 내에서 지표는 인스턴스 유형별로 집계됩니다.

{
    "widgets": [
        {
            "type": "explorer",
            "width": 24,
            "height": 15,
            "x": 0,
            "y": 0,
            "properties": {
                "metrics": [
                    {
                        "metricName": "CPUUtilization",
                        "resourceType": "AWS::EC2::Instance",
                        "stat": "Average"
                    },
                    {
                        "metricName": "NetworkIn",
                        "resourceType": "AWS::EC2::Instance",
                        "stat": "Average"
                    },
                    {
                        "metricName": "NetworkOut",
                        "resourceType": "AWS::EC2::Instance",
                        "stat": "Average"
                    }
                ],
                "aggregateBy": {
                    "key": "InstanceType",
                    "func": "MAX"
                },
                "labels": [
                    {
                        "key": "State",
                        "value": "running"
                    }
                ],
                "widgetOptions": {
                    "legend": {
                        "position": "bottom"
                    },
                    "view": "timeSeries",
                    "rowsPerPage": 8,
                    "widgetsPerRow": 2
                },
                "period": 300,
                "splitBy": "AvailabilityZone",
                "title": "Running EC2 Instances by AZ"
            }
        }
    ]
}

Metric Explorer 위젯 객체에 대한 유효한 resourceType 값

Metric Explorer 위젯의 metrics 섹션에 있는 resourceType 필드의 유효한 값은 다음과 같습니다.

경보 상태 위젯 객체의 속성

alarm 유형의 위젯에는 properties 내에 다음 필드가 있을 수 있습니다.

다음 예제는 현재 상태에 관계없이 이름으로 지정된 4개의 경보를 표시하는 경보 상태 위젯입니다.

{
    "type": "alarm",
    "x": 0,
    "y": 0,
    "width": 12,
    "height": 6,
    "properties": {
        "alarms": [
            "arn:aws:cloudwatch:us-east-1:012345678901:alarm:EC2FrontendCPU",
            "arn:aws:cloudwatch:us-east-1:012345678901:alarm:EC2BackendCPU",
            "arn:aws:cloudwatch:eu-west-1:987654321098:alarm:EC2FrontendCPU",
            "arn:aws:cloudwatch:eu-west-1:987654321098:alarm:EC2BackendCPU"
        ],
        "sortBy": "stateUpdatedTimestamp",
        "title": "All EC2 CPU alarms"
    }
}

다음 예제 위젯은 동일한 4개의 경보를 지정하지만 위젯은 현재 ALARM 또는 INSUFFICIENT_DATA 상태인 경보만 표시합니다.

{
    "type": "alarm",
    "x": 0,
    "y": 0,
    "width": 12,
    "height": 6,
    "properties": {
        "alarms": [
            "arn:aws:cloudwatch:us-east-1:012345678901:alarm:EC2FrontendCPU",
            "arn:aws:cloudwatch:us-east-1:012345678901:alarm:EC2BackendCPU",
            "arn:aws:cloudwatch:eu-west-1:987654321098:alarm:EC2FrontendCPU",
            "arn:aws:cloudwatch:eu-west-1:987654321098:alarm:EC2BackendCPU"
        ],
        "sortBy": "stateUpdatedTimestamp",
        "states": [
            "ALARM",
            "INSUFFICIENT_DATA"
        ],
        "title": "EC2 alarms that are not currently OK"
    }
}