Update Billing.md by ellis-elastic · Pull Request #3584 · elastic/integrations

ellis-elastic · 2022-06-24T11:03:44Z

added new content based on the new documentation guidelines.

Type of change

Enhancement

What does this PR do?

added new content based on the new documentation guidelines.
This PR adds more context the AWS integration including:

Adds context to the "Overview" including a link to the relevant AWS page and an example
Lists the types of "Data streams" for the service
"Requirements" points back to "AWS" for detailed information on credentials and permissions
"Requirements" includes any other service-specific requirements
"Setup" establishes a relationship between the AWS integration/package ("AWS") and this integration
Includes "Reference" sections

Checklist

I have reviewed tips for building integrations and this pull request is aligned with them.
I have verified that all data streams collect metrics or logs.
I have added an entry to my package's changelog.yml file.
I have verified that Kibana version constraints are current according to guidelines.

Author's Checklist

Review by docs team
Review by integrations team

How to test this PR locally

Related issues

Update integration docs for individual AWS/Amazon services #3572

Screenshots

added new content based on the new documentation guidelines.

elasticmachine · 2022-06-24T11:15:29Z

💔 Build Failed

the below badges are clickable and redirect to their specific view in the CI or DOCS

Expand to view the summary

Build stats

Start Time: 2022-07-22T14:31:42.003+0000
Duration: 10 min 27 sec

Steps errors

Expand to view the steps failures

`Check integration: aws`

Took 0 min 3 sec . View more details here
Description: ../../build/elastic-package check -v

`Google Storage Download`

Took 0 min 0 sec . View more details here

🤖 GitHub comments

To re-run your PR in the CI, just comment with:

/test : Re-trigger the build.

ellis-elastic · 2022-06-24T11:24:37Z

We weren’t sure if AWS billing collected logs or metrics. We assumed it was logs. And we weren’t sure about the elastic-package build stage. We ran it on the integrations/packages/AWS folder.

elasticmachine · 2022-06-24T11:38:29Z

🌐 Coverage report

Name	Metrics % (`covered/total`)	Diff
Packages	100.0% (`11/11`)	💚
Files	91.667% (`11/12`)	👎 -5.392
Classes	91.667% (`11/12`)	👎 -5.392
Methods	82.692% (`172/208`)	👎 -6.558
Lines	92.894% (`2157/2322`)	👍 2.311
Conditionals	100.0% (`0/0`)	💚

This reverts commit c0fda79.

ellis-elastic · 2022-06-24T13:07:13Z

I ran build but got an error

1. item [.DS_Store] is not allowed in folder [/Users/cex/Documents/GitHub-elastic/integrations/build/packages/aws/1.16.7/data_stream]
   2. item [.DS_Store] is not allowed in folder [/Users/cex/Documents/GitHub-elastic/integrations/build/packages/aws/1.16.7/data_stream/billing]
   3. item [.DS_Store] is not allowed in folder [/Users/cex/Documents/GitHub-elastic/integrations/build/packages/aws/1.16.7/kibana]

So I've not not run build.

packages/aws/_dev/build/docs/billing.md

Co-authored-by: Colleen McGinnis <colleen.j.mcginnis@gmail.com>

This reverts commit 3868827.

…ations into aws-billing

Co-authored-by: Colleen McGinnis <colleen.j.mcginnis@gmail.com>

added details on the metrics collected

ran build

ellis-elastic · 2022-06-27T10:33:01Z

I resolved the build issue with some help from Coleen

packages/aws/_dev/build/docs/billing.md

Co-authored-by: Brandon Morelli <bmorelli25@gmail.com>

packages/aws/docs/billing.md

Co-authored-by: kaiyan-sheng <kaiyan.sheng@elastic.co>

Removed overview heading

Fixed duplicated word

elasticmachine · 2022-07-29T18:23:49Z

💔 Build Failed

the below badges are clickable and redirect to their specific view in the CI or DOCS

Expand to view the summary

Build stats

Start Time: 2022-07-29T18:13:23.180+0000
Duration: 10 min 11 sec

Steps errors

Expand to view the steps failures

`Check integration: aws`

Took 0 min 3 sec . View more details here
Description: ../../build/elastic-package check -v

`Google Storage Download`

Took 0 min 0 sec . View more details here

🤖 GitHub comments

