-
Notifications
You must be signed in to change notification settings - Fork 500
[aws_cloudtrail_otel] Content pack of EDOT Cloud Forwarder for AWS - CloudTrail Logs #15644
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
base: main
Are you sure you want to change the base?
Changes from all commits
17b7ea3
d89c87b
91d2848
d7931e0
aca5d11
2b9c97d
467c6eb
ad22e61
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,93 @@ | ||
Elastic License 2.0 | ||
|
||
URL: https://www.elastic.co/licensing/elastic-license | ||
|
||
## Acceptance | ||
|
||
By using the software, you agree to all of the terms and conditions below. | ||
|
||
## Copyright License | ||
|
||
The licensor grants you a non-exclusive, royalty-free, worldwide, | ||
non-sublicensable, non-transferable license to use, copy, distribute, make | ||
available, and prepare derivative works of the software, in each case subject to | ||
the limitations and conditions below. | ||
|
||
## Limitations | ||
|
||
You may not provide the software to third parties as a hosted or managed | ||
service, where the service provides users with access to any substantial set of | ||
the features or functionality of the software. | ||
|
||
You may not move, change, disable, or circumvent the license key functionality | ||
in the software, and you may not remove or obscure any functionality in the | ||
software that is protected by the license key. | ||
|
||
You may not alter, remove, or obscure any licensing, copyright, or other notices | ||
of the licensor in the software. Any use of the licensor’s trademarks is subject | ||
to applicable law. | ||
|
||
## Patents | ||
|
||
The licensor grants you a license, under any patent claims the licensor can | ||
license, or becomes able to license, to make, have made, use, sell, offer for | ||
sale, import and have imported the software, in each case subject to the | ||
limitations and conditions in this license. This license does not cover any | ||
patent claims that you cause to be infringed by modifications or additions to | ||
the software. If you or your company make any written claim that the software | ||
infringes or contributes to infringement of any patent, your patent license for | ||
the software granted under these terms ends immediately. If your company makes | ||
such a claim, your patent license ends immediately for work on behalf of your | ||
company. | ||
|
||
## Notices | ||
|
||
You must ensure that anyone who gets a copy of any part of the software from you | ||
also gets a copy of these terms. | ||
|
||
If you modify the software, you must include in any modified copies of the | ||
software prominent notices stating that you have modified the software. | ||
|
||
## No Other Rights | ||
|
||
These terms do not imply any licenses other than those expressly granted in | ||
these terms. | ||
|
||
## Termination | ||
|
||
If you use the software in violation of these terms, such use is not licensed, | ||
and your licenses will automatically terminate. If the licensor provides you | ||
with a notice of your violation, and you cease all violation of this license no | ||
later than 30 days after you receive that notice, your licenses will be | ||
reinstated retroactively. However, if you violate these terms after such | ||
reinstatement, any additional violation of these terms will cause your licenses | ||
to terminate automatically and permanently. | ||
|
||
## No Liability | ||
|
||
*As far as the law allows, the software comes as is, without any warranty or | ||
condition, and the licensor will not be liable to you for any damages arising | ||
out of these terms or the use or nature of the software, under any kind of | ||
legal claim.* | ||
|
||
## Definitions | ||
|
||
The **licensor** is the entity offering these terms, and the **software** is the | ||
software the licensor makes available under these terms, including any portion | ||
of it. | ||
|
||
**you** refers to the individual or entity agreeing to these terms. | ||
|
||
**your company** is any legal entity, sole proprietorship, or other kind of | ||
organization that you work for, plus all organizations that have control over, | ||
are under the control of, or are under common control with that | ||
organization. **control** means ownership of substantially all the assets of an | ||
entity, or the power to direct its management and policies by vote, contract, or | ||
otherwise. Control can be direct or indirect. | ||
|
||
**your licenses** are all the licenses granted to you for the software under | ||
these terms. | ||
|
||
**use** means anything you do with the software requiring one of your licenses. | ||
|
||
**trademark** means trademarks, service marks, and similar rights. |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,6 @@ | ||
# newer versions go on top | ||
- version: "0.1.0" | ||
changes: | ||
- description: Initial draft of the AWS CloudTrail Logs OpenTelemetry Assets package | ||
type: enhancement | ||
link: https://github.com/elastic/integrations/pull/15644 |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,25 @@ | ||
# AWS CloudTrail Logs OpenTelemetry Assets | ||
|
||
## Overview | ||
|
||
The AWS CloudTrail OpenTelemetry Assets allow you to monitor [Amazon CloudTrail logs](https://docs.aws.amazon.com/cloudtrail/). With AWS CloudTrail, you can monitor your AWS deployments in the cloud by getting a history of AWS API calls for your account, including API calls made by using the AWS Management Console, the AWS SDKs, the command line tools, and higher-level AWS services. | ||
|
||
The [EDOT Cloud Forwarder for AWS](https://www.elastic.co/docs/reference/opentelemetry/edot-cloud-forwarder/aws) enables you to collect **CloudTrail Logs** from Amazon S3 and forward them directly into Elastic Observability. Use this integration to visualize that data in Kibana, create alerts to notify you if something goes wrong, and reference logs when troubleshooting an issue. | ||
|
||
## What do I need to use this integration? | ||
|
||
You need an Elastic Observability project (**Serverless only**) for storing, analyzing, and visualizing your ELB logs. | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. How do we plan to update this if in the future ECF supports more than just serverless? CC @ishleenk17 There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. When ECF supports more than serverless they will do that with a particular new stack version. There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Do we have a process to ensure that we don't miss this and then proactively update the README? |
||
|
||
From the AWS side, to collect CloudTrail logs, you need: | ||
|
||
- An S3 bucket for storing logs | ||
- CloudTrail trail configured with S3 bucket as log storage destination | ||
|
||
## How do I deploy this integration? | ||
|
||
For step-by-step instructions on how to set up an EDOT Cloud Forwarder for AWS, see the | ||
[EDOT Cloud Forwarder for AWS](https://www.elastic.co/docs/reference/opentelemetry/edot-cloud-forwarder/aws) guide. | ||
|
||
## Logs Reference | ||
|
||
For a complete list of all available logs and their detailed descriptions, refer to the [OpenTelemetry AWS Logs encoding extension](https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/main/extension/encoding/awslogsencodingextension#cloudtrail-log-record-fields) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Should we exclude "from Amazon S3" in case in the future we enable other ways to get the logs? CC @ishleenk17
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@daniela-elastic : Since currently we are supporting only ECF, I think its fine to mention this way.
when we update it with other flows, we will be updating our README's as well