Added remote jmx flag for jBoss6 (#175)

* Added remote jmx flag for jBoss6

* using optional paramters

* removed bool value for remote flag command parameter

* Changelog

* removed deprecated methods Open and OpenWithSSL

* changelog

* Added documentation

Author: ferranorriols

CHANGELOG.md

@@ -7,6 +7,13 @@ and this project adheres to [Semantic Versioning](http://semver.org/).
 
 ## Next Release
 
+### Changed
+
+- New JMX option for remote URL protocol connections.
+- Changed JMX open method. New `jmx.OpenWithParameters` accepts optionals parameters like SSL, remote connections, etc. Old integrations using old  methods `jmx.OpenWithSSL` and `jmx.Open` should use this new `jmx.OpenWithParameters` method instead. 
+
+## 3.1.2
+
 ### Added
 
 - Protocol v3: See full [documentation](docs/protocol-v3.md).

docs/toolset/jmx.md

@@ -30,7 +30,9 @@ the [SDK JMX GoDoc page]([http.New GoDoc](https://godoc.org/github.com/newrelic/
 
 * `jmx.Open` ([GoDoc]([http.New GoDoc](https://godoc.org/github.com/newrelic/infra-integrations-sdk/jmx#Open)))
     - Instantiates a JMX client. It requires a `hostname` and a `port` as arguments. `username` and
-      `password` are optional (pass empty strings `""` if no user/password).
+      `password` are optional (pass empty strings `""` if no user/password). There is also the possibility to configure
+     the JMX agent with SSL or configure the remote URL connection using the [Option](https://godoc.org/github.com/newrelic/infra-integrations-sdk/jmx#Option) type.
+     See example below using the SSL configuration.
     - By default, the generated client will look for the [NRJMX tool](#installing-nr-jmx) in the path `/usr/bin/nrjmx`,
       but this location can be overriden by means of the `NR_JMX_TOOL` environment variable.
     - This function will return the global `ErrJmxCmdRunning` error, if there is already another instance of NRJMX
@@ -42,7 +44,7 @@ the [SDK JMX GoDoc page]([http.New GoDoc](https://godoc.org/github.com/newrelic/
        MBean Object Name (in the `domain:key-property-list` form) and the value is the sample value for this metric
        at the given moment.
 
-## Basic usage example
+## Example 1: Basic usage
 
 ```go
 jmx.Open("127.0.0.1", "9010", "", "")
@@ -74,3 +76,23 @@ java.lang:type=OperatingSystem,attr=AvailableProcessors -> 8
 java.lang:type=OperatingSystem,attr=FreeSwapSpaceSize -> 977272832
 java.lang:type=OperatingSystem,attr=ProcessCpuTime -> 1039197000
 ```
+
+# Example 2: Open connection with SSL
+```go
+ssl := WithSSL(
+	"/etc/pki/JMXClientKeyStore.key", 
+	"password_key", 
+	"/etc/pki/JMXClientTrustStore.key", 
+	"password_trust",
+)
+jmx.Open("127.0.0.1", "9010", "", "", ssl)
+```
+
+# Example 3: Remoting protocol for JMX
+Some jBoss versions need the `remoting-jmx` protocol URL. Use `WithRemoteProtocol()` for using this remoting URL.
+- **URL without remoting protocol** `service:jmx:rmi:///jndi/rmi://host:port/jmxrmi`
+- **Remoting URL** `service:jmx:remoting-jmx://host:port`
+
+```go
+jmx.Open("127.0.0.1", "9010", "", "", WithRemoteProtocol())
+```

jmx/jmx.go

@@ -39,38 +39,82 @@ const (
 	jmxLineBuffer = 4 * 1024 * 1024 // Max 4MB per line. If single lines are outputting more JSON than that, we likely need smaller-scoped JMX queries
 )
 
-func getCommand(hostname, port, username, password string) (c []string) {
+// connectionConfig is the configuration for the nrjmx command.
+type connectionConfig struct {
+	hostname           string
+	port               string
+	username           string
+	password           string
+	keyStore           string
+	keyStorePassword   string
+	trustStore         string
+	trustStorePassword string
+	remote             bool
+}
+
+func (cfg *connectionConfig) isSSL() bool {
+	return cfg.keyStore != "" && cfg.keyStorePassword != "" && cfg.trustStore != "" && cfg.trustStorePassword != ""
+}
+
+func (cfg *connectionConfig) command() []string {
+	c := make([]string, 0)
 	if os.Getenv("NR_JMX_TOOL") != "" {
 		c = strings.Split(os.Getenv("NR_JMX_TOOL"), " ")
 	} else {
 		c = []string{jmxCommand}
 	}
 
-	c = append(c, "--hostname", hostname, "--port", port)
-	if username != "" && password != "" {
-		c = append(c, "--username", username, "--password", password)
+	c = append(c, "--hostname", cfg.hostname, "--port", cfg.port)
+	if cfg.username != "" && cfg.password != "" {
+		c = append(c, "--username", cfg.username, "--password", cfg.password)
+	}
+	if cfg.remote {
+		c = append(c, "--remote")
+	}
+	if cfg.isSSL() {
+		c = append(c, "--keyStore", cfg.keyStore, "--keyStorePassword", cfg.keyStorePassword, "--trustStore", cfg.trustStore, "--trustStorePassword", cfg.trustStorePassword)
 	}
 
-	return
+	return c
 }
 
-func getCommandWithSSL(hostname, port, username, password, keyStore, keyStorePassword, trustStore, trustStorePassword string) []string {
-	c := getCommand(hostname, port, username, password)
+// Open executes a nrjmx command using the given options.
+func Open(hostname, port, username, password string, opts ...Option) error {
+	config := &connectionConfig{
+		hostname: hostname,
+		port:     port,
+		username: username,
+		password: password,
+	}
 
-	if keyStore != "" && keyStorePassword != "" && trustStore != "" && trustStorePassword != "" {
-		c = append(c, "--keyStore", keyStore, "--keyStorePassword", keyStorePassword, "--trustStore", trustStore, "--trustStorePassword", trustStorePassword)
+	for _, opt := range opts {
+		opt(config)
 	}
 
-	return c
+	return openConnection(config)
 }
 
-// Open will start the nrjmx command with the provided connection parameters.
-func Open(hostname, port, username, password string) error {
-	return OpenWithSSL(hostname, port, username, password, "", "", "", "")
+// Option sets an option on integration level.
+type Option func(config *connectionConfig)
+
+// WithSSL for SSL connection configuration.
+func WithSSL(keyStore, keyStorePassword, trustStore, trustStorePassword string) Option {
+	return func(config *connectionConfig) {
+		config.keyStore = keyStore
+		config.keyStorePassword = keyStorePassword
+		config.trustStore = trustStore
+		config.trustStorePassword = trustStorePassword
+	}
+}
+
+// WithRemoteProtocol uses the remote JMX protocol URL.
+func WithRemoteProtocol() Option {
+	return func(config *connectionConfig) {
+		config.remote = true
+	}
 }
 
-// OpenWithSSL will start the nrjmx command with the provided SSL connection parameters
-func OpenWithSSL(hostname, port, username, password, keyStore, keyStorePassword, trustStore, trustStorePassword string) error {
+func openConnection(config *connectionConfig) error {
 	lock.Lock()
 	defer lock.Unlock()
 
@@ -88,7 +132,7 @@ func OpenWithSSL(hostname, port, username, password, keyStore, keyStorePassword,
 	var err error
 	var ctx context.Context
 
-	cliCommand := getCommandWithSSL(hostname, port, username, password, keyStore, keyStorePassword, trustStore, trustStorePassword)
+	cliCommand := config.command()
 
 	ctx, cancel = context.WithCancel(context.Background())
 	cmd = exec.CommandContext(ctx, cliCommand[0], cliCommand[1:]...)

jmx/jmx_test.go

@@ -60,7 +60,7 @@ func TestMain(m *testing.M) {
 	}
 }
 
-func TestOpen_OnlyWorksWhenClosed(t *testing.T) {
+func TestOpenWithParameters_OnlyWorksWhenClosed(t *testing.T) {
 	defer Close()
 
 	assert.NoError(t, Open("", "", "", ""))
@@ -69,15 +69,6 @@ func TestOpen_OnlyWorksWhenClosed(t *testing.T) {
 	assert.NoError(t, Open("", "", "", ""))
 }
 
-func TestOpenWithSSL_OnlyWorksWhenClosed(t *testing.T) {
-	defer Close()
-
-	assert.NoError(t, OpenWithSSL("", "", "", "", "", "", "", ""))
-	assert.Error(t, OpenWithSSL("", "", "", "", "", "", "", ""))
-	Close()
-	assert.NoError(t, OpenWithSSL("", "", "", "", "", "", "", ""))
-}
-
 func TestQuery(t *testing.T) {
 	for q, isErr := range query2IsErr {
 		assert.NoError(t, openWait("", "", "", "", openAttempts), "error on opening for query %s", q)
@@ -160,7 +151,8 @@ func openWait(hostname, port, username, password string, attempts int) error {
 }
 
 func openWaitWithSSL(hostname, port, username, password, keyStore, keyStorePassword, trustStore, trustStorePassword string, attempts int) error {
-	err := OpenWithSSL(hostname, port, username, password, keyStore, keyStorePassword, trustStore, trustStorePassword)
+	ssl := WithSSL(keyStore, keyStorePassword, trustStore, trustStorePassword)
+	err := Open(hostname, port, username, password, ssl)
 	if err == ErrJmxCmdRunning && attempts > 0 {
 		attempts--
 		time.Sleep(10 * time.Millisecond)