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

[DOCS-9557] adding storage monitoring doc #26377

Merged
merged 25 commits into from
Nov 22, 2024

Conversation

rmshree
Copy link
Contributor

@rmshree rmshree commented Nov 19, 2024

What does this PR do? What is the motivation?

Add a new "private" setup guide for the Storage Monitoring product in Preview.

Merge instructions

Merge queue is enabled in this repo. To have it automatically merged after it receives the required reviews, create the PR (from a branch that follows the <yourname>/description naming convention) and then add the following PR comment:

/merge

Additional notes

@rmshree rmshree requested a review from a team as a code owner November 19, 2024 21:25
@github-actions github-actions bot added the Guide Content impacting a guide label Nov 19, 2024
@rmshree rmshree marked this pull request as draft November 19, 2024 21:27
@rmshree rmshree marked this pull request as ready for review November 19, 2024 21:27
Copy link
Contributor

Preview links (active after the build_preview check completes)

New or renamed files

@buraizu buraizu added the editorial review Waiting on a more in-depth review label Nov 19, 2024
@buraizu
Copy link
Contributor

buraizu commented Nov 19, 2024

DOCS-9557 has been created for review

@buraizu buraizu changed the title adding storage monitoring doc [DOCS-9557] adding storage monitoring doc Nov 19, 2024
Copy link
Contributor

@buraizu buraizu 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 PR! In addition to the edits requested:

  • Image files are not rendering in their current location. They will need to be moved to static/images/integrations/guide/storage_monitoring/. Note that the storage_monitoring folder will need to be created first
  • For the cloud-inventory-policies-cfn.yaml instructions, no information is provided for the Configure stack options screen. Is this intentional?

Please let me know if you have any feedback or questions!

content/en/integrations/guide/storage-monitoring-setup.md Outdated Show resolved Hide resolved
content/en/integrations/guide/storage-monitoring-setup.md Outdated Show resolved Hide resolved
content/en/integrations/guide/storage-monitoring-setup.md Outdated Show resolved Hide resolved
content/en/integrations/guide/storage-monitoring-setup.md Outdated Show resolved Hide resolved
content/en/integrations/guide/storage-monitoring-setup.md Outdated Show resolved Hide resolved
Comment on lines 100 to 104
4. Configure the following settings:
- Set a configuration name
- (Optional) Specify a source bucket prefix
- We also advise picking “Current Versions Only”
- In select destination bucket, pick the newly created destination bucket. Example, if bucket is named destination-bucket `s3://your-destination-bucket`
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
4. Configure the following settings:
- Set a configuration name
- (Optional) Specify a source bucket prefix
- We also advise picking “Current Versions Only
- In select destination bucket, pick the newly created destination bucket. Example, if bucket is named destination-bucket `s3://your-destination-bucket`
4. Configure the following settings:
- Set a configuration name
- (Optional) Specify a source bucket prefix
- **Object versions**: Datadog recommends selecting **Current Versions Only**
- **Destination**: Select the destination bucket. For example, if the bucket is named `destination-bucket`, enter `s3://your-destination-bucket`

content/en/integrations/guide/storage-monitoring-setup.md Outdated Show resolved Hide resolved
content/en/integrations/guide/storage-monitoring-setup.md Outdated Show resolved Hide resolved
content/en/integrations/guide/storage-monitoring-setup.md Outdated Show resolved Hide resolved
content/en/integrations/guide/storage-monitoring-setup.md Outdated Show resolved Hide resolved
@github-actions github-actions bot added the Images Images are added/removed with this PR label Nov 21, 2024
Copy link
Contributor

@buraizu buraizu left a comment

Choose a reason for hiding this comment

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

This review:

  • Fixes image addresses
  • Moves links within tabs (each tab needs to contain its own set of links, apologies for my mistaken suggestions in the first review)
  • Updates image widths to 90%, because currently the text on them is too small to read without expanding the image
  • Moves your email address out of the page and into the list of reference links, since our guidance on PII in public content requests that these not be added to the docs. With that said, could users just as well reach out on #storage-monitoring instead, as mentioned on line 127? If so, that would likely be the ideal approach.

Also, I'm guessing that it's intentional to not add a link to this page to the integration guides page, but let me know if that's incorrect

