Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Sadhbh a/gcp guide - WIP #25708

Open
wants to merge 60 commits into
base: master
Choose a base branch
from
Open

Sadhbh a/gcp guide - WIP #25708

wants to merge 60 commits into from

Conversation

sadhbh-a
Copy link
Contributor

What does this PR do? What is the motivation?

Merge instructions

  • Please merge after reviewing

Additional notes

@sadhbh-a sadhbh-a added the WORK IN PROGRESS No review needed, it's a wip ;) label Oct 11, 2024
@sadhbh-a sadhbh-a requested review from a team as code owners October 11, 2024 14:21
@github-actions github-actions bot added Architecture Everything related to the Doc backend Images Images are added/removed with this PR labels Oct 11, 2024
Copy link
Contributor

github-actions bot commented Oct 11, 2024

Preview links (active after the build_preview check completes)

New or renamed files

content/en/getting_started/integrations/google_cloud.md Outdated Show resolved Hide resolved
content/en/getting_started/integrations/google_cloud.md Outdated Show resolved Hide resolved
content/en/getting_started/integrations/google_cloud.md Outdated Show resolved Hide resolved
content/en/getting_started/integrations/google_cloud.md Outdated Show resolved Hide resolved
content/en/getting_started/integrations/google_cloud.md Outdated Show resolved Hide resolved
content/en/getting_started/integrations/google_cloud.md Outdated Show resolved Hide resolved
content/en/getting_started/integrations/google_cloud.md Outdated Show resolved Hide resolved
content/en/getting_started/integrations/google_cloud.md Outdated Show resolved Hide resolved
content/en/getting_started/integrations/google_cloud.md Outdated Show resolved Hide resolved
content/en/getting_started/integrations/google_cloud.md Outdated Show resolved Hide resolved
sadhbh-a and others added 19 commits October 15, 2024 12:37

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We'll be changing this later this week, may want an updated snapshot

Copy link

@dtru-ddog dtru-ddog left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Second pass of feedback

content/en/getting_started/integrations/google_cloud.md Outdated Show resolved Hide resolved
content/en/getting_started/integrations/google_cloud.md Outdated Show resolved Hide resolved
content/en/getting_started/integrations/google_cloud.md Outdated Show resolved Hide resolved

### Limit metric collection filters

Limit the GCE/GKE instances and Cloud Run revisions that are pulled into Datadog by entering tags in the **Limit Metric Collection Filters** text boxes under the **General** tab of the Google Cloud Integration tile.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@sriramkraman per our recent Metric Collection configuration convo we may want to update this, also this has been moved to the Metric Collection tab

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This has been moved to the Metric Collection lets update the naming accordingly.

Suggested change
Limit the GCE/GKE instances and Cloud Run revisions that are pulled into Datadog by entering tags in the **Limit Metric Collection Filters** text boxes under the **General** tab of the Google Cloud Integration tile.
Limit the GCE/GKE instances and Cloud Run revisions that are pulled into Datadog by entering tags in the **Limit Metric Collection Filters** text boxes under the **Metric Collection** tab of the Google Cloud Integration tile.

Screenshot 2024-12-26 at 9 35 56 AM

@buraizu buraizu requested a review from dtru-ddog November 21, 2024 17:02
3) Review these Google Cloud Prerequisites:

{{% site-region region="us,us3,us5,eu,ap1" %}}
- If your organization restricts identities by domain, you must add Datadog's customer identity `C0147pk0i` as an allowed value in your policy.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nit: can we update these dashes to be bullets?

{{% site-region region="us,us3,us5,eu,ap1" %}}
- If your organization restricts identities by domain, you must add Datadog's customer identity `C0147pk0i` as an allowed value in your policy.
{{% /site-region %}}
- Datadog does not support [scoping projects][42] that pull in metrics from multiple other projects.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is not a "prerequisite". We should instead note it as a warning.


For the most comprehensive level of monitoring in your Google Cloud environment, integrate Datadog with [Google Cloud][4] using [service account impersonation][5] at the organization or folder level.

After reviewing the above [Prerequisites][3], follow these step-by-step instructions to set up the Google Cloud integration:

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

why do we need this?

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sorry do you mean this section or this sentence?

Comment on lines 89 to 92
- Compute Viewer
- Monitoring Viewer
- Cloud Asset Viewer
- Browser

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes true but why?

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Are you suggesting adding a justification for each role assignment for the customer, would that be better served in our general docs instead of this getting started guide that's meant to be a quick onboarding?

Copy link

@dtru-ddog dtru-ddog left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Left a couple more updates, mainly around some recent UI changes we should persist on this page otherwise changes look great!

