Console

To list the synthetic monitors in your Google Cloud project, do the following:

1. In the Google Cloud console, go to the Synthetic monitoring page:

   Go toSynthetic monitoring

   If you use the search bar to find this page, then select the result whose subheading isMonitoring.

2. In the toolbar of the Google Cloud console,select your Google Cloud project. ForApp Hubconfigurations, select the App Hub host project or management project.

3. Optional: To restrict which synthetic monitors are listed, add filters.

   Each filter is composed of a name and a value.You can set the value to be an exact match for an synthetic monitor nameor a partial match. Matches aren't case sensitive. For example, to list allsynthetic monitors whose name containsdefault, do the following:

   • ClickFilter table and selectDisplay name.
   • Enterdefault and then press the return key.

   If you have multiple filters, then the filters are automatically joinedby a logicalAND unless you insert anOR filter.The previous example uses theOR filter so that an uptime check islisted if its name matchesdefault orTesting check.

TheSynthetic monitors page displays the following for eachsynthetic monitor:

• Status of the most recent execution.
• A link to detailed information about that synthetic monitor.
• The success rate and average execution time.
• The number of alerting policies.
• To edit, copy, or delete the synthetic monitor, and to create analerting policy, use themore_vertMore options menu.

gcloud

To list your uptime checks and synthetic monitors, runthegcloud monitoring uptime list-configscommand:

gcloudmonitoringuptimelist-configs--project=PROJECT_ID

Before you run the previous command, replace the following:

• PROJECT_ID: The identifier of the project. ForApp Hubconfigurations, select the App Hub host project or management project.

The returned data includes the following:

• Name and display name.
• Check identifier.
• Monitored resource.
• Period between checks.

You can configure the Google Cloud CLI command to filter and sort the results.

REST

To list the synthetic monitors in your Google Cloud project, includinguptime checks, call theprojects.uptimeCheckConfigs.list method:

1. Clickprojects.uptimeCheckConfigs.list.

2. Use the APIs Explorer.

   Set the method'sparent to the name of the project, ensure that youuse the following format:

   projects/PROJECT_ID

   In the previous expression,PROJECT_ID is your Google Cloud project ID.ForApp Hubconfigurations, select the App Hub host project or management project.

For a synthetic monitor, the result contains a field labeledsyntheticMonitor.

Console

To view the details of a synthetic monitor in your Google Cloud project,do the following:

1. In the Google Cloud console, go to the Synthetic monitoring page:

   Go toSynthetic monitoring

   If you use the search bar to find this page, then select the result whose subheading isMonitoring.

2. In the toolbar of the Google Cloud console,select your Google Cloud project. ForApp Hubconfigurations, select the App Hub host project or management project.

3. To open theSynthetic monitor details page, locate thesynthetic monitor that you want to view, and then click its name.

   If you want to view your Cloud Run function from theFunctions details pageprovided by Cloud Run functions, then select theCode tab and thenclick the function's name. TheFunctions details page opensin a new window. The tabs on this page let you view metrics and logs,and configuration information.

gcloud

To list the details of an uptime check or synthetic monitor,run thegcloud monitoring uptime describecommand:

gcloudmonitoringuptimedescribeCHECK_ID--project=PROJECT_ID

Before you run the previous command, replace the following:

• PROJECT_ID: The identifier of the project. ForApp Hubconfigurations, select the App Hub host project or management project.
• CHECK_ID: The identifier of the uptime check or synthetic monitor.You can find theidentifier by running thegcloud monitoring uptime list-configs commandand examining thename field. For more information, seeFind the unique identifier of a synthetic monitor.

The data returned for the uptime check includes the following:

• Name and display name.
• Check identifier.
• Monitored resource.
• Period between checks.

REST

To list the details of a specific synthetic monitor in your Google Cloud project,call theprojects.uptimeCheckConfigs.get method:

1. Clickprojects.uptimeCheckConfigs.get.

