moira-kotlin-client

Client for Moira written in Kotlin.

This is Kotlin implementation of the official Python client.

Installation

To install client just add it as a dependency to your build tool.

Gradle example:

dependencies {
    implementation 'ru.yoomoney.tech:moira-kotlin-client:2.0.0'
}

Getting started

First of all you have to initialize instance of Moira client:

import ru.yoomoney.tech.moira.client.Moira
import ru.yoomoney.tech.moira.client.settings.MoiraSettings

val moira = Moira(
    MoiraSettings(
        // Moira API URL
        baseUrl = "http://example.net/api"
    )
)

In addition, you can specify user login and credentials to authorize operations in Moira via MoiraSettings. For more information about security in Moira see this page.

User Guide

Triggers

Create new trigger

import ru.yoomoney.tech.moira.client.triggers.Trigger
import ru.yoomoney.tech.moira.client.triggers.TriggerState.ERROR
import ru.yoomoney.tech.moira.client.triggers.TriggerType.RISING
import ru.yoomoney.tech.moira.client.triggers.expression.SimpleExpression
import ru.yoomoney.tech.moira.client.triggers.ttl.TtlCondition

val triggerId = moira.triggers.create(
    trigger = Trigger(
        id = "service_trigger_name",
        name = "Trigger Name",
        description = "My trigger",
        tags = listOf("service"),
        targets = listOf("prefix.service.*.postfix"),
        triggerExpression = SimpleExpression(
            triggerType = RISING,
            warnValue = 300.0,
            errorValue = 600.0
        ),
        ttlCondition = TtlCondition(state = ERROR)
    )
)

println(triggerId) // 'service_trigger_name'

Note: id parameter is not required but highly recommended for large production solutions. If parameter is not specified, random trigger guid will be generated.

Update triggers

For example, turn off all triggers for Monday.

import java.time.DayOfWeek

moira.triggers.fetchAll()
    .map { 
        val newDays = it.schedule.days.map { day -> 
            if (day.dayOfWeek == DayOfWeek.MONDAY) day.copy(enabled = false) else day 
        }
        val newSchedule = it.schedule.copy(days = newDays)
        it.copy(schedule = newSchedule)
    }.forEach { moira.triggers.update(it) }

Delete trigger

val trigger = moira.triggers.fetchById(id = "bb1a8514-128b-406e-bec3-25e94153ab30")
if (trigger != null) {
    if (moira.triggers.delete(id = trigger.id!!)) {
        println("Trigger deleted")
    }
}

Check whether trigger exists or not (manually)

import ru.yoomoney.tech.moira.client.triggers.Trigger
import ru.yoomoney.tech.moira.client.triggers.TriggerType.RISING
import ru.yoomoney.tech.moira.client.triggers.expression.SimpleExpression

val trigger = Trigger(
    name = "Trigger name",
    targets = listOf("service.rps"),
    tags = listOf("ops"),
    triggerExpression = SimpleExpression(
        triggerType = RISING,
        warnValue = 300.0,
        errorValue = 600.0
    )
)

val existingTriggerWithSameName = moira.triggers.fetchAll().find { it.name == trigger.name }
if (existingTriggerWithSameName == null) {
    val triggerId = moira.triggers.create(trigger = trigger)
    println(triggerId) // randomly generated GUID by Moira
}

Subscription

Create subscription

import ru.yoomoney.tech.moira.client.subscriptions.Subscription

val subscriptionId = moira.subscriptions.create(subscription = Subscription(
    contacts = listOf("79ac9de2-a3b3-4f94-b3ea-74f6f4094fd2"),
    tags = listOf("tag")
))
    
println(subscriptionId) // random generated GUID by Moira

Delete subscription

Delete all subscriptions

moira.subscriptions.fetchAll().forEach { moira.subscriptions.delete(id = it.id!!) }

Contact

Get all contacts

moira.contacts.all().forEach { println(it.id) }

Get contact id by type and value

import ru.yoomoney.tech.moira.client.contacts.Contacts

fun Contacts.fetchId(type: String, value: String): String? {
    return all().find { it.type == type && it.value == value }?.id
}

val contactId = moira.contacts.fetchId(type = "slack", value = "#err")
println(contactId)