From bf3a8db3a889d3e429e2ab455405087df8f18f69 Mon Sep 17 00:00:00 2001 From: ajasnosz Date: Thu, 3 Oct 2024 14:48:39 +0200 Subject: [PATCH] docs: set up gh pages --- .github/workflows/gh-pages.yml | 33 ++ docs/index.md | 558 +++++++++++++++++++++++++++++++++ mkdocs.yml | 37 +++ tile/tile-history.yml | 27 +- 4 files changed, 642 insertions(+), 13 deletions(-) create mode 100644 .github/workflows/gh-pages.yml create mode 100644 docs/index.md create mode 100644 mkdocs.yml diff --git a/.github/workflows/gh-pages.yml b/.github/workflows/gh-pages.yml new file mode 100644 index 00000000..b14673da --- /dev/null +++ b/.github/workflows/gh-pages.yml @@ -0,0 +1,33 @@ +name: ci +on: + push: + branches: + - main + - develop + tags: + - "v*" + +permissions: + contents: write + +jobs: + publish-docs: + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v4 + with: + fetch-depth: 0 + - name: Set up Python + uses: actions/setup-python@v1 + with: + python-version: 3.x + - name: Install dependencies + run: | + pip install mkdocs-material + pip install mike + - name: Setup git user + run: | + git config --global user.name ${{github.actor}} + git config --global user.email ${{ github.actor }}@users.noreply.github.com + - name: Build docs website + run: mike deploy --push ${GITHUB_REF##*/} \ No newline at end of file diff --git a/docs/index.md b/docs/index.md new file mode 100644 index 00000000..4e0dd257 --- /dev/null +++ b/docs/index.md @@ -0,0 +1,558 @@ +## Splunk Nozzle + +Cloud Foundry Firehose-to-Splunk Nozzle + +- - - - + +### VMware Tanzu Application Service version +Splunk Firehose Nozzle has been tested on v3.0, v4.0, v5.0 and v6.0 of Tanzu Application Service + +- - - - + +### VMware Ops Manager version +Splunk Firehose Nozzle has been tested on v3.0.9 LTS of VMware Ops Manager + +- - - - + +### Usage +Splunk nozzle is used to stream Cloud Foundry Firehose events to Splunk HTTP Event Collector. Using pre-defined Splunk sourcetypes, the nozzle automatically parses the events and enriches them with additional metadata before forwarding to Splunk. For detailed descriptions of each Firehose event type and their fields, refer to underlying [dropsonde protocol](https://github.com/cloudfoundry/dropsonde-protocol). Below is a mapping of each Firehose event type to its corresponding Splunk sourcetype. Refer to [Searching Events](#searching-events) for example Splunk searches. + +| Firehose event type | Splunk sourcetype | Description +|---|---|--- +| Error | `cf:error` | An Error event represents an error in the originating process +| HttpStartStop | `cf:httpstartstop` | An HttpStartStop event represents the whole lifecycle of an HTTP request +| LogMessage | `cf:logmessage` | A LogMessage contains a "log line" and associated metadata +| ContainerMetric | `cf:containermetric` | A ContainerMetric records resource usage of an app in a container +| CounterEvent | `cf:counterevent` | A CounterEvent represents the increment of a counter +| ValueMetric | `cf:valuemetric` | A ValueMetric indicates the value of a metric at an instant in time + +In addition, logs from the nozzle itself are of sourcetype `cf:splunknozzle`. + +### Setup + +The Nozzle requires a client with the authorities `doppler.firehose` and `cloud_controller.admin_read_only` (the latter is only required if `ADD_APP_INFO` is enabled) and grant-types `client_credentials` and `refresh_token`. If `cloud_controller.admin_read_only` is not +available in the system, switch to use `cloud_controller.admin`. + +You can either +* Add the client manually using [uaac](https://github.com/cloudfoundry/cf-uaac) +* Add the client to the deployment manifest; see [uaa.scim.users](https://github.com/cloudfoundry/uaa-release/blob/master/jobs/uaa/spec) + +Manifest example: + +```yaml + +# Clients +uaa.clients: + splunk-firehose: + id: splunk-firehose + override: true + secret: splunk-firehose-secret + authorized-grant-types: client_credentials,refresh_token + authorities: doppler.firehose,cloud_controller.admin_read_only +``` + +`uaac` example: +```shell +uaac target https://uaa.[system domain url] +uaac token client get admin -s [admin client credentials secret] +uaac client add splunk-firehose --name splunk-firehose +uaac client add splunk-firehose --secret [your_client_secret] +uaac client add splunk-firehose --authorized_grant_types client_credentials,refresh_token +uaac client add splunk-firehose --authorities doppler.firehose,cloud_controller.admin_read_only + +``` + +`cloud_controller.admin_read_only` will work for cf v241 +or later. Earlier versions should use `cloud_controller.admin` instead. + +- - - - +#### Environment Parameters +You can declare parameters by making a copy of the scripts/nozzle.sh.template. +* `DEBUG`: Enable debug mode (forward to standard out instead of Splunk). (Default: false). + +__Cloud Foundry configuration parameters:__ +* `API_ENDPOINT`: Cloud Foundry API endpoint address. It is required parameter. +* `CLIENT_ID`: UAA Client ID (Must have authorities and grant_types described above). It is required parameter. +* `CLIENT_SECRET`: Secret for Client ID. It is required parameter. + +__Splunk configuration parameters:__ +* `SPLUNK_TOKEN`: [Splunk HTTP event collector token](http://docs.splunk.com/Documentation/Splunk/latest/Data/UsetheHTTPEventCollector/). It is required parameter. +* `SPLUNK_HOST`: Splunk HTTP event collector host. example: https://example.cloud.splunk.com:8088. It is required parameter. +* `SPLUNK_INDEX`: The Splunk index events will be sent to. Warning: Setting an invalid index will cause events to be lost. This index must match one of the selected indexes for the Splunk HTTP event collector token used for the SPLUNK_TOKEN parameter. It is required parameter. + +__Advanced Configuration Features:__ +* `JOB_NAME`: Tags nozzle log events with job name. It is optional. (Default: 'splunk-nozzle') +* `JOB_INDEX`: Tags nozzle log events with job index. (Default: -1) +* `JOB_HOST`: Tags nozzle log events with job host. (Default: "") +* `SKIP_SSL_VALIDATION_CF`: Skips SSL certificate validation for connection to Cloud Foundry. Secure communications will not check SSL certificates against a trusted certificate authority. +This is recommended for dev environments only. (Default: false) +* `SKIP_SSL_VALIDATION_SPLUNK`: Skips SSL certificate validation for connection to Splunk. Secure communications will not check SSL certificates against a trusted certificate authority. (Default: false) +This is recommended for dev environments only. +* `FIREHOSE_SUBSCRIPTION_ID`: Tags nozzle events with a Firehose subscription id. See https://docs.vmware.com/en/VMware-Tanzu-Application-Service/6.0/tas-for-vms/log-ops-guide.html. (Default: splunk-firehose) +* `FIREHOSE_KEEP_ALIVE`: Keep alive duration for the Firehose consumer. (Default: 25s) +* `ADD_APP_INFO`: Enrich raw data with app info. A comma separated list of app metadata (AppName,OrgName,OrgGuid,SpaceName,SpaceGuid). (Default: "") +* `ADD_TAGS`: Add additional tags from envelope to splunk event. (Default: false) + (Please note: Enabling this feature may slightly impact the performance due to the increased event size) +* `IGNORE_MISSING_APP`: If the application is missing, then stop repeatedly querying application info from Cloud Foundry. (Default: true) +* `MISSING_APP_CACHE_INVALIDATE_TTL`: How frequently the missing app info cache invalidates (in s/m/h. For example, 3600s or 60m or 1h). (Default: 0s) (see below for more details) +* `APP_CACHE_INVALIDATE_TTL`: How frequently the app info local cache invalidates (in s/m/h. For example, 3600s or 60m or 1h). (Default: 0s) (see below for more details) +* `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. It is a required field. Possible values: ValueMetric,CounterEvent,Error,LogMessage,HttpStartStop,ContainerMetric. If no event type is selected, nozzle will automatically select LogMessage to keep the nozzle running. (Default: "ValueMetric,CounterEvent,ContainerMetric") +* `EXTRA_FIELDS`: Extra fields to annotate your events with (format is key:value,key:value). (Default: "") +* `FLUSH_INTERVAL`: Time interval (in s/m/h. For example, 3600s or 60m or 1h) for flushing queue to Splunk regardless of `CONSUMER_QUEUE_SIZE`. Protects against stale events in low throughput systems. (Default: 5s) +* `CONSUMER_QUEUE_SIZE`: Sets the internal consumer queue buffer size. Events will be pushed to Splunk after queue is full. (Default: 10000) +* `HEC_BATCH_SIZE`: Set the batch size for the events to push to HEC (Splunk HTTP Event Collector). (Default: 100) +* `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_LOGGING_INDEX`: The Splunk index where logs from the nozzle of the sourcetype `cf:splunknozzle` will be sent to. Warning: Setting an invalid index will cause events to be lost. This index must match one of the selected indexes for the Splunk HTTP event collector token used for the SPLUNK_TOKEN parameter. When not provided, all logging events will be forwarded to the default SPLUNK_INDEX. (Default: "") +* `STATUS_MONITOR_INTERVAL`: Time interval (in s/m/h. For example, 3600s or 60m or 1h) to enable monitoring of metric data within the connector. (This increases CPU load and should be used only for insights purposes. Default: 0s). +* `SPLUNK_METRIC_INDEX`: Index in which metric data will be ingested when monitoring module is enabled +* `SELECTED_MONITORING_METRICS`: Name of the metrics that you want to monitor and add using comma seprated values. List of the metrics that are supported in the metrics modules are given below +* `REFRESH_SPLUNK_CONNECTION`: If set to true, PCF will periodically refresh connection to Splunk (how often depends on KEEP_ALIVE_TIMER value). If set to false connection will be kept alive and reused. (Default: false) +* `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: 0). + +__About app cache params:__ + +When ADD_APP_INFO config is enabled, the nozzle will enrich the event with app metadata. For this, the nozzle maintains a cache of all the apps locally so that it doesn’t need to query from remote every time. + +Now, when there is a change in this app data in remote, the nozzle has to update this local cache. For this, the config has APP_CACHE_INVALIDATE_TTL parameter. At every APP_CACHE_INVALIDATE_TTL interval, the nozzle will update the local cache by querying the remote (CF APIs). + +If APP_CACHE_INVALIDATE_TTL is set to 10s, the nozzle will refresh the local cache at every 10s. So, AppCacheTTL should be set based on how frequently the app data is expected to change. + +When the nozzle receives events from the doppler, it will check the local cache for the given app-id. But on cache-miss, it will query remote for that specific app. If it doesn’t find the app data from remote too, then the nozzle will add that app to MissingAppCache (if IGNORE_MISSING_APP config is **enabled**. so that the nozzle does not waste time in querying the remote for an app which is likely not to be found). So, from the next time onwards, the nozzle will first check in the MissingAppCache, if found then it will ignore the app and move on to the next event with a warning. + +MISSING_APP_CACHE_INVALIDATE_TTL is used to clear the MissingAppCache so nozzle can retry querying from remote. + +For example, given MISSING_APP_CACHE_INVALIDATE_TTL is set to 60s, when nozzle receives event from app that is not available in local cache and remote, it’ll add it to MissingAppCache. Until next MISSING_APP_CACHE_INVALIDATE_TTL, nozzle will not query from remote for the missing app. + +- - - - + +### Push as an App to Cloud Foundry + +Push Splunk Firehose Nozzle as an application to Cloud Foundry. Please refer to **Setup** section for details +on user authentication. + +1. Download the latest release + + ```shell + git clone https://github.com/cloudfoundry-community/splunk-firehose-nozzle.git + cd splunk-firehose-nozzle + ``` + +2. Authenticate to Cloud Foundry + + ```shell + cf login -a https://api.[your cf system domain] -u [your id] + ``` + +3. Copy the manifest template and fill in needed values (using the credentials created during setup) + + ```shell + vim scripts/ci_nozzle_manifest.yml + ``` + +4. Push the nozzle + + ```shell + make deploy-nozzle + ``` + +#### Dump application info to boltdb #### +If in production where there are lots of CF applications (say tens of thousands) and if the user would like to enrich +application logs by including application metadata, querying all application metadata information from CF may take some time - +for example if we include: add app name, space ID, space name, org ID and org name to the events. +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 +cache the metadata information to the local boltdb file. These queries will introduce load to the CF system and could potentially take a long time to finish. +Users can run this tool to generate a copy of all application metadata and copy this to each Splunk nozzle deployment. Each Splunk nozzle can pick up the cache copy and update the cache file incrementally afterwards. + +Example of how to run the dump application info tool: + +``` +$ cd tools/dump_app_info +$ go build dump_app_info.go +$ ./dump_app_info --skip-ssl-validation --api-endpoint=https:// --user= --password= +``` + +After populating the application info cache file, user can copy to different Splunk nozzle deployments and start Splunk nozzle to pick up this cache file by +specifying correct "--boltdb-path" flag or "BOLTDB_PATH" environment variable. + +### Disable logging for noisy applications +Set F2S_DISABLE_LOGGING = true as a environment variable in applications's manifest to disable logging. + + +## Index routing +Index routing is a feature that can be used to send different Cloud Foundry logs to different indexes for better ACL and data retention control in Splunk. + +### Per application index routing via application manifest +To enable per app index routing, +* Please set environment variable `SPLUNK_INDEX` in your application's manifest ([example below](#example-manifest-file)) +* Make sure Splunk nozzle is configured with `ADD_APP_INFO` (Select at least one of AppName,OrgName,OrgGuid,SpaceName,SpaceGuid) to enable app info caching +* Make sure `SPLUNK_INDEX` specified in app's manifest exist in Splunk and can receive data for the configured Splunk HEC token. + +> **WARNING**: If `SPLUNK_INDEX` is invalid, events from other apps may also get lost as splunk will drop entire event batch if any of the event from batch is invalid (i.e. invalid index) + +There are two ways to set the variable: + +In your app manifest provide an environment variable called `SPLUNK_INDEX` and assign it the index you would like to send the app data to. + +#### Example Manifest file +``` +applications: +- name: + memory: 256M + disk_quota: 256M + ... + env: + SPLUNK_INDEX: + ... +``` + +You can also update the env on the fly using cf-cli command: +``` +cf set-env SPLUNK_INDEX +``` +#### Please note +> If you are updating env on the fly, make sure that `APP_CACHE_INVALIDATE_TTL` is greater tha 0s. Otherwise cached app-info will not be updated and events will not be sent to required index. + + +### Index routing via Splunk configuration +Logs can be routed using fields such as app ID/name, space ID/name or org ID/name. +Users can configure the Splunk configuration files props.conf and transforms.conf on Splunk indexers or Splunk Heavy Forwarders if deployed. + +Below are few sample configuration: + +1. Route data from application ID `95930b4e-c16c-478e-8ded-5c6e9c5981f8` to a Splunk `prod` index: + +*$SPLUNK_HOME/etc/system/local/props.conf* +``` +[cf:logmessage] +TRANSFORMS-index_routing = route_data_to_index_by_field_cf_app_id +``` + + +*$SPLUNK_HOME/etc/system/local/transforms.conf* +``` +[route_data_to_index_by_field_cf_app_id] +REGEX = "(\w+)":"95930b4e-c16c-478e-8ded-5c6e9c5981f8" +DEST_KEY = _MetaData:Index +FORMAT = prod +``` + + +2. Routing application logs from any Cloud Foundry orgs whose names are prefixed with `sales` to a Splunk `sales` index. + +*$SPLUNK_HOME/etc/system/local/props.conf* +``` +[cf:logmessage] +TRANSFORMS-index_routing = route_data_to_index_by_field_cf_org_name + +``` + +*$SPLUNK_HOME/etc/system/local/transforms.conf* +``` +[route_data_to_index_by_field_cf_org_name] +REGEX = "cf_org_name":"(sales.*)" +DEST_KEY = _MetaData:Index +FORMAT = sales +``` + +3. Routing data from sourcetype `cf:splunknozzle` to index `new_index`: + +*$SPLUNK_HOME/etc/system/local/props.conf* +``` +[cf:splunknozzle] +TRANSFORMS-route_to_new_index = route_to_new_index +``` + +*$SPLUNK_HOME/etc/system/local/transforms.conf* +``` +[route_to_new_index] +SOURCE_KEY = MetaData:Sourcetype +DEST_KEY =_MetaData:Index +REGEX = (sourcetype::cf:splunknozzle) +FORMAT = new_index +``` +

Note:Moving from version 1.2.4 to 1.2.5, timestamp will use nanosecond precision instead of milliseconds.

+ + +## __Monitoring(Metric data Ingestion):__ + +| Metric Name | Description +|---|--- +| `nozzle.queue.percentage` | Shows how much internal queue is filled +| `splunk.events.dropped.count` | Number of events dropped from splunk HEC +| `splunk.events.sent.count` | Number of events sent to splunk +| `firehose.events.dropped.count` | Number of events dropped from nozzle +| `firehose.events.received.count` | Number of events received from firehose(websocket) +| `splunk.events.throughput` | Average Payload size +| `nozzle.usage.ram` | RAM Usage +| `nozzle.usage.cpu` | CPU Usage +| `nozzle.cache.memory.hit` | How many times it has successfully retrieved the data from memory +| `nozzle.cache.memory.miss` | How many times it has unsuccessfully tried to retreive the data from memory +| `nozzle.cache.remote.hit` | How many times it has successfully retrieved the data from remote +| `nozzle.cache.remote.miss` | How many times it has unsuccessfully tried to retrieve the data from remote +| `nozzle.cache.boltdb.hit` | How many times it has successfully retrieved the data from BoltDB +| `nozzle.cache.boltdb.miss` | How many times it has unsuccessfully tried to retrieve the data from BoltDB + +![event_count](https://user-images.githubusercontent.com/89519924/200804220-1adff84c-e6f1-4438-8d30-6e2cce4984f5.png) + +![nozzle_logs](https://user-images.githubusercontent.com/89519924/200804285-22ad7863-1db3-493a-8196-cc589837db76.png) + +

Note:Select value Rate(Avg) for Aggregation from Analysis tab on the top right.

+ +You can find a pre-made dashboard that can be used for monitoring in the `dashboards` directory. + +### Routing data through edge processor via HEC +Logs can be routed to Splunk via Edge Processor. Assuming that you have a working Edge Processor instance, you can use it with minimal +changes to nozzle configuration. + +Configuratino fields that you should change are: +* `SPLUNK_HOST`: Use the host of your Edge Processor instance instead of Splunk. Example: https://x.x.x.x:8088. +* `SPLUNK_TOKEN`: It is a required parameter. A token used to authorize your request, can be found in Edge Processor settings. If your +EP token authentication is turned off, you can enter a placeholder values instead (e.x. "-"). + +## Troubleshooting +This topic describes how to troubleshoot Splunk Firehose Nozzle for Cloud Foundry. + +#### 1. I can't find my data! + + Are you searching for events and not finding them or looking at a dashboard and seeing "No result found"? Check Splunk Nozzle app logs. + + To view the nozzle's logs running on CF do the following: + +
    +
  1. Log in as an admin via the CLI.
    2. +
  2. Target the org created by the tile.
    + 
    cf target -o SPLUNK-NOZZLE-ORG
    +
    3. +
  3. View the recent app Splunk Nozzle logs (the version number installed by the tile will vary).
    + 
    cf logs --recent splunk-firehoze-nozzle
    +
    4. +
  4. Alternatively, you can stream the app logs as they're emitted.
    + 
    cf logs splunk-firehose-nozzle
    +
    5. +
+ + +### Here are a few common errors and possible resolutions: + +#### Splunk configuration related errors: + +
{"timestamp":"
+ +This error usually occurs when SSL is enabled on the Splunk HEC endpoint. Confirm that you're using https' in the Splunk HEC URL. + + +
{"timestamp":"
+ +This usually means the index value specified in the configuration doesn't exist on Splunk Host. Confirm that you're using the correct Splunk index value. + + +
{"timestamp":"
+ +This can occur when the Splunk HEC Token value is invalid. Confirm that you're using a valid token. + +
{"timestamp":"
+ +This usually means that there was no valid SSL certificate found. Confirm that you're using a valid SSL certificate for the Splunk server, or set 'Skip SSL Validation' to `true` under Splunk settings. + +

Note:Disabling SSL validation is not recommended for production environments.

+ + +
{"timestamp":"
+ +This error can occur when the Splunk server is offline or when the Splunk HEC URL is not valid. Confirm that both the Splunk server is running and that you're using a valid URL. + +#### Cloud Foundry configuration related errors: + +
{"timestamp":"
+ +This error can occur when the credentials provided for CF environment are invalid. Confirm that the API User and API Password each have access to the CF environment. + + +
{"timestamp":"
+ +This means that no valid SSL certificate was found. To remediate this error, provide a valid SSL certificate for Cloud Foundry or set 'Skip SSL Validation' to true under Cloud Foundry Settings. + +

Note:Disabling SSL validation is not recommended for production environments.

+ +The following troubleshooting tips assume you have access to Splunk to run basic searches against index `_internal` and the user-specified index for Firehose events. + +### 2. Ensure Splunk Nozzle is forwarding events from the Firehose: + +Search app logs of the Nozzle to confirm correct behavior: + +
+sourcetype="cf:splunknozzle"
+
+ +A correct setup logs a start message with configuration parameters of the Nozzle logged as a JSON object, for example: + +
+  data:	{
+     add-app-info: AppName,OrgName,OrgGuid,SpaceName,SpaceGuid
+     api-endpoint: https://api.endpoint.com
+     app-cache-ttl: 0
+     app-limits: 0
+     batch-size: 1000
+     boltdb-path: cache.db
+     branch: null
+     buildos: null
+     commit: null
+     debug:	 false
+     extra-fields:
+     flush-interval: 5000000000
+     hec-workers: 8
+     ignore-missing-apps: true
+     job-host:
+     job-index: -1
+     job-name: splunk-nozzle
+     keep-alive: 25000000000
+     missing-app-cache-ttl:	 0
+     queue-size: 10000
+     retries: 2
+     skip-ssl: true
+     splunk-host: http://localhost:8088
+     splunk-index: atomic
+     firehose-subscription-id: splunk-firehose
+     trace-logging: true
+     status-monitor-interval: 0s
+     version:
+     wanted-events: ValueMetric,CounterEvent,Error,LogMessage,HttpStartStop,ContainerMetric
+  }
+  ip: 10.0.0.0
+  log_level: 1
+  logger_source: splunk-nozzle-logger
+  message: splunk-nozzle-logger.Running splunk-firehose-nozzle with following configuration variables
+  origin: splunk_nozzle
+
+ + Search app logs of the Nozzle for any errors: +
+sourcetype="cf:splunknozzle" data.error=*
+
+ +Errors are logged with corresponding message and stacktrace. + +### 3. Check for dropped events due to HTTP Event Collector availability: + +As the Splunk Firehose Nozzle sends data to Splunk via HTTPS using the HTTP Event Collector, it is also susceptible to any network issues across the network path from point to point. Run the following search to determine if Splunk has indexed any events indicating issues with the HEC Endpoint. + +
+  sourcetype="cf:splunknozzle" "dropping events"
+
+ +### 4. Check for dropped events due to slow downstream(Network/Splunk): + +If the nozzle emits the ‘dropped events’ warning saying that downstream is slow, then the network or Splunk environment might needs to be scaled. (eg. Splunk HEC receiver node, Splunk Indexer, LB etc) + +Run the following search to determine if Splunk has indexed any events indicating such issues. + +
+  sourcetype="cf:splunknozzle" "dropped Total of"
+
+ +### 5. Check for data loss inside the Splunk Firehose Nozzle: + +If "Event Tracing" is enabled, extra metadata will be attached to events. This allows searches to calculate the percentage of data loss inside the Splunk Firehose Nozzle, if applicable. + +Each instance of the Splunk Firehose Nozzle will run with a randomly generated UUID. The query below will display the message success rate for each UUID (Please update the index value based on your nozzle configuration). + +
+index=main | stats count as total_events, min(nozzle-event-counter) as min_number, max(nozzle-event-counter) as max_number by uuid | eval event_number =  max_number - min_number | eval success_percentage = total_events/event_number*100 | stats max(success_percentage) by uuid
+
+ +### 6. Authentication is not working even if correct CF Client ID/secret is configured: (applicable in v1.2.3) + +Due to a known issue in an indirect dependency (an OAuth library), if the client secret has any special characters (eg. *!#$&@^) then it will not work. For now, user has to configure a client secret without any of this characters. Once the library in question is updated in the next release it will work even with the special characters. + +#### Searching Events + +Here are two short Splunk queries to start exploring some of the Cloud Foundry events in Splunk. + +``` +sourcetype="cf:valuemetric" + | stats avg(value) by job_instance, name +``` + +``` +sourcetype="cf:counterevent" + | eval job_and_name=source+"-"+name + | stats values(job_and_name) +``` + +### 7. Nozzle is not collecting any data with 'websocket' (bad handshake) error + +If the nozzle reports below error, then check if the configured "firehose-subscription-id" has '#' as a prefix. Please remove the prefix or prepend any other character than '#' to fix this issue. +``` +Error dialing trafficcontroller server: websocket: bad handshake.\nPlease ask your Cloud Foundry Operator to check the platform configuration (trafficcontroller is wss://****:443). +``` + +### Development + +#### Software Requirements + +Make sure you have the following installed on your workstation: + +| Software | Version +| --- | --- | +| go | go1.17.x + +Then make sure that all dependent packages are there: + +``` +$ cd +$ make installdeps +``` + +#### Environment + +For development against [bosh-lite](https://github.com/cloudfoundry/bosh-lite), +copy `tools/nozzle.sh.template` to `tools/nozzle.sh` and supply missing values: + +``` +$ cp tools/nozzle.sh.template tools/nozzle.sh +$ chmod +x tools/nozzle.sh +``` + +Build project: + +``` +$ make VERSION=1.3.1 +``` + +Run tests with [Ginkgo](http://onsi.github.io/ginkgo/) + +``` +$ ginkgo -r +``` + +Run all kinds of testing + +``` +$ make test # run all unittest +$ make race # test if there is race condition in the code +$ make vet # examine GoLang code +$ make cov # code coverage test and code coverage html report +``` + +Or run all testings: unit test, race condition test, code coverage etc +``` +$ make testall +``` + +Run app + +``` +# this will run: go run main.go +$ ./tools/nozzle.sh +``` + +# Maintenance And Support + +Splunk Firehose Nozzle project is supported through Splunk Support assuming the customer has a current Splunk support entitlement. For customers that do not have a current Splunk support entitlement, please file an issue at [create a new issue](https://github.com/cloudfoundry-community/splunk-firehose-nozzle/issues/new/choose) + diff --git a/mkdocs.yml b/mkdocs.yml new file mode 100644 index 00000000..b89c5ac2 --- /dev/null +++ b/mkdocs.yml @@ -0,0 +1,37 @@ +--- +site_name: Splunk Firehose Nozzle + +extra: + version: + provider: mike + default: develop + +markdown_extensions: + - toc: + permalink: true + - smarty + - fenced_code + - sane_lists + - codehilite + - attr_list + - md_in_html + +plugins: + - search: + lang: en + - mike + +extra_javascript: + - javascripts/footer.js + +copyright:

Webpages built on GitHub Pages | Github Terms | GitHub Privacy

+ +theme: + name: "material" + palette: + primary: "black" + accent: "orange" + +nav: + - Home: "index.md" + - Monitoring dashboard: "index.md" diff --git a/tile/tile-history.yml b/tile/tile-history.yml index 0610d5b0..720a32f9 100644 --- a/tile/tile-history.yml +++ b/tile/tile-history.yml @@ -1,15 +1,16 @@ --- history: - - 0.2.1 - - 1.0.0 - - 1.0.1 - - 1.0.2 - - 1.1.0 - - 1.1.1 - - 1.1.2 - - 1.2.0 - - 1.2.1 - - 1.2.2 - - 1.2.3 - - 1.3.0 -version: 1.3.1 +- 0.2.1 +- 1.0.0 +- 1.0.1 +- 1.0.2 +- 1.1.0 +- 1.1.1 +- 1.1.2 +- 1.2.0 +- 1.2.1 +- 1.2.2 +- 1.2.3 +- 1.3.0 +- 1.3.1 +version: 1.3.2