You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@turbine.apache.org by Pete Kazmier <pe...@kazmier.com> on 2002/02/16 07:10:29 UTC

[DOCUMENTATION] Stratum / JCS Documentation

I just finished converting all of Aaron's JCS documents to xdoc format.
While doing this, I also created the start of a stratum xdoc hierarchy.
This includes Jason's description of stratum from last week's status
update, and all of the JCS documentation that I converted.

Attached to this email is a tarball of the xdoc directory I built and
patches for build.xml, deps.list, and default.properties.  

The patch to build.xml adds the 'docs' target which has the DVSL task
that generates the docs and copy task to copy all images over to the
output directory.  

The default.properties patch adds dvsl and velocity jars.  I used the
latest version of DVSL (0.40) so I could use the 'force' attribute in
the DVSL task which forces all of the docs to be built all of the time.
Unlike, Anakia, if you modify the project.xml file, the other pages are
not automatically regenerated.  

The patch for deps.list adds dvsl and velocity to the list of
dependencies.  If someone could update the dvsl jar on the turbine site,
that would be appreciated.

Finally, if someone wants to preview the stratum documentation, you can
check it out on my home site at:

http://www.kazmier.com/~kaz/stratum

Thanks!
Pete

Re: [DOCUMENTATION] Stratum / JCS Documentation

Posted by Martin Poeschl <mp...@marmot.at>.
Pete Kazmier wrote:
> I just finished converting all of Aaron's JCS documents to xdoc format.
> While doing this, I also created the start of a stratum xdoc hierarchy.
> This includes Jason's description of stratum from last week's status
> update, and all of the JCS documentation that I converted.
> 
> Attached to this email is a tarball of the xdoc directory I built and
> patches for build.xml, deps.list, and default.properties.  
> 
> The patch to build.xml adds the 'docs' target which has the DVSL task
> that generates the docs and copy task to copy all images over to the
> output directory.  
> 
> The default.properties patch adds dvsl and velocity jars.  I used the
> latest version of DVSL (0.40) so I could use the 'force' attribute in
> the DVSL task which forces all of the docs to be built all of the time.
> Unlike, Anakia, if you modify the project.xml file, the other pages are
> not automatically regenerated.  
> 
> The patch for deps.list adds dvsl and velocity to the list of
> dependencies.  If someone could update the dvsl jar on the turbine site,
> that would be appreciated.

done

thanx!!!!!

martin



--
To unsubscribe, e-mail:   <ma...@jakarta.apache.org>
For additional commands, e-mail: <ma...@jakarta.apache.org>

Re: jprobe of jcs

Posted by James Taylor <jt...@4lane.com>.
On Fri, 2002-02-22 at 00:28, Aaron Smuts wrote:
> Some profiling of JCS.  The relative timing is ok, but it cannot be
> taken as absolute time since it is running inside JProbe.
> 
> I'll see if I can get it some better data.
> 
> The LinkedQueue is significant.

Is it? Can you elaborate on your interpretation of the data. It'd be
great to see similar profiling of the version with the JGLQueue.
LinkedQueue looks pretty quick to me -- most of the time in the take
operation is from waiting for objects to become available. I'm not
entirely sure how to read the profiling output though.

> All the bottlenecks are in disk io.

NIO!

-- jt



--
To unsubscribe, e-mail:   <ma...@jakarta.apache.org>
For additional commands, e-mail: <ma...@jakarta.apache.org>

jprobe of jcs

Posted by Aaron Smuts <aa...@verizon.net>.
Some profiling of JCS.  The relative timing is ok, but it cannot be
taken as absolute time since it is running inside JProbe.

I'll see if I can get it some better data.

The LinkedQueue is significant.

All the bottlenecks are in disk io.

Aaron