2. Use the APIs Explorer.

   Set the method'sparent to the identifier of the synthetic monitor,ensure that you use the following format:

   projects/PROJECT_ID/uptimeCheckConfigs/CHECK_ID

   In the previous expression:

   • PROJECT_ID is your Google Cloud project ID. ForApp Hubconfigurations, select the App Hub host project or management project.
   • CHECK_ID is the ID of the synthetic monitor.

   For example, the value of the parent field might be:

   projects/my-project/uptimeCheckConfigs/10863117100295372627

   To find the value of theCHECK_ID, you can issue theprojects.uptimeCheckConfigs.list method.To reduce the number of returned results, include a filter.For example, add the filterdisplayName="MySyntheticMonitor".

Console

1. In the Google Cloud console, go to the Synthetic monitoring page:

   Go toSynthetic monitoring

   If you use the search bar to find this page, then select the result whose subheading isMonitoring.

2. In the toolbar of the Google Cloud console,select your Google Cloud project. ForApp Hubconfigurations, select the App Hub host project or management project.
3. Locate the synthetic monitor that you want to edit,clickmore_vertMore options, and then selectEdit.

4. Optional: To edit the Cloud Run function, clickEdit function,make your changes, and then clickApply function.

   For broken-link checkers, to modify the origin URI or the options thatdefine which links are tested, edit the Cloud Run function, and thenupdate theoptions object in theindex.js file. For information aboutthe fields and syntax for this object, seebroken-links-ok/index.js.

5. To retain your modifications, clickSave. Otherwise, clickCancel.

gcloud

To modify an uptime check or synthetic monitor,run thegcloud monitoring uptime updatecommand:

gcloudmonitoringuptimeupdateCHECK_IDOPTIONAL_FLAGS--project=PROJECT_ID

Before you run the previous command, replace the following:

• PROJECT_ID: The identifier of the project. ForApp Hubconfigurations, select the App Hub host project or management project.

• CHECK_ID: The identifier of the uptime check orsynthetic monitor. You can find the identifier by running thegcloud monitoring uptime list-configs command andexamining thename field. For more information, seeFind the unique identifier of an uptime check.

• Define which fields that you want to modify. For synthetic monitors, you canonly update the following fields:

  • Period
  • Display name
  • Timeout
  • User labels

For example, to set the period of a synthetic monitor to be 10 minutes,run the following command:

gcloudmonitoringuptimeupdateCHECK_ID--period=10--project=PROJECT_ID

REST

Alerting policies and functions aren't contained by a synthetic monitor, andtherefore they can't be edited by the procedure described in this section:

• To modify an alerting policy, use the Google Cloud console or call thealertPolicies.patch method. For more information,seeManage alerting policies by API.

• To modify a Cloud Run function, after you update the function sourceyou must redeploy the function. For more information, seeDeploy a Cloud Run function.

To edit a synthetic monitor, call theprojects.uptimeCheckConfigs.patch method:

1. Clickprojects.uptimeCheckConfigs.patch.

2. Use the APIs Explorer.

   1. Set the method'sparent to the identifier of the synthetic monitor,The identifier has the following format:

      projects/PROJECT_ID/uptimeCheckConfigs/CHECK_ID

      In the previous expression:

      • PROJECT_ID is your project ID. ForApp Hubconfigurations, select the App Hub host project or management project.
      • CHECK_ID is the ID of the synthetic monitor.

      To find the value of theCHECK_ID, you can issue theprojects.uptimeCheckConfigs.list method.To reduce the number of returned results, include a filter.For example, add the filterdisplayName="MySyntheticMonitor".

   2. Set the method's query parameter,updateMask, to identify whichfields in the object are being modified. For example, to update thevalue of thedisplayName, then query parameter is as follows:

      updateMask=displayName

Console

To copy a synthetic monitor in your Google Cloud project, do the following:

