{"id":31904157,"url":"https://github.com/cloudfoundry-community/firehose-plugin","last_synced_at":"2025-10-13T13:47:46.936Z","repository":{"id":57543830,"uuid":"85695338","full_name":"cloudfoundry-community/firehose-plugin","owner":"cloudfoundry-community","description":"Cloud Foundry CLI plugin to connect to the firehose","archived":false,"fork":false,"pushed_at":"2017-11-28T05:19:25.000Z","size":56,"stargazers_count":6,"open_issues_count":0,"forks_count":2,"subscribers_count":49,"default_branch":"master","last_synced_at":"2024-06-20T11:16:16.025Z","etag":null,"topics":["cf-cli","cf-cli-plugin","cloudfoundry"],"latest_commit_sha":null,"homepage":"https://plugins.cloudfoundry.org","language":"Go","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/cloudfoundry-community.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2017-03-21T11:46:47.000Z","updated_at":"2024-02-09T14:25:38.000Z","dependencies_parsed_at":"2022-08-27T18:51:27.096Z","dependency_job_id":null,"html_url":"https://github.com/cloudfoundry-community/firehose-plugin","commit_stats":null,"previous_names":[],"tags_count":4,"template":false,"template_full_name":null,"purl":"pkg:github/cloudfoundry-community/firehose-plugin","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cloudfoundry-community%2Ffirehose-plugin","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cloudfoundry-community%2Ffirehose-plugin/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cloudfoundry-community%2Ffirehose-plugin/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cloudfoundry-community%2Ffirehose-plugin/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/cloudfoundry-community","download_url":"https://codeload.github.com/cloudfoundry-community/firehose-plugin/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cloudfoundry-community%2Ffirehose-plugin/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":279015339,"owners_count":26085685,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-10-13T02:00:06.723Z","response_time":61,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["cf-cli","cf-cli-plugin","cloudfoundry"],"created_at":"2025-10-13T13:47:40.890Z","updated_at":"2025-10-13T13:47:46.928Z","avatar_url":"https://github.com/cloudfoundry-community.png","language":"Go","readme":"# nozzle-plugin\n\n[![Build Status](https://travis-ci.org/cloudfoundry-community/firehose-plugin.svg?branch=master)](https://travis-ci.org/cloudfoundry-community/firehose-plugin)\n\n## Installation\n\n```bash\ncf add-plugin-repo CF-Community http://plugins.cloudfoundry.org/\ncf install-plugin \"Firehose Plugin\" -r CF-Community\n```\n\n## Usage\n\nUser must be logged in as admin\n\n### Options\n\nThe entire firehose for CF.\n\n```\nNAME:\n   nozzle - Displays messages from the firehose\n\nUSAGE:\n   cf nozzle\n\nOPTIONS:\n   -debug                 -d, enable debugging\n   -filter                -f, specify message filter such as LogMessage, ValueMetric, CounterEvent, HttpStartStop\n   -no-filter             -n, no firehose filter. Display all messages\n   -subscription-id       -s, specify subscription id for distributing firehose output between clients\n```\n\nAll logs, metrics and events for a given app. This differs from `cf logs APP_NAME`\nbecause it provides other information like container metrics that are related\nto the app.\n\n```\nNAME:\n   app-nozzle - Displays messages from the firehose for a given app\n\nUSAGE:\n   cf app-nozzle APP_NAME\n\nOPTIONS:\n   -debug           -d, enable debugging\n   -filter          -f, specify message filter such as LogMessage, ValueMetric, CounterEvent, HttpStartStop\n   -no-filter       -n, no filter. Display all messages\n```\n\n### With Interactive Prompt\n\n```bash\ncf nozzle\ncf app-nozzle APP_NAME\n```\n\n### Without Interactive Prompt\n\nError message will be displayed for unrecognized filter type\n\n```bash\n# For debug\ncf nozzle --debug\ncf app-nozzle APP_NAME --debug\n\n# For all messages\ncf nozzle --no-filter\ncf app-nozzle APP_NAME --no-filter\n\n# For Log Messages\ncf nozzle --filter LogMessage\ncf app-nozzle APP_NAME --filter LogMessage\n\n# For HttpStartStop\ncf nozzle --filter HttpStartStop\ncf app-nozzle APP_NAME --filter HttpStartStop\n\n# For ValueMetric\ncf nozzle --filter ValueMetric\ncf app-nozzle APP_NAME --filter ValueMetric\n\n# For CounterEvent\ncf nozzle --filter CounterEvent\ncf app-nozzle APP_NAME --filter CounterEvent\n\n# For ContainerMetric\ncf nozzle --filter ContainerMetric\ncf app-nozzle APP_NAME --filter ContainerMetric\n\n# For Error\ncf nozzle --filter Error\ncf app-nozzle APP_NAME --filter Error\n```\n\n#### Subscription ID\n\nIn order to distribute the firehose data evenly among multiple CLI sessions, the user must specify\nthe same subscription ID to each of the client connections.\n\n```bash\ncf nozzle --no-filter --subscription-id myFirehose\n```\n\n## Uninstall\n\n```bash\ncf uninstall-plugin FirehosePlugin\n```\n\n## Testing\n\nRun tests\n\n```bash\n./scripts/test.sh\n```\n\nIf you want to install the plugin locally and test it manually\n\n```bash\n./scripts/install.sh\n```\n\n## Releasing\n\nIn order to create a new release, follow these steps\n\n1. Create local tag and binaries\n  ```\n  ./scripts/build-all.sh release VERSION_NUMBER #(e.g. 0.7.0)\n  ```\n1. Copy the output of the previous command from the first line (should be '- name: Firehose Plugin' to the last checksum line (should be something like checksum: fde5fd52c40ea4c34330426c09c143a76a77a8db)\n1. Push the tag `git push --follow-tags`\n1. On github, create new release based on new tag [here](https://github.com/cloudfoundry-community/firehose-plugin/releases/new)\n1. Upload the three binaries from the ./bin folders to the release (Linux, OSX and Win64)\n1. Fork [this repo](https://github.com/cloudfoundry-incubator/cli-plugin-repo) and clone it locally\n1. Edit the `repo-index.yml` to override the existing section about the firehose plugin with the text previously copied in Step 2.\n1. Run `go run sort/main.go repo-index.yml` in the cli-plugin-repo to alphabetize the properties\n1. Run `BINARY_VALIDATION=true go test`\n1. Push the change to your fork\n1. Create a PR against the [original repo](https://github.com/cloudfoundry-incubator/cli-plugin-repo/compare)\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcloudfoundry-community%2Ffirehose-plugin","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcloudfoundry-community%2Ffirehose-plugin","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcloudfoundry-community%2Ffirehose-plugin/lists"}