From d17f354d4fc8ea89e9df27da1040ae77dd3f839d Mon Sep 17 00:00:00 2001 From: Bob Roldan Date: Mon, 30 Nov 2020 15:38:54 -0500 Subject: [PATCH] DBZ-2741 Remove obsolete monitoring content from `/partials` directory --- .../assembly-enabling-jmx-docker.adoc | 17 ------- ...mbly-enabling-jmx-local-installations.adoc | 13 ----- .../con-metrics-monitoring-connectors.adoc | 16 ------ .../con-using-prometheus-grafana.adoc | 10 ---- ...nect-jmx-environment-variables-docker.adoc | 51 ------------------- ...fka-connect-jmx-environment-variables.adoc | 17 ------- ...afka-jmx-environment-variables-docker.adoc | 41 --------------- .../ref-kafka-jmx-environment-variables.adoc | 17 ------- ...eper-jmx-environment-variables-docker.adoc | 47 ----------------- ...f-zookeeper-jmx-environment-variables.adoc | 28 ---------- 10 files changed, 257 deletions(-) delete mode 100644 documentation/modules/ROOT/partials/assemblies/monitoring/assembly-enabling-jmx-docker.adoc delete mode 100644 documentation/modules/ROOT/partials/assemblies/monitoring/assembly-enabling-jmx-local-installations.adoc delete mode 100644 documentation/modules/ROOT/partials/modules/monitoring/con-metrics-monitoring-connectors.adoc delete mode 100644 documentation/modules/ROOT/partials/modules/monitoring/con-using-prometheus-grafana.adoc delete mode 100644 documentation/modules/ROOT/partials/modules/monitoring/ref-kafka-connect-jmx-environment-variables-docker.adoc delete mode 100644 documentation/modules/ROOT/partials/modules/monitoring/ref-kafka-connect-jmx-environment-variables.adoc delete mode 100644 documentation/modules/ROOT/partials/modules/monitoring/ref-kafka-jmx-environment-variables-docker.adoc delete mode 100644 documentation/modules/ROOT/partials/modules/monitoring/ref-kafka-jmx-environment-variables.adoc delete mode 100644 documentation/modules/ROOT/partials/modules/monitoring/ref-zookeeper-jmx-environment-variables-docker.adoc delete mode 100644 documentation/modules/ROOT/partials/modules/monitoring/ref-zookeeper-jmx-environment-variables.adoc diff --git a/documentation/modules/ROOT/partials/assemblies/monitoring/assembly-enabling-jmx-docker.adoc b/documentation/modules/ROOT/partials/assemblies/monitoring/assembly-enabling-jmx-docker.adoc deleted file mode 100644 index 075e0126b..000000000 --- a/documentation/modules/ROOT/partials/assemblies/monitoring/assembly-enabling-jmx-docker.adoc +++ /dev/null @@ -1,17 +0,0 @@ -:context: debezium - -[id="enabling-jmx-docker"] -= Enabling JMX in Docker - -If you are running Zookeeper, Kafka, and Kafka Connect in Docker containers, -enabling JMX requires several additional environment variables that are not typically needed when running on a local machine. -This is because the JVM requires the host name to which it will advertise itself to JMX clients. -Thus, {prodname}'s Docker images for Zookeeper, Kafka, and Kafka Connect use several environment variables to enable and configure JMX. -Most of the environment variables are the same for all of the images, -but there are some minor differences. - -include::{partialsdir}/modules/monitoring/ref-zookeeper-jmx-environment-variables-docker.adoc[leveloffset=+1] - -include::{partialsdir}/modules/monitoring/ref-kafka-jmx-environment-variables-docker.adoc[leveloffset=+1] - -include::{partialsdir}/modules/monitoring/ref-kafka-connect-jmx-environment-variables-docker.adoc[leveloffset=+1] diff --git a/documentation/modules/ROOT/partials/assemblies/monitoring/assembly-enabling-jmx-local-installations.adoc b/documentation/modules/ROOT/partials/assemblies/monitoring/assembly-enabling-jmx-local-installations.adoc deleted file mode 100644 index a277f0b93..000000000 --- a/documentation/modules/ROOT/partials/assemblies/monitoring/assembly-enabling-jmx-local-installations.adoc +++ /dev/null @@ -1,13 +0,0 @@ -:context: debezium - -[id="enabling-jmx-local-installation"] -= Enabling JMX in local installations - -With Zookeeper, Kafka, and Kafka Connect, -you enable JMX by setting the appropriate environment variables when you start each service. - -include::{partialsdir}/modules/monitoring/ref-zookeeper-jmx-environment-variables.adoc[leveloffset=+1] - -include::{partialsdir}/modules/monitoring/ref-kafka-jmx-environment-variables.adoc[leveloffset=+1] - -include::{partialsdir}/modules/monitoring/ref-kafka-connect-jmx-environment-variables.adoc[leveloffset=+1] diff --git a/documentation/modules/ROOT/partials/modules/monitoring/con-metrics-monitoring-connectors.adoc b/documentation/modules/ROOT/partials/modules/monitoring/con-metrics-monitoring-connectors.adoc deleted file mode 100644 index 26b06f114..000000000 --- a/documentation/modules/ROOT/partials/modules/monitoring/con-metrics-monitoring-connectors.adoc +++ /dev/null @@ -1,16 +0,0 @@ - -[id="metrics-monitoring-connectors"] -= Metrics for monitoring {prodname} connectors - -In addition to the built-in support for JMX metrics in Kafka, Zookeeper, and Kafka Connect, -each connector provides additional metrics that you can use to monitor their activities. - -* {link-prefix}:{link-mysql-connector}#mysql-monitoring[MySQL connector metrics] -* {link-prefix}:{link-mongodb-connector}#mongodb-monitoring[MongoDB connector metrics] -* {link-prefix}:{link-postgresql-connector}#postgresql-monitoring[PosgreSQL connector metrics] -* {link-prefix}:{link-sqlserver-connector}#sqlserver-monitoring[SQL Server connector metrics] -* {link-prefix}:{link-db2-connector}#db2-monitoring[Db2 connector metrics] -ifdef::community[] -* {link-prefix}:{link-oracle-connector}#oracle-monitoring[Oracle connector metrics] -* {link-prefix}:{link-cassandra-connector}#cassandra-monitoring[Cassandra connector metrics] -endif::community[] diff --git a/documentation/modules/ROOT/partials/modules/monitoring/con-using-prometheus-grafana.adoc b/documentation/modules/ROOT/partials/modules/monitoring/con-using-prometheus-grafana.adoc deleted file mode 100644 index ef57d72d2..000000000 --- a/documentation/modules/ROOT/partials/modules/monitoring/con-using-prometheus-grafana.adoc +++ /dev/null @@ -1,10 +0,0 @@ -[id="using-prometheus-grafana"] -= Using Prometheus and Grafana - -The metrics exposed by {prodname} and Kafka can be exported and displayed with https://prometheus.io/[Prometheus] and https://grafana.com/[Grafana]. -You can find an example for the required configuration and example dashboards for different connectors in the https://github.com/debezium/debezium-examples/tree/master/monitoring[Debezium examples repository]. - -[NOTE] -==== -These dashboards are not part of {prodname} itself and are maintained on a best-effort basis. -==== diff --git a/documentation/modules/ROOT/partials/modules/monitoring/ref-kafka-connect-jmx-environment-variables-docker.adoc b/documentation/modules/ROOT/partials/modules/monitoring/ref-kafka-connect-jmx-environment-variables-docker.adoc deleted file mode 100644 index d15297326..000000000 --- a/documentation/modules/ROOT/partials/modules/monitoring/ref-kafka-connect-jmx-environment-variables-docker.adoc +++ /dev/null @@ -1,51 +0,0 @@ -[id="kafka-connect-jmx-environment-variables-docker"] -= Kafka Connect JMX environment variables in Docker - -The `debezium/connect` image recognizes the following JMX-related environment variables: - -`JMXPORT` (Required):: -The port number that will be used for JMX. -The value is used to specify the following JVM parameters: -+ -** `-Dcom.sun.management.jmxremote.port=$JMXPORT` -** `-Dcom.sun.management.jmxremote.rmi.port=$JMXPORT` - -`JMXHOST` (Required):: -The IP address or resolvable host name of the Docker host, -which JMX uses to construct a URL sent to the JMX client. -A value of `localhost` or `127.0.0.1` will not work. -Typically, `0.0.0.0` can be used. -The value is used to specify the JVM parameter `-Djava.rmi.server.hostname=$JMXHOST`. - -`JMXAUTH`:: -Whether JMX clients must use password authentication when connecting. -Must be either `true` or `false`. -The default is `false`. -The value is used to specify the JVM parameter `-Dcom.sun.management.jmxremote.authenticate=$JMXAUTH`. - -`JMXSSL`:: -Whether JMX clients connect using SSL/TLS. -Must be either `true` or `false`. -The default is `false`. -The value is used to specify the JVM parameter `-Dcom.sun.management.jmxremote.ssl=$JMXSSL`. - -.Enabling JMX in a Kafka Connect Docker container -==== -The following example Docker command starts a container using the `debezium/connect` image with values for the `JMXPORT` and `JMXHOST` environment variables, -and maps the Docker host's port 9012 to the container's JMX port: - -[source,shell,options="nowrap"] ----- -$ docker run -it --rm --name connect \ - -p 8083:8083 -p 9012:9012 \ - -e JMXPORT=9012 -e JMXHOST=10.0.1.10 \ - -e GROUP_ID=1 \ - -e CONFIG_STORAGE_TOPIC=my_connect_configs \ - -e OFFSET_STORAGE_TOPIC=my_connect_offsets \ - -e STATUS_STORAGE_TOPIC=my_connect_statuses \ - --link zookeeper:zookeeper \ - --link kafka:kafka \ - --link mysql:mysql \ - debezium/connect:latest ----- -==== diff --git a/documentation/modules/ROOT/partials/modules/monitoring/ref-kafka-connect-jmx-environment-variables.adoc b/documentation/modules/ROOT/partials/modules/monitoring/ref-kafka-connect-jmx-environment-variables.adoc deleted file mode 100644 index 90a57a81d..000000000 --- a/documentation/modules/ROOT/partials/modules/monitoring/ref-kafka-connect-jmx-environment-variables.adoc +++ /dev/null @@ -1,17 +0,0 @@ -[id="kafka-connect-jmx-environment-variables"] -= Kafka Connect JMX environment variables - -When running Kafka using a local installation, -the `connect-distributed.sh` script recognizes the following environment variables: - -`JMX_PORT`:: -Enables JMX and specifies the port number that will be used for JMX. -The value is used to specify the JVM parameter `-Dcom.sun.management.jmxremote.port=$JMX_PORT`. - -`KAFKA_JMX_OPTS`:: -The JMX options, which are passed directly to the JVM during startup. -The default options are: -+ -** `-Dcom.sun.management.jmxremote` -** `-Dcom.sun.management.jmxremote.authenticate=false` -** `-Dcom.sun.management.jmxremote.ssl=false` diff --git a/documentation/modules/ROOT/partials/modules/monitoring/ref-kafka-jmx-environment-variables-docker.adoc b/documentation/modules/ROOT/partials/modules/monitoring/ref-kafka-jmx-environment-variables-docker.adoc deleted file mode 100644 index 6462c6d36..000000000 --- a/documentation/modules/ROOT/partials/modules/monitoring/ref-kafka-jmx-environment-variables-docker.adoc +++ /dev/null @@ -1,41 +0,0 @@ -[id="kafka-jmx-environment-variables-docker"] -= Kafka JMX environment variables in Docker - -The `debezium/kafka` image recognizes the following JMX-related environment variables: - -`JMXPORT` (Required):: -The port number that will be used for JMX. -The value is used to specify the following JVM parameters: -+ -** `-Dcom.sun.management.jmxremote.port=$JMXPORT` -** `-Dcom.sun.management.jmxremote.rmi.port=$JMXPORT` - -`JMXHOST` (Required):: -The IP address or resolvable host name of the Docker host, -which JMX uses to construct a URL sent to the JMX client. -A value of `localhost` or `127.0.0.1` will not work. -Typically, `0.0.0.0` can be used. -The value is used to specify the JVM parameter `-Djava.rmi.server.hostname=$JMXHOST`. - -`JMXAUTH`:: -Whether JMX clients must use password authentication when connecting. -Must be either `true` or `false`. -The default is `false`. -The value is used to specify the JVM parameter `-Dcom.sun.management.jmxremote.authenticate=$JMXAUTH`. - -`JMXSSL`:: -Whether JMX clients connect using SSL/TLS. -Must be either `true` or `false`. -The default is `false`. -The value is used to specify the JVM parameter `-Dcom.sun.management.jmxremote.ssl=$JMXSSL`. - -.Enabling JMX in a Kafka Docker container -==== -The following example Docker command starts a container using the `debezium/kafka` image with values for the `JMXPORT` and `HOST_NAME` environment variables, -and maps the Docker host's port 9011 to the container's JMX port: - -[source,shell,options="nowrap"] ----- -$ docker run -it --rm --name kafka -p 9092:9092 -p 9011:9011 -e JMXPORT=9011 -e JMXHOST=10.0.1.10 --link zookeeper:zookeeper debezium/kafka:latest ----- -==== diff --git a/documentation/modules/ROOT/partials/modules/monitoring/ref-kafka-jmx-environment-variables.adoc b/documentation/modules/ROOT/partials/modules/monitoring/ref-kafka-jmx-environment-variables.adoc deleted file mode 100644 index 8c2beb42e..000000000 --- a/documentation/modules/ROOT/partials/modules/monitoring/ref-kafka-jmx-environment-variables.adoc +++ /dev/null @@ -1,17 +0,0 @@ -[id="kafka-jmx-environment-variables"] -= Kafka JMX environment variables - -When running Kafka using a local installation, -the `kafka-server-start.sh` script recognizes the following environment variables: - -`JMX_PORT`:: -Enables JMX and specifies the port number that will be used for JMX. -The value is used to specify the JVM parameter `-Dcom.sun.management.jmxremote.port=$JMX_PORT`. - -`KAFKA_JMX_OPTS`:: -The JMX options, which are passed directly to the JVM during startup. -The default options are: -+ -** `-Dcom.sun.management.jmxremote` -** `-Dcom.sun.management.jmxremote.authenticate=false` -** `-Dcom.sun.management.jmxremote.ssl=false` diff --git a/documentation/modules/ROOT/partials/modules/monitoring/ref-zookeeper-jmx-environment-variables-docker.adoc b/documentation/modules/ROOT/partials/modules/monitoring/ref-zookeeper-jmx-environment-variables-docker.adoc deleted file mode 100644 index 40844c85e..000000000 --- a/documentation/modules/ROOT/partials/modules/monitoring/ref-zookeeper-jmx-environment-variables-docker.adoc +++ /dev/null @@ -1,47 +0,0 @@ -[id="zookeeper-jmx-environment-variables-docker"] -= Zookeeper JMX environment variables in Docker - -The `debezium/zookeeper` image recognizes the following JMX-related environment variables: - -`JMXPORT` (Required):: -The port number that will be used for JMX. -The value is used to specify the following JVM parameters: -+ -** `-Dcom.sun.management.jmxremote.port=$JMXPORT` -** `-Dcom.sun.management.jmxremote.rmi.port=$JMXPORT` - -`JMXHOST` (Required):: -The IP address or resolvable host name of the Docker host, -which JMX uses to construct a URL sent to the JMX client. -A value of `localhost` or `127.0.0.1` will not work. -Typically, `0.0.0.0` can be used. -The value is used to specify the JVM parameter `-Djava.rmi.server.hostname=$JMXHOST`. - -`JMXAUTH`:: -Whether JMX clients must use password authentication when connecting. -Must be either `true` or `false`. -The default is `false`. -The value is used to specify the JVM parameter `-Dcom.sun.management.jmxremote.authenticate=$JMXAUTH`. - -`JMXSSL`:: -Whether JMX clients connect using SSL/TLS. -Must be either `true` or `false`. -The default is `false`. -The value is used to specify the JVM parameter `-Dcom.sun.management.jmxremote.ssl=$JMXSSL`. - -`JMXLOG4J`:: -Whether the Log4J JMX MBeans should be disabled. -Must be either `true` or `false`. -The default is `true`. -The value is used to specify the JVM parameter `-Dzookeeper.jmx.log4j.disable=$JMXLOG4J`. - -.Enabling JMX in a Zookeeper Docker container -==== -The following example Docker command starts a container using the `debezium/zookeeper` image with values for the `JMXPORT` and `JMXHOST` environment variables, -and maps the Docker host's port 9010 to the container's JMX port: - -[source,shell,options="nowrap"] ----- -$ docker run -it --rm --name zookeeper -p 2181:2181 -p 2888:2888 -p 3888:3888 -p 9010:9010 -e JMXPORT=9010 -e JMXHOST=10.0.1.10 debezium/zookeeper:latest ----- -==== diff --git a/documentation/modules/ROOT/partials/modules/monitoring/ref-zookeeper-jmx-environment-variables.adoc b/documentation/modules/ROOT/partials/modules/monitoring/ref-zookeeper-jmx-environment-variables.adoc deleted file mode 100644 index 753ea6aa6..000000000 --- a/documentation/modules/ROOT/partials/modules/monitoring/ref-zookeeper-jmx-environment-variables.adoc +++ /dev/null @@ -1,28 +0,0 @@ -[id="zookeeper-jmx-environment-variables"] -= Zookeeper JMX environment variables - -Zookeeper has built-in support for JMX. -When running Zookeeper using a local installation, -the `zkServer.sh` script recognizes the following environment variables: - -`JMXPORT`:: -Enables JMX and specifies the port number that will be used for JMX. -The value is used to specify the JVM parameter `-Dcom.sun.management.jmxremote.port=$JMXPORT`. - -`JMXAUTH`:: -Whether JMX clients must use password authentication when connecting. -Must be either `true` or `false`. -The default is `false`. -The value is used to specify the JVM parameter `-Dcom.sun.management.jmxremote.authenticate=$JMXAUTH`. - -`JMXSSL`:: -Whether JMX clients connect using SSL/TLS. -Must be either `true` or `false`. -The default is `false`. -The value is used to specify the JVM parameter `-Dcom.sun.management.jmxremote.ssl=$JMXSSL`. - -`JMXLOG4J`:: -Whether the Log4J JMX MBeans should be disabled. -Must be either `true` (default) or `false`. -The default is `true`. -The value is used to specify the JVM parameter `-Dzookeeper.jmx.log4j.disable=$JMXLOG4J`.