Monitoring VPN gateway for VPC metrics

Enabling metrics monitoring

To receive monitoring metrics, you must set up your IBM Cloud Monitoring instance.

To receive monitoring metrics, use the following steps:

1. Navigate to the metrics monitoring portal and click Options > Create.

2. Select a region for your IBM Cloud Monitoring instance.

   If you do not have an existing VPN gateway, see Creating a VPN gateway to provision one.

   The region needs to match the location of your existing VPN gateway.

3. Choose your pricing plan.

   Pricing plan details are explained in the selection window. Select the plan that best meets your requirements.

4. Provide a unique service name for your instance. The name can be any name that you want. The name has no impact on functionality.

   Do not give multiple IBM Cloud Monitoring instances the same name.

5. Optionally, select a resource group. A resource group organizes account resources in customizable groupings. Any account resource that is managed by using IBM Cloud Identity and Access Management (IAM) access control belongs to a resource group within your account.

   If you do not have any pre-configured resource groups, or have no reason to share this resource selectively, use the default selection.

   If your account has multiple resource groups, you can choose which group has access to this IBM Cloud Monitoring instance. By using this selective access, metrics can be available to some resource groups and not to others.

6. Select the Enable checkbox. You must select this option to receive metrics from your VPN gateway.

7. Click Create. You are taken back to the monitoring metrics home page.

Within a few minutes, your new IBM Cloud Monitoring instance displays with several configurations. You might have to refresh your browser to see it.

Working with the IBM Cloud Monitoring dashboard

To view and work with your IBM Cloud Monitoring metrics, follow these steps:

1. Navigate to the metrics monitoring portal.

2. Click Open dashboard next to the service name of the IBM Cloud Monitoring instance that you want to work with.

   The first time that you access your IBM Cloud Monitoring instance, several windows display as part of the internal setup. Keep the default entries, and click through the pages until you reach the main IBM Cloud Monitoring page.

3. Open the IBM VPN for VPC Monitoring Metrics dashboard by selecting Dashboards.

4. Click Dashboard Library > IBM > VPC VPN. The default dashboard is not editable.

5. Ten main metrics in the dashboard are shown. These metrics include Gateway/Connection status, Gateway/Connection bytes input/output, and Gateway/Connection packets input/output. If you want to modify parameters and segment your metrics by VPN gateway name and VPN connection name, you must create a custom dashboard.

   You can choose what time window that you'd like to see your metrics by using the time selection bar.

Creating a custom metrics dashboard

You can create your own dashboard to customize your monitoring metrics, such as viewing information about particular VPN gateways, or seeing traffic that comes through only a VPN connection.

To customize your dashboard, use the following steps:

1. Navigate to the metrics monitoring portal.

2. Click Open dashboard next to the service name of the IBM Cloud Monitoring instance you want to work with. You now see the dashboard.

3. Select Dashboards and click the + in the panel.

4. Select Blank dashboard and select the type of visual representation that you want.

   IBM Cloud Monitoring offers eight different visualizations for your dashboard. Read the description for each visualization and choose the one that best meets your requirements.

   The line View trends over time is the most frequently selected option. The following examples show a line-based visualization.

5. Configure your custom dashboard.

   • In the Metrics field, enter ibm_is to display the ten IBM Cloud VPN for VPC metrics: ibm_is_vpn_gateway_status, ibm_is_vpn_connection_status, ibm_is_vpn_gateway_bytes_in, ibm_is_vpn_gateway_bytes_out, ibm_is_vpn_gateway_packets_in, ibm_is_vpn_gateway_packets_out, ibm_is_vpn_connection_bytes_in, ibm_is_vpn_connection_bytes_out, ibm_is_vpn_connection_packets_in, and ibm_is_vpn_connection_packets_out.

   • You can choose a scope to display in your dashboard by clicking Override Dashboard Scope. For example, you can display the metrics for a particular VPN gateway.

   • You can also set a segment to compare metrics across the scope that you define. For example, you can look at the connection status for a particular VPN gateway that is segmented by gateway name and connection name.

6. Click Save.

   By default, the dashboard is named "blank dashboard". You can change the name by selecting Dashboards from the sidebar and clicking the Pencil icon next to the name.