> -----Original Message-----
> From: dlr@despot.finemaltcoding.com
[mailto:dlr@despot.finemaltcoding.com]
> On Behalf Of Daniel Rall
> Sent: Thursday, February 21, 2002 11:20 PM
> To: kaz@kazmier.com
> Cc: Turbine Developers List
> Subject: Re: [DOCUMENTATION] Stratum / JCS Documentation
> 
> Cool, thanks Pete.
> 
> "Pete Kazmier" <pe...@kazmier.com> writes:
> 
> > Dan,
> >
> > There are quite a few xdocs up on the Stratum site about JCS.  I
believe
> > Aaron's most recent addition, "Basic JCS Configuration", was
prompted by
> > this very thread.
> >
> > Thanks,
> > Pete
> >
> > On Thu, Feb 21, 2002 at 09:17:38AM -0800, Daniel Rall wrote:
> > > Anyone get this good stuff into an xdoc yet?
> 
> --
> To unsubscribe, e-mail:   <mailto:turbine-dev-
> unsubscribe@jakarta.apache.org>
> For additional commands, e-mail: <mailto:turbine-dev-
> help@jakarta.apache.org>

Re: [DOCUMENTATION] Stratum / JCS Documentation

Posted by Daniel Rall <dl...@finemaltcoding.com>.
Cool, thanks Pete.

"Pete Kazmier" <pe...@kazmier.com> writes:

> Dan,
>
> There are quite a few xdocs up on the Stratum site about JCS.  I believe
> Aaron's most recent addition, "Basic JCS Configuration", was prompted by
> this very thread.  
>
> Thanks,
> Pete
>
> On Thu, Feb 21, 2002 at 09:17:38AM -0800, Daniel Rall wrote:
> > Anyone get this good stuff into an xdoc yet?

--
To unsubscribe, e-mail:   <ma...@jakarta.apache.org>
For additional commands, e-mail: <ma...@jakarta.apache.org>

Moving on with JCS -- seeking help

Posted by Aaron Smuts <aa...@verizon.net>.
 
JCS areas of need and future development, in no particular order:

Turbine service for JCS.
XML-RPC lateral cache completion.
Javagroups lateral cache.
Applet XML-RPC monitor.
Session distribution testing.
Examples -- Applet test access?
XML config
Run-time auxiliary selection (establish all lateral available and choose
via access). XML . . .
Idle time check in hub on get.  ( only check maxLife expiration now)
Memory shrinker improvements.
More structured documentation.
Rename Composite cache to CacheHub and CompositeCacheAttributes.
ElementAttributes copy -- create new constructor, avoid methods.
Torque JCS integration.
LFU memory cache.
Lateral Token ring locking.
Cluster architecture proposals.
JUnit tests.
Embedded servlet options.
JMS lateral cache.
Disk and lateral cache refactoring.

Let us know if you have nay ideas or would like to tackle some of these.

Cheers,

Aaron


--
To unsubscribe, e-mail:   <ma...@jakarta.apache.org>
For additional commands, e-mail: <ma...@jakarta.apache.org>

Re: [DOCUMENTATION] Stratum / JCS Documentation

Posted by Pete Kazmier <pe...@kazmier.com>.
Dan,

There are quite a few xdocs up on the Stratum site about JCS.  I believe
Aaron's most recent addition, "Basic JCS Configuration", was prompted by
this very thread.  

Thanks,
Pete

On Thu, Feb 21, 2002 at 09:17:38AM -0800, Daniel Rall wrote:
> Anyone get this good stuff into an xdoc yet?

--
To unsubscribe, e-mail:   <ma...@jakarta.apache.org>
For additional commands, e-mail: <ma...@jakarta.apache.org>

Re: [DOCUMENTATION] Stratum / JCS Documentation

Posted by Daniel Rall <dl...@finemaltcoding.com>.
Anyone get this good stuff into an xdoc yet?

"Aaron Smuts" <aa...@verizon.net> writes:

