Set the yAxis of a metric in a widget

[harrisonhjones]

Describe the feature

I would like to be able to set the yAxis value of a metric using the CDK. As per https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/CloudWatch-Dashboard-Body-Structure.html it's defined as:

yAxis
Where on the graph to display the y-axis for this metric. The default is left.

Valid Values: left | right

Type: String

Required: No

Use Case

Without the ability to change the yAxis value of a metric I have to graph some metric math expressions on an entirely different graph to avoid conflicting units and scale. This is incredibly frustrating and results in a suboptimal dashboard.

Proposed Solution

Add the ability to set the yAxis value for a metric. Similar to how we can already set color and label.

Other Information

No response

Acknowledgements

• I may be able to implement this feature request
• This feature might incur a breaking change

CDK version used

1

Environment details (OS name and version, etc.)

N/A

[markmansur]

I think we expect this to be on the GraphWidget class correct?

[harrisonhjones]

I was actually thinking we should add it to https://docs.aws.amazon.com/cdk/api/v1/docs/@aws-cdk_aws-cloudwatch.MetricProps.html. Similar to how color and label are there.

If you look at the example from https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/CloudWatch-Dashboard-Body-Structure.html you see:

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

I'm specifically interested in setting "yAxis":"right", in that second metric.

[christophercarney]

Any updates on this? Kind of shocking it isn't included anywhere by default

[shipitsteven]

For CloudWatch, you can utilize cdk-monitoring-constructs to build dashboards with GraphWidgets.

An example would be:

monitoring
  .monitorCustom({
    alarmFriendlyName: 'MyMetric',
    metricGroups: [
      {
        title: `My Awesome Metric`,
        graphWidgetAxis: {
          label: 'Success rate %',
          showUnits: false,
          min: 0,
          max: 100,
        },
        graphWidgetRightAxis: {   // specify your right Y axis here
          label: 'SampleCount',
          min: 0,
        },
        metrics: [...],
      }
    ],
  });

Although I'm unsure if you're able to negate the left axis entirely and only show right axis.