Improve documentation of destination_conf parameter #17631
Merged
Conversation
This file contains hidden or 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
victor-perov
requested review from
a team,
angelampcosta,
bharatnc,
jherre and
soheiokamoto
as code owners
![hyperlint-ai[bot]](https://avatars.githubusercontent.com/in/718456?s=60&v=4){kind=small}
Contributor
Author
|
@soheiokamoto @angelampcosta please review when you get a chance. This change was motivated by a set of customer support tickets. |
Contributor
Author
|
i will ignore those two ai suggestions on this occasion. |
cmackenzie1
reviewed
Oct 18, 2024
| * `datadog`, | ||
| * `https`, | ||
| * `r2`, | ||
| * `kinesis`. |
Contributor
There was a problem hiding this comment.
Can we omit kinesis one for now? It is not GA yet.
Contributor
Author
There was a problem hiding this comment.
Thanks, Cole! Updated
This commit sheds more light on destination_conf attribute of logpush job configuration by adding details on the format it has and stresses more details on accepted schemes such as r2, sumo, etc.
victor-perov
force-pushed
the
viktor/update-destination_conf
branch
from
c6887c3 to
987b27f
Compare
cmackenzie1
approved these changes
Oct 18, 2024
angelampcosta
approved these changes
Oct 21, 2024
| * **Splunk** (scheme `splunk`): Splunk endpoint URL + Splunk channel ID + insecure-skip-verify flag + Splunk sourcetype + Splunk authorization token; for example: `splunk://<SPLUNK_ENDPOINT_URL>?channel=<SPLUNK_CHANNEL_ID>&insecure-skip-verify=<INSECURE_SKIP_VERIFY>&sourcetype=<SOURCE_TYPE>&header_Authorization=<SPLUNK_AUTH_TOKEN>` | ||
| * **Sumo Logic** (scheme `sumo`): HTTP source address URL with `https` replaced by `sumo`; for example: `sumo://<SUMO_ENDPOINT_URL>/receiver/v1/http/<UNIQUE_HTTP_COLLECTOR_CODE>` | ||
|
|
||
| For **R2**, **S3**, **Google Cloud Storage**, and **Azure**, logs can be separated into daily subdirectories by using the special string `{DATE}` in the URL path; for example: `s3://mybucket/logs/{DATE}?region=us-east-1&sse=AES256` or `azure://myblobcontainer/logs/{DATE}?[QueryString]`. It will be substituted with the date in `YYYYMMDD` format, like `20180523`. |
Contributor
There was a problem hiding this comment.
Suggested change
| For **R2**, **S3**, **Google Cloud Storage**, and **Azure**, logs can be separated into daily subdirectories by using the special string `{DATE}` in the URL path; for example: `s3://mybucket/logs/{DATE}?region=us-east-1&sse=AES256` or `azure://myblobcontainer/logs/{DATE}?[QueryString]`. It will be substituted with the date in `YYYYMMDD` format, like `20180523`. | |
| For **R2**, **S3**, **Google Cloud Storage**, and **Azure**, logs can be separated into daily subdirectories by using the special string `{DATE}` in the URL path; for example: `s3://mybucket/logs/{DATE}?region=us-east-1&sse=AES256` or `azure://myblobcontainer/logs/{DATE}?[QueryString]`. The parameter will be substituted with the date in `YYYYMMDD` format, like `20180523`. |
This commit provides a bit more details on `{DATE}` and restructures
examples.
Co-authored-by: hyperlint-ai[bot] <154288675+hyperlint-ai[bot]@users.noreply.github.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
6 participants
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.
Summary
This commit sheds more light on destination_conf attribute of logpush job configuration by adding details on the format it has and stresses more details on accepted schemes such as r2, sumo, etc.
Documentation checklist