https://github.com/itzg/stackdriver-spring-boot-autoconfigure

Provides a Spring Boot auto-configuration to export actuator metrics to Google Cloud's Stackdriver
https://github.com/itzg/stackdriver-spring-boot-autoconfigure

Last synced: 8 months ago
JSON representation

Provides a Spring Boot auto-configuration to export actuator metrics to Google Cloud's Stackdriver

• Host: GitHub
• URL: https://github.com/itzg/stackdriver-spring-boot-autoconfigure
• Owner: itzg
• License: apache-2.0
• Created: 2019-01-08T18:48:04.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2019-02-19T15:34:29.000Z (over 7 years ago)
• Last Synced: 2025-03-04T04:41:52.159Z (over 1 year ago)
• Language: Java
• Size: 132 KB
• Stars: 1
• Watchers: 3
• Forks: 2
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.txt

Awesome Lists containing this project

README

          
[![CircleCI](https://circleci.com/gh/itzg/stackdriver-spring-boot-autoconfigure.svg?style=svg)](https://circleci.com/gh/itzg/stackdriver-spring-boot-autoconfigure)

[![Release](https://jitpack.io/v/itzg/stackdriver-spring-boot-autoconfigure.svg)](https://jitpack.io/#itzg/stackdriver-spring-boot-autoconfigure)

This module provides a Spring Boot auto-configuration to export actuator metrics to 

Google Cloud's Stackdriver.

# Adding to your project

Follow the instructions [at JitPack](https://jitpack.io/#itzg/stackdriver-spring-boot-autoconfigure).

# Application configuration

The only configuration needed is to set the Spring property

`management.metrics.export.stackdriver.project-id` to reference your GCP project's ID.

# Authentication

If running external to a GCP compute resource, refer to the 

[GCP Monitoring Client documentation](https://cloud.google.com/monitoring/docs/reference/libraries#setting_up_authentication)

and you will need to generate an authentication key file and pass the path to that via the

environment variable `GOOGLE_APPLICATION_CREDENTIALS`.

# Stackdriver resource type and metric naming

You will be able to locate your metrics within the Resource Type "Global", as shown here:

![](docs/resource_types.png)

The default Stackdriver naming convention prepends your metric's name with "custom/", as shown here:

![](docs/metrics.png)

The metric shown in the example was declared like the following:

```java

  @Autowired

  public SomeAppService(MeterRegistry meterRegistry) {

    messagesPre = meterRegistry.counter("messages", "stage", "pre");

    messagesPost = meterRegistry.counter("messages", "stage", "post");

  }

```

# Development

## Preparing a release

Use the Maven release plugin to perform the build, tag, and update

```bash

mvn release:prepare

```

With that completed, git push the commits and tag to the repo.