search

kieker-monitoring / kieker

Kieker's main repository
Apache License 2.0
70 stars 41 forks source link

[KIEKER-1126] Getting Started Checklist #2798

Closed rju closed 1 week ago

rju commented 1 week ago

JIRA Issue: KIEKER-1126 Getting Started Checklist Original Reporter: Christian Wulf

Since many students (and myself ) still have problems to get kieker running out-of-the-box, especially using AspectJ, a checklist could be very helpful that describes steps necessary to monitor a given java project.

Such a checklist should at least include the following:

1. main class must be executed with the JVM parameter -javaagent:<lib-to-kieker> (if aspectj is not in the classpath of the given java project, one should use the kieker_aspectj.jar)

2. folder bin/META-INF must exist containing at least the files "aop.xml" and "kieker.monitoring.properties"

3. add further steps with short reasons here

rju commented 1 week ago

author Jan Waller -- Wed, 22 May 2013 16:40:56 +0200

Replying to KIEKER-1126 Done :
> 2. folder bin/META-INF must exist containing at least the files "aop.xml" and "kieker.monitoring.properties"
>
> * reason: kieker expects both files in /META-INF within the denoted classpath

Actually, "kieker.monitoring.properties" is not required.

To further clarify the location: A META-INF folder at the base of the compiled project, e.g., in Eclipse everything within the src folder gets copied to the bin folder, so it should be located in src/META-INF

rju commented 1 week ago

author André van Hoorn -- Wed, 22 May 2013 16:41:19 +0200

See also KIEKER-1128 Done . Quick start guide (using AspectJ) is on our agenda.

rju commented 1 week ago

author André van Hoorn -- Tue, 17 Sep 2013 12:39:17 +0200

Really 1.8?

rju commented 1 week ago

author Jan Waller -- Mon, 24 Feb 2014 17:06:21 +0100

Maybe you could use this (also fix this?)

rju commented 1 week ago

author nils-christian -- Tue, 18 Mar 2014 18:04:54 +0100

Indeed related to KIEKER-977 Open . We already have this quickstart chapter. The simplified steps:

1. Copy the prepared META-INF directory with the aop.xml (from examples\userguide\ch5--trace-monitoring-aspectj) into the build-directory or the classpath of the project to be monitored
1. Start the project with the java-agent (java −javaagent:kieker-1.9-SNAPSHOT aspectj.jar −classpath build main.Main)

What to do with this ticket? Either wait for the new userguide or simply put this two-step-checklist somewhere into the release.

rju commented 1 week ago

author nils-christian -- Tue, 18 Mar 2014 18:11:33 +0100

I suggest to simply add a new page under http://kieker-monitoring.net/documentation/ for the quickstart steps (without any examples to download
- we simply show how to use Kieker).

rju commented 1 week ago

author nils-christian -- Thu, 3 Apr 2014 13:38:50 +0200

I used the quickstart guide from Henry and me from the new-userguide-branch to create such a page. It is saved as a draft in the wordpress system. Please take a look at it and feel free to comment it.

rju commented 1 week ago

author André van Hoorn -- Mon, 7 Apr 2014 16:34:46 +0200

Replying to [nie|comment:10]:
> I used the quickstart guide from Henry and me from the new-userguide-branch to create such a page. It is saved as a draft in the wordpress system. Please take a look at it and feel free to comment it.

Thanks, you'll find some remarks in the attachment:20140407-quickstart-avh.pdf. Let's discuss this in the next meeting.

rju commented 1 week ago

author nils-christian -- Fri, 11 Apr 2014 14:13:57 +0200

Current steps necessary for a monitoring (!) quickstart:

Shouldn't be more on the website for this part.

rju commented 1 week ago

author nils-christian -- Mon, 14 Apr 2014 15:52:40 +0200

Added the remaining steps for command line & Eclipse and linked the quickstart guides from http://kieker-monitoring.net/documentation/.

rju commented 1 week ago

author Unknown -- Mon, 14 Apr 2014 20:39:59 +0200

A nice quick start tutorial! It would be a very nice one if you could say a few words about what information is monitored by default, i.e., what monitoring probe and record are used. Perhaps you could also reference the corresponding Java class(es).

rju commented 1 week ago

author nils-christian -- Mon, 14 Apr 2014 21:10:09 +0200

Replying to [chw|comment:16]:
> A nice quick start tutorial! It would be a very nice one if you could say a few words about what information is monitored by default, i.e., what monitoring probe and record are used. Perhaps you could also reference the corresponding Java class(es).

I would put these information into an "extended" quick start guide in the user manual (whenever the new user guide will be written). For the website I wanted to use as little text as possible.

rju commented 1 week ago

author nils-christian -- Tue, 15 Apr 2014 13:04:18 +0200

Added the note that the steps are possible since 1.9 and with the nightly build. Added also a news post for this.