> Just don't specify a disk cache in the cache.ccf file and you have a
> cache without a disk cache.  You can setup the default region and that's
> all.  It will work.  Your complete cache.ccf file could look like:
>
> ##############################################################
> ################## DEFAULT CACHE REGION  #####################
> # sets the default aux value for any non configured caches
> jcs.default=
> jcs.default.cacheattributes=org.apache.stratum.jcs.engine.CompositeCache
> Attributes
> jcs.default.cacheattributes.MaxObjects=1000
> jcs.default.cacheattributes.MemoryCacheName=org.apache.stratum.jcs.engin
> e.memory.lru.LRUMemoryCache
> jcs.default.cacheattributes.cacheattributes.UseMemoryShrinker=true
> jcs.default.cacheattributes.cacheattributes.MaxMemoryIdleTimeSeconds=360
> 0
> jcs.default.cacheattributes.cacheattributes.ShrinkerIntervalSeconds=60
>
> Or even simpler:
>
> ##############################################################
> ################## DEFAULT CACHE REGION  #####################
> # sets the default aux value for any non configured caches
> jcs.default=
> jcs.default.cacheattributes=org.apache.stratum.jcs.engine.CompositeCache
> Attributes
> jcs.default.cacheattributes.MaxObjects=1000
> jcs.default.cacheattributes.MemoryCacheName=org.apache.stratum.jcs.engin
> e.memory.lru.LRUMemoryCache
>
> Add a disk cache by adding:
>
> jcs.auxiliary.DC=org.apache.stratum.jcs.auxiliary.disk.indexed.IndexedDi
> skCacheFactory
> jcs.auxiliary.DC.attributes=org.apache.stratum.jcs.auxiliary.disk.indexe
> d.IndexedDiskCacheAttributes
> jcs.auxiliary.DC.attributes.DiskPath=g:/dev/jakarta-turbine-stratum/raf
>
> and changing the first line to:
>
> jcs.default=DC
>
> Your done.
>
> This could be the configuration file for the book store example.
>
>
> Configuration is pretty easy, the remote cache is the most difficult,
> but basically:
>
> Configuring a disk cache is a simple as telling it what folder to use.
>
> Setting up remote caches involves specifying the server address and
> starting the server.
>
> Setting up lateral caches (only use the TCP) involves listing the other
> lateral caches in the TCPServers attribute. 
>
> Aaron
>
>> -----Original Message-----
>> From: jmcnally@localhost.localdomain
>> [mailto:jmcnally@localhost.localdomain] On Behalf Of John McNally
>> Sent: Tuesday, February 19, 2002 10:40 PM
>> To: Turbine Developers List
>> Subject: Re: [DOCUMENTATION] Stratum / JCS Documentation
>> 
>> A simple example setting up a LRU cache with and without disk storage
>> would interest me.  Would the simplest case of a completely in memory
>> cache, be too simple a case to use JCS?
>> 
>> john mcnally
>> 
>> Daniel Rall wrote:
>> >
>> > "Pete Kazmier" <pe...@kazmier.com> writes:
>> >
>> > > On Sat, Feb 16, 2002 at 10:55:02AM -0500, Aaron Smuts wrote:
>> > >> Suggestions on more documentation?  We really need more examples
> of
> > > >> how to use this thing.
>> > >
>> > > I think it would be useful if there was a document that presented
>> > > 'typical' deployment(s) of JCS.  The overview doc is very
> high-level,
> > > > while the other docs deal with specifics.  How about something in
> the
> > > > middle?  A document about how to use JCS effectively in an
>> application?
>> > > This might specify recommended numbers of caches and what types of
>> > > caches to deploy (local, remote, lateral, etc ...) as well as
> other
> > > > architectural issues?
>> >
>> > Definitely, concrete examples are key to grasping new concepts.  I
>> > would love to see an example which shows how to setup a distributed,
>> > in-memory cache which propogates cache invalidations across hosts in
>> > the cluster.
>> >
>> > --
>> > To unsubscribe, e-mail:   <mailto:turbine-dev-
>> unsubscribe@jakarta.apache.org>
>> > For additional commands, e-mail: <mailto:turbine-dev-
>> help@jakarta.apache.org>
>> 
>> --
>> To unsubscribe, e-mail:   <mailto:turbine-dev-
>> unsubscribe@jakarta.apache.org>
>> For additional commands, e-mail: <mailto:turbine-dev-
>> help@jakarta.apache.org>
>
>
> --
> To unsubscribe, e-mail:   <ma...@jakarta.apache.org>
> For additional commands, e-mail: <ma...@jakarta.apache.org>