To re-run your PR in the CI, just comment with:

/test : Re-trigger the build.

* Update Readme - First draft of AWS integration edits (#3834) Added new content based on the new documentation guidelines * Update WAF - First draft of AWS integration edits (#3833) Added new content based on the new documentation guidelines. * Update VPN.MD First draft of AWS integration edits (#3828) * Update VPN.MD First draft of AWS integration edits Added new content based on the new documentation guidelines. * fixed typo Removed space and duplicated for example * Update vpcflow,md First draft of AWS integration edits (#3826) Added new content based on the new documentation guidelines. * Update AWS Usage - First draft of AWS integration edits (#3824) * Update AWS Usage - First draft of AWS integration edits Added new content based on the new documentation guidelines. * Fixed typo removed a space * Update AWS transit gateway - first draft of AWS integration edits (#3810) added new content based on the new documentation guidelines. * Update SQS First draft of AWS integration edits (#3809) Added new content based on the new documentation guidelines. * Update SNS - First draft of AWS integration edits (#3808) * Update S3 storage lens- First draft of AWS integration edits (#3806) * update S3 - first draft of AWS integration edits (#3804) Added new content based on the new doc guidelines * Update Route 53 - First draft of AWS integration edits (#3756) * update Route 53 - first draft of AWS integration edits Added new content based on the new documentation guidelines * Fixed typo Added missing full stop * Update RDS - first draft of AWS integration edits (#3752) Added new content based on the new documentation guidelines * Update Nat gateway - first draft of AWS integration edits (#3751) Added new content based on the new documentation guidelines * Update Lambda - first draft of AWS integration edits (#3749) * update Lambda - first draft of AWS integration edits Added new content based on the new documentation guidelines * Fix typos in Lambda.md * Update Network Firewall - added new content based on the new doc guidelines (#3732) * Update Network Firewall - added new content based on the new documentation guidelines. * Update Manifest and Changelog * Ran build * revert cl/mani Co-authored-by: bmorelli25 <brandon.morelli@elastic.co> * Update ELB - first draft of AWS integration edits (#3656) * Update ELB - first draft of AWS integration edits Added new content based on the new documentation guidelines. * update changelog and manifest * update elb ran build * revert cl/mani Co-authored-by: bmorelli25 <brandon.morelli@elastic.co> * Update EC2 - first draft of AWS integration edits (#3638) * Update EC2 - first draft of AWS integration edits Added new content based on the new documentation guidelines. * Update Changelog and Manifest * update ec2.md ran build * Update packages/aws/_dev/build/docs/ec2.md Co-authored-by: Colleen McGinnis <colleen.j.mcginnis@gmail.com> * Update packages/aws/_dev/build/docs/ec2.md Co-authored-by: Colleen McGinnis <colleen.j.mcginnis@gmail.com> * Update packages/aws/_dev/build/docs/ec2.md Co-authored-by: Colleen McGinnis <colleen.j.mcginnis@gmail.com> * Update packages/aws/_dev/build/docs/ec2.md Co-authored-by: Colleen McGinnis <colleen.j.mcginnis@gmail.com> * Update packages/aws/_dev/build/docs/ec2.md Co-authored-by: Colleen McGinnis <colleen.j.mcginnis@gmail.com> * revert cl/mani Co-authored-by: Colleen McGinnis <colleen.j.mcginnis@gmail.com> Co-authored-by: bmorelli25 <brandon.morelli@elastic.co> * Update EBS- first draft of AWS integration edits (#3634) * Update EBS- first draft of AWS integration edits Added new content based on the new documentation guidelines. * Update Changelog and Manifest * Ran elastic-pacakge build * Update packages/aws/_dev/build/docs/ebs.md Co-authored-by: Colleen McGinnis <colleen.j.mcginnis@gmail.com> * Update packages/aws/_dev/build/docs/ebs.md Co-authored-by: Colleen McGinnis <colleen.j.mcginnis@gmail.com> * Update packages/aws/_dev/build/docs/ebs.md Co-authored-by: Colleen McGinnis <colleen.j.mcginnis@gmail.com> * Update packages/aws/_dev/build/docs/ebs.md Co-authored-by: Colleen McGinnis <colleen.j.mcginnis@gmail.com> * Update packages/aws/_dev/build/docs/ebs.md Co-authored-by: Colleen McGinnis <colleen.j.mcginnis@gmail.com> * Update packages/aws/_dev/build/docs/ebs.md Co-authored-by: Colleen McGinnis <colleen.j.mcginnis@gmail.com> * Update packages/aws/_dev/build/docs/ebs.md Co-authored-by: Colleen McGinnis <colleen.j.mcginnis@gmail.com> * revert cl/mani Co-authored-by: Colleen McGinnis <colleen.j.mcginnis@gmail.com> Co-authored-by: bmorelli25 <brandon.morelli@elastic.co> * Update DynamoDB- first draft of AWS integration edits (#3633) * Update Dynamodb - first draft of aws integration edits Added new content based on the new documentation guidelines. * Update Changelog and Manifest * Ran build, updated changelog and manifest * Update packages/aws/_dev/build/docs/dynamodb.md Co-authored-by: Brandon Morelli <bmorelli25@gmail.com> * Update dynamoDB Re worded the example para in light of reviewers comments * Ran elastic package build * revert cl/mani Co-authored-by: Brandon Morelli <bmorelli25@gmail.com> Co-authored-by: bmorelli25 <brandon.morelli@elastic.co> * Update CloudTrail - First draft of AWS integration edits (#3611) * Update CloudTrail - first draft of aws integration edits Added new content based on the new documentation guidelines. * Update CouldTrail - fixed typo Changed Cloudtrail to CloudTrail * Update Changelog and manifest * Ran Build * Update packages/aws/_dev/build/docs/cloudtrail.md Co-authored-by: Colleen McGinnis <colleen.j.mcginnis@gmail.com> * Update packages/aws/_dev/build/docs/cloudtrail.md Co-authored-by: Colleen McGinnis <colleen.j.mcginnis@gmail.com> * Update packages/aws/_dev/build/docs/cloudtrail.md Co-authored-by: Colleen McGinnis <colleen.j.mcginnis@gmail.com> * Update packages/aws/_dev/build/docs/cloudtrail.md Co-authored-by: Colleen McGinnis <colleen.j.mcginnis@gmail.com> * Updated note section Updated note section in light on Coleen's comments * Re ran build * Update packages/aws/_dev/build/docs/cloudtrail.md Co-authored-by: Brandon Morelli <bmorelli25@gmail.com> * Update packages/aws/_dev/build/docs/cloudtrail.md Co-authored-by: Brandon Morelli <bmorelli25@gmail.com> * Update packages/aws/_dev/build/docs/cloudtrail.md Co-authored-by: Brandon Morelli <bmorelli25@gmail.com> * revert cl/mani Co-authored-by: Colleen McGinnis <colleen.j.mcginnis@gmail.com> Co-authored-by: Brandon Morelli <bmorelli25@gmail.com> Co-authored-by: bmorelli25 <brandon.morelli@elastic.co> * Update Billing.md (#3584) * update Billing.md added new content based on the new documentation guidelines. * Update Changelog, manifest and ran build * Revert "Update Changelog, manifest and ran build" This reverts commit c0fda79. * Update changelog and manifest * Update Billing.md * Update packages/aws/_dev/build/docs/billing.md Co-authored-by: Colleen McGinnis <colleen.j.mcginnis@gmail.com> * Update packages/aws/_dev/build/docs/billing.md Co-authored-by: Colleen McGinnis <colleen.j.mcginnis@gmail.com> * Revert "Update Billing.md" This reverts commit 3868827. * Update packages/aws/_dev/build/docs/billing.md Co-authored-by: Colleen McGinnis <colleen.j.mcginnis@gmail.com> * Update packages/aws/_dev/build/docs/billing.md Co-authored-by: Colleen McGinnis <colleen.j.mcginnis@gmail.com> * Update packages/aws/_dev/build/docs/billing.md Co-authored-by: Colleen McGinnis <colleen.j.mcginnis@gmail.com> * Update packages/aws/_dev/build/docs/billing.md Co-authored-by: Colleen McGinnis <colleen.j.mcginnis@gmail.com> * update billing added details on the metrics collected * update billing ran build * fix changelog formatting * Update packages/aws/_dev/build/docs/billing.md Co-authored-by: Brandon Morelli <bmorelli25@gmail.com> * Update packages/aws/docs/billing.md Co-authored-by: kaiyan-sheng <kaiyan.sheng@elastic.co> * Update Billing.md Removed overview heading * Update changelog and ran build * Update Billing Fixed duplicated word * revert cl/mani Co-authored-by: Colleen McGinnis <colleen.j.mcginnis@gmail.com> Co-authored-by: Brandon Morelli <bmorelli25@gmail.com> Co-authored-by: kaiyan-sheng <kaiyan.sheng@elastic.co> Co-authored-by: bmorelli25 <brandon.morelli@elastic.co> * get it passing ci * update docs * Revert "Update Readme - First draft of AWS integration edits (#3834)" This reverts commit 76eaca3. * Update packages/aws/_dev/build/docs/natgateway.md Co-authored-by: Colleen McGinnis <colleen.mcginnis@elastic.co> * Update packages/aws/_dev/build/docs/vpcflow.md Co-authored-by: Colleen McGinnis <colleen.mcginnis@elastic.co> * Update packages/aws/_dev/build/docs/vpcflow.md Co-authored-by: Colleen McGinnis <colleen.mcginnis@elastic.co> * Update packages/aws/_dev/build/docs/waf.md Co-authored-by: Colleen McGinnis <colleen.mcginnis@elastic.co> * Update packages/aws/_dev/build/docs/vpcflow.md Co-authored-by: Colleen McGinnis <colleen.mcginnis@elastic.co> * Update packages/aws/_dev/build/docs/s3.md Co-authored-by: Colleen McGinnis <colleen.mcginnis@elastic.co> * Update packages/aws/_dev/build/docs/rds.md Co-authored-by: Colleen McGinnis <colleen.mcginnis@elastic.co> * Update packages/aws/_dev/build/docs/elb.md Co-authored-by: Colleen McGinnis <colleen.mcginnis@elastic.co> * Apply suggestions from code review * Update packages/aws/_dev/build/docs/ebs.md * Update packages/aws/_dev/build/docs/ec2.md Co-authored-by: Colleen McGinnis <colleen.mcginnis@elastic.co> * feedback * feedback * Apply suggestions from code review Co-authored-by: Colleen McGinnis <colleen.mcginnis@elastic.co> * feedback * `elastic-package build` * Update packages/aws/docs/ebs.md Co-authored-by: Colleen McGinnis <colleen.mcginnis@elastic.co> * `elastic-package build` * docs: address feedback * `elastic-package build` * address more feedback * more feedback * address feedback Co-authored-by: Ellis Pratt <103435263+ellis-elastic@users.noreply.github.com> Co-authored-by: Colleen McGinnis <colleen.j.mcginnis@gmail.com> Co-authored-by: kaiyan-sheng <kaiyan.sheng@elastic.co> Co-authored-by: Colleen McGinnis <colleen.mcginnis@elastic.co>

update Billing.md

5492c0d

added new content based on the new documentation guidelines.

ellis-elastic added documentation Improvements or additions to documentation. Applied to PRs that modify *.md files. enhancement New feature or request labels Jun 24, 2022

ellis-elastic requested a review from a team as a code owner June 24, 2022 11:03

ellis-elastic assigned bmorelli25 Jun 24, 2022

Update Changelog, manifest and ran build

c0fda79

ellis-elastic added 2 commits June 24, 2022 13:52

Revert "Update Changelog, manifest and ran build"

4ea5b11

This reverts commit c0fda79.

Update changelog and manifest

2a4d25e

ellis-elastic requested a review from a team June 24, 2022 13:05

colleenmcginnis reviewed Jun 24, 2022

View reviewed changes

colleenmcginnis mentioned this pull request Jun 24, 2022

Update integration docs for individual AWS/Amazon services #3572

Closed

24 tasks

kaiyan-sheng reviewed Jun 24, 2022

View reviewed changes

packages/aws/_dev/build/docs/billing.md Outdated Show resolved Hide resolved

kaiyan-sheng reviewed Jun 24, 2022

View reviewed changes

packages/aws/_dev/build/docs/billing.md Outdated Show resolved Hide resolved

ellis-elastic and others added 11 commits June 27, 2022 09:59

Update Billing.md

3868827

Update packages/aws/_dev/build/docs/billing.md

6bfde6b

Co-authored-by: Colleen McGinnis <colleen.j.mcginnis@gmail.com>

Update packages/aws/_dev/build/docs/billing.md

c0e5228

Co-authored-by: Colleen McGinnis <colleen.j.mcginnis@gmail.com>

Revert "Update Billing.md"

8782192

This reverts commit 3868827.

Merge branch 'aws-billing' of https://github.com/ellis-elastic/integr…

d5b14c7

…ations into aws-billing

Update packages/aws/_dev/build/docs/billing.md

d436bd0

Co-authored-by: Colleen McGinnis <colleen.j.mcginnis@gmail.com>

Update packages/aws/_dev/build/docs/billing.md

f08cfc5

Co-authored-by: Colleen McGinnis <colleen.j.mcginnis@gmail.com>

Update packages/aws/_dev/build/docs/billing.md

33fd3a3

Co-authored-by: Colleen McGinnis <colleen.j.mcginnis@gmail.com>

Update packages/aws/_dev/build/docs/billing.md

64356f9

Co-authored-by: Colleen McGinnis <colleen.j.mcginnis@gmail.com>

update billing

1a7dcbb

added details on the metrics collected

update billing

1b201a7

ran build

Merge branch 'main' into aws-billing

ba9e3e2

ellis-elastic and others added 2 commits June 30, 2022 08:04

Merge branch 'main' into aws-billing

53519ed

fix changelog formatting

9d315e7

bmorelli25 reviewed Jun 30, 2022

View reviewed changes

packages/aws/_dev/build/docs/billing.md Outdated Show resolved Hide resolved

bmorelli25 reviewed Jun 30, 2022

View reviewed changes

packages/aws/_dev/build/docs/billing.md Show resolved Hide resolved

bmorelli25 reviewed Jun 30, 2022

View reviewed changes

packages/aws/_dev/build/docs/billing.md Outdated Show resolved Hide resolved

bmorelli25 reviewed Jun 30, 2022

View reviewed changes

packages/aws/_dev/build/docs/billing.md Show resolved Hide resolved

bmorelli25 marked this pull request as draft June 30, 2022 19:13

Update packages/aws/_dev/build/docs/billing.md

14b4ea8

Co-authored-by: Brandon Morelli <bmorelli25@gmail.com>

kaiyan-sheng reviewed Jul 5, 2022

View reviewed changes

packages/aws/docs/billing.md Show resolved Hide resolved

ellis-elastic and others added 5 commits July 6, 2022 08:45

Update packages/aws/docs/billing.md

c1ce628

Co-authored-by: kaiyan-sheng <kaiyan.sheng@elastic.co>

Update Billing.md

6ba7d99

Removed overview heading

Update changelog and ran build

0ac39e4

Merge branch 'main' into aws-billing

c6409e9

Update Billing

7d9e4a3

Fixed duplicated word

ellis-elastic marked this pull request as ready for review July 25, 2022 08:31

bmorelli25 changed the base branch from main to aws-doc-updates July 29, 2022 18:02

bmorelli25 added 2 commits July 29, 2022 11:12

revert cl/mani

e51ea3a

Merge branch 'main' of github.com:elastic/integrations into aws-billing

b3e79b8

bmorelli25 merged commit f6c2363 into elastic:aws-doc-updates Jul 29, 2022

Conversation

ellis-elastic commented Jun 24, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

What does this PR do?

Checklist

Author's Checklist

How to test this PR locally

Related issues

Screenshots

Uh oh!

elasticmachine commented Jun 24, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

💔 Build Failed

Build stats

Steps errors

Check integration: aws

Google Storage Download

🤖 GitHub comments

Uh oh!

ellis-elastic commented Jun 24, 2022

Uh oh!

elasticmachine commented Jun 24, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

🌐 Coverage report

Uh oh!

ellis-elastic commented Jun 24, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

ellis-elastic commented Jun 27, 2022

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

elasticmachine commented Jul 29, 2022

💔 Build Failed

Build stats

Steps errors

Check integration: aws

Google Storage Download

🤖 GitHub comments

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

ellis-elastic commented Jun 24, 2022 •

edited

Loading

elasticmachine commented Jun 24, 2022 •

edited

Loading

`Check integration: aws`

`Google Storage Download`

elasticmachine commented Jun 24, 2022 •

edited

Loading

ellis-elastic commented Jun 24, 2022 •

edited

Loading

`Check integration: aws`

`Google Storage Download`