JSON Source CLI parameters #4575
Draft
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
jpipkin1
reviewed
Sep 25, 2024
| | `sourceType` | String | Yes | | HTTP | not modifiable | | ||
| | `messagePerRequest` | Boolean | Yes | | When set to `true`, only a single message will be sent for each HTTP request. To disable this feature, set to `false`. <br/>You need to specify the common parameter `multilineProcessingEnabled` as false when setting `messagePerRequest` to `true`. | modifiable | | ||
| | `url` | String | No | URL assigned by Sumo for Source | The Source's unique HTTP endpoint web address. | not modifiable | | ||
| ###### `fields` |
There was a problem hiding this comment.
@kimsauce, I like the older layout better. I find info like | JSON Object | Optional | Modifiable | listed under each parameter a little confusing. But if you want to go ahead and use the new layout, go for it.
jpipkin1
reviewed
Sep 25, 2024
|
|
||
| In addition to the [common parameters](/docs/send-data/use-json-configure-sources/#common-parameters-for-log-source-types), the following parameters are specific to local file sources. | ||
|
|
||
| ###### `sourceType` |
There was a problem hiding this comment.
Same comment as above for the new layout of parameters in this article.
jpipkin1
approved these changes
Sep 25, 2024
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.
Purpose of this pull request
JSON Source CLI parameters are too difficult to navigate in large tables. I pulled each parameter out and formatted them with distinct headings, specifying the field type, whether it's optional or modifiable, and any default values. Each parameter now has a concise description underneath, making it easier to scan and understand the options.
Select the type of change
Ticket (if applicable)
https://sumologic.atlassian.net/browse/DOCS-373