README.md

Statful Starter for Springboot

Statful starter for Springboot. Initializes the statful-client-java and springboot-actuator to gather and send metrics to Statful.

Table of Contents

• Supported Versions
• Requirements
• Quick Start
• Examples
• Reference
• Authors
• License

Supported Versions

Statful client version	Tested Java versions	Tested Spring Boot versions
1.x.x	Java 8	1.4.1.RELEASE
2.x.x	Java 8	2.1.0.RELEASE

Requirements

This client has the following requirements:

• statful-metric-registry in order to collect system, datasource, http, etc. metrics.
• statful-client-java in order to send metrics into Statful.

Quick start

Add the dependency using Maven for example:

<dependency>
    <groupId>com.statful.client.framework</groupId>
    <artifactId>statful-springboot-starter</artifactId>
    <version>${statful-client-springboot.version}</version>
</dependency>

And set your API Token for authentication

statful.client.token=your-token

By default the starter configures the Statful Java Client with HTTP transport. For more values configured by default check https://github.com/statful/statful-client-java/#global-configuration

You can also define some custom properties for the metrics collected. For examples and detailed explanation on these properties check statful-metric-registry

Authors

Mindera - Software Craft

License

Statful Spring Boot Starter is available under the MIT license. See the LICENSE file for more information.