Skip to content

Latest commit

 

History

History
189 lines (140 loc) · 9.88 KB

settings-sysdig-metrics.md

File metadata and controls

189 lines (140 loc) · 9.88 KB
copyright lastupdated keywords subcollection
years
2021, 2024
2024-07-01
monitoring, monitor metrics
hs-crypto

{{site.data.keyword.attribute-definition-list}}

Managing metrics

{: #manage-monitoring-metrics}

After you set up your {{site.data.keyword.hscrypto}} instance, you can manage Monitoring metrics by using the service API. {: shortdesc}

Managing metrics settings

{: #manage-metrics-policy}

Metrics for {{site.data.keyword.hscrypto}} instances are an extra policy, with which, you can receive the operational metrics for your {{site.data.keyword.hscrypto}} instance. When you enable this policy, {{site.data.keyword.mon_short}} can be used to monitor any operations that are performed on the resources in your {{site.data.keyword.hscrypto}} instance.

Before you enable operational metrics for your {{site.data.keyword.hscrypto}} instance, keep in mind the following considerations:

  • When you enable metrics for your {{site.data.keyword.hscrypto}} instance, metrics are only reported after the time that the policy is enabled.

    Once your metrics policy is enabled, you will see operational metrics for all API requests that occur in your instance after the policy is activated. You will not be able to view any metrics prior to the time that the policy is enabled.

  • You need to provision a {{site.data.keyword.mon_short}} instance first in order to see the metrics.

    You need to provision a {{site.data.keyword.mon_short}} instance{: external} that is located in the same region as the {{site.data.keyword.hscrypto}} instance that you want to receive operational metrics for. After you provision the {{site.data.keyword.mon_short}} instance, you need to enable platform metrics.

Enabling metrics for your {{site.data.keyword.hscrypto}} instance with the UI

{: #enable-metrics-instance-policy-ui} {: ui}

After you create a {{site.data.keyword.hscrypto}} instance, provision a {{site.data.keyword.mon_short}} instance, and enable platform metrics, complete the following steps to enable a metrics policy:

  1. Log in to the UI{: external}.
  2. Go to Menu > Resource list to view a list of your resources.
  3. From your {{site.data.keyword.cloud_notm}} resource list, select your provisioned instance of {{site.data.keyword.hscrypto}}.
  4. In the UI of the selected service instance, select the Instance policies tab in the side menu.
  5. In the Metrics section, check Send metrics to IBM Cloud Monitoring and click Save policy.

Enabling metrics for your {{site.data.keyword.hscrypto}} instance with the API

{: #enable-metrics-instance-policy-api} {: api}

As an instance manager, enable a metrics policy for a {{site.data.keyword.hscrypto}} instance by making a PUT call to the following endpoint.

https://<instance_ID>.api.<region>.hs-crypto.appdomain.cloud/api/v2/instance/policies?policy=metrics

{: codeblock}

  1. Retrieve your authentication credentials to work with the API.

    To enable metrics policies, you must be assigned a Manager IAM role for your {{site.data.keyword.hscrypto}} instance. To learn how IAM roles map to {{site.data.keyword.hscrypto}} service actions, check out Service access roles. {: note}

  2. Enable a metrics policy for your {{site.data.keyword.hscrypto}} instance by running the following curl command.

    curl -X  PUT \
 "https://<instance_ID>.api.<region>.hs-crypto.appdomain.cloud/api/v2/instance/policies?policy=metrics" \
 -H "accept: application/vnd.ibm.kms.policy+json" \
 -H "authorization: Bearer <IAM_token>" \
 -H "bluemix-instance: <instance_ID>" \
 -H "content-type: application/vnd.ibm.kms.policy+json" \
 -d '{
         "metadata": {
             "collectionType": "application/vnd.ibm.kms.policy+json",
             "collectionTotal": 1
         },
         "resources": [
             {
                 "policy_type": "metrics",
                 "policy_data": {
                     "enabled": false
                 }
             }
         ]
     }'

    {: codeblock}

    Replace the variables in the example request according to the following table.

    Variable Description
    region Required. The region abbreviation, such as us-south, that represents the geographic area where your {{site.data.keyword.hscrypto}} instance resides. For more information, see Regional service endpoints.
    port Required. The port number of the API endpoint.
    IAM_token Required. Your {{site.data.keyword.cloud_notm}} access token. Include the full contents of the IAM token, including the Bearer value, in the curl request. For more information, see Retrieving an access token.
    instance_ID Required. The unique identifier that is assigned to your {{site.data.keyword.hscrypto}} instance. For more information, see Retrieving an instance ID.
    {: caption="Table 1. Describes the variables needed to enable a metrics policy" caption-side="bottom"}

    A successful request returns an HTTP 204 No Content response, which indicates that your {{site.data.keyword.hscrypto}} instance is now enabled for reporting operational metrics.

    This new policy only reports on operations that occur after the policy is enabled. {: note}

  3. Optional: Verify that the metrics policy is created by browsing the policies that are available for your {{site.data.keyword.hscrypto}} instance.

    $ curl -X GET \
    "https://<instance_ID>.api.<region>.hs-crypto.appdomain.cloud/api/v2/instance/policies?policy=metrics" \
    -H "accept: application/vnd.ibm.kms.policy+json" \
    -H "authorization: Bearer <IAM_token>" \
    -H "bluemix-instance: <instance_ID>"

    {: codeblock}

Disabling metrics for your {{site.data.keyword.hscrypto}} instance with the API

{: #disable-metrics-api} {: api}

As an instance manager, disable an existing metrics policy for a {{site.data.keyword.hscrypto}} instance by making a PUT call to the following endpoint.

https://<instance_ID>.api.<region>.hs-crypto.appdomain.cloud/api/v2/instance/policies?policy=metrics

{: codeblock}

  1. Retrieve your authentication credentials to work with the API.

    To enable metrics policies, you must be assigned a Manager IAM role for your {{site.data.keyword.hscrypto}} instance. To learn how IAM roles map to {{site.data.keyword.hscrypto}} service actions, check out Service access roles. {: note}

  2. Disable an existing metrics policy for your {{site.data.keyword.hscrypto}} instance by running the following curl command.

    $ curl -X PUT \
    "https://<instance_ID>.api.<region>.hs-crypto.appdomain.cloud/api/v2/instance/policies?policy=metrics" \
    -H "accept: application/vnd.ibm.kms.policy+json" \
    -H "authorization: Bearer <IAM_token>" \
    -H "bluemix-instance: <instance_ID>" \
    -H "content-type: application/vnd.ibm.kms.policy+json" \
    -d '{
            "metadata": {
                "collectionType": "application/vnd.ibm.kms.policy+json",
                "collectionTotal": 1
            },
            "resources": [
                {
                    "policy_type": "metrics",
                    "policy_data": {
                        "enabled": false
                    }
                }
            ]
        }'

    {: codeblock}

    Replace the variables in the example request according to the following table.

    Variable Description
    region Required. The region abbreviation, such as us-south, that represents the geographic area where your {{site.data.keyword.hscrypto}} instance resides. For more information, see Regional service endpoints.
    port Required. The port number of the API endpoint.
    IAM_token Required. Your {{site.data.keyword.cloud_notm}} access token. Include the full contents of the IAM token, including the Bearer value, in the curl request. For more information, see Retrieving an access token.
    instance_ID Required. The unique identifier that is assigned to your {{site.data.keyword.hscrypto}} instance. For more information, see Retrieving an instance ID.
    {: caption="Table 2. Describes the variables needed to disable metrics policies" caption-side="bottom"}

    A successful request returns an HTTP 204 No Content response, which indicates that the metrics policy is disabled for your service instance.

  3. Optional: Verify that the metrics policy is disabled by browsing the policies that are available for your {{site.data.keyword.hscrypto}} instance.

    $ curl -X GET \
    "https://<instance_ID>.api.<region>.hs-crypto.appdomain.cloud/api/v2/instance/policies?policy=metrics" \
    -H "accept: application/vnd.ibm.kms.policy+json" \
    -H "authorization: Bearer <IAM_token>" \
    -H "bluemix-instance: <instance_ID>"

    {: codeblock}

What's next

{: #monitor-metrics-next-steps}

To find out more about configuring your {{site.data.keyword.hscrypto}} instance with {{site.data.keyword.mon_short}}, check out Monitoring Operational Metrics.