To return to the default IBM Cloud Monitoring dashboard at any time, select Dashboards > Default Dashboards > IBM > VPC VPN.

Working with IBM Cloud Monitoring by using APIs

You can also work with the IBM Cloud Monitoring instance by using metric query APIs. You might want to use APIs if you need raw data points or want to consume your metrics from a command-line interface rather than using the IBM Cloud Monitoring dashboard.

After you create your IBM Cloud Monitoring instance, you must collect the following two pieces of information.

• The Monitor API token
• The endpoint of your IBM Cloud Monitoring instance

To collect this information and work with your IBM Cloud Monitoring instance by using metric query API, follow these steps:

1. Access the Monitoring home page.

2. Click Open Dashboard next to the instance that you want to work with.

3. After the IBM Cloud Monitoring dashboard is displayed, select your Account Profile icon on the sidebar and select Settings. You now see your account settings.

4. Your Monitor API token is an alphanumeric string that is located in the Sysdig Monitor API Token field. Click the Copy button to copy the token to your clipboard.

   Do not share this API token. Anyone who has this API token has full access to your metrics.

5. The endpoint of your IBM Cloud Monitoring instance is per region. For example, if your IBM Cloud Monitoring instance exists in us-south, then its endpoint is:

   https://us-south.monitoring.cloud.ibm.com/api/data/batch
   

6. After you have both the API token and the endpoint, you can format your POST request. The following POST request is an example, with all the parameters that you can modify. The following are parameters:

   • The Monitor API token.
   • The endpoint of your IBM Cloud Monitoring instance.
   • The value for ibm_is_vpn_gateway_name (the VPN gateway name that you want to see metrics for).

   If you want to see this metric for all of your VPN gateways, do not enter a value for the scope attribute. For example, use "scope" : "".

   • The metric type that you want to see the results for. This example uses ibm_is_vpn_gateway_status.
   • The from and to attributes define the timeframe to focus the scan, set in epoch time, and in microseconds.
   • The sampling and value attributes set the granularity of the data that is returned in the POST request.

   Because a large volume of data is stored in IBM Cloud Monitoring, choosing the specific level of granularity is important. IBM Cloud Monitoring can return only 600 data points at a time per request. As a result, the sampling and value attributes are important. Leaving these two lines out of your request returns an aggregate sum over that time period instead.

   If the time range that is specified by from and to is large (for example, 4 days), but you define a sampling and value of 10 seconds, it means that you receive 4 days worth of data that is split into 10-second chunks. This sample is not useful because of the large amount of data that is returned. Specifying a larger chunk is recommended (for example, 1 hour instead of 10 seconds).

      curl \
      -H 'Authorization: Bearer <API_TOKEN>’ \
      -H 'Content-Type: application/json' \
      https://us-south.monitoring.cloud.ibm.com/api/data/batch  \
      -d '{
        "requests": [
            {
                "format": {
                    "type": "data"
                },
                "scope": "ibm_is_vpn_gateway_name = \"test-001\"",
                "metrics": {
                    "k0": "timestamp",
                    "v1": "ibm_is_vpn_gateway_status"
                },
                "time": {
                    "from": 1589877054000000,
                    "to": 1589877114000000,
                    "sampling": 60000000
                },
                "group": {
                    "by": [
                        {
                           "metric": "k0",
                            "value" : 60000000
                        }
                    ],
                    "aggregations": {
                        "v1": "avg"
                    },
                    "groupAggregations": {
                        "v1": "avg"
                    }
                }
            }
        ]
    }'
   

Working with IBM Cloud Monitoring by using VPN for VPC UI

You can view individual VPN gateway metrics and launch the IBM Cloud Monitoring dashboard from the VPN UI.

1. Navigate to the VPN UI.

2. Click a VPN gateway name whose IBM Cloud Monitoring metrics that you want to view and go to its Overview page.

   The Monitoring preview panel displays the sum of every metric over the last hour.

   You can click Launch monitoring to launch the VPN gateway's default IBM Cloud Monitoring dashboard.

3. Open the VPN gateway's Monitoring page. The page displays a VPN gateway's throughput and packets in a time range.

   Similarly, you can also launch the VPN gateway's default IBM Cloud Monitoring dashboard by clicking Launch monitoring.