Skip to content

[AWS Cloudwatch input] - Update documentation - #19624

Merged
muthu-mps merged 10 commits into
elastic:mainfrom
muthu-mps:enhance_documentation
Jun 24, 2026
Merged

[AWS Cloudwatch input] - Update documentation#19624
muthu-mps merged 10 commits into
elastic:mainfrom
muthu-mps:enhance_documentation

Conversation

@muthu-mps

@muthu-mps muthu-mps commented Jun 18, 2026 •
edited
Loading

Copy link
Copy Markdown
Contributor
  • Enhancement

Proposed commit message

This PR adds more details to the documentation related to the services supported and prerequisites and troubleshooting steps and the logo images for the different services.

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.
  • I have verified that any added dashboard complies with Kibana's Dashboard good practices

Author's Checklist

  • [ ]

How to test this PR locally

Related issues

Screenshots
@muthu-mps
muthu-mps requested a review from a team as a code owner June 18, 2026 07:00
@github-actions

github-actions Bot commented Jun 18, 2026

Copy link
Copy Markdown
Contributor

✅ Elastic Docs Style Checker (Vale)

No issues found on modified lines!

The Vale linter checks documentation changes against the Elastic Docs style guide. To use Vale locally or report issues, refer to Elastic style guide for Vale.
@muthu-mps
muthu-mps requested a review from ishleenk17 June 18, 2026 07:03
@muthu-mps muthu-mps changed the title update readme Jun 18, 2026
@andrewkroh andrewkroh added Integration:aws_cloudwatch_input_otel AWS CloudWatch (OpenTelemetry) documentation Improvements or additions to documentation. Applied to PRs that modify *.md files. Team:Obs-InfraObs Observability Infrastructure Monitoring team [elastic/obs-infraobs-integrations] labels Jun 18, 2026
@muthu-mps
muthu-mps requested a review from Copilot June 22, 2026 09:20
Copilot AI reviewed Jun 22, 2026
View reviewed changes

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Pull request overview

Updates the aws_cloudwatch_input_otel package documentation and branding assets to better describe supported services, prerequisites, and troubleshooting, and to add service-specific icons.

Changes:

  • Refresh README content (overview, deployment modes, requirements, authentication, troubleshooting) and regenerate build docs.
  • Add per-service icons in manifest.yml and introduce new SVG logo assets.
  • Bump package version to 0.3.1 and add a changelog entry.

Reviewed changes

Copilot reviewed 4 out of 11 changed files in this pull request and generated 2 comments.

Show a summary per file
File Description
packages/aws_cloudwatch_input_otel/manifest.yml Version/title update; adds per-service icons; package icon title tweak (needs receiver description alignment).
packages/aws_cloudwatch_input_otel/docs/README.md Expanded end-user documentation (overview, requirements, auth, troubleshooting).
packages/aws_cloudwatch_input_otel/_dev/build/docs/README.md Source template for generated docs updated to match published README.
packages/aws_cloudwatch_input_otel/changelog.yml Adds 0.3.1 changelog entry for documentation update.
packages/aws_cloudwatch_input_otel/img/logo_aws_cloudwatch_otel.svg Replaces package-level icon artwork.
packages/aws_cloudwatch_input_otel/img/logo_ec2.svg Adds EC2 service icon.
packages/aws_cloudwatch_input_otel/img/logo_lambda.svg Adds Lambda service icon.
packages/aws_cloudwatch_input_otel/img/logo_rds.svg Adds RDS service icon.
packages/aws_cloudwatch_input_otel/img/logo_sqs.svg Adds SQS service icon.
packages/aws_cloudwatch_input_otel/img/logo_ecs.svg Adds ECS/Fargate service icon.
packages/aws_cloudwatch_input_otel/img/logo_elb.svg Adds ELB service icon (currently exported with heavy Inkscape metadata; recommend optimizing).

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Comment thread packages/aws_cloudwatch_input_otel/manifest.yml Outdated
Comment thread packages/aws_cloudwatch_input_otel/manifest.yml
ishleenk17
ishleenk17 reviewed Jun 22, 2026
View reviewed changes
Comment thread packages/aws_cloudwatch_input_otel/docs/README.md
| AWS Access Key ID | The access key used to authenticate to AWS. |
| AWS Secret Access Key | The secret key paired with the access key. |
| AWS Session Token | Required only when using temporary (STS) credentials. |

@ishleenk17 ishleenk17 Jun 22, 2026

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Do we need to mention here about recommended values for limit, collection_interval and other time related config paramters @muthu-mps ?

@muthu-mps muthu-mps Jun 23, 2026

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Let me check and add the configurations and their default to the document. This will cover the required defaults that user can adjust at any given point.
ishleenk17
ishleenk17 approved these changes Jun 23, 2026
View reviewed changes

@ishleenk17 ishleenk17 left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

1 nit. Please take care of that. Else looks good!
Comment thread packages/aws_cloudwatch_input_otel/_dev/build/docs/README.md Outdated
@@ -1,15 +1,35 @@
# AWS CloudWatch OpenTelemetry Input Package
{{- generatedHeader }}
# AWS CloudWatch OpenTelemetry Input

@ishleenk17 ishleenk17 Jun 23, 2026

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

This is being followed for now :AWS CloudWatch (OpenTelemetry)
Discussion thread: https://github.com/elastic/integrations/pull/19526/changes#r3453908503
@mergify

mergify Bot commented Jun 23, 2026

Copy link
Copy Markdown
Contributor

Tick the box to add this pull request to the merge queue (same as @mergifyio queue).

  • Queue this pull request
@elastic-vault-github-plugin-prod

elastic-vault-github-plugin-prod Bot commented Jun 24, 2026

Copy link
Copy Markdown
Contributor

✅ All changelog entries have the correct PR link.
@elasticmachine

elasticmachine commented Jun 24, 2026

Copy link
Copy Markdown

💚 Build Succeeded

History
@muthu-mps
muthu-mps merged commit 17a370b into elastic:main Jun 24, 2026
11 checks passed
@muthu-mps
muthu-mps deleted the enhance_documentation branch June 24, 2026 03:24
@elastic-vault-github-plugin-prod

elastic-vault-github-plugin-prod Bot commented Jun 24, 2026

Copy link
Copy Markdown
Contributor

Package aws_cloudwatch_input_otel - 0.3.2 containing this change is available at https://epr.elastic.co/package/aws_cloudwatch_input_otel/0.3.2/
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation. Applied to PRs that modify *.md files. Integration:aws_cloudwatch_input_otel AWS CloudWatch (OpenTelemetry) Team:Obs-InfraObs Observability Infrastructure Monitoring team [elastic/obs-infraobs-integrations]

5 participants

@muthu-mps @elasticmachine @ishleenk17 @andrewkroh