metrics-common-tags-autoconfigure

Micro-util for adding common tags to Spring Boot metrics (micrometer)

License	The Apache Software License, Version 2.0
Categories	Auto Application Layer Libs Code Generators config Configuration Metrics Application Testing & Monitoring Monitoring
GroupId	io.github.ing8ar.metrics-common-tags
ArtifactId	metrics-common-tags-autoconfigure
Last Version	0.1.1
Release Date	Nov 19, 2018
Type	jar
Description	metrics-common-tags-autoconfigure Micro-util for adding common tags to Spring Boot metrics (micrometer)
Project URL	https://github.com/ing8ar/metrics-common-tags
Source Code Management	https://github.com/ing8ar/metrics-common-tags

Download metrics-common-tags-autoconfigure

Filename	Size
metrics-common-tags-autoconfigure-0.1.1.pom
metrics-common-tags-autoconfigure-0.1.1.jar	7 KB
metrics-common-tags-autoconfigure-0.1.1-sources.jar	2 KB
metrics-common-tags-autoconfigure-0.1.1-javadoc.jar	26 KB

How to add to project

Apache Maven

<!-- https://jarcasting.com/artifacts/io.github.ing8ar.metrics-common-tags/metrics-common-tags-autoconfigure/ -->
<dependency>
    <groupId>io.github.ing8ar.metrics-common-tags</groupId>
    <artifactId>metrics-common-tags-autoconfigure</artifactId>
    <version>0.1.1</version>
</dependency>

Gradle Groovy

// https://jarcasting.com/artifacts/io.github.ing8ar.metrics-common-tags/metrics-common-tags-autoconfigure/
implementation 'io.github.ing8ar.metrics-common-tags:metrics-common-tags-autoconfigure:0.1.1'

Gradle Kotlin

// https://jarcasting.com/artifacts/io.github.ing8ar.metrics-common-tags/metrics-common-tags-autoconfigure/
implementation ("io.github.ing8ar.metrics-common-tags:metrics-common-tags-autoconfigure:0.1.1")

Apache Buildr

'io.github.ing8ar.metrics-common-tags:metrics-common-tags-autoconfigure:jar:0.1.1'

Apache Ivy

<dependency org="io.github.ing8ar.metrics-common-tags" name="metrics-common-tags-autoconfigure" rev="0.1.1">
  <artifact name="metrics-common-tags-autoconfigure" type="jar" />
</dependency>

Groovy Grape

@Grapes(
@Grab(group='io.github.ing8ar.metrics-common-tags', module='metrics-common-tags-autoconfigure', version='0.1.1')
)

Scala SBT

libraryDependencies += "io.github.ing8ar.metrics-common-tags" % "metrics-common-tags-autoconfigure" % "0.1.1"

Leiningen

[io.github.ing8ar.metrics-common-tags/metrics-common-tags-autoconfigure "0.1.1"]

Dependencies

runtime (4)

Group / Artifact	Type	Version
io.github.ing8ar.metrics-common-tags : metrics-common-tags-core	jar	0.1.0
org.springframework.boot : spring-boot-autoconfigure	jar
org.springframework.boot : spring-boot-actuator-autoconfigure	jar
io.micrometer : micrometer-core	jar

Project Modules

There are no modules declared in this project.

Metrics Common Tags

Micro-util for adding common tags to spring boot metrics (spring boot actuator).

Similarly, but not the same feature (since Spring Boot 2.1.0) - management.metrics.tags.*, because it helps to extract some non constant data.

Getting Started

1. Add dependency to build file (build.gradle.kts)

implementation("io.github.ing8ar.metrics-common-tags:metrics-common-tags-autoconfigure:0.1.1")

2. Add properties to your spring boot application.yml

metrics:
  common:
    tags:
      - app
      - host

3. Run app

Your app will add that tags with values for each metric:

Key	Value
app	${spring.application.name}
host	InetAddress.getLocalHost().hostName

Pre-initialize tags

Tag	Extractor class
app	DefaultAppNameTagExtractor
host	DefaultHostNameTagExtractor

Customization

You can add your own tags, or override exist.

Add your own tag

Create bean which implements TagExtractor:

    @Bean
    open fun customTagExtractor() = object : TagExtractor {
        override val tagName: String
            get() = "custom-tag"

        override fun extract() = "custom tag data"

    }

, then add tag name to configuration file (ex.: application.yml):

metrics:
  common:
    tags:
      - custom-tag

Override exist

See example project

Versions

Version
0.1.1 Nov 19, 2018
0.1.0 Nov 18, 2018