Updated docs with required field & optional value #293
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
luckyj5
approved these changes
Sep 28, 2021
|
LGTM. thanks |
luckyj5
reviewed
Sep 28, 2021
README.md
Outdated
| * `HEC_RETRIES`: Retry count for sending events to Splunk. After expiring, events will begin dropping causing data loss. (Default: 5) | ||
| * `HEC_WORKERS`: Set the amount of Splunk HEC workers to increase concurrency while ingesting in Splunk. (Default: 8) | ||
| * `ENABLE_EVENT_TRACING`: Enables event trace logging. Splunk events will now contain a UUID, Splunk Nozzle Event Counts, and a Subscription-ID for Splunk correlation searches. (Default: false) | ||
| * `SPLUNK_VERSION`: The Splunk version that determines how HEC ingests metadata fields. Only required for Splunk version 6.3 or below. (Default: "7.2") |
There was a problem hiding this comment.
let's remove this. 6.3 is old and wont be needed anymore. Also, if there is any ref of this in the code, lets clean that up as well.
README.md
Outdated
| * `ORG_SPACE_CACHE_INVALIDATE_TTL`: How frequently the org and space cache invalidates (in s/m/h. For example, 3600s or 60m or 1h). (Default: 72h) | ||
| * `APP_LIMITS`: Restrict to APP_LIMITS the most updated apps per request when populating the app metadata cache. keep it 0 to update all the apps. (Default: 0) | ||
| * `BOLTDB_PATH`: Bolt database path. (Default: cache.db) | ||
| * `EVENTS`: A comma separated list of events to include. Possible values: ValueMetric,CounterEvent,Error,LogMessage,HttpStartStop,ContainerMetric. If it is blank, nozzle will automatically select LogMessage (Default: "ValueMetric,CounterEvent,ContainerMetric") |
There was a problem hiding this comment.
EVENTS - It's a required field and cannot be blank in the Tile.
Also, is the default "logmessage" or "Default: "ValueMetric,CounterEvent,ContainerMetric"
There was a problem hiding this comment.
We are required to select at least one eventtype in the tile.
But in local execution or pushed via cf, if we explicitly set EVENTS="", nozzle will automatically select logmessage at the parsing level parsing level.
Made some changes to make it more clear
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.
No description provided.