1. In the Google Cloud console, go to the Synthetic monitoring page:

   Go toSynthetic monitoring

   If you use the search bar to find this page, then select the result whose subheading isMonitoring.

2. In the toolbar of the Google Cloud console,select your Google Cloud project. ForApp Hubconfigurations, select the App Hub host project or management project.

3. Locate the synthetic monitor that you want to edit,clickmore_vertMore options, and then selectCopy.

   TheCopy Synthetic Check dialog opens with fields pre-populated,including a copy of the Cloud Run function.

4. ClickCreate function, update the function as necessary, and thenclickApply function.

5. To retain your modifications, clickCreate. Otherwise, clickCancel.

   When you clickCreate, your Cloud Run function is created anddeployed, and then the synthetic monitor is created.

gcloud

There is no Google Cloud CLI method that lets you copy a synthetic monitor.

REST

There is no API method that lets you copy a synthetic monitor. However, you canmake a copy by performing the following steps:

1. Call theprojects.uptimeCheckConfigs.get methodand save the response. For more information, seeView details of a synthetic monitor.
2. Edit the response.
3. Call theprojects.uptimeCheckConfigs.createmethod and pass to the method the edited response.

Console

1. In the Google Cloud console, go to the Synthetic monitoring page:

   Go toSynthetic monitoring

   If you use the search bar to find this page, then select the result whose subheading isMonitoring.

2. In the toolbar of the Google Cloud console,select your Google Cloud project. ForApp Hubconfigurations, select the App Hub host project or management project.

3. Locate the synthetic monitor that you want to delete, and then click thename.

4. Optional: If you want to delete the Cloud Run function, thenthen select theCode tab and thenclick the function's name. TheFunctions details page opensin a new window.

5. In theSynthetic monitor details page,clickdeleteDelete, and then complete the dialog.

   You've now deleted the synthetic monitor.

6. To delete the Cloud Run function, go to theFunctions details page,clickdeleteDelete, and then complete the dialog.

gcloud

Note: You can't delete an uptime check or a synthetic monitor by using theGoogle Cloud CLI or the Cloud Monitoring API when there is an alerting policyassociated with that uptime check or synthetic monitor. You mustdelete the alerting policy first. Deleting a synthetic monitor doesn'tdelete the Cloud Run function.

To delete an uptime check or synthetic monitor,run thegcloud monitoring uptime deletecommand:

gcloudmonitoringuptimedeleteCHECK_ID--project=PROJECT_ID

Before you run the previous command, replace the following:

• PROJECT_ID: The identifier of the project. ForApp Hubconfigurations, select the App Hub host project or management project.
• CHECK_ID: The identifier of the uptime check or synthetic monitor.You can find theidentifier by running thegcloud monitoring uptime list-configs commandand examining thename field. For more information, seeFind the unique identifier of a synthetic monitor.

REST

Note: You can't delete an uptime check or a synthetic monitor by using theGoogle Cloud CLI or the Cloud Monitoring API when there is an alerting policyassociated with that uptime check or synthetic monitor. You mustdelete the alerting policy first. Deleting a synthetic monitor doesn'tdelete the Cloud Run function.

To delete a synthetic monitor and associated alerting policies, call theprojects.uptimeCheckConfigs.delete method:

1. Clickprojects.uptimeCheckConfigs.delete.

2. Use the APIs Explorer.

   Set the method'sparent to the identifier of the synthetic monitor,ensure that you use the following format:

   projects/PROJECT_ID/uptimeCheckConfigs/CHECK_ID

   In the previous expression:

   • PROJECT_ID is your project ID. ForApp Hubconfigurations, select the App Hub host project or management project.
   • CHECK_ID is the ID of the synthetic monitor.

   To find the value of theCHECK_ID, you can issue theprojects.uptimeCheckConfigs.list method.To reduce the number of returned results, include a filter.For example, add the filterdisplayName="MySyntheticMonitor".