A Cloud Foundry CLI plugin for access service instance logs
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
cfutil
cli
docs
format
integration_test
logclient
logging
pluginutil
vendor
.gitignore
CONTRIBUTING.md
LICENSE
NOTICE
README.md
plugin.go
version

README.md

Service Instance Logging CLI Plugin

This repository provides a Cloud Foundry CLI plugin for accessing the logs of service instances created by Spring Cloud Dataflow or, in the future, Spring Cloud Services.

For information on plugin development, see Developing a plugin.

Building

To build the plugin, install go and govendor (see the Go Development guide for instructions) and issue:

$ rm $GOPATH/bin/service-instance-logs-cli-plugin
$ cd $GOPATH/src/github.com/pivotal-cf/service-instance-logs-cli-plugin
$ govendor install -ldflags="-X main.pluginVersion=$(cat version)" +local

This builds the plugin with the current version number in the version file.

Note: if an invalid version number is provided, the build will succeed, but the plugin will fail to install (with exit status code 64).

To print the version number of the built plugin, run it as a stand-alone executable, for example:

$ $GOPATH/bin/service-instance-logs-cli-plugin
This program is a plugin which expects to be installed into the cf CLI. It is not intended to be run stand-alone.
Plugin version: 0.0.8

Installing

From CF Community

To install the plugin from the Cloud Foundry Community Plugins, run the following command:

cf install-plugin -r CF-Community "Service Instance Logging"

From Manual Build

To install the plugin in the cf CLI from generated, first build it and then issue:

$ cf install-plugin -f $GOPATH/bin/service-instance-logs-cli-plugin

The plugin's commands may then be listed by issuing cf help.

To update the plugin, uninstall it as follows and then re-install the plugin as above:

$ cf uninstall-plugin service-instance-logging

Command docs

With the plugin installed in the cf CLI, the Service Instance Logs CLI plugin command docs can be generated by running the following commands:

$ cd docs
$ ./generate-cli-docs-from-help.sh

The generated docs may be viewed here.

Go Development

See the Go Development guide. (If you just want to build and install the plugin, simply install go and govendor.)

Testing

Run the tests as follows:

$ cd $GOPATH/src/github.com/pivotal-cf/service-instance-logs-cli-plugin
$ govendor test +local

License

The Service Instance Logs CLI plugin is Open Source software released under the Apache 2.0 license.

Contributing

Contributions are welcomed. Please refer to the Contributor's Guide.