[O11y][Cassandra] Add documentation for Jolokia setup #9817

harnish-crest-data · 2024-05-08T09:29:06Z

Proposed commit message

Added detailed instructions for Jolokia setup in Apache Cassandra README.

Checklist

I have reviewed tips for building integrations and this pull request is aligned with them.
I have verified that all data streams collect metrics or logs.
I have added an entry to my package's changelog.yml file.
I have verified that Kibana version constraints are current according to guidelines.

Related issues

Closes Cassandra integration add documentation for jolokia setup. #9749

elasticmachine · 2024-05-08T09:46:14Z

🚀 Benchmarks report

To see the full report comment with /test benchmark fullreport

shmsr · 2024-05-08T17:54:29Z

packages/cassandra/_dev/build/docs/README.md

+- Java Development Kit (JDK) 1.8 or later
+- Apache Cassandra 3.x/4.x (Adjust according to version)
+- Jolokia agent


Suggested change

- Java Development Kit (JDK) 1.8 or later

- Apache Cassandra 3.x/4.x (Adjust according to version)

- Jolokia agent

- Java Development Kit (JDK) 1.8 or later

- Apache Cassandra 3.x or 4.x (depending on your version)

- Jolokia agent JAR file

shmsr · 2024-05-08T17:56:21Z

packages/cassandra/_dev/build/docs/README.md