--
To unsubscribe, e-mail:   <ma...@jakarta.apache.org>
For additional commands, e-mail: <ma...@jakarta.apache.org>

RE: [DOCUMENTATION] Stratum / JCS Documentation

Posted by Aaron Smuts <aa...@verizon.net>.
Just don't specify a disk cache in the cache.ccf file and you have a
cache without a disk cache.  You can setup the default region and that's
all.  It will work.  Your complete cache.ccf file could look like:

##############################################################
################## DEFAULT CACHE REGION  #####################
# sets the default aux value for any non configured caches
jcs.default=
jcs.default.cacheattributes=org.apache.stratum.jcs.engine.CompositeCache
Attributes
jcs.default.cacheattributes.MaxObjects=1000
jcs.default.cacheattributes.MemoryCacheName=org.apache.stratum.jcs.engin
e.memory.lru.LRUMemoryCache
jcs.default.cacheattributes.cacheattributes.UseMemoryShrinker=true
jcs.default.cacheattributes.cacheattributes.MaxMemoryIdleTimeSeconds=360
0
jcs.default.cacheattributes.cacheattributes.ShrinkerIntervalSeconds=60

Or even simpler:

##############################################################
################## DEFAULT CACHE REGION  #####################
# sets the default aux value for any non configured caches
jcs.default=
jcs.default.cacheattributes=org.apache.stratum.jcs.engine.CompositeCache
Attributes
jcs.default.cacheattributes.MaxObjects=1000
jcs.default.cacheattributes.MemoryCacheName=org.apache.stratum.jcs.engin
e.memory.lru.LRUMemoryCache

Add a disk cache by adding:

jcs.auxiliary.DC=org.apache.stratum.jcs.auxiliary.disk.indexed.IndexedDi
skCacheFactory
jcs.auxiliary.DC.attributes=org.apache.stratum.jcs.auxiliary.disk.indexe
d.IndexedDiskCacheAttributes
jcs.auxiliary.DC.attributes.DiskPath=g:/dev/jakarta-turbine-stratum/raf

and changing the first line to:

jcs.default=DC

Your done.

This could be the configuration file for the book store example.


Configuration is pretty easy, the remote cache is the most difficult,
but basically:

Configuring a disk cache is a simple as telling it what folder to use.

Setting up remote caches involves specifying the server address and
starting the server.

Setting up lateral caches (only use the TCP) involves listing the other
lateral caches in the TCPServers attribute. 

Aaron

> -----Original Message-----
> From: jmcnally@localhost.localdomain
> [mailto:jmcnally@localhost.localdomain] On Behalf Of John McNally
> Sent: Tuesday, February 19, 2002 10:40 PM
> To: Turbine Developers List
> Subject: Re: [DOCUMENTATION] Stratum / JCS Documentation
> 
> A simple example setting up a LRU cache with and without disk storage
> would interest me.  Would the simplest case of a completely in memory
> cache, be too simple a case to use JCS?
> 
> john mcnally
> 
> Daniel Rall wrote:
> >
> > "Pete Kazmier" <pe...@kazmier.com> writes:
> >
> > > On Sat, Feb 16, 2002 at 10:55:02AM -0500, Aaron Smuts wrote:
> > >> Suggestions on more documentation?  We really need more examples
of
> > >> how to use this thing.
> > >
> > > I think it would be useful if there was a document that presented
> > > 'typical' deployment(s) of JCS.  The overview doc is very
high-level,
> > > while the other docs deal with specifics.  How about something in
the
> > > middle?  A document about how to use JCS effectively in an
> application?
> > > This might specify recommended numbers of caches and what types of
> > > caches to deploy (local, remote, lateral, etc ...) as well as
other
> > > architectural issues?
> >
> > Definitely, concrete examples are key to grasping new concepts.  I
> > would love to see an example which shows how to setup a distributed,
> > in-memory cache which propogates cache invalidations across hosts in
> > the cluster.
> >
> > --
> > To unsubscribe, e-mail:   <mailto:turbine-dev-
> unsubscribe@jakarta.apache.org>
> > For additional commands, e-mail: <mailto:turbine-dev-
> help@jakarta.apache.org>
> 
> --
> To unsubscribe, e-mail:   <mailto:turbine-dev-
> unsubscribe@jakarta.apache.org>
> For additional commands, e-mail: <mailto:turbine-dev-
> help@jakarta.apache.org>


