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.

Sign up for GitHub

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

Jump to bottom

[Cloudflare Logpush] update documentation for s3 and sqs #5687

Closed
wants to merge 1 commit into from
Closed

[Cloudflare Logpush] update documentation for s3 and sqs #5687

wants to merge 1 commit into from

Conversation

nathangiuliani
Copy link

What does this PR do?

Update the documentation for configuring the Cloudflare Logpush integration, specifically with SQS.

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

n/a

How to test this PR locally

n/a

Related issues

Screenshots

n/a

@cla-checker-service
Copy link

cla-checker-service bot commented Mar 27, 2023 •
edited
Loading

💚 CLA has been signed

@elasticmachine
Copy link

elasticmachine commented Mar 27, 2023 •
edited
Loading

💔 Build Failed

the below badges are clickable and redirect to their specific view in the CI or DOCS
Pipeline View Test View Changes Artifacts preview preview

Expand to view the summary

Build stats

  • Start Time: 2023-03-31T05:11:44.105+0000

  • Duration: 10 min 58 sec

Steps errors 3

Expand to view the steps failures

Check integration: cloudflare_logpush
  • Took 0 min 1 sec . View more details here
  • Description: ../../build/elastic-package check -v
Google Storage Download
  • Took 0 min 0 sec . View more details here
Google Storage Download
  • Took 0 min 0 sec . View more details here

🤖 GitHub comments

Expand to view the GitHub comments

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

  • /test : Re-trigger the build.

@nathangiuliani nathangiuliani changed the title update documentation for s3 and sqs [enhancement] update documentation for s3 and sqs Mar 27, 2023
@nathangiuliani nathangiuliani marked this pull request as ready for review March 27, 2023 00:38
@nathangiuliani nathangiuliani requested a review from a team as a code owner March 27, 2023 00:38
@efd6
Copy link
Contributor

efd6 commented Mar 27, 2023

@nathangiuliani Please sign the CLA so that we can take a look at this.

@nathangiuliani
Copy link
Author

@nathangiuliani Please sign the CLA so that we can take a look at this.

I have.

@efd6
Copy link
Contributor

efd6 commented Mar 27, 2023

@nathangiuliani Please check that the email address that is associated with the signing is the only git author email address in all commits that are in the PR. If they do not match, please also sign with the newly used email addresses.

@nathangiuliani nathangiuliani force-pushed the cloudflare-logpush-sqs-doc-fix branch from 9b462be to 367d9eb Compare March 31, 2023 04:49
@nathangiuliani
Copy link
Author

@nathangiuliani Please check that the email address that is associated with the signing is the only git author email address in all commits that are in the PR. If they do not match, please also sign with the newly used email addresses.

Fixed :)

@efd6
Copy link
Contributor

efd6 commented Mar 31, 2023

/test

efd6
efd6 reviewed Mar 31, 2023
View reviewed changes
Copy link
Contributor

@efd6 efd6 left a comment

Choose a reason for hiding this comment

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

Note that the changes in the docs/README.md file should be made in _dev/build/docs/README.md. Then please run elastic-package build to render the changes into the docs/README.md file.

packages/cloudflare_logpush/changelog.yml
@@ -1,4 +1,9 @@
# newer versions go on top
- version: "0.6.1"
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
- version: "0.6.1"
- version: "0.7.0"

(bump minor for enhancements — also please make the corresponding change in the manifest file)

packages/cloudflare_logpush/docs/README.md
@@ -11,7 +11,7 @@ The Cloudflare Logpush integration can be used in three different modes to colle

For example, you could use the data from this integration to know which websites have the highest traffic, which areas have the highest network traffic, or observe mitigation statistics.

## Data streams
## Logpush Data Sets
Copy link
Contributor

Choose a reason for hiding this comment

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

Please revert this. The current state is conventional wording.

packages/cloudflare_logpush/docs/README.md
Comment on lines +44 to +46
- The default values of the "Bucket Prefix" for each Logpush data set are listed below. However, the user can set the parameter "Bucket Prefix" for each Logpush data set according to their requirements.

| Logpush Data Set Name | Bucket Prefix |
Copy link
Contributor

Choose a reason for hiding this comment

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

Why are these changes needed?

packages/cloudflare_logpush/docs/README.md
1. Create an SQS queue
- To setup an SQS queue, follow "Step 1: Create an Amazon SQS queue" mentioned in the [Documentation](https://docs.aws.amazon.com/AmazonS3/latest/userguide/ways-to-add-notification-config-to-bucket.html).
- While creating an SQS Queue, please provide the same bucket ARN that has been generated after creating an AWS S3 Bucket.
2. Setup event notification from the S3 bucket. Follow this [Link](https://docs.aws.amazon.com/AmazonS3/latest/userguide/enable-event-notifications.html). Use 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.

Suggested change
2. Setup event notification from the S3 bucket. Follow this [Link](https://docs.aws.amazon.com/AmazonS3/latest/userguide/enable-event-notifications.html). Use the following settings:
2. Setup event notification from the S3 bucket according to the documentation [here](https://docs.aws.amazon.com/AmazonS3/latest/userguide/enable-event-notifications.html). Use the following settings:

@andrewkroh andrewkroh changed the title [enhancement] update documentation for s3 and sqs [Cloudflare Logpush] update documentation for s3 and sqs Mar 31, 2023
@botelastic
Copy link

botelastic bot commented Apr 30, 2023

Hi! We just realized that we haven't looked into this PR in a while. We're sorry! We're labeling this issue as Stale to make it hit our filters and make sure we get back to it as soon as possible. In the meantime, it'd be extremely helpful if you could take a look at it as well and confirm its relevance. A simple comment with a nice emoji will be enough :+1. Thank you for your contribution!

@botelastic botelastic bot added the Stalled label Apr 30, 2023
@botelastic
Copy link

botelastic bot commented May 30, 2023

Hi! This PR has been stale for a while and we're going to close it as part of our cleanup procedure. We appreciate your contribution and would like to apologize if we have not been able to review it, due to the current heavy load of the team. Feel free to re-open this PR if you think it should stay open and is worth rebasing. Thank you for your contribution!

@botelastic botelastic bot closed this May 30, 2023
@chemamartinez chemamartinez mentioned this pull request Aug 2, 2024
Merged
4 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@efd6 efd6 efd6 left review comments

Assignees
No one assigned
Labels
docs Integration:cloudflare_logpush Cloudflare Logpush Stalled
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@nathangiuliani @elasticmachine @efd6 @andrewkroh