Nile Project

Nile project - is a monitoring system, set of libraries, containing useful API for building, export, analyzing and visualizing business metrics of your Spring Java/Kotlin application.

Nile project contains of 3 modules:

nile-micrometer

• building different types of business metrics (counter, timer, gauge, distribution summary)
• building database metrics via executing select queries
• collecting metrics by schedule

nile-anomaly

• analyzing business time series on anomalies
• exporting anomalies metrics

nile-grafana

• Kotlin DSL for building grafana dashboards (grafana as a code)
• Grafana Dashboard management via Grafana API

Example of usage for all modules can be found in nile-application module.

Table of contents

• Dependency
• Nile micrometer
  • Counter
  • Timer
  • Gauge
  • Distribution Summary
  • Scheduled metric
• Nile anomaly
• Nile grafana

Dependency

Gradle (.kts)

val nileVersion = "0.0.1"

implementation(group = "tech.volkov.nile", name = "nile-micrometer", version = nileVersion)
implementation(group = "tech.volkov.nile", name = "nile-anomaly", version = nileVersion)
implementation(group = "tech.volkov.nile", name = "nile-grafana", version = nileVersion)

Maven

<dependencies>
  <dependency>
    <groupId>tech.volkov.nile</groupId>
    <artifactId>nile-micrometer</artifactId>
    <version>0.0.1</version>
  </dependency>
  <dependency>
    <groupId>tech.volkov.nile</groupId>
    <artifactId>nile-anomaly</artifactId>
    <version>0.0.1</version>
  </dependency>
  <dependency>
    <groupId>tech.volkov.nile</groupId>
    <artifactId>nile-grafana</artifactId>
    <version>0.0.1</version>
  </dependency>
</dependencies>

Nile Micrometer

Counter

Increases micrometer counter each time when function calls

Function

nileCounter(
    name = "dog_facts_counter",
    description = "Counts how many request were executed to dog facts API",
    tags = mapOf("tagName" to "tagValue"),
    isSuccess = isSuccess,
    amount = { 10.0 }
)

Annotation

@NileCounter(
    name = "dog_facts_counter",
    description = "Counts how many request were executed to dog facts API",
    tags = ["tagName", "tagValue"],
    amount = 10.0
)
fun getDogFacts() {
    // getting dogs facts
}

Prometheus metrics

Timer

val dogFactsResponse = nileTimer(
    name = "dog_facts_timer",
    description = "Response time for dog facts API",
    tags = mapOf("tagName" to "tagValue"),
    percentiles = listOf(0.5, 0.75, 0.9, 0.95, 0.99)
) {    
    getDogFacts(number)
}

Prometheus metrics

# HELP cat_fact_seconds Time to execute call to cat fact API
# TYPE cat_fact_seconds summary
cat_fact_seconds_count{application="nile-application",status="OK",} 5.0
cat_fact_seconds_sum{application="nile-application",status="OK",} 17.0398064
# HELP cat_fact_seconds_max Time to execute call to cat fact API
# TYPE cat_fact_seconds_max gauge
cat_fact_seconds_max{application="nile-application",status="OK",} 7.1959512

Gauge

Prometheus metrics

Distribution Summary

Prometheus metrics

Scheduled metric

Nile Scheduler Spring Configuration

@Configuration
class NileConfiguration {

    @Bean
    fun nileScheduler() = NileScheduler.builder()
        .corePoolSize(5)
        .maximumPoolSize(10)
        .keepAliveTime(5000)
        .queueCapacity(10)
        .defaultScrapeInterval(Duration.ofSeconds(30))
        .build()
}

Scheduled metric

fun scheduleMetric(): MetricDto {
    nileScheduler.scheduleMetric(
        name = "random_number",
        description = "Returns random number between 0 to 9",
        scrapeInterval = Duration.ofSeconds(5)
    ) {
        Random.nextDouble(10.0)
    }
}

Prometheus metrics (the value updates automatically every 5 seconds)

# HELP random_number Returns random number between 0 to 9
# TYPE random_number gauge
random_number{application="nile-application",} 5.295077022881081

Nile Anomaly

Nile Grafana