--
To unsubscribe, e-mail:   <ma...@jakarta.apache.org>
For additional commands, e-mail: <ma...@jakarta.apache.org>

Re: [DOCUMENTATION] Stratum / JCS Documentation

Posted by John McNally <jm...@collab.net>.
A simple example setting up a LRU cache with and without disk storage
would interest me.  Would the simplest case of a completely in memory
cache, be too simple a case to use JCS?

john mcnally

Daniel Rall wrote:
> 
> "Pete Kazmier" <pe...@kazmier.com> writes:
> 
> > On Sat, Feb 16, 2002 at 10:55:02AM -0500, Aaron Smuts wrote:
> >> Suggestions on more documentation?  We really need more examples of
> >> how to use this thing.
> >
> > I think it would be useful if there was a document that presented
> > 'typical' deployment(s) of JCS.  The overview doc is very high-level,
> > while the other docs deal with specifics.  How about something in the
> > middle?  A document about how to use JCS effectively in an application?
> > This might specify recommended numbers of caches and what types of
> > caches to deploy (local, remote, lateral, etc ...) as well as other
> > architectural issues?
> 
> Definitely, concrete examples are key to grasping new concepts.  I
> would love to see an example which shows how to setup a distributed,
> in-memory cache which propogates cache invalidations across hosts in
> the cluster.
> 
> --
> To unsubscribe, e-mail:   <ma...@jakarta.apache.org>
> For additional commands, e-mail: <ma...@jakarta.apache.org>

--
To unsubscribe, e-mail:   <ma...@jakarta.apache.org>
For additional commands, e-mail: <ma...@jakarta.apache.org>

Re: [DOCUMENTATION] Stratum / JCS Documentation

Posted by Daniel Rall <dl...@finemaltcoding.com>.
"Pete Kazmier" <pe...@kazmier.com> writes:

> On Sat, Feb 16, 2002 at 10:55:02AM -0500, Aaron Smuts wrote:
>> Suggestions on more documentation?  We really need more examples of
>> how to use this thing.
>
> I think it would be useful if there was a document that presented
> 'typical' deployment(s) of JCS.  The overview doc is very high-level,
> while the other docs deal with specifics.  How about something in the
> middle?  A document about how to use JCS effectively in an application?
> This might specify recommended numbers of caches and what types of
> caches to deploy (local, remote, lateral, etc ...) as well as other
> architectural issues?

Definitely, concrete examples are key to grasping new concepts.  I
would love to see an example which shows how to setup a distributed,
in-memory cache which propogates cache invalidations across hosts in
the cluster.

--
To unsubscribe, e-mail:   <ma...@jakarta.apache.org>
For additional commands, e-mail: <ma...@jakarta.apache.org>

RE: [DOCUMENTATION] Stratum / JCS Documentation

Posted by Aaron Smuts <aa...@verizon.net>.
Good idea.  I'll start something.

