You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@sirona.apache.org by rm...@apache.org on 2013/11/22 10:20:44 UTC
svn commit: r1544442 - in /incubator/sirona/site-content/trunk/src/site:
markdown/ehcache.md markdown/jaxrs.md xdoc/index.xml.vm
Author: rmannibucau
Date: Fri Nov 22 09:20:43 2013
New Revision: 1544442
URL: http://svn.apache.org/r1544442
Log:
adding jaxrs and ehcache doc
Added:
incubator/sirona/site-content/trunk/src/site/markdown/ehcache.md
incubator/sirona/site-content/trunk/src/site/markdown/jaxrs.md
Modified:
incubator/sirona/site-content/trunk/src/site/xdoc/index.xml.vm
Added: incubator/sirona/site-content/trunk/src/site/markdown/ehcache.md
URL: http://svn.apache.org/viewvc/incubator/sirona/site-content/trunk/src/site/markdown/ehcache.md?rev=1544442&view=auto
==============================================================================
--- incubator/sirona/site-content/trunk/src/site/markdown/ehcache.md (added)
+++ incubator/sirona/site-content/trunk/src/site/markdown/ehcache.md Fri Nov 22 09:20:43 2013
@@ -0,0 +1,49 @@
+<!---
+Licensed to the Apache Software Foundation (ASF) under one
+or more contributor license agreements. See the NOTICE file
+distributed with this work for additional information
+regarding copyright ownership. The ASF licenses this file
+to you under the Apache License, Version 2.0 (the
+"License"); you may not use this file except in compliance
+with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing,
+software distributed under the License is distributed on an
+"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+KIND, either express or implied. See the License for the
+specific language governing permissions and limitations
+under the License.
+-->
+# Goal
+
+Be able to monitor EhCache usage in an application.
+
+# Installation
+
+Just drop the EhCache jar. If EhCache `CacheManager` are already created the `org.apache.sirona.agent.ehcache.EhCacheGaugeFactory`
+will fond them and monitor them. If not you'll need to register the gauges yourself calling `Repository.Instance.addGauge()`
+for each gauge returned by `org.apache.sirona.agent.ehcache.EhCacheGaugeFactory#register`.
+
+# Data monitored
+
+The EhCache monitoring provides the following gauges for each cache:
+
+* hit count
+* miss expired count
+* miss not found count
+* miss count
+* put added count
+* put updated count
+* put count
+* remove count
+* expired count
+* evicted count
+* hit ratio
+
+And the following for each cache manager:
+
+* cache count
+* commit count
+* rollback count
Added: incubator/sirona/site-content/trunk/src/site/markdown/jaxrs.md
URL: http://svn.apache.org/viewvc/incubator/sirona/site-content/trunk/src/site/markdown/jaxrs.md?rev=1544442&view=auto
==============================================================================
--- incubator/sirona/site-content/trunk/src/site/markdown/jaxrs.md (added)
+++ incubator/sirona/site-content/trunk/src/site/markdown/jaxrs.md Fri Nov 22 09:20:43 2013
@@ -0,0 +1,40 @@
+<!---
+Licensed to the Apache Software Foundation (ASF) under one
+or more contributor license agreements. See the NOTICE file
+distributed with this work for additional information
+regarding copyright ownership. The ASF licenses this file
+to you under the Apache License, Version 2.0 (the
+"License"); you may not use this file except in compliance
+with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing,
+software distributed under the License is distributed on an
+"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+KIND, either express or implied. See the License for the
+specific language governing permissions and limitations
+under the License.
+-->
+# Goal
+
+JAX-RS module is comparable to Web performance monitoring
+excepted it uses JAX-RS mapping instead of raw request url.
+
+For instance you'll get as counter name `/user/{name}` instead of `/user/apache`.
+
+# Installation
+
+JAXRS integration comes with two main flavors: jaxrs2 and cxf.
+
+The first one targets recent implementations and 100% relies on the specification. The second one
+is specific to cxf (it targets mainly cxf 2.6.x but should work with more recent releases). This
+is mainly for JAX-RS 1.0 servers.
+
+## JAX-RS 2
+
+Just add the `org.apache.sirona.agent.jaxrs.jaxrs2.SironaFeature` to your configuration.
+
+## CXF 2.6
+
+Just add the provider `org.apache.sirona.agent.jaxrs.cxf.CxfJaxRsPerformanceHandler`.
Modified: incubator/sirona/site-content/trunk/src/site/xdoc/index.xml.vm
URL: http://svn.apache.org/viewvc/incubator/sirona/site-content/trunk/src/site/xdoc/index.xml.vm?rev=1544442&r1=1544441&r2=1544442&view=diff
==============================================================================
--- incubator/sirona/site-content/trunk/src/site/xdoc/index.xml.vm (original)
+++ incubator/sirona/site-content/trunk/src/site/xdoc/index.xml.vm Fri Nov 22 09:20:43 2013
@@ -103,6 +103,10 @@
<a href="./collector.html">See Collector</a>
<br/>
<a href="./cassandra.html">See Cassandra</a>
+ <br/>
+ <a href="./jaxrs.html">See JAX-RS</a>
+ <br/>
+ <a href="./ehcache.html">See EhCache</a>
</p>