docs: update variable description #377
Merged
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
ajasnosz
had a problem deploying
to
workflow-approval
GitHub Actions
Failure
README.md
Outdated
| * `KEEP_ALIVE_TIMER`: Time after which connection to Splunk will be refreshed, if REFRESH_SPLUNK_CONNECTION is set to true (in s/m/h. For example, 3600s or 60m or 1h). (Default: 30s) | ||
| * `MEMORY_BALLAST_SIZE`: Size of memory allocated to reduce GC cycles. Default is 0, Size should be less than the total memory. | ||
| * `KEEP_ALIVE_TIMER`: Time after which connection to Splunk will be refreshed, if `REFRESH_SPLUNK_CONNECTION` is set to true (in s/m/h. For example, 3600s or 60m or 1h). (Default: 30s) | ||
| * `MEMORY_BALLAST_SIZE`: Size of memory allocated to reduce GC cycles. Size should be less than the total memory. Default is 0. |
There was a problem hiding this comment.
(Default: 0) to keep it the same as others?
tile/tile.yml
Outdated
| default: main | ||
| - name: splunk_logging_index | ||
| type: string | ||
| label: Logging Index | ||
| description: The name of the Splunk index where logging events will be sent to. WARNING:Setting an invalid index will cause events to be lost. When not provided, all logging events will be forwarded to the splunk_index. | ||
| description: The name of the Splunk index where logging events will be sent to. When not provided, all logging events will be forwarded to the splunk_index. WARNING:Setting an invalid index will cause events to be lost. |
There was a problem hiding this comment.
Maybe add " internal events " or " cf:splunknozzle events "
tile/tile.yml
Outdated
| @@ -28,26 +28,27 @@ forms: | |||
| - name: splunk_host | |||
| type: string | |||
| label: HTTP Event Collector Endpoint URL | |||
| description: HTTP Event Collector endpoint URL. | |||
| description: Splunk HTTP Event Collector endpoint URL. It is required parameter. | |||
There was a problem hiding this comment.
a required parameter
tile/tile.yml
Outdated
| @@ -104,13 +102,14 @@ forms: | |||
| - name: scale_out_nozzle | |||
| type: integer | |||
| label: Scale Out Nozzle | |||
| description: Scale out Splunk nozzle. Recommendation:Run 2 or more nozzles for high availability. | |||
| description: Adds more Splunk nozzle components to spread the load. Recommendation:Run 2 or more nozzles for high availability. | |||
tile/tile.yml
Outdated
| default: 0s | ||
| description: Time interval (in s/m/h. For example, 3600s or 60m or 1h) for monitoring memory queue pressure. Use to help with back-pressure insights. (Increases CPU load. Use for insights purposes only) Default is 0s (Disabled). | ||
| description: Time interval (in s/m/h. For example, 3600s or 60m or 1h) for Enabling Monitoring - metric data of insights with in the connectors. (Increases CPU load. Use for insights purposes only) Default is 0s (Disabled). |
There was a problem hiding this comment.
Maybe something like:
Time interval (in s/m/h. For example, 3600s or 60m or 1h) to enable the monitoring of metric data within the connector. (This increases CPU load and should be used for insights purposes only.) The default is 0s (monitoring disabled).
I would also change the one in readme to match this.
ajasnosz
temporarily deployed
to
workflow-approval
GitHub Actions
Inactive
ajasnosz
temporarily deployed
to
workflow-approval
GitHub Actions
Inactive
ajasnosz
temporarily deployed
to
workflow-approval
GitHub Actions
Inactive
sbylica-splunk
approved these changes
Sep 20, 2024
ajasnosz
temporarily deployed
to
workflow-approval
GitHub Actions
Inactive
ajasnosz
temporarily deployed
to
workflow-approval
GitHub Actions
Inactive
ajasnosz
force-pushed
the
docs/review-variables
branch
from
8549dd2 to
54ba795
Compare
ajasnosz
had a problem deploying
to
workflow-approval
GitHub Actions
Failure
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.
Reviewing the descriptions of variables in UI.