Skip to content
This repository has been archived by the owner on Jun 3, 2024. It is now read-only.

Commit

Permalink
Fix broken Markdown headings
Browse files Browse the repository at this point in the history
  • Loading branch information
bryant1410 committed Apr 16, 2017
1 parent 4daa5ed commit 2fa5d7d
Showing 1 changed file with 9 additions and 9 deletions.
18 changes: 9 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
#Metrics for Spring
# Metrics for Spring

[![Build Status](https://img.shields.io/travis/ryantenney/metrics-spring/master.svg?style=flat-square)](https://travis-ci.org/ryantenney/metrics-spring)
![Maven Central](https://img.shields.io/maven-central/v/com.ryantenney.metrics/metrics-spring.svg?style=flat-square)
![GitHub license](https://img.shields.io/github/license/ryantenney/metrics-spring.svg?style=flat-square)

##About
## About

The `metrics-spring` module integrates [Dropwizard Metrics library](http://metrics.dropwizard.io/) with Spring, and provides XML and Java configuration.

Expand All @@ -17,7 +17,7 @@ This module does the following:
* Creates reporters from XML config and binds them to the Spring lifecycle
* Registers metrics and metric sets in XML

###Maven
### Maven

Current version is 3.1.3, which is compatible with Metrics 3.1.2

Expand All @@ -29,7 +29,7 @@ Current version is 3.1.3, which is compatible with Metrics 3.1.2
</dependency>
```

###Basic Usage
### Basic Usage

As of version 3, `metrics-spring` may be configured using XML or Java, depending on your personal preference.

Expand Down Expand Up @@ -101,7 +101,7 @@ public class SpringConfiguringClass extends MetricsConfigurerAdapter {
}
```

###XML Config Documentation
### XML Config Documentation

The `<metrics:annotation-driven />` element is required, and has 4 optional arguments:
* Attributes
Expand Down Expand Up @@ -137,7 +137,7 @@ The `<metrics:register />` element registers with the MetricRegistry a bean whic
* `<bean />` - The beans to register with the specified registry.
* `metrics:name` attribute on the bean element - specifies the name with which the metric will be registered. Optional if the bean is a MetricSet.

###Java Config Documentation
### Java Config Documentation

A `@Configuration` class annotated with `@EnableMetrics` is functionally equivalent to using the `<metrics:annotation-driven />` element.

Expand All @@ -150,7 +150,7 @@ The class may also implement the interface `MetricsConfigurer`, or extend the ab
* `getHealthCheckRegistry()` - return the `HealthCheckRegsitry` instance with which to register any beans which extend the class `HealthCheck`. If omitted a new `HealthCheckRegistry` instance is created.
* `configureReporters(MetricRegistry)` - configure reporters

###A Note on the Limitations of Spring AOP
### A Note on the Limitations of Spring AOP

Due to limitations of Spring AOP only public methods can be proxied, so `@Timed`, `@Metered`, `@ExceptionMetered`, and `@Counted` have no effect on non-public methods. Additionally, calling an annotated method from within the same class will not go through the proxy.

Expand All @@ -173,11 +173,11 @@ public class Foo {
As `@Gauge` doesn’t involve a proxy, it may be used on non-public fields and methods.
Additionally, `@InjectMetric` may be used on non-public, non-final fields.

###Users of the Maven Shade plugin
### Users of the Maven Shade plugin

Please see the [Shade Readme](SHADE-README.md)

###Documentation
### Documentation

Javadocs are hosted at http://ryantenney.github.io/metrics-spring/docs/

Expand Down

0 comments on commit 2fa5d7d

Please sign in to comment.