Google Cloud Platform - GCP API Extractor

Before you configure and run the ETL, complete the pre-configuration tasks. The ETL uses the service account key files to collect data from your Google Cloud Platform project resources.

You can create a service account in one of the following ways:

• Create a single service account and share it across multiple GCP projects.
• Create a separate service account for each GCP project.

Depending on how you create your service account, select a tab, and complete the steps:

You must configure the ETL to connect to GCP for data collection. ETL configuration includes specifying the basic and optional advanced properties. While configuring the basic properties is sufficient, you can optionally configure the advanced properties for additional customization.

A. Configuring the basic properties

Some of the basic properties display default values. You can modify these values if required.

To configure the basic properties:

1. Navigate to Administration > ETL & System Tasks > and select ETL tasks.
2. On the ETL tasks page, click Add > Add ETL under the Last run tab. The Add ETL page displays the configuration properties. You must configure properties in the following tabs: Run configuration, Entity catalog, and Google Cloud configuration
3. On the Run configuration tab, select Google Cloud Platform - GCP API Extractor from the ETL module list. The name of the ETL is displayed in the ETL task name field. You can edit this field to customize the name.
4. Click the Entity catalog tab, and select one of the following options:
   
   • Shared Entity Catalog: Select if other ETLs access the same entities that are used by the GCP API ETL.
     • From the Sharing with Entity Catalog list, select the entity catalog name that is shared between ETLs.
   • Private Entity Catalog: Select if this is the only ETL that extracts data from the GCP resources.

5. Click the Google Cloud configuration tab, and configure the following properties:

6. (Optional) Override the default values of properties in the following tabs:

   Run configuration

   Object relationships

   ETL task properties

7. Click Save.
   The details of the newly configured GCP API ETL are displayed.

(Optional) B. Configuring the advanced properties

You can configure the advanced properties to change the way the ETL works or to collect additional metrics.

To configure the advanced properties:

1. On the Add ETL page, click Advanced.

2. Configure the following properties:

   Run configuration

   Collection level

   Additional properties

   Loader configuration

   Scheduling options

3. Click Save.
   The details of the newly configured GCP API ETL are displayed.

After you configure the ETL, you can run it to collect data. You can run the ETL in the following modes:

A. Simulation mode: Only validates connection to the data source, does not collect data. Use this mode when you want to run the ETL for the first time or after you make any changes to the ETL configuration.

B. Production mode: Collects data from the data source.

A. To run the ETL in the simulation mode

To run the ETL in the simulation mode:

1. Navigate to Administration > ETL & System Tasks, and select ETL tasks.
2. On the ETL tasks page, click the ETL. The ETL details are displayed.
   
   
   
3. In the Run configurations table, click Edit  to modify the ETL configuration settings.
4. On the Run configuration tab, ensure that the Execute in simulation mode option is set to Yes, and click Save.
5. Click Run active configuration. A confirmation message about the ETL run job submission is displayed.
6. On the ETL tasks page, check the ETL run status in the Last exit column.
   OK Indicates that the ETL ran without any error. You are ready to run the ETL in the production mode.
7.  If the ETL run status is Warning, Error, or Failed:
   1. On the ETL tasks page, clickin the last column of the ETL name row.
   2. Check the log and reconfigure the ETL if required.
   3. Run the ETL again.
   4. Repeat these steps until the ETL run status changes to OK.

B. To run the ETL in the production mode

You can run the ETL manually when required or schedule it to run at a specified time.

To run the ETL manually

1. On the ETL tasks page, click the ETL. The ETL details are displayed.
2. In the Run configurations table, click Edit  to modify the ETL configuration settings. The Edit run configuration page is displayed.
3. On the Run configuration tab, select No for the Execute in simulation mode option, and click Save.
4. To run the ETL immediately, click Run active configuration. A confirmation message about the ETL run job submission is displayed.
   When the ETL runs, it collects data from the source and transfers it to the BMC Helix Continuous Optimization database.

To schedule the ETL run in the production mode

By default, the ETL is scheduled to run daily. You can customize this schedule by changing the frequency and period of running the ETL.

To configure the ETL run schedule:

1. On the ETL tasks page, click the ETL, and click Edit task. The ETL details are displayed.
   
2. On the Edit task page, do the following, and click Save:
   • Specify a unique name and description for the ETL task.
   • In the Maximum execution time before warning field, specify the duration for which the ETL must run before generating warnings or alerts, if any.
   • Select a predefined or custom frequency for starting the ETL run. The default selection is Predefined.
   • Select the task group and the scheduler to which you want to assign the ETL task.
3. Click Schedule. A message confirming the scheduling job submission is displayed.
   When the ETL runs as scheduled, it collects data from the source and transfers it to the BMC Helix Continuous Optimization database.

Verify that the ETL ran successfully and check whether the GCP data is refreshed in the Workspace.

To verify whether the ETL ran successfully

1. Click Administration > ETL and System Tasks > ETL tasks.
2. In the Last exec time column corresponding to the ETL name, verify that the current date and time are displayed.
3. In the Last exit column corresponding to the ETL name, verify that the status is OK.
   In case of WARNING or ERROR, click in the last column of the ETL name row to review the log files.

To verify that the GCP data is refreshed:

1. In the Workspace tab, expand (domain name) > Business Services > (system name) > Instances.
2. In the left pane, verify that the hierarchy displays your new and updated GCP instances.
3. Click a GCP virtual machine instance, and click the Metrics tab in the right pane.
4. Check if the Last Activity column in the Configuration data and Performance metrics tables displays the current date.

To learn more about these metrics and other related concepts, see Entities-lookup-information-and-metrics-for-Google-Cloud-Platform. To collect additional data such as metrics and logs from third-party applications, see Collecting-additional-metrics-using-the-Stackdriver-monitoring.