|
| 1 | +--- |
| 2 | +name: splunk-nozzle |
| 3 | +label: Splunk Firehose Nozzle for PCF |
| 4 | +description: Forward firehose logs & metrics to Splunk |
| 5 | +icon_file: icon.png |
| 6 | + |
| 7 | + |
| 8 | +org_quota: 4096 # Optional, memory quota in mb |
| 9 | +apply_open_security_group: true # Apply open security group, default: false |
| 10 | +allow_paid_service_plans: true # Allow paid service plans, default: false |
| 11 | + |
| 12 | +stemcell_criteria: |
| 13 | + os: ubuntu-trusty |
| 14 | + requires_cpi: false |
| 15 | + version: '3421' |
| 16 | + |
| 17 | +properties: |
| 18 | +- name: author |
| 19 | + type: string |
| 20 | + label: Author |
| 21 | + value: Shubham Jain |
| 22 | + |
| 23 | +forms: |
| 24 | +- name: splunk-config |
| 25 | + label: Splunk Settings |
| 26 | + description: Splunk HTTP Event Collector Settings |
| 27 | + markdown: | |
| 28 | + Configure your Splunk HTTP Event Collector. See http://docs.splunk.com/Documentation/Splunk/latest/Data/UsetheHTTPEventCollector |
| 29 | + properties: |
| 30 | + - name: splunk_host |
| 31 | + type: string |
| 32 | + label: HTTP Event Collector Endpoint URL |
| 33 | + description: HTTP Event Collector endpoint URL. |
| 34 | + - name: splunk_token |
| 35 | + type: secret |
| 36 | + label: HTTP Event Collector Token |
| 37 | + description: Splunk HTTP Event Collector token. |
| 38 | + - name: skip_ssl_validation_splunk |
| 39 | + type: boolean |
| 40 | + label: Skip SSL Validation |
| 41 | + default: false |
| 42 | + description: Skip SSL certificate validation for connection to Splunk. Secure communications will not check SSL certificates against a trusted Certificate Authority. |
| 43 | + - name: splunk_index |
| 44 | + type: string |
| 45 | + label: Index |
| 46 | + description: The name of the Splunk index that events will be sent to. WARNING:Setting an invalid index will cause events to be lost. |
| 47 | + default: main |
| 48 | + |
| 49 | +- name: cf-config |
| 50 | + label: Cloud Foundry Settings |
| 51 | + description: Cloud Foundry Connection Settings |
| 52 | + properties: |
| 53 | + - name: api_endpoint |
| 54 | + type: string |
| 55 | + label: API Endpoint |
| 56 | + description: Cloud Foundry API endpoint. |
| 57 | + - name: api_user |
| 58 | + type: string |
| 59 | + label: API User |
| 60 | + description: API username |
| 61 | + - name: api_password |
| 62 | + type: secret |
| 63 | + label: API Password |
| 64 | + description: Password for API user |
| 65 | + - name: skip_ssl_validation_cf |
| 66 | + type: boolean |
| 67 | + label: Skip SSL Validation |
| 68 | + default: false |
| 69 | + description: Skip SSL certificate validation for connection to Cloud Foundry. Secure communications will not check SSL certificates against a trusted Certificate Authority. Skipping SSL validation in production environment is not recommended. |
| 70 | + - name: events |
| 71 | + type: multi_select_options |
| 72 | + label: Event Types |
| 73 | + default: ['HttpStartStop', 'LogMessage', 'ValueMetric', 'CounterEvent', 'Error', 'ContainerMetric'] |
| 74 | + options: |
| 75 | + - name: HttpStartStop |
| 76 | + label: HttpStartStop |
| 77 | + - name: LogMessage |
| 78 | + label: LogMessage |
| 79 | + - name: ValueMetric |
| 80 | + label: ValueMetric |
| 81 | + - name: CounterEvent |
| 82 | + label: CounterEvent |
| 83 | + - name: Error |
| 84 | + label: Error |
| 85 | + - name: ContainerMetric |
| 86 | + label: ContainerMetric |
| 87 | + description: Event types to forward to Splunk. |
| 88 | + |
| 89 | +- name: advanced |
| 90 | + label: Advanced |
| 91 | + description: Additional Nozzle Configuration |
| 92 | + properties: |
| 93 | + - name: scale_out_nozzle |
| 94 | + type: integer |
| 95 | + label: Scale Out Nozzle |
| 96 | + description: Scale out Splunk nozzle. Recommendation:Run 2 or more nozzles for high availability. |
| 97 | + default: 2 |
| 98 | + - name: firehose_subscription_id |
| 99 | + type: string |
| 100 | + label: Firehose Subscription ID |
| 101 | + description: Unique subscription ID to nozzle. Firehose balances across socket connections with the same ID. |
| 102 | + optional: true |
| 103 | + - name: extra_fields |
| 104 | + type: string |
| 105 | + label: Additional Fields |
| 106 | + description: A set of key:value pairs formatted as "key1:value1, key2:value2, key3:value3" that do not occur in the event payload. These fields are added to every event payload for indexing by Splunk and are used to tag all events. |
| 107 | + optional: true |
| 108 | + - name: add_app_info |
| 109 | + type: boolean |
| 110 | + default: false |
| 111 | + label: Add App Information |
| 112 | + description: Enriches raw data with application metadata, such as application name, space name, org name, etc. |
| 113 | + - name: enable_event_tracing |
| 114 | + type: boolean |
| 115 | + label: Enable Event Tracing |
| 116 | + default: false |
| 117 | + description: Enables data loss tracing. |
| 118 | + |
| 119 | + |
| 120 | +packages: |
| 121 | +- name: splunk-firehose-nozzle |
| 122 | + type: app |
| 123 | + label: Splunk-Firehose-Nozzle |
| 124 | + manifest: |
| 125 | + memory: 512M |
| 126 | + instances: MY_INSTANCE_COUNT |
| 127 | + buildpack: binary_buildpack |
| 128 | + health-check-type: process |
| 129 | + no-route: true |
| 130 | + path: ../splunk-firehose-nozzle |
| 131 | + command: ./splunk-firehose-nozzle |
| 132 | + env: |
| 133 | + GOPACKAGENAME: main |
| 134 | + pre_deploy: | |
| 135 | + sed -i "s/MY_INSTANCE_COUNT/$SCALE_OUT_NOZZLE/g" $PACKAGE_PATH/splunk_firehose_nozzle/manifest.yml |
0 commit comments