Skip to content

Commit 81d781c

Browse files
Merge pull request #2744 from splunk/urbiz-OD7195-gcp-wif-updates
[7195]: GCP - Improve WIF steps
2 parents b113a4d + 93a2996 commit 81d781c

File tree

1 file changed

+77
-24
lines changed

1 file changed

+77
-24
lines changed

gdi/get-data-in/connect/gcp/gcp-connect.rst

Lines changed: 77 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ Connect to Google Cloud Platform: Guided setup and other options
55
*********************************************************************
66

77
.. meta::
8-
:description: Connect your Google Cloud Platform / GCP account to Splunk Observability Cloud.
8+
:description: Connect your Google Cloud Platform / GCP account to Splunk Observability Cloud.
99

1010
You can connect your GCP account and send data to Splunk Observability Cloud with the following methods:
1111

@@ -28,7 +28,7 @@ Follow these steps to connect to GCP:
2828

2929
.. _gcp-one:
3030

31-
1. Define a role for your GCP service account
31+
1. Define a role for your GCP principal
3232
--------------------------------------------------------------------------------------
3333

3434
Use GCP's :strong:`Viewer` role as it comes with the permissions you need for most scenarios.
@@ -37,7 +37,7 @@ To customize the permissions for your role refer to :ref:`gcp-prereqs-role-permi
3737

3838
.. _gcp-two:
3939

40-
2. Configure GCP
40+
2. Configure your GCP services
4141
--------------------------------------------------------------------------------------
4242

4343
To configure your GCP service:
@@ -52,60 +52,113 @@ To configure your GCP service:
5252

5353
.. _gcp-three:
5454

55-
3. Connect to Splunk Observability Cloud and start the integration
55+
3. Connect your GCP services to Splunk Observability Cloud and start the integration
5656
--------------------------------------------------------------------------------------
5757

58-
By default, Splunk Observability Cloud monitors all supported services, and any new services added later are also monitored. When you set integration parameters, you can choose to import metrics from a subset of the available services.
58+
By default, Splunk Observability Cloud monitors all supported services, and any new services added later are also monitored. When you set the parameters for your integration you can choose to import metrics from a subset of the available services.
5959

60-
1. Log in to Splunk Observability Cloud and open the :new-page:`Google Cloud Platform guided setup <https://login.signalfx.com/#/integrations/gcp>`. Optionally, you can navigate to the guided setup on your own:
60+
.. note:: Splunk is not responsible for data availability, and it can take up to several minutes (or longer, depending on your configuration) from the time you connect until you start seeing valid data from your account.
61+
62+
Log in to Splunk Observability Cloud and open the :new-page:`Google Cloud Platform guided setup <https://login.signalfx.com/#/integrations/gcp>`. Optionally, you can navigate to the guided setup on your own:
63+
64+
#. In the left navigation menu, select :menuselection:`Data Management`.
65+
66+
#. Go to the :guilabel:`Available integrations` tab, or select :guilabel:`Add Integration` in the :guilabel:`Deployed integrations` tab.
67+
68+
#. In the integration filter menu, select :guilabel:`By Use Case`, and select the :guilabel:`Monitor Infrastructure` use case.
69+
70+
#. In the :guilabel:`Cloud Integrations` section, select the :guilabel:`Google Cloud Platform` tile to open the Google Cloud Platform guided setup.
71+
72+
Authenticate with Workload Identity Federation (WIF)
73+
++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
74+
75+
1. In the wizard, select Workload Identity Federation (WIF) as the authentication method.
6176

62-
#. In the left navigation menu, select :menuselection:`Data Management`.
77+
2. Continue to define the connection with GCP:
78+
79+
* Poll rate. Select the rate (in seconds) at which you want Splunk Observability Cloud to poll GCP for metric data, with 1 minute as the minimum unit, and 10 minutes as the maximum unit. For example, a value of 300 polls metrics once every 5 minutes.
80+
81+
* Specify if you want to use quota from the project where metrics are stored. See more at :ref:`gcp-quota`.
82+
83+
* Note that GCP metadata is automatically imported.
84+
85+
3. Prepare your GCP account following the steps on the UI.
6386

64-
#. Go to the :guilabel:`Available integrations` tab, or select :guilabel:`Add Integration` in the :guilabel:`Deployed integrations` tab.
87+
4. Establish the connection:
6588

66-
#. In the integration filter menu, select :guilabel:`By Use Case`, and select the :guilabel:`Monitor Infrastructure` use case.
89+
* Name your integration.
6790

68-
#. In the :guilabel:`Cloud Integrations` section, select the :guilabel:`Google Cloud Platform` tile to open the Google Cloud Platform guided setup.
91+
* Import your WIF configuration. Learn more at :ref:`gcp-prereqs-authenticate`.
92+
93+
* Add your projects.
6994

70-
2. Complete the following fields:
95+
* Select your access token.
7196

72-
* Name. Type in the name of the GCP integration.
97+
5. Select the data to import:
7398

