New Custom Logs Buckets documentation #6254
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
fdalmaup
force-pushed
the
13577-custom-logs-bucket-subscriber
branch
2 times, most recently
from
b482198
to
40767aa
Compare
fdalmaup
force-pushed
the
13577-custom-logs-bucket-subscriber
branch
from
40767aa
to
457622d
Compare
fdalmaup
force-pushed
the
13577-custom-logs-bucket-subscriber
branch
from
457622d
to
7f153b0
Compare
Selutario
suggested changes
Aug 4, 2023
source/cloud-security/amazon/services/supported-services/custom-buckets.rst
Outdated
Show resolved
Hide resolved
source/cloud-security/amazon/services/supported-services/custom-buckets.rst
Outdated
Show resolved
Hide resolved
Selutario
approved these changes
Aug 7, 2023
javimed
reviewed
Aug 9, 2023
| `Amazon Simple Queue Service (Amazon SQS) <https://aws.amazon.com/sqs/>`_ is a fully managed message queuing service that offers secure, durable, and available hosted queues to decouple and scale software systems and components. | ||
| It allows sending, storing, and receiving messages between software components at any volume, without losing messages or requiring other services to be available. These features make it an optimal component to associate with Amazon S3 Buckets to consume any type of log. | ||
|
|
||
| Combining Amazon SQS with Amazon S3 buckets, allows Wazuh to fetch any JSON, CSV or plain text logs, originated in AWS or not, and process the events inside them. |
There was a problem hiding this comment.
This is not clear enough. What's new to Wazuh about fetching logs and processing the events inside?
There was a problem hiding this comment.
The difference with what already exists is the following:
- Currently, all Wazuh's AWS integrations to read logs stored in buckets like Cloudtrail, Macie, etc. they require specifying the path in the configuration and that the logs are saved in a defined and very strict folder structure. These structures are the ones that can be consulted here (Paths to logs). Wazuh directly accessed those paths and downloaded the items found inside.
- Now, this new feature of
Custom Logs Bucketsallows to read logs stored in any path of a bucket, even from multiple buckets. In addition, it allows one to do it in a distributed and simultaneous way with different managers or Wazuh agents, without duplicating logs. This is done because the bucket publishes a notification to the SQS queue containing the full path of each new file stored in it. The notification is consumed only once, so it won't duplicate alerts.
javimed
reviewed
Aug 9, 2023
|
|
||
| The steps to have an S3 bucket reporting creation events are: | ||
|
|
||
| #. Configure an S3 bucket as defined in the :ref:`Configuring an S3 Bucket <s3_bucket>` section with the name provided in the previous section. |
There was a problem hiding this comment.
What previous section? What name provided?
javimed
requested changes
Aug 9, 2023
|
|
||
| The available authentication methods are :ref:`IAM Roles <iam_roles>` or :ref:`Profiles <aws_profile>`. | ||
|
|
||
| * ``<profile>``: A valid profile name from a Shared Credential File or AWS Config File with the permission to read logs from the bucket. |
There was a problem hiding this comment.
Suggested change
| * ``<profile>``: A valid profile name from a Shared Credential File or AWS Config File with the permission to read logs from the bucket. | |
| * ``<aws_profile>``: A valid profile name from a Shared Credential File or AWS Config File with the permission to read logs from the bucket. |
| @@ -252,3 +252,7 @@ Error codes reference | |||
| +-----------+-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ | |||
| | 21 | Failed fetch/delete from SQS | Check that no more instances of the wodle are running at the same time. | | |||
| +-----------+-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ | |||
| | 22 | Invalid region | Check the provided ``region`` in the ``ossec.conf`` file. | | |||
| +-----------+-------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ | |||
| | 23 | Profile not found | Check the provided ``profile`` in the ``ossec.conf`` file. | | |||
There was a problem hiding this comment.
Suggested change
| | 23 | Profile not found | Check the provided ``profile`` in the ``ossec.conf`` file. | | |
| | 23 | Profile not found | Check the provided ``aws_profile`` in the ``ossec.conf`` file. | |
javimed
approved these changes
Aug 9, 2023
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
This PR adds the documentation for the new Custom Logs Buckets feature to be included in wazuh/wazuh#13577, adding new parameters for the AWS module reference and extending the available
<subscriber>values.Checks
codefont for Bash commands, file names, REST paths, and code.redirects.jsscript if necessary (check this guide).