com.zepben.evolve.database.sqlite.metrics.MetricsEntryWriter.kt Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of evolve-sdk Show documentation
SDK for interaction with the evolve platform
There is a newer version: 0.24.0rc1
/*
 * Copyright 2024 Zeppelin Bend Pty Ltd
 *
 * This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at https://mozilla.org/MPL/2.0/.
 */

package com.zepben.evolve.database.sqlite.metrics

import com.zepben.evolve.database.sqlite.common.BaseEntryWriter
import com.zepben.evolve.database.sqlite.extensions.setInstant
import com.zepben.evolve.database.sqlite.metrics.tables.TableJobSources
import com.zepben.evolve.database.sqlite.metrics.tables.TableJobs
import com.zepben.evolve.database.sqlite.metrics.tables.TableNetworkContainerMetrics
import com.zepben.evolve.metrics.*
import java.util.*

/**
 * Class for writing entries to the metrics database.
 *
 * @param databaseTables The tables in the metrics database.
 * @param jobId The ID of the job to write entries for.
 */
class MetricsEntryWriter(
    private val databaseTables: MetricsDatabaseTables,
    private val jobId: UUID
) : BaseEntryWriter() {

    /**
     * Save an [IngestionMetadata] to the `jobs` table.
     *
     * @param metadata the [IngestionMetadata] to save.
     * @return true if the [metadata] saved successfully.
     */
    fun save(metadata: IngestionMetadata): Boolean {
        val table = databaseTables.getTable()
        val insert = databaseTables.getInsert()

        insert.setString(table.JOB_ID.queryIndex, jobId.toString())
        insert.setInstant(table.INGEST_TIME.queryIndex, metadata.startTime)
        insert.setString(table.SOURCE.queryIndex, metadata.source)
        insert.setString(table.APPLICATION.queryIndex, metadata.application)
        insert.setString(table.APPLICATION_VERSION.queryIndex, metadata.applicationVersion)

        return insert.tryExecuteSingleUpdate("job")
    }

    /**
     * Save a [JobSource] to the `job_sources` table.
     *
     * @param jobSource The [JobSource] to save.
     * @return true if the [jobSource] was saved successfully.
     */
    fun saveSource(jobSource: JobSource): Boolean {
        val table = databaseTables.getTable()
        val insert = databaseTables.getInsert()
        val (sourceName, sourceMetadata) = jobSource

        insert.setString(table.JOB_ID.queryIndex, jobId.toString())
        insert.setString(table.DATA_SOURCE.queryIndex, sourceName)
        insert.setInstant(table.SOURCE_TIME.queryIndex, sourceMetadata.timestamp)
        insert.setObject(table.FILE_SHA.queryIndex, sourceMetadata.fileHash)

        return insert.tryExecuteSingleUpdate("job source")
    }

    /**
     * Save a [NetworkMetric] to the `job_sources` table.
     *
     * @param networkMetric The [NetworkMetric] to save.
     * @return true if the [networkMetric] was saved successfully.
     */
    fun saveMetric(networkMetric: NetworkMetric): Boolean {
        val table = databaseTables.getTable()
        val insert = databaseTables.getInsert()
        val (container, containerMetric) = networkMetric

        insert.setString(table.JOB_ID.queryIndex, jobId.toString())
        when (container) {
            is TotalNetworkContainer -> {
                insert.setString(table.HIERARCHY_ID.queryIndex, "GLOBAL")
                insert.setString(table.HIERARCHY_NAME.queryIndex, "")
                insert.setString(table.CONTAINER_TYPE.queryIndex, "TOTAL")
            }
            is PartialNetworkContainer -> {
                insert.setString(table.HIERARCHY_ID.queryIndex, container.mRID)
                insert.setString(table.HIERARCHY_NAME.queryIndex, container.name)
                insert.setString(table.CONTAINER_TYPE.queryIndex, container.level.name)
            }
        }

        containerMetric.entries.forEach { (metricName, metricValue) ->
            insert.setString(table.METRIC_NAME.queryIndex, metricName)
            insert.setDouble(table.METRIC_VALUE.queryIndex, metricValue)
            insert.addBatch()
        }

        return insert.executeBatch().none { it < 0 }
    }

}