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 52 commits into
base: master
Choose a base branch
from
Open

Sadhbh a/gcp guide - WIP #25708

wants to merge 52 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
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.

Did a first pass with a few comments, let me know if you want to review

Choose a reason for hiding this comment

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

This image is going to change relatively soon with the Resource Change input modification cc @sriramkraman

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
- If your organization restricts identities by domain, you must add Datadog's customer identity `C0147pk0i` as an allowed value in your policy.
{{% /site-region %}}

- Ensure that any projects being monitored are **not** configured as [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.

I would like to say to customers we don't support scoping projects as we are rolling out this change. How do we change this framing so it doesn't sound like they (customers) have to take some action to confirm (which is the current status quo) to the future model of scoping projects simply aren't supported. (i.e that we will only pull metrics from the project itself and not any metric scopes)

cc @dtru-ddog

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Would something like this work?

  • Datadog does not support scoping projects that pull in metrics from multiple other projects. Only metrics from the project itself will be ingested

Comment on lines +66 to +67
[Google Cloud Billing API][12]
: 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.

@dtru-ddog what do we use this for?

Choose a reason for hiding this comment

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

We need to have a customer to enable that so that Google can bill the customer for the API calls we'll be making


## Setup

Integrate Datadog with [Google Cloud][4] using [service account impersonation][5] and project discovery. This enables Datadog to automatically discover and monitor new projects as they are created within the assigned scope, providing seamless monitoring as your Google Cloud environment grows.

Choose a reason for hiding this comment

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

I like the organization here but it's essentially a copy of the setup instructions in Google Cloud setup page. That's not useful as an opinionated Getting Started guide. Consider instead telling customers how they can give Datadog broad access to their entire Google Cloud environment.

Copy link
Contributor

Choose a reason for hiding this comment

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

Updated in e66f3b8, but I don't have a sandbox organization to confirm the steps. Is there one available for testing?

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

## Metric collection

The Google Cloud integration collects [**all GA Google Cloud metrics**][17] from your projects through the Google Cloud Monitoring API.

Choose a reason for hiding this comment

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

it turns out we do collect all Beta metrics that are available. Do we still want to say we collect "GA" metrics?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

How does "The Google Cloud integration collects all available Google Cloud metrics from your projects through the Google Cloud Monitoring API." sound to you?

Comment on lines 238 to 240
The [Integrations page][26] provides a full listing of the available sub-integrations for Google Cloud.
Many of these integrations are installed by default when Datadog recognizes data being ingested in from your Google Cloud account.

Choose a reason for hiding this comment

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

Please don't call them "sub-" integrations. They are integrations for Google Cloud services. I would recommend saying we have 35+ integrations for Google Cloud services including BigQuery, ... (and link to blogs)

Copy link
Contributor

Choose a reason for hiding this comment

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

Updated in e66f3b8, thanks in advance for any additional feedback

Comment on lines 228 to 229
Forward logs from your Google Cloud services to Datadog using [Google Cloud Dataflow][21] and the [Datadog template][22]. This method provides both compression and batching of events before they are forwarded to Datadog.

Choose a reason for hiding this comment

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

Start each section with a brief "why". Let me know if I can help point to feature blogs that speak to the value proposition.

https://www.datadoghq.com/blog/stream-logs-datadog-dataflow-template/

Choose a reason for hiding this comment

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

A link to the blog would be helpful @sriramkraman

Copy link
Contributor

Choose a reason for hiding this comment

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

Updated in e66f3b8, thanks in advance for any additional 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

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
2) Set up a [Service Account][2] in any of your Google Cloud projects
3) Review these Google Cloud Prerequisites:

{{% site-region region="us,us3,us5,eu,ap1" %}}

Choose a reason for hiding this comment

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

dope


## Setup

For simplicity of setup, and to ensure there are no gaps in your monitoring, integrate Datadog with [Google Cloud][4] using [service account impersonation][5] at the organization or folder level.

Choose a reason for hiding this comment

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

nit: sentence seems a bit wordy

Copy link
Contributor

Choose a reason for hiding this comment

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

Updated in 0493d54


The Google Cloud integration collects all available [Google Cloud metrics][17] from your projects through the Google Cloud Monitoring API.

{{% collapse-content title="Click here for a sample of the Google Cloud metrics Datadog collects" level="h5" %}}

Choose a reason for hiding this comment

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

Is there a way to have this table be centralized since we have the same content on the README md and I can see opportunities for this to get out of sync

Copy link
Contributor

Choose a reason for hiding this comment

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

Good idea, added a shortcode in bb8b1cf that we can use to render this table on multiple pages


### 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

@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?

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?

Comment on lines +95 to +96
**Note**: The `Browser` role is only required in the default project of the service account. Other projects require only the other listed roles.
{{% /collapse-content %}}

Choose a reason for hiding this comment

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

What is "default" project here? (Would a customer know?)

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