https://github.com/statful/statful-springboot-starter

Statful Spring Boot Client
https://github.com/statful/statful-springboot-starter

Last synced: 1 day ago
JSON representation

Statful Spring Boot Client

• Host: GitHub
• URL: https://github.com/statful/statful-springboot-starter
• Owner: statful
• License: mit
• Created: 2016-10-19T22:37:22.000Z (about 8 years ago)
• Default Branch: master
• Last Pushed: 2020-04-24T19:10:21.000Z (over 4 years ago)
• Last Synced: 2024-04-09T15:02:20.662Z (7 months ago)
• Language: Java
• Size: 104 KB
• Stars: 4
• Watchers: 5
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
Statful Starter for Springboot

==============

[![Build Status](https://travis-ci.org/statful/statful-client-springboot.svg?branch=master)](https://travis-ci.org/statful/statful-client-springboot)

Statful starter for Springboot. Initializes the [statful-client-java](https://github.com/statful/statful-client-java) 

 and [springboot-actuator](http://docs.spring.io/spring-boot/docs/current/reference/html/production-ready-metrics.html) to gather and send metrics to Statful.

## Table of Contents

* [Supported Versions](#supported-versions)

* [Requirements](#requirements)

* [Quick Start](#quick-start)

* [Examples](#examples)

* [Reference](#reference)

* [Authors](#authors)

* [License](#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](https://github.com/statful/statful-micrometer-registry) in order to collect system, datasource, http, etc. metrics.

* [statful-client-java](https://github.com/statful/statful-client-java) in order to send metrics into Statful.

## Quick start

Add the dependency using Maven for example:

```

    com.statful.client.framework

    statful-springboot-starter

    ${statful-client-springboot.version}

```

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](https://github.com/statful/statful-micrometer-registry)

 

## Authors

[Mindera - Software Craft](https://github.com/Mindera)

## License

Statful Spring Boot Starter is available under the MIT license. See the [LICENSE](https://raw.githubusercontent.com/statful/statful-client-springboot/master/LICENSE) file for more information.