# blackbox **Repository Path**: mirrors_cloudfoundry/blackbox ## Basic Information - **Project Name**: blackbox - **Description**: Forward logs from files on windows and linux. - **Primary Language**: Unknown - **License**: Apache-2.0 - **Default Branch**: main - **Homepage**: None - **GVP Project**: No ## Statistics - **Stars**: 0 - **Forks**: 0 - **Created**: 2020-09-24 - **Last Updated**: 2026-03-15 ## Categories & Tags **Categories**: Uncategorized **Tags**: None ## README # blackbox If you have any questions, or want to get attention for a PR or issue please reach out on the [#logging-and-metrics channel in the cloudfoundry slack](https://cloudfoundry.slack.com/archives/CUW93AF3M) ## About Blackbox will tail all files in sub-directories of a specified `source_dir`, and forward any new lines to a syslog server. This is currently used in [syslog-release][syslog] and [windows-syslog-release][windows-syslog]. ## Usage ``` blackbox -config config.yml ``` The configuration file schema is as follows: ``` yaml hostname: this-host syslog: destination: transport: udp address: logs.example.com:1234 source_dir: /path/to/log-dir log_filename: false ``` Consider the case where `log-dir` has the following structure: ``` /path/to/log-dir |-- app1 | |-- stdout.log | `-- stderr.log `-- app2 |-- foo.log `-- bar.log ``` Any new lines written to `app1/stdout.log` and `app1/stderr.log` get sent to syslog tagged as `app1`, while new lines written to `app2/foo.log` and `app2/bar.log` get sent to syslog tagged as `app2`. If `log_filename` is set to `true` then the filename is included in the tag. For example, new lines written to `app1/stdout.log` get sent to syslog tagged as `app1/stdout.log`. Currently, the priority and facility are hardcoded to `INFO` and `user`. ## Installation ``` go get -u code.cloudfoundry.org/blackbox/cmd/blackbox ``` [windows-syslog]: https://github.com/cloudfoundry/windows-syslog-release [syslog]: https://github.com/cloudfoundry/syslog-release