Using the Stackdriver Monitoring console
For information on creating and managing a Workspace using the Stackdriver Monitoring console, see Managing Workspaces.
Using the Google Cloud Console
This page explains how to create and manage Workspaces. Your Google Cloud projects and Amazon Web Service (AWS) accounts must be members of a Workspace before they can be monitored.
Creating a single-project Workspace
To determine if you have sufficient privileges to create a Workspace for an existing Google Cloud project or an AWS account, see Required permissions.
To create a Workspace for an existing Google Cloud project, do the following:
Go to the Cloud Console:
In the menu bar, select your Google Cloud project from the project menu arrow_drop_down.
In the navigation menu, click Monitoring. After you click Monitoring, one of the following occurs:
- If your Google Cloud project is already associated with a Workspace, then the Stackdriver Monitoring home page is displayed.
- If you've never created a Workspace or if all of your Workspaces are single-project, then Stackdriver Monitoring automatically creates a Workspace and associates it with your Google Cloud project.
If you have at least one multi-project Workspace, then the Add your project to a Workspace dialog is displayed. To create a new Workspace, select your Google Cloud project under New Workspace and then click Add.
In the following image, the Google Cloud project name is Quickstart:
When a Workspace is created, the Google Cloud project becomes the Workspace host project. The Workspace and Google Cloud project also have the same name. After Workspace creation, which takes a few moments to complete, the Monitoring Overview pane is displayed:
Selecting a Workspace
After you create a Workspace, the navigation panel lists your current Workspace and includes a menu that you can use to select a different Workspace.
In the following screenshot, the Workspace "A Sample Project" is selected:
Creating a multi-project Workspace
A single Workspace can monitor any number of Google Cloud projects or AWS accounts. If you want to create a multi-project Workspace, the best practice recommendation is to use the following procedure:
Create a new Google Cloud project:
- In the menu bar of the Cloud Console, click Menu arrow_drop_down and then click New Project.
- Enter a descriptive project name, and then click Create.
Create a new Workspace for that project by following the steps in Creating a single-project Workspace. The Google Cloud project you created in the first step is the hosting project for your Workspace.
Add Google Cloud projects or AWS accounts to the Workspace by following the steps in Adding monitored projects.
Adding a monitored project
This procedure covers adding a Google Cloud project or an AWS account that isn't associated with a Workspace to an existing Workspace:
- To create a Workspace to which you can add projects and accounts, see Creating a multi-project Workspace.
- To determine if you have sufficient privileges to add a Google Cloud project or an AWS account to a Workspace, see Required permissions.
- For information on how to move a project to a different Workspace, see Moving a project to a different Workspace.
To add a Google Cloud project or an AWS account that isn't associated with a Workspace to an existing Workspace, do the following:
In the Cloud Console, select Monitoring:
Select Settings.
Ensure that the proper Workspace is selected.
To add a Google Cloud project, click Add Google Cloud projects.
- Select the checkboxes for the names of the Google Cloud projects that you want to add to this Workspace. You don't have to select any projects.
- Click Add projects.
To add an AWS account, click Add AWS account:
Follow the instructions for connecting your AWS account.
Click Add AWS account. Monitoring connects to your AWS account.
During the connection, Stackdriver Monitoring creates an AWS connector projector project.
Repeat these steps to add another AWS account.
Adding users to a Workspace
You can share your Workspace with other users by adding them as members to the Workspaces hosting project. You must have Project > Owner permission for the host project to add more users.
To add users to your Workspace, do the following:
In the Google Cloud Console, go to the IAM & admin page:
From the list of projects, select your Workspace's host project.
At the top of the page, click Add.
In the New members box, enter a user, group, service account, or domain.
Assign a Project role to the new member: Owner, Editor, Viewer, or Browser. Click Save.
Removing a project or account from a Workspace
Removing a project, moving a project, and merging Workspaces all might result in loss of some configuration information. For example, if you move a project, group definitions aren't moved. Before taking any of theses actions, make sure you take the right action for your situation:
If you want to stop accruing charges, see Billing.
If you want to remove a host project from its Workspace or move a host project to a different Workspace, you must perform a merge. After the merge operation, your Google Cloud project is no longer a host project and therefore it can be removed from its Workspace or moved to a different Workspace.
If you want to change the Workspace associated with a Google Cloud project, move the project. For more information, see Moving a project.
If you want to move an AWS account from one Workspace to another Workspace, you must remove the AWS connector project and delete that project. You cannot use the AWS connector project with another Workspace. You can then add your AWS account to another Workspace, letting Monitoring create a new connector project. For more information, see Adding a monitored project.
If you use Stackdriver Logging, the logs are stored with the AWS connector account. The impact is that deletion of the AWS connector project also deletes the logs.
To remove a Google Cloud project or an AWS account from a Workspace, do the following:
In the Cloud Console, select Monitoring:
Select Settings.
Ensure that the proper Workspace is selected.
Click More more_vert for the Google Cloud project or an AWS account that you want to remove, click Remove from workspace.
If you removed an AWS account from a Workspace, you removed the AWS connector project, which represents the AWS account. You cannot use the AWS connector project with another Workspace. Delete the connector project.
Moving a project to a different Workspace
When you move a Google Cloud project to a different Workspace, you move the project and its metrics:
- Alerting policies and uptime checks aren't moved.
- Group definitions aren't moved but group membership might decrease in the Workspace losing the project and increase in the Workspace gaining the project.
- Dashboards and charts aren't moved. However, the content of the dashboards and charts might change in both Workspaces due to the movement of metrics.
Moving a (non-hosting) Google Cloud project
To move a non-host Google Cloud project to another Workspace, do the following:
In the Cloud Console, select Monitoring:
Select Settings.
Ensure that the proper Workspace is selected.
Click More more_vert for the Google Cloud project that you want to move, click Move to another workspace.
Select the new Workspace and click Move.
Moving a hosting project
To move the host project from a Workspace to another Workspace, follow the instructions in Merging Workspaces.
Moving an AWS account
To move an AWS account from one Workspace to another Workspace, do the following:
- Remove the AWS connector project from its Workspace by following the steps in Removing a project.
- Delete the AWS connector project.
- Add your AWS account to the desired Workspace by following the steps in Adding a monitored project.
Merging Workspaces
Merging Workspace A into Workspace B moves all the Google Cloud projects except AWS connector projects from Workspace A to Workspace B. Specifically, here is the effect of merging A into B:
All Google Cloud projects that were added to Workspace A are moved into Workspace B. Metrics for the projects are also moved into Workspace B. However, dashboards, resource groups, uptime checks, notification channels, and alerting policies aren't moved into Workspace B.
In Workspace B, existing dashboards and charts might have more data, and groups might have more members. These changes are due to the inclusion of additional metrics and are dependent on your configuration choices. In addition, uptime checks and alerting policies might be impacted.
The host project for Workspace A is added to Workspace B.
Merging is the only way to separate a host project from its Workspace.
After the merge completes, Workspace A isn't accessible.
To merge Workspaces, do the following:
In the Cloud Console, select Monitoring:
Select Settings.
Ensure that the Workspace that you want to keep is selected. In this scenario, that is Workspace B.
Click Merge.
Select the Workspace that you want to merge into Workspace B. In this scenario, select Workspace A.
Review the information that is lost during the merge. If you agree to that information loss, click Merge.
Deleting a Workspace
Before deleting a Workspace, check if the project you used to create the Workspace has resources you want to preserve, or if the Workspace is still linked to additional Google Cloud projects or AWS accounts. If so, see Merging Workspaces for a way to move resources to another place before deleting the Workspace.
If your Workspace project has no resources you want to preserve, then delete the Workspace by deleting the Workspace's host project:
In the Cloud Console, go to the IAM & admin console:
Ensure that the host project is selected in the menu bar of the Cloud Console.
Click Settings.
Click Shut Down delete.
Viewing your workspaces
To view all of your Workspaces, click Menu arrow_drop_down in the navigation panel:
- The Recent tab displays your more recently access Workspaces. You can filter and sort the display.
- The All tab displays all accessible Workspaces:
- To page through the Workspaces, use the Forward arrow_forward_ios and Backward arrow_back_ios buttons.
- To filter the list, enter a partial name or project identifier.
Troubleshooting
For information on some common issues when using Workspaces, see Troubleshooting.