Skip to content

Monitoring your deployed VSatellites

Use the VSatellite's page to monitor your deployed VSatellites. From the Drawer view, you can do the following:

  • view a VSatellite's current status
  • verify the last time a VSatellite checked in to TLS Protect Cloud
  • view each VSatellite's list of currently supported services

To monitor a VSatellite

  1. Sign in to Venafi Control Plane.
  2. Click Configurations > VSatellites.

  3. Select the VSatellite you want to monitor.

    You can view the status of a VSatellite by looking in the Status column of the VSatellites List view or at the top of the slideout drawer under the VSatellite's name.

  4. (Optional) Scroll to the Supported Services table to view the list of services assigned to the selected VSatellite.

    To view the details of a specific service, click a service's name.

VSatellite health email notifications

VSatellite health email notifications System Administrators monitor connectivity issues between VSatellite and the Venafi Control Plane. These notifications help administrators quickly identify and resolve issues, ensuring consistent service availability.

System Administrators receive email alerts whenever a VSatellite instance is in an unhealthy state for more than five minutes. Each alert includes critical information such as the affected VSatellite instance, tenant prefix, last-seen timestamp, and other relevant details, enabling faster diagnosis and resolution.

When the VSatellite returns to a healthy state, a follow-up email is sent to notify System Administrators.

These notifications helps streamline issue detection and resolution, ensuring seamless functionality and minimizing disruptions.

For help getting your VSatellite back online, see troubleshooting your VSatellites.

Disabling VSatellite email notifications

To disable VSatellite offline notifications for your entire tenant, follow these steps:

  1. Locate the Notification Routing Configuration ID.

    Run the following command, replacing <API_KEY> with a System Administrator's API key. 

    curl --request POST \
  --url https://api.venafi.cloud/graphql \
  --header 'tppl-api-key: <API_KEY>' \
  --header 'content-type: application/json' \
  --data '{"query": "query SearchNotificationRoutingConfigurations { searchNotificationRoutingConfigurations { nodes { id enabled notificationRouterFilterConfig { notificationRouterCelExpression } } } }"}' | jq

    This command will produce output similar to the following:

    {
  "data": {
    "searchNotificationRoutingConfigurations": {
      "nodes": [
        {
          "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
          "enabled": true,
          "notificationRouterFilterConfig": {
            "notificationRouterCelExpression": "type.startsWith('evt.healthstatus.edgeinstances')"
          }
        }
      ]
    }
  }
}

    From the list of routing configurations under the nodes node, find the node with the following notificationRouterCelExpression:

    "notificationRouterCelExpression": "type.startsWith('evt.healthstatus.edgeinstances')"

    Copy the id value for this specific node. From the example output above, the id is xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx.

  2. Disable the notifications.

    Run the following command, replacing <API_KEY> with your API key and <NOTIFICATION_ROUTING_ID> with the id value from the previous step:

    curl --request POST \
  --url 'https://api.venafi.cloud/graphql' \
  --header 'tppl-api-key: <API_KEY>' \
  --header 'Content-Type: application/json' \
  --data '{"query":"mutation UpdateNotificationRouter($id: UUID!, $enabled: Boolean) { updateNotificationRoutingConfiguration(id: $id, enabled: $enabled) { id enabled }}","variables":{"id":"<NOTIFICATION_ROUTING_ID>","enabled":false}}'

  3. Verify the disablement.

    Re-execute the command from step 1. Verify that the enabled property for the identified routing configuration is set to false.

What's next?

Get help troubleshooting your VSatellites.