Montplex Cache
docs
docs

Amazon CloudWatch

Amazon CloudWatch (AWS) is a monitoring service from AWS that helps you observe your applications and infrastructure resources. Montplex Cache provides integration, allowing you to include Montplex Cache service data in Amazon CloudWatch metrics and logs.

Create Data Source

  1. Visit https://console.aws.amazon.com/cloudwatch/ to open the CloudWatch console.
  2. Select the Region for creating the data source.
  3. In the navigation pane, select Settings.
  4. Select the Metrics data sources tab.
  5. Choose Create data source.
  6. Select the desired source, Prometheus, then click Next.
  7. Enter the data source's name.

This name must match the Montplex Cache Resource Monitor name. In the Update Data Source section, you will update the Dashboard's Metrics JSON file, and the name needs to match the LAMBDA call name in the JSON. Example: us-east-1-eks

  1. Enter the required information based on the selected data source.

    Endpoint should be the monitoring address URL exposed by Montplex Cache. User/Password should be the monitoring user/password information exposed by Montplex Cache.

  2. For the VPC option, select Do not use VPC.

  3. Confirm the creation of IAM resources by AWS CloudFormation, which is the Lambda function execution role.

  4. Choose Create data source.

Create Dashboard

  1. visit https://console.aws.amazon.com/cloudwatch/ to open the CloudWatch console.
  2. In the navigation pane, select Dashboards, then choose Create dashboard.
  3. In the Create new dashboard dialog, enter the dashboard's name, then select Create dashboard.

It is recommended to use a name consistent with the Montplex Cache running environment cluster name for easy identification.

  1. Choose Save dashboard.

Update Data Source

  1. Select the target Resource Monitor in Montplex Cache and copy the exposed Metrics JSON.
  2. Visit https://console.aws.amazon.com/cloudwatch/ to open the CloudWatch console.
  3. In the navigation pane, select Dashboards and click the Dashboard that needs the data source update.
  4. Choose View/edit source from the Actions dropdown list.

  1. Paste the copied JSON content into the editor and select Save dashboard.
  • The data source name in the JSON must match the data source name created in CloudWatch.
  • The Region should match the region where the data source was created.
{ "widgets": [ { "height": 7, "width": 8, "y": 0, "x": 0, "type": "metric", "properties": { "view": "timeSeries", "stacked": false, "metrics": [ [ { "expression": "LAMBDA('datasource-name', 'redis_up')", "id": "e1", "region": "region-name" } ] ], "region": "ap-southeast-1", "title": "Redis Status", "period": 300, "legend": { "position": "bottom" } } } ] }

Custom Widgets

  1. On the dashboard page, select Add widget.
  2. In the Add to this dashboard dialog, perform one of the following actions:
    • To add a chart to the dashboard, select Line or Stacked area, then choose Configure. In the Add metric graph dialog, select the metrics to graph, then choose Create widget.
    • To add a number displaying metrics to the dashboard, select Number, then choose Configure. In the Add metric graph dialog, select the metrics to graph, then choose Create widget.
    • To add a text block to the dashboard, select Text, then choose Configure. In the New text widget dialog, format the text using Markdown, then choose Create widget.
  3. (Optional) Select Add widget and repeat step 2 to add another widget to the dashboard. You can repeat this step multiple times.

For each chart on the dashboard, there is an information icon in the upper right corner. Selecting this icon will display a description of the metrics in the chart.