> -----Original Message-----
> From: Pete Kazmier [mailto:pete@kazmier.com]
> Sent: Sunday, February 17, 2002 1:34 AM
> To: 'Turbine Developers List'
> Subject: Re: [DOCUMENTATION] Stratum / JCS Documentation
> 
> On Sat, Feb 16, 2002 at 10:55:02AM -0500, Aaron Smuts wrote:
> > Thanks.
> 
> No problem.
> 
> > Suggestions on more documentation?  We really need more examples of
> > how to use this thing.
> 
> I think it would be useful if there was a document that presented
> 'typical' deployment(s) of JCS.  The overview doc is very high-level,
> while the other docs deal with specifics.  How about something in the
> middle?  A document about how to use JCS effectively in an
application?
> This might specify recommended numbers of caches and what types of
> caches to deploy (local, remote, lateral, etc ...) as well as other
> architectural issues?
> 
> 
> --
> To unsubscribe, e-mail:   <mailto:turbine-dev-
> unsubscribe@jakarta.apache.org>
> For additional commands, e-mail: <mailto:turbine-dev-
> help@jakarta.apache.org>


--
To unsubscribe, e-mail:   <ma...@jakarta.apache.org>
For additional commands, e-mail: <ma...@jakarta.apache.org>

Re: [DOCUMENTATION] Stratum / JCS Documentation

Posted by Pete Kazmier <pe...@kazmier.com>.
On Sat, Feb 16, 2002 at 10:55:02AM -0500, Aaron Smuts wrote:
> Thanks.

No problem.

> Suggestions on more documentation?  We really need more examples of
> how to use this thing.

I think it would be useful if there was a document that presented
'typical' deployment(s) of JCS.  The overview doc is very high-level,
while the other docs deal with specifics.  How about something in the
middle?  A document about how to use JCS effectively in an application?
This might specify recommended numbers of caches and what types of
caches to deploy (local, remote, lateral, etc ...) as well as other
architectural issues?


--
To unsubscribe, e-mail:   <ma...@jakarta.apache.org>
For additional commands, e-mail: <ma...@jakarta.apache.org>

RE: [DOCUMENTATION] Stratum / JCS Documentation

Posted by Aaron Smuts <aa...@verizon.net>.
Wow!  We actually have documentation on the web now.

Thanks.

Suggestions on more documentation?  We really need more examples of how
to use this thing.

Aaron

> -----Original Message-----
> From: Pete Kazmier [mailto:pete@kazmier.com]
> Sent: Saturday, February 16, 2002 1:46 AM
> To: turbine-dev@jakarta.apache.org
> Subject: Re: [DOCUMENTATION] Stratum / JCS Documentation
> 
> Here is an additional xdoc with instructions on how to build stratum
and
> a patch to the previously submitted project.xml file that has a
pointer
> to the new doc.  Sorry for the confusion, but I thought this might be
> useful too.
> 
> On Sat, Feb 16, 2002 at 01:10:29AM -0500, Pete Kazmier wrote:
> > I just finished converting all of Aaron's JCS documents to xdoc
format.
> > While doing this, I also created the start of a stratum xdoc
hierarchy.
> > This includes Jason's description of stratum from last week's status
> > update, and all of the JCS documentation that I converted.


--
To unsubscribe, e-mail:   <ma...@jakarta.apache.org>
For additional commands, e-mail: <ma...@jakarta.apache.org>

Re: [DOCUMENTATION] Stratum / JCS Documentation

Posted by Pete Kazmier <pe...@kazmier.com>.
Here is an additional xdoc with instructions on how to build stratum and
a patch to the previously submitted project.xml file that has a pointer
to the new doc.  Sorry for the confusion, but I thought this might be
useful too.

On Sat, Feb 16, 2002 at 01:10:29AM -0500, Pete Kazmier wrote:
> I just finished converting all of Aaron's JCS documents to xdoc format.
> While doing this, I also created the start of a stratum xdoc hierarchy.
> This includes Jason's description of stratum from last week's status
> update, and all of the JCS documentation that I converted.