From 26925baaff0868c7a32bba61891cfda2901c727d Mon Sep 17 00:00:00 2001 From: Julia <611228+hithwen@users.noreply.github.com> Date: Tue, 18 Aug 2020 15:16:09 +0200 Subject: [PATCH] Apply suggestions from code review Co-authored-by: Kari Halsted <12926135+kayayarai@users.noreply.github.com> --- .../assets/configuration/spec.yaml | 18 +++++++++--------- .../cassandra_nodetool/data/conf.yaml.example | 18 +++++++++--------- 2 files changed, 18 insertions(+), 18 deletions(-) diff --git a/cassandra_nodetool/assets/configuration/spec.yaml b/cassandra_nodetool/assets/configuration/spec.yaml index 2f0f7e191b99c..9d6933e9d03a9 100644 --- a/cassandra_nodetool/assets/configuration/spec.yaml +++ b/cassandra_nodetool/assets/configuration/spec.yaml @@ -6,13 +6,13 @@ files: options: - name: nodetool description: | - command or path to nodetool (e.g. /usr/bin/nodetool or docker exec container nodetool) - can be overwritten on an instance + The command or path to nodetool (for example, /usr/bin/nodetool or docker exec container nodetool) + can be overwritten on an instance. Note: Agent v6.11+ on Windows runs as an unprivileged user (`ddagentuser`). That user needs to be granted access to the nodetool installation directory for the check to work. - The nodetool installation also sets some environment variables (e.g. `CASSANDRA_HOME` and `DSCINSTALLDIR`), - but sets them as variables only for the user doing the nodetool installation. Those environment variables should - be set as system-wide variables. + The nodetool installation also sets some environment variables (for example, `CASSANDRA_HOME` + and `DSCINSTALLDIR`), but sets them as variables only for the user doing the nodetool installation. + You should set those environment variables as system-wide variables. required: true value: type: string @@ -35,26 +35,26 @@ files: type: string example: localhost - name: port - description: The port JMX is listening to for connections. + description: The port JMX listens to for connections. value: type: integer example: 7199 - name: username description: | Username from the credentials needed to connect to the host. These are the credentials for the JMX server. - For the check to work, this user must have a read/write access so that the Datadog Cassandra nodetool + For the check to work, this user must have a read/write access so that the Datadog Cassandra Nodetool check can execute the `status` command value: type: string - name: password description: | - Username from the credentials needed to connect to the host. These are the credentials for the JMX server. + Password from the credentials needed to connect to the host. These are the credentials for the JMX server. For the check to work, this user must have a read/write access so that the Datadog Cassandra Nodetool check can execute the `status` command value: type: string - name: ssl - description: Whether or not to use the --ssl parameter to nodetool to initiate a connection over SSL to the JMX server. + description: Whether to use the --ssl parameter with nodetool to initiate a connection over SSL to the JMX server. value: type: boolean example: false diff --git a/cassandra_nodetool/datadog_checks/cassandra_nodetool/data/conf.yaml.example b/cassandra_nodetool/datadog_checks/cassandra_nodetool/data/conf.yaml.example index 966df454b95d1..d993b1ce0886c 100644 --- a/cassandra_nodetool/datadog_checks/cassandra_nodetool/data/conf.yaml.example +++ b/cassandra_nodetool/datadog_checks/cassandra_nodetool/data/conf.yaml.example @@ -3,13 +3,13 @@ init_config: ## @param nodetool - string - required - ## command or path to nodetool (e.g. /usr/bin/nodetool or docker exec container nodetool) - ## can be overwritten on an instance + ## The command or path to nodetool (for example, /usr/bin/nodetool or docker exec container nodetool) + ## can be overwritten on an instance. ## Note: Agent v6.11+ on Windows runs as an unprivileged user (`ddagentuser`). That user needs to be granted ## access to the nodetool installation directory for the check to work. - ## The nodetool installation also sets some environment variables (e.g. `CASSANDRA_HOME` and `DSCINSTALLDIR`), - ## but sets them as variables only for the user doing the nodetool installation. Those environment variables should - ## be set as system-wide variables. + ## The nodetool installation also sets some environment variables (for example, `CASSANDRA_HOME` + ## and `DSCINSTALLDIR`), but sets them as variables only for the user doing the nodetool installation. + ## You should set those environment variables as system-wide variables. # nodetool: nodetool @@ -36,26 +36,26 @@ instances: # host: localhost ## @param port - integer - optional - default: 7199 - ## The port JMX is listening to for connections. + ## The port JMX listens to for connections. # # port: 7199 ## @param username - string - optional ## Username from the credentials needed to connect to the host. These are the credentials for the JMX server. - ## For the check to work, this user must have a read/write access so that the Datadog Cassandra nodetool + ## For the check to work, this user must have a read/write access so that the Datadog Cassandra Nodetool ## check can execute the `status` command # # username: ## @param password - string - optional - ## Username from the credentials needed to connect to the host. These are the credentials for the JMX server. + ## Password from the credentials needed to connect to the host. These are the credentials for the JMX server. ## For the check to work, this user must have a read/write access so that the Datadog Cassandra Nodetool ## check can execute the `status` command # # password: ## @param ssl - boolean - optional - default: false - ## Whether or not to use the --ssl parameter to nodetool to initiate a connection over SSL to the JMX server. + ## Whether to use the --ssl parameter with nodetool to initiate a connection over SSL to the JMX server. # # ssl: false