Skip to content

Commit bffd114

Browse files
authored
update config per new params and versions (#256)
* added new config and updated version no.
1 parent c6402db commit bffd114

File tree

2 files changed

+15
-11
lines changed

2 files changed

+15
-11
lines changed

.circleci/ci_nozzle_manifest.yml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -34,3 +34,5 @@ applications:
3434
HEC_WORKERS: 8
3535
DEBUG: false
3636
ENABLE_EVENT_TRACING: true
37+
RLP_GATEWAY_RETRIES: 5
38+
STATUS_MONITOR_INTERVAL: 0s

README.md

Lines changed: 13 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -79,7 +79,7 @@ This is recommended for dev environments only.
7979
This is recommended for dev environments only.
8080
* `FIREHOSE_SUBSCRIPTION_ID`: Tags nozzle events with a Firehose subscription id. See https://docs.pivotal.io/pivotalcf/1-11/loggregator/log-ops-guide.html.
8181
* `FIREHOSE_KEEP_ALIVE`: Keep alive duration for the Firehose consumer.
82-
* `ADD_APP_INFO`: Enriches raw data with app details.
82+
* `ADD_APP_INFO`: Enrich raw data with app info. A comma separated list of app metadata (AppName,OrgName,OrgGuid,SpaceName,SpaceGuid).
8383
* `IGNORE_MISSING_APP`: If the application is missing, then stop repeatedly querying application info from Cloud Foundry.
8484
* `MISSING_APP_CACHE_INVALIDATE_TTL`: How frequently the missing app info cache invalidates.
8585
* `APP_CACHE_INVALIDATE_TTL`: How frequently the app info local cache invalidates.
@@ -95,6 +95,9 @@ This is recommended for dev environments only.
9595
* `HEC_WORKERS`: Set the amount of Splunk HEC workers to increase concurrency while ingesting in Splunk.
9696
* `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.
9797
* `SPLUNK_VERSION`: The Splunk version that determines how HEC ingests metadata fields. Only required for Splunk version 6.3 or below.
98+
* `RLP_GATEWAY_RETRIES`: Number of retries to connect to RLP gateway.
99+
* `STATUS_MONITOR_INTERVAL`: Time interval for monitoring memory queue pressure to help with back-pressure insights.
100+
98101
### Please note
99102
> SPLUNK_VERSION configuration parameter is only required for Splunk version 6.3 and below.
100103
For Splunk version 6.3 or below, please deploy nozzle via CLI. Update nozzle_manifest.yml with splunk_version (eg:- SPLUNK_VERSION: 6.3) as an env variable and [deploy nozzle as an app via CLI](#push-as-an-app-to-cloud-foundry).
@@ -134,11 +137,11 @@ on user authentication.
134137
```
135138

136139
#### Dump application info to boltdb ####
137-
If in production there are lots of PCF applications(say tens of thousands) and if the user would like to enrich
138-
application logs by including application meta data,querying all application metadata information from PCF may take some time.
140+
If in production there are lots of Cloud Foundry applications(say tens of thousands) and if the user would like to enrich
141+
application logs by including application meta data,querying all application metadata information from Cloud Foundry may take some time.
139142
For example if we include, add app name, space ID, space name, org ID and org name to the events.
140143
If there are multiple instances of Spunk nozzle deployed the situation will be even worse, since each of the Splunk nozzle(s) will query all applications meta data and
141-
cache the meta data information to the local boltdb file. These queries will introduce load to the PCF system and could potentially take a long time to finish.
144+
cache the meta data information to the local boltdb file. These queries will introduce load to the Cloud Foundry system and could potentially take a long time to finish.
142145
Users can run this tool to generate a copy of all application meta data and copy this to each Splunk nozzle deployment. Each Splunk nozzle can pick up the cache copy and update the cache file incrementally afterwards.
143146

144147
Example of how to run the dump application info tool:
@@ -167,8 +170,6 @@ applications:
167170
timeout: 180
168171
buildpack: https://github.com/SUSE/stratos-buildpack
169172
health-check-type: port
170-
services:
171-
- splunk-index
172173
env:
173174
SPLUNK_INDEX: testing_index
174175
```
@@ -238,7 +239,7 @@ This topic describes how to troubleshoot Splunk Firehose Nozzle for Cloud Foundr
238239
239240
Are you searching for events and not finding them or looking at a dashboard and seeing "No result found"? Check Splunk Nozzle app logs.
240241
241-
To view the nozzle's logs running on PCF do the following:
242+
To view the nozzle's logs running on Cloud Foundry do the following:
242243
243244
<ol>
244245
<li>Log in as an admin via the CLI.</li>
@@ -310,7 +311,7 @@ A correct setup logs a start message with configuration parameters of the Nozzle
310311
311312
<pre class="terminal">
312313
data: {
313-
add-app-info: true
314+
add-app-info: AppName,OrgName,OrgGuid,SpaceName,SpaceGuid
314315
api-endpoint: https://api.endpoint.com
315316
app-cache-ttl: 0
316317
app-limits: 0
@@ -337,7 +338,8 @@ A correct setup logs a start message with configuration parameters of the Nozzle
337338
splunk-version: 6.6
338339
subscription-id: splunk-firehose
339340
trace-logging: true
340-
version:
341+
rlp-gateway-retries: 5
342+
status-monitor-interval: 0s
341343
wanted-events: ValueMetric,CounterEvent,Error,LogMessage,HttpStartStop,ContainerMetric
342344
}
343345
ip: 10.0.0.0
@@ -394,7 +396,7 @@ Make sure you have the following installed on your workstation:
394396
395397
| Software | Version
396398
| --- | --- |
397-
| go | go1.8.x
399+
| go | go1.12.x
398400
| glide | 0.12.x
399401
400402
Then install all dependent packages via [Glide](https://glide.sh/):
@@ -417,7 +419,7 @@ $ chmod +x tools/nozzle.sh
417419
Build project:
418420
419421
```
420-
$ make VERSION=1.1
422+
$ make VERSION=2.0.0
421423
```
422424
423425
Run tests with [Ginkgo](http://onsi.github.io/ginkgo/)

0 commit comments

Comments
 (0)