extensions/metrics-codahale/src/docs/metrics-codahale.txt

///////////////////////////////////////////////////////////////
 * 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.
///////////////////////////////////////////////////////////////

[[extension-metrics-metrics, Codahale Metrics]]
= Codahale Metrics =

[devstatus]
--------------
source=extensions/metrics-codahale/dev-status.xml
--------------

Metrics extension backed by the http://metrics.dropwizard.io/[Codahale] metrics library
maintained by the http://www.dropwizard.io/[Dropwizard] folks.

include::../../build/docs/buildinfo/artifact.txt[]

== Assembly ==

Assembly is done using the provided Assembler:

[snippet,java]
----
source=extensions/metrics-codahale/src/test/java/org/apache/polygene/metrics/codahale/CodahaleMetricsTest.java
tag=assembly
----

== Reporting to Ganglia or Graphite ==

Dropwizard provide metrics reporter for Ganglia or Graphite, see the http://metrics.dropwizard.io/[official documentation]
for details.

To register reporters you need a handle to the underlying `MetricsRegistry`, the `CodahaleMetricsProvider` service
provide accessor to it:

[snippet,java]
----
source=extensions/metrics-codahale/src/test/java/org/apache/polygene/metrics/codahale/CodahaleMetricsTest.java
tag=registry
----