74-
* Project. Select :guilabel:`Add Project` to add a new project and follow the prompts to authenticate it. For more details, see :ref:`gcp-prereqs-authenticate`.
99+
* Specify which GCP services you want to monitor.
100+
101+
* Optionally you can import additional data. See more at :ref:`gcp-additional-data`.
75102

76-
* Services. By default the new integration syncs with all supported GCP services. Select :guilabel:`All services > Sync only selected services` to select specific services to sync with.
103+
Your GCP integration is now complete!
77104

105+
Authenticate with Service Account keys
106+
++++++++++++++++++++++++++++++++++++++++++++++++
107+
108+
1. In the wizard, select Service Account keys as the authentication method.
109+
110+
2. Continue to define the connection with GCP:
111+
78112
* Poll rate. Select the rate (in seconds) at which you want Splunk Observability Cloud to poll GCP for metric data, with 1 minute as the minimum unit, and 10 minutes as the maximum unit. For example, a value of 300 polls metrics once every 5 minutes.
79113

80-
* Specify data to import: Metadata and/or metrics.
114+
* Specify if you want to use quota from the project where metrics are stored. See more at :ref:`gcp-quota`.
81115

82-
* Specify if you want to use quota from the project where metrics are stored. See :ref:`gcp-quota` for more information.
116+
* Note that GCP metadata is automatically imported.
83117

84-
3. Optional fields:
118+
3. Prepare your GCP account following the steps on the UI.
85119

86-
* Custom Metric Type Domains. To list any additional GCP service domain names that you want to monitor, use commas to separate domain names in the :strong:`Custom Metric Type Domains` field. For example, to obtain Apigee metrics, add ``apigee.googleapis.com``.
120+
4. Establish the connection:
87121

88-
- For information on the available GCP metric domains refer to the official GCP docs at :new-page:`Google Cloud metrics <https://cloud.google.com/monitoring/api/metrics_gcp>`.
122+
* Name your integration.
89123

90-
- To learn about custom metric type domain syntax, see :new-page:`Custom metric type domain examples <https://dev.splunk.com/observability/docs/integrations/gcp_integration_overview#Custom-metric-type-domain-examples>` in the Splunk developer documentation.
124+
* Project. Select :guilabel:`Import service account keys` to add a new project. Your project's ID is automatically extracted from the imported file. Follow the prompts to authenticate it. For more details, see :ref:`gcp-prereqs-authenticate`.
91125

92-
* Compute Metadata Included List. If you select Compute Engine as one of the services to monitor, you can enter a comma-separated list of Compute Engine Instance metadata keys to send as properties. These metadata keys are sent as properties named ``gcp_metadata_<metadata-key>``.
126+
* Select your access token.
93127

94-
Your GCP integration is now complete.
128+
5. Select the data to import.
95129

96-
.. note:: Splunk is not responsible for data availability, and it can take up to several minutes (or longer, depending on your configuration) from the time you connect until you start seeing valid data from your account.
130+
* Specify which GCP services you want to monitor.
131+
132+
* Optionally you can import additional data. See more at :ref:`gcp-additional-data`.
133+
134+
Your GCP integration is now complete!
97135

98136
.. _gcp-quota:
99137

100138
Use a single principal for your resources
101-
++++++++++++++++++++++++++++++++++++++++++++++++
139+
--------------------------------------------------------------------------------------
102140

103141
In IAM you can grant access to your resources to one or more entities called principals, regardless of the authentication method (single Service Account or Workload Identity Federation).
104142

105143
If you're using a single principal for multiple projects, GCP tracks all API usage quota in the project where the principal originates from, which can result in throttling in your integration. To mitigate this, select :strong:`Use quota from the project where metrics are stored`. To use this option the principal provided for the project needs either the ``serviceusage.services.use`` permission or the Service Usage Consumer role.
106144

107145
For a more detailed description see :new-page:`Principals <https://cloud.google.com/iam/docs/overview#concepts_related_identity>` in GCP's docs.
108146

147+
.. _gcp-additional-data:
148+
149+
Import additional data
150+
--------------------------------------------------------------------------------------
151+
152+
On step 5 of the guided set-up you can configure the import of the following additional data:
153+
154+
* Custom metric type domains. To list any additional GCP service domain names that you want to monitor, use commas to separate domain names in the :strong:`Custom Metric Type Domains` field. For example, to obtain Apigee metrics, add ``apigee.googleapis.com``.
155+
156+
- For information on the available GCP metric domains refer to the official GCP docs at :new-page:`Google Cloud metrics <https://cloud.google.com/monitoring/api/metrics_gcp>`.
157+
158+
- To learn about custom metric type domain syntax, see :new-page:`Custom metric type domain examples <https://dev.splunk.com/observability/docs/integrations/gcp_integration_overview#Custom-metric-type-domain-examples>` in the Splunk developer documentation.
159+
160+
* Compute metadata included list. If you select Compute Engine as one of the services to monitor, you can enter a comma-separated list of Compute Engine Instance metadata keys to send as properties. These metadata keys are sent as properties named ``gcp_metadata_<metadata-key>``.
161+
109162
Alternatives to connect to GCP
110163
============================================
111164

0 commit comments

Comments
 (0)