+
+1. Download the Jolokia JVM Agent:
+
+   Obtain the latest Jolokia JVM agent `.jar` file from the [Jolokia official download page](https://repo1.maven.org/maven2/org/jolokia/jolokia-jvm/).


Suggested change

Obtain the latest Jolokia JVM agent `.jar` file from the [Jolokia official download page](https://repo1.maven.org/maven2/org/jolokia/jolokia-jvm/).

Visit the [Jolokia official download page](https://repo1.maven.org/maven2/org/jolokia/jolokia-jvm/) to obtain the latest version of the Jolokia JVM agent JAR file. Download the `jolokia-jvm-<version>-agent.jar` file.

shmsr · 2024-05-08T17:56:39Z

packages/cassandra/_dev/build/docs/README.md

+
+   Obtain the latest Jolokia JVM agent `.jar` file from the [Jolokia official download page](https://repo1.maven.org/maven2/org/jolokia/jolokia-jvm/).
+
+2. Place the Jolokia Agent:


Suggested change

2. Place the Jolokia Agent:

2. Copy the Jolokia Agent to Cassandra's Library Directory:

shmsr · 2024-05-08T17:58:18Z

packages/cassandra/_dev/build/docs/README.md

+
+2. Place the Jolokia Agent:
+
+   Copy the downloaded `.jar` file to a suitable location on the server where Cassandra is installed.


Suggested change

Copy the downloaded `.jar` file to a suitable location on the server where Cassandra is installed.

Copy the downloaded `jolokia-jvm-<version>-agent.jar` file to the Cassandra library directory on the server where Cassandra is installed.

shmsr · 2024-05-08T17:59:28Z

packages/cassandra/_dev/build/docs/README.md

+   For example:
+
+   ```bash
+   sudo cp jolokia-jvm-<version>-agent.jar /path/to/cassandra/lib/


Suggested change

sudo cp jolokia-jvm-<version>-agent.jar /path/to/cassandra/lib/

cp jolokia-jvm-<version>-agent.jar /path/to/cassandra/lib/

Don't use sudo by default. It totally depends on perms of /path/to/cassandra/lib/ that we don't know. If they face problem they will automatically add sudo themselves.

shmsr · 2024-05-08T18:05:26Z

packages/cassandra/_dev/build/docs/README.md

+
+### Jolokia Setup
+
+To monitor Cassandra with Jolokia, need to set up the Jolokia JVM agent.


Suggested change

To monitor Cassandra with Jolokia, need to set up the Jolokia JVM agent.

Follow these steps to set up Jolokia for monitoring Apache Cassandra:

shmsr · 2024-05-08T18:12:50Z

packages/cassandra/_dev/build/docs/README.md

+4. Restart Cassandra:
+
+   After configuring Cassandra with the Jolokia agent, restart the Cassandra service to apply the changes.


Suggested change

4. Restart Cassandra:

After configuring Cassandra with the Jolokia agent, restart the Cassandra service to apply the changes.

4. Restart Cassandra:

Restart the Apache Cassandra service to apply the changes made to the configuration.

shmsr · 2024-05-08T18:14:24Z

packages/cassandra/_dev/build/docs/README.md

+   Note:
+   - Restarting the Cassandra service will temporarily disrupt database connectivity. Dependent services may experience failures and should be designed to handle such interruptions gracefully.
+   - Immediately after a restart, Cassandra's performance may be impacted due to cold caches and commit log replay.
+   - Ensure no cluster maintenance tasks are in progress during the restart to prevent any unintended consequences.


Suggested change

Note:

- Restarting the Cassandra service will temporarily disrupt database connectivity. Dependent services may experience failures and should be designed to handle such interruptions gracefully.

- Immediately after a restart, Cassandra's performance may be impacted due to cold caches and commit log replay.

- Ensure no cluster maintenance tasks are in progress during the restart to prevent any unintended consequences.

> Note:

- Restarting the Apache Cassandra service will temporarily disrupt database connectivity. Ensure that dependent services are designed to handle such interruptions gracefully.

- Immediately after a restart, Cassandra's performance may be impacted due to cold caches and commit log replay. Allow some time for the system to stabilize.

- Before restarting Cassandra, ensure that no cluster maintenance tasks are in progress to prevent any unintended consequences.

Please note the exact steps will vary based on the installation type. For example: if cassandra is installed via kkubernetes, the steps above could be different,.

We could mention, this is representative example only and can provide minimal guideline on restart scenario.

shmsr · 2024-05-08T18:15:51Z

packages/cassandra/_dev/build/docs/README.md

+   - Restarting the Cassandra service will temporarily disrupt database connectivity. Dependent services may experience failures and should be designed to handle such interruptions gracefully.
+   - Immediately after a restart, Cassandra's performance may be impacted due to cold caches and commit log replay.
+   - Ensure no cluster maintenance tasks are in progress during the restart to prevent any unintended consequences.
+


Do you think we add something like:

Verifying the setup

After restarting Cassandra, you can verify that Jolokia is properly set up by accessing the Jolokia endpoint:

http://<cassandra-host>:7777/jolokia/

Replace with the hostname or IP address of your Cassandra server.

If the setup is successful, you should see a JSON response containing information about the available Jolokia operations and the Cassandra instance.

You can now use Jolokia to monitor and manage your Apache Cassandra cluster.

Agree, this step will be useful.

Updated, thanks!

shmsr · 2024-05-08T18:17:20Z

packages/cassandra/changelog.yml

@@ -1,4 +1,9 @@
 # newer versions go on top
+- version: "1.12.2"
+  changes:
+    - description: Add documentation for Jolokia setup in the README.


Suggested change

- description: Add documentation for Jolokia setup in the README.

- description: Add documentation for setting up Jolokia to monitor Apache Cassandra in the README file.

shmsr · 2024-05-08T18:18:45Z

Left some comments to make the tone of the doc consistent. Also suggested some improvements and clarified some parts where paths need to be changed. Please check.

harnish-crest-data · 2024-05-09T13:14:01Z

Left some comments to make the tone of the doc consistent. Also suggested some improvements and clarified some parts where paths need to be changed. Please check.

Addressed, thanks! 🙌

milan-elastic

LGTM

packages/cassandra/changelog.yml

shmsr

Left one comment. Else, LGTM.

Co-authored-by: subham sarkar <sarkar.subhams2@gmail.com>

elasticmachine · 2024-05-16T05:33:14Z

💚 Build Succeeded

Buildkite Build
Commit: f4da7dc

History

💚 Build #11372 succeeded 0b3a469
💚 Build #11306 succeeded 9c33cf3
💚 Build #11255 succeeded fd54ee5

cc @harnish-elastic

elastic-sonarqube · 2024-05-16T05:33:16Z

Quality Gate passed

Issues
0 New issues
0 Fixed issues
0 Accepted issues

Measures
0 Security Hotspots
No data about Coverage
No data about Duplication

See analysis details on SonarQube

elasticmachine · 2024-05-16T10:01:10Z

Package cassandra - 1.12.2 containing this change is available at https://epr.elastic.co/search?package=cassandra

Add documentation for Jolokia setup in the README

64c72f5

harnish-crest-data added the enhancement New feature or request label May 8, 2024

harnish-crest-data self-assigned this May 8, 2024

update changelog.yml

fd54ee5

harnish-crest-data marked this pull request as ready for review May 8, 2024 09:34

harnish-crest-data requested a review from a team as a code owner May 8, 2024 09:34

shmsr requested changes May 8, 2024

View reviewed changes

harnish-crest-data added 2 commits May 9, 2024 18:37

address review comments

6c3715c

update changelog.yml

9c33cf3

harnish-crest-data requested review from lalit-satapathy, shmsr and milan-elastic May 9, 2024 13:17

address review comments

0b3a469

milan-elastic approved these changes May 13, 2024

View reviewed changes

shmsr changed the title ~~[O11y][Cassandra] Add documentation for Jolokia setup in the README~~ [O11y][Cassandra] Add documentation for Jolokia setup May 15, 2024

shmsr reviewed May 15, 2024

View reviewed changes

packages/cassandra/changelog.yml Outdated Show resolved Hide resolved

shmsr approved these changes May 15, 2024

View reviewed changes

Update packages/cassandra/changelog.yml

f4da7dc

Co-authored-by: subham sarkar <sarkar.subhams2@gmail.com>

harnish-crest-data merged commit b3c56a7 into elastic:main May 16, 2024

andrewkroh added the Integration:cassandra Cassandra label Jul 22, 2024


		1. Download the Jolokia JVM Agent:

		Obtain the latest Jolokia JVM agent `.jar` file from the [Jolokia official download page](https://repo1.maven.org/maven2/org/jolokia/jolokia-jvm/).

	Obtain the latest Jolokia JVM agent `.jar` file from the [Jolokia official download page](https://repo1.maven.org/maven2/org/jolokia/jolokia-jvm/).
	Visit the [Jolokia official download page](https://repo1.maven.org/maven2/org/jolokia/jolokia-jvm/) to obtain the latest version of the Jolokia JVM agent JAR file. Download the `jolokia-jvm-<version>-agent.jar` file.


		Obtain the latest Jolokia JVM agent `.jar` file from the [Jolokia official download page](https://repo1.maven.org/maven2/org/jolokia/jolokia-jvm/).

		2. Place the Jolokia Agent:

	2. Place the Jolokia Agent:
	2. Copy the Jolokia Agent to Cassandra's Library Directory:


		2. Place the Jolokia Agent:

		Copy the downloaded `.jar` file to a suitable location on the server where Cassandra is installed.

	Copy the downloaded `.jar` file to a suitable location on the server where Cassandra is installed.
	Copy the downloaded `jolokia-jvm-<version>-agent.jar` file to the Cassandra library directory on the server where Cassandra is installed.

	sudo cp jolokia-jvm-<version>-agent.jar /path/to/cassandra/lib/
	cp jolokia-jvm-<version>-agent.jar /path/to/cassandra/lib/


		### Jolokia Setup

		To monitor Cassandra with Jolokia, need to set up the Jolokia JVM agent.

	To monitor Cassandra with Jolokia, need to set up the Jolokia JVM agent.
	Follow these steps to set up Jolokia for monitoring Apache Cassandra:

		4. Restart Cassandra:

		After configuring Cassandra with the Jolokia agent, restart the Cassandra service to apply the changes.

	- description: Add documentation for Jolokia setup in the README.
	- description: Add documentation for setting up Jolokia to monitor Apache Cassandra in the README file.

[O11y][Cassandra] Add documentation for Jolokia setup #9817

[O11y][Cassandra] Add documentation for Jolokia setup #9817

Uh oh!

Conversation

harnish-crest-data commented May 8, 2024 • edited by shmsr Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Proposed commit message

Checklist

Related issues

Uh oh!

elasticmachine commented May 8, 2024

🚀 Benchmarks report

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

shmsr commented May 8, 2024

Uh oh!

harnish-crest-data commented May 9, 2024

Uh oh!

milan-elastic left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

shmsr left a comment

Choose a reason for hiding this comment

Uh oh!

elasticmachine commented May 16, 2024

💚 Build Succeeded

History

Uh oh!

elastic-sonarqube bot commented May 16, 2024

Quality Gate passed

Uh oh!

elasticmachine commented May 16, 2024

Uh oh!

Uh oh!

harnish-crest-data commented May 8, 2024 •

edited by shmsr

Loading