AWS s3 exporter component #730
Open
+393
−0
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
Added documentation
Added exported fields section to docs
Update docs with example added a test
clayton-cornell
added
the
type/docs
rfratto
added
the
backport-to-agent:no
Co-authored-by: Clayton Cornell <131809008+clayton-cornell@users.noreply.github.com>
Co-authored-by: Clayton Cornell <131809008+clayton-cornell@users.noreply.github.com>
Co-authored-by: Clayton Cornell <131809008+clayton-cornell@users.noreply.github.com>
Co-authored-by: Clayton Cornell <131809008+clayton-cornell@users.noreply.github.com>
Co-authored-by: Clayton Cornell <131809008+clayton-cornell@users.noreply.github.com>
Co-authored-by: Clayton Cornell <131809008+clayton-cornell@users.noreply.github.com>
Co-authored-by: Clayton Cornell <131809008+clayton-cornell@users.noreply.github.com>
Co-authored-by: Clayton Cornell <131809008+clayton-cornell@users.noreply.github.com>
Co-authored-by: Clayton Cornell <131809008+clayton-cornell@users.noreply.github.com>
Co-authored-by: Clayton Cornell <131809008+clayton-cornell@users.noreply.github.com>
Updates to docs
Comment on lines
+27
to
+29
| region = "REGION" | ||
| s3_bucket = "BUCKET_NAME" | ||
| s3_prefix = "PREFIX" |
There was a problem hiding this comment.
Suggested change
| region = "REGION" | |
| s3_bucket = "BUCKET_NAME" | |
| s3_prefix = "PREFIX" | |
| region = "<REGION>" | |
| s3_bucket = "<BUCKET_NAME>" | |
| s3_prefix = "<PREFIX>" |
| ## Usage | ||
|
|
||
| ```alloy | ||
| otelcol.exporter.awss3 "LABEL" { |
There was a problem hiding this comment.
Suggested change
| otelcol.exporter.awss3 "LABEL" { | |
| otelcol.exporter.awss3 "<LABEL>" { |
| } | ||
| } | ||
| ``` | ||
|
|
There was a problem hiding this comment.
Suggested change
| Replace the following: | |
| * _`<LABEL>`_: The label for the `otelcol.exporter.awss3` component. | |
| * _`<REGION>`_: The AWS region. | |
| * _`<BUCKET_NAME>`_: The S3 bucket. | |
| * _`<PREFIX>`_: The prefix for the S3 key. | |
This implements the Placeholder Variables: https://grafana.com/docs/writers-toolkit/write/style-guide/write-for-developers/#placeholder-variables and the style is matched to the other component topics.
Comment on lines
+110
to
+111
| - `none` (default): No compression will be applied | ||
| - `gzip`: Files will be compressed with gzip. **This doesn't support `sumo_ic`marshaler.** |
There was a problem hiding this comment.
Suggested change
| - `none` (default): No compression will be applied | |
| - `gzip`: Files will be compressed with gzip. **This doesn't support `sumo_ic`marshaler.** | |
| - `none` (default): File compression isn't used. | |
| - `gzip`: Files are compressed with Gzip. **This doesn't support `sumo_ic`marshaler.** |
|
|
||
| Encoding overrides the marshaler if it's present and sets it to use the encoding extension defined in the collector configuration. | ||
|
|
||
| Refer to the Open Telemetry [encoding extensions] documentation for more information. |
There was a problem hiding this comment.
Suggested change
| Refer to the Open Telemetry [encoding extensions] documentation for more information. | |
| Refer to the Open Telemetry [encoding extensions][] documentation for more information. |
|
|
||
| Marshaler determines the format of data sent to AWS S3. Currently, the following marshalers are implemented: | ||
|
|
||
| - `otlp_json` (default): the [OpenTelemetry Protocol format](https://github.com/open-telemetry/opentelemetry-proto), represented as json. |
There was a problem hiding this comment.
Suggested change
| - `otlp_json` (default): the [OpenTelemetry Protocol format](https://github.com/open-telemetry/opentelemetry-proto), represented as json. | |
| - `otlp_json` (default): the [OpenTelemetry Protocol format](https://github.com/open-telemetry/opentelemetry-proto), represented as JSON. |
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.
PR Description
Adding in an
otelcol.exporter.awss3component.Which issue(s) this PR fixes
#256
Fixes #256
Notes to the Reviewer
Uses the upstream
opentelemetry-collector-contribawss3exporterPR Checklist