Copy link

@dtru-ddog dtru-ddog left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the changes looks great!

@buraizu buraizu requested a review from sriramkraman January 2, 2025 23:48
Copy link

@sriramkraman sriramkraman left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hey @buraizu I've taken a pass at the getting started page. Thanks for being so patient to wait for my input. I will take another pass once you are done making the changes.


## Overview

Use this guide to maximize the value of the Google Cloud integration by setting it up at the Organization or Folder level with optimized configurations and permissions.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

let's start with the why - so customers can get started monitoring their Google Cloud environment quickly.


## Overview

Use this guide to maximize the value of the Google Cloud integration by setting it up at the Organization or Folder level with optimized configurations and permissions.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

consider rephrasing the "maximize the value" to something simple like "monitor your".

Comment on lines 47 to 48
◆ The Google Cloud integration requires the below APIs to be enabled **for each of the projects** you want to monitor:

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I see we are bolding "each of the projects" but I believe this can be done at the folder level? (or maybe org level too?)

Comment on lines 64 to 66
[Google Cloud Billing API][8]
: Enables accurate billing for API calls.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't believe this is accurate based on what I see in the API. Why do we actually require it?

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

"Allows developers to manage billing for their Google Cloud Platform projects programmatically." - Are we requesting this for CCM?

[Google Cloud Billing API][8]
: Enables accurate billing for API calls.

<div class="alert alert-info">You can confirm if these APIs are enabled by heading to <a href="https://console.cloud.google.com/apis/dashboard"><b>Enabled APIs & Services</a></b> under each project in your Google Cloud workspace.</div>

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There's the "under each project" again that I think we should remove. Consider the user's predicament when they have 100s of projects.

Comment on lines 156 to 162
## Resource changes collection

Resource changes collection allows you to monitor changes in your Google Cloud environment. You receive resource events in Datadog when Google's Cloud Asset Inventory detects changes in your cloud resources. These events are forwarded to Datadog through a Cloud Pub/Sub topic and subscription.

For detailed setup instructions, see the [resource changes collection section][18] of the Google Cloud integration documentation.

**Note**: The Google Cloud service account used by the integration needs the `pubsub.subscriptions.consume` permission for the Cloud Pub/Sub topic and subscription created for this purpose.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

why are we including the notes here when we are hyperlinking to the setup instructions in the other page? Either embed both in collapsible boxes or leave out the notes also.

Comment on lines 148 to 150
## Log collection

Use the [Pub/Sub to Datadog template][14] to batch and compresses your log events before forwarding them to Datadog through [Google Cloud Dataflow][15]. This is the most network-efficient way to forward your logs.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

An opening sentence on "why" collecting logs is important and also a way to specify what type of logs (i.e non-Agent logs) should be collected this way is important for the customer's understanding.

Comment on lines 164 to 168
## Google Cloud integrations

You can send monitoring data to Datadog from 35+ integrations for Google Cloud services. The [Integrations page][19] provides a full listing of the available integrations. Many of these integrations are installed by default when Datadog recognizes data being ingested in from your Google Cloud account.

See the blog links below for deep dives into monitoring many of the more popular services.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is the most important section, let's add more details here to inform the customer how we help them get started quickly monitoring Google Cloud service.

If we have time, a single line summary for each of the integrations would be amazing -- I can help or please work with our PMM, Trammell, to help cover this section.

Tying an earlier comment - I'd like for this to be what the customer does when they wait 15 minutes for the metrics to start flowing.

Comment on lines 191 to 193
The Agent also supports a wide range of [integrations][34], enabling you to extend visibility into specific services and databases running on your hosts.

[Traces][35] collected through the Trace Agent enable comprehensive Application Performance Monitoring (APM), helping you understand end-to-end service performance.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

missing logs!

Comment on lines 202 to 204
Use the [Google Cloud Private Service Connect integration][201] to visualize connections, data transferred, and dropped packets through Private Service Connect. This gives you visibility into important metrics from your Private Service Connect connections, both for producers as well as consumers.
[Private Service Connect (PSC)][202] is a Google Cloud networking product that enables you to access [Google Cloud services][203], [third-party partner services][204], and company-owned applications directly from your Virtual Private Cloud (VPC).

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please link to the blog. I am fine if we prefer to keep this for all regions and mention in the note this is available only for US5/EU1 regions.

rationale: Customers sometimes care enough to migrate data centers (esp when just getting started)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Architecture Everything related to the Doc backend Images Images are added/removed with this PR WORK IN PROGRESS No review needed, it's a wip ;)
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants