kieker-monitoring / kieker

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

[KIEKER-746] Example configuration files distributed over two directories #878

Open rju opened 2 weeks ago

rju commented 2 weeks ago

JIRA Issue: KIEKER-746 Example configuration files distributed over two directories Original Reporter: Andre van Hoorn


Some example configuration files are in examples, others in META-INF. The file kieker.monitoring.adaptiveMonitoring.conf is even contained in both:

avh@avh-ThinkPad-RSS:0:~/git_work/kieker/tmp/kieker-1.9 <1.9> $ find examples/ META-INF/ -maxdepth 1 -type f
examples/aop.example.xml
examples/kieker.monitoring.adaptiveMonitoring.example.conf
examples/kieker.logging.example.properties
META-INF/kieker.monitoring.adaptiveMonitoring.conf
META-INF/kieker.monitoring.properties
avh@avh-ThinkPad-RSS:0:~/git_work/kieker/tmp/kieker-1.9 <1.9> $ diff examples/kieker.monitoring.adaptiveMonitoring.example.conf META-INF/kieker.monitoring.adaptiveMonitoring.conf
avh@avh-ThinkPad-RSS:0:~/git_work/kieker/tmp/kieker-1.9 <1.9> $

Would suggest to move all example configuration files to examples and remove META-INF.

Checklist:

rju commented 1 week ago

author Jan Waller -- Mon, 14 Apr 2014 21:58:48 +0200

I would advice against it, as an eclipse compiled Kieker version would not be useable out of the box without these files in META-INF under source.
I would rather move all (that are copied by our ant scritps) into the src/META-INF folder...

rju commented 1 week ago

author André van Hoorn -- Mon, 14 Apr 2014 22:13:49 +0200

Replying to [jwa|comment:1]:
> I would advice against it, as an eclipse compiled Kieker version would not be useable out of the box without these files in META-INF under source.
> I would rather move all (that are copied by our ant scritps) into the src/META-INF folder...

Note that I'm talking about META-INF in the binary release archive not about src/.../META-INF. During release creation, the files from src/.../META-INF are copied to META-INF. My suggestion would be to copy them to examples instead.

rju commented 1 week ago

author Jan Waller -- Tue, 15 Apr 2014 09:54:04 +0200

I am not sure where to move them, both would be fine I guess. If we move to example, should name all files with something like .example, too?

rju commented 1 week ago

author André van Hoorn -- Tue, 15 Apr 2014 09:56:45 +0200

Replying to [jwa|comment:3]:
> I am not sure where to move them, both would be fine I guess. If we move to example, should name all files with something like .example, too?

In my opinion, yes.

rju commented 1 week ago

author André van Hoorn -- Thu, 25 Sep 2014 14:03:03 +0200

Fixed in changeset:7893584389ce3f12e6415a11f415d01e41180f70/kieker-git

Before

 
avhAndrè van Hoorn-ThinkPad-RSS:0:/tmp/kieker-1.10-SNAPSHOT $ find examples/ -maxdepth 1 -type f
examples/aop.example.xml
examples/kieker.monitoring.adaptiveMonitoring.example.conf
examples/kieker.logging.example.properties

avhAndrè van Hoorn-ThinkPad-RSS:0:/tmp/kieker-1.10-SNAPSHOT $ find META-INF/ -maxdepth 1 -type f
META-INF/kieker.monitoring.adaptiveMonitoring.conf
META-INF/kieker.monitoring.properties

diff examples/kieker.monitoring.adaptiveMonitoring.example.conf META-INF/kieker.monitoring.adaptiveMonitoring.conf
avhAndrè van Hoorn-ThinkPad-RSS:0:/tmp/kieker-1.10-SNAPSHOT $

After

avhAndrè van Hoorn-ThinkPad-RSS:1:/tmp/kieker-1.10-SNAPSHOT $ find examples/ -maxdepth 1 -type f
examples/kieker.monitoring.example.properties
examples/aop.example.xml
examples/kieker.monitoring.adaptiveMonitoring.example.conf
examples/kieker.logging.example.properties

avhAndrè van Hoorn-ThinkPad-RSS:0:/tmp/kieker-1.10-SNAPSHOT $ find META-INF/ -maxdepth 1 -type f
find: `META-INF/': No such file or directory

Also fixed the release check script and the user guide.