content/en/integrations/guide/storage-monitoring-setup.md Outdated Show resolved Hide resolved
content/en/integrations/guide/storage-monitoring-setup.md Outdated Show resolved Hide resolved
content/en/integrations/guide/storage-monitoring-setup.md Outdated Show resolved Hide resolved
content/en/integrations/guide/storage-monitoring-setup.md Outdated Show resolved Hide resolved
content/en/integrations/guide/storage-monitoring-setup.md Outdated Show resolved Hide resolved
content/en/integrations/guide/storage-monitoring-setup.md Outdated Show resolved Hide resolved
content/en/integrations/guide/storage-monitoring-setup.md Outdated Show resolved Hide resolved
content/en/integrations/guide/storage-monitoring-setup.md Outdated Show resolved Hide resolved
content/en/integrations/guide/storage-monitoring-setup.md Outdated Show resolved Hide resolved
@rmshree
Copy link
Contributor Author

rmshree commented Nov 22, 2024

Thank you Bryce! Yes it's intentional that we've not added to the integration guides page because we will be sharing this as a "private" link to interested customers and this page shouldn't be visible in search or lists.
I've also removed my personal email and replaced it with a common mailing list. I've also removed the slack handle.

content/en/integrations/guide/storage-monitoring-setup.md Outdated Show resolved Hide resolved
content/en/integrations/guide/storage-monitoring-setup.md Outdated Show resolved Hide resolved
{{% /tab %}}
{{% tab "AWS Console" %}}

To manually set up the required [Amazon S3 Inventory][2] and related configuration, follow these steps:
Copy link
Contributor

Choose a reason for hiding this comment

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

The link to Amazon S3 Inventory is broken in the preview.

1. Go to the [Amazon S3 buckets page][203] in the AWS console, and select the bucket.
2. Navigate to the bucket's **Management** tab.
3. Click **Create inventory configuration**.
4. Configure the following settings:
Copy link
Contributor

Choose a reason for hiding this comment

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

This formatting is broken in the preview. To make a nested list, each level of nesting needs to be indented by 4 spaces. Here it looks like you may have indented it only 2 sapces.

content/en/integrations/guide/storage-monitoring-setup.md Outdated Show resolved Hide resolved
@urseberry urseberry dismissed buraizu’s stale review November 22, 2024 23:22

Taking over Documentation review because Bryce is on PTO.

@urseberry
Copy link
Contributor

/merge

@dd-devflow
Copy link

dd-devflow bot commented Nov 22, 2024

Devflow running: /merge

View all feedbacks in Devflow UI.


2024-11-22 23:23:03 UTC ℹ️ MergeQueue: pull request added to the queue

The median merge time in master is 10m.

@dd-mergequeue dd-mergequeue bot merged commit a8d2b8b into master Nov 22, 2024
19 of 22 checks passed
@dd-mergequeue dd-mergequeue bot deleted the mahashree.rajendran/storage-monitoring-private branch November 22, 2024 23:31
theraffoul pushed a commit that referenced this pull request Nov 25, 2024
* adding storage monitoring doc

* add images & frontmatter

* Apply suggestions from code review

Co-authored-by: Bryce Eadie <[email protected]>

* Apply suggestions from code review

Co-authored-by: Bryce Eadie <[email protected]>

* Apply suggestions from code review

Co-authored-by: Bryce Eadie <[email protected]>

* Apply suggestions from code review

Co-authored-by: Bryce Eadie <[email protected]>

* Apply suggestions from code review

Co-authored-by: Bryce Eadie <[email protected]>

* Apply suggestions from code review

Co-authored-by: Bryce Eadie <[email protected]>

* Apply suggestions from code review

Co-authored-by: Bryce Eadie <[email protected]>

* Apply suggestions from code review

Co-authored-by: Bryce Eadie <[email protected]>

* Apply suggestions from code review

Co-authored-by: Bryce Eadie <[email protected]>

* Apply suggestions from code review

Co-authored-by: Bryce Eadie <[email protected]>

* Apply suggestions from code review

Co-authored-by: Bryce Eadie <[email protected]>

* Apply suggestions from code review

Co-authored-by: Bryce Eadie <[email protected]>

* addressing review comments

* add cost call out

* Apply suggestions from code review

Co-authored-by: Bryce Eadie <[email protected]>

* Apply suggestions from code review

Co-authored-by: Bryce Eadie <[email protected]>

* address review comments

* add single destination bucket requirement

* Apply suggestions from code review

Co-authored-by: Ursula Chen <[email protected]>

* addressing review

* line break

* line break

* fixing formatting

---------

Co-authored-by: Bryce Eadie <[email protected]>
Co-authored-by: Ursula Chen <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
editorial review Waiting on a more in-depth review Guide Content impacting a guide Images Images are added/removed with this PR mergequeue-status: done
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants