Skip to content

Commit

Permalink
refactor: update the karaf steps
Browse files Browse the repository at this point in the history
Signed-off-by: Sarthak160 <[email protected]>
  • Loading branch information
Sarthak160 committed Jan 13, 2025
1 parent d40a268 commit 9d8c89b
Showing 1 changed file with 25 additions and 2 deletions.
27 changes: 25 additions & 2 deletions versioned_docs/version-2.0.0/running-keploy/keploy-karaf.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,17 @@
---
id: keploy-karaf-example
title: Keploy Karaf Example
sidebar_label: Keploy Karaf Example
description: This section documents how to run keploy with Karaf
tags:
- keploy
- keploy karaf
keywords:
- keploy
- documentation
- running-guide
---

# Setting Up Keploy Agent in Apache Karaf for Local Development

Check failure on line 15 in versioned_docs/version-2.0.0/running-keploy/keploy-karaf.md

View workflow job for this annotation

GitHub Actions / vale

[vale] versioned_docs/version-2.0.0/running-keploy/keploy-karaf.md#L15

[Vale.Spelling] Did you really mean 'Karaf'?
Raw output
{"message": "[Vale.Spelling] Did you really mean 'Karaf'?", "location": {"path": "versioned_docs/version-2.0.0/running-keploy/keploy-karaf.md", "range": {"start": {"line": 15, "column": 37}}}, "severity": "ERROR"}

Follow these steps to set up and run the Keploy agent in Apache Karaf for your local development environment.

Check failure on line 17 in versioned_docs/version-2.0.0/running-keploy/keploy-karaf.md

View workflow job for this annotation

GitHub Actions / vale

[vale] versioned_docs/version-2.0.0/running-keploy/keploy-karaf.md#L17

[Vale.Spelling] Did you really mean 'Karaf'?
Raw output
{"message": "[Vale.Spelling] Did you really mean 'Karaf'?", "location": {"path": "versioned_docs/version-2.0.0/running-keploy/keploy-karaf.md", "range": {"start": {"line": 17, "column": 65}}}, "severity": "ERROR"}
Expand All @@ -22,7 +36,7 @@ wget https://keploy-enterprise.s3.us-west-2.amazonaws.com/agent-jars/org.jacoco.

## Step 2: Configure Apache Karaf

Check failure on line 37 in versioned_docs/version-2.0.0/running-keploy/keploy-karaf.md

View workflow job for this annotation

GitHub Actions / vale

[vale] versioned_docs/version-2.0.0/running-keploy/keploy-karaf.md#L37

[Vale.Spelling] Did you really mean 'Karaf'?
Raw output
{"message": "[Vale.Spelling] Did you really mean 'Karaf'?", "location": {"path": "versioned_docs/version-2.0.0/running-keploy/keploy-karaf.md", "range": {"start": {"line": 37, "column": 29}}}, "severity": "ERROR"}

### Update `JAVA_OPTS` in `setenv` File
### Update `JAVA_OPTS` for linux/mac in `setenv` File

1. Navigate to the `bin` directory of your Apache Karaf installation.

Check failure on line 41 in versioned_docs/version-2.0.0/running-keploy/keploy-karaf.md

View workflow job for this annotation

GitHub Actions / vale

[vale] versioned_docs/version-2.0.0/running-keploy/keploy-karaf.md#L41

[Vale.Spelling] Did you really mean 'Karaf'?
Raw output
{"message": "[Vale.Spelling] Did you really mean 'Karaf'?", "location": {"path": "versioned_docs/version-2.0.0/running-keploy/keploy-karaf.md", "range": {"start": {"line": 41, "column": 51}}}, "severity": "ERROR"}
2. Open the `setenv` file for editing.
Expand All @@ -33,6 +47,15 @@ wget https://keploy-enterprise.s3.us-west-2.amazonaws.com/agent-jars/org.jacoco.
export JAVA_OPTS="$JAVA_OPTS -javaagent:/path/to/org.jacoco.agent-0.8.12-runtime.jar=address=*,port=36320,destfile=jacoco-it.exec,output=tcpserver"
```

### Update `JAVA_OPTS` for windows in `setenv.bat` File
1. Navigate to the `bin` directory of your Apache Karaf installation.

Check failure on line 51 in versioned_docs/version-2.0.0/running-keploy/keploy-karaf.md

View workflow job for this annotation

GitHub Actions / vale

[vale] versioned_docs/version-2.0.0/running-keploy/keploy-karaf.md#L51

[Vale.Spelling] Did you really mean 'Karaf'?
Raw output
{"message": "[Vale.Spelling] Did you really mean 'Karaf'?", "location": {"path": "versioned_docs/version-2.0.0/running-keploy/keploy-karaf.md", "range": {"start": {"line": 51, "column": 51}}}, "severity": "ERROR"}
2. Open the `setenv.bat` file for editing.
3. Add the paths of the downloaded agents under the `JAVA_OPTS` section. For example:

```bash
set JAVA_OPTS=-javaagent:/path/to/java-agent-1.0-SNAPSHOT.jar
set JAVA_OPTS=%JAVA_OPTS% -javaagent:/path/to/org.jacoco.agent-0.8.12-runtime.jar=address=*,port=36320,destfile=jacoco-it.exec,output=tcpserver
```
Replace `/path/to/` with the actual paths where you downloaded the JAR files.

### Update `config.properties`
Expand Down Expand Up @@ -78,7 +101,7 @@ wget https://keploy-enterprise.s3.us-west-2.amazonaws.com/agent-jars/org.jacoco.
3. Export the application path to point to your target folder containing Java classes:

```bash
export APP_PATH="/path/to/user-service"
export APP_PATH="/Users/sarthak_1/Downloads/karaf-sample/user-service"
```

Replace the `APP_PATH` value with the absolute path to your application's target folder.
Expand Down

0 comments on commit 9d8c89b

Please sign in to comment.