2 * ============LICENSE_START=======================================================
3 * dcaegen2-collectors-veshv
4 * ================================================================================
5 * Copyright (C) 2018-2019 NOKIA
6 * ================================================================================
7 * Licensed under the Apache License, Version 2.0 (the "License");
8 * you may not use this file except in compliance with the License.
9 * You may obtain a copy of the License at
11 * http://www.apache.org/licenses/LICENSE-2.0
13 * Unless required by applicable law or agreed to in writing, software
14 * distributed under the License is distributed on an "AS IS" BASIS,
15 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
16 * See the License for the specific language governing permissions and
17 * limitations under the License.
18 * ============LICENSE_END=========================================================
20 package org.onap.dcae.collectors.veshv.main.metrics
22 import arrow.syntax.function.memoize
23 import io.micrometer.core.instrument.Counter
24 import io.micrometer.core.instrument.Timer
25 import io.micrometer.core.instrument.binder.jvm.ClassLoaderMetrics
26 import io.micrometer.core.instrument.binder.jvm.JvmGcMetrics
27 import io.micrometer.core.instrument.binder.jvm.JvmMemoryMetrics
28 import io.micrometer.core.instrument.binder.jvm.JvmThreadMetrics
29 import io.micrometer.core.instrument.binder.system.ProcessorMetrics
30 import io.micrometer.prometheus.PrometheusConfig
31 import io.micrometer.prometheus.PrometheusMeterRegistry
32 import org.onap.dcae.collectors.veshv.boundary.Metrics
33 import org.onap.dcae.collectors.veshv.domain.WireFrameMessage
34 import org.onap.dcae.collectors.veshv.model.ClientRejectionCause
35 import org.onap.dcae.collectors.veshv.model.MessageDropCause
36 import org.onap.dcae.collectors.veshv.domain.RoutedMessage
37 import org.onap.dcae.collectors.veshv.domain.VesMessage
38 import org.onap.dcae.collectors.veshv.utils.TimeUtils.epochMicroToInstant
39 import java.time.Duration
40 import java.time.Instant
44 * @author Piotr Jaszczyk <piotr.jaszczyk@nokia.com>
47 class MicrometerMetrics internal constructor(
48 private val registry: PrometheusMeterRegistry = PrometheusMeterRegistry(PrometheusConfig.DEFAULT)
50 private val receivedBytes = registry.counter(name(DATA, RECEIVED, BYTES))
51 private val receivedMessages = registry.counter(name(MESSAGES, RECEIVED))
52 private val receivedMessagesPayloadBytes = registry.counter(name(MESSAGES, RECEIVED, PAYLOAD, BYTES))
54 private val totalConnections = registry.counter(name(CONNECTIONS))
55 private val disconnections = registry.counter(name(DISCONNECTIONS))
57 private val processingTime = Timer.builder(name(MESSAGES, PROCESSING, TIME))
58 .maximumExpectedValue(MAX_BUCKET_DURATION)
59 .publishPercentileHistogram(true)
61 private val processingTimeWithoutRouting = Timer.builder(name(MESSAGES, PROCESSING, TIME, WITHOUT, ROUTING))
62 .maximumExpectedValue(MAX_BUCKET_DURATION)
63 .publishPercentileHistogram(true)
65 private val totalLatency = Timer.builder(name(MESSAGES, LATENCY))
66 .maximumExpectedValue(MAX_BUCKET_DURATION)
67 .publishPercentileHistogram(true)
70 private val sentMessages = registry.counter(name(MESSAGES, SENT))
71 private val sentMessagesByTopic = { topic: String ->
72 registry.counter(name(MESSAGES, SENT, TOPIC), TOPIC, topic)
73 }.memoize<String, Counter>()
74 private val droppedMessages = registry.counter(name(MESSAGES, DROPPED))
75 private val messagesDroppedByCause = { cause: String ->
76 registry.counter(name(MESSAGES, DROPPED, CAUSE), CAUSE, cause)
77 }.memoize<String, Counter>()
78 private val clientsRejected = registry.counter(name(CLIENTS, REJECTED))
79 private val clientsRejectedByCause = { cause: String ->
80 registry.counter(name(CLIENTS, REJECTED, CAUSE), CAUSE, cause)
81 }.memoize<String, Counter>()
85 registry.gauge(name(CONNECTIONS, ACTIVE), this) {
86 (totalConnections.count() - disconnections.count()).coerceAtLeast(0.0)
89 ClassLoaderMetrics().bindTo(registry)
90 JvmMemoryMetrics().bindTo(registry)
91 JvmGcMetrics().bindTo(registry)
92 ProcessorMetrics().bindTo(registry)
93 JvmThreadMetrics().bindTo(registry)
96 val metricsProvider = MicrometerPrometheusMetricsProvider(registry)
98 override fun notifyBytesReceived(size: Int) {
99 receivedBytes.increment(size.toDouble())
102 override fun notifyMessageReadyForRouting(msg: VesMessage) {
103 processingTimeWithoutRouting.record(Duration.between(msg.wtpFrame.receivedAt, Instant.now()))
106 override fun notifyMessageReceived(msg: WireFrameMessage) {
107 receivedMessages.increment()
108 receivedMessagesPayloadBytes.increment(msg.payloadSize.toDouble())
111 override fun notifyMessageSent(msg: RoutedMessage) {
112 val now = Instant.now()
113 sentMessages.increment()
114 sentMessagesByTopic(msg.targetTopic).increment()
116 processingTime.record(Duration.between(msg.message.wtpFrame.receivedAt, now))
117 totalLatency.record(Duration.between(epochMicroToInstant(msg.message.header.lastEpochMicrosec), now))
120 override fun notifyMessageDropped(cause: MessageDropCause) {
121 droppedMessages.increment()
122 messagesDroppedByCause(cause.tag).increment()
125 override fun notifyClientRejected(cause: ClientRejectionCause) {
126 clientsRejected.increment()
127 clientsRejectedByCause(cause.tag).increment()
130 override fun notifyClientConnected() {
131 totalConnections.increment()
134 override fun notifyClientDisconnected() {
135 disconnections.increment()
139 val INSTANCE by lazy { MicrometerMetrics() }
140 internal const val PREFIX = "hvves"
141 internal const val MESSAGES = "messages"
142 internal const val RECEIVED = "received"
143 internal const val DISCONNECTIONS = "disconnections"
144 internal const val CONNECTIONS = "connections"
145 internal const val ACTIVE = "active"
146 internal const val BYTES = "bytes"
147 internal const val DATA = "data"
148 internal const val SENT = "sent"
149 internal const val PROCESSING = "processing"
150 internal const val CAUSE = "cause"
151 internal const val CLIENTS = "clients"
152 internal const val REJECTED = "rejected"
153 internal const val TOPIC = "topic"
154 internal const val DROPPED = "dropped"
155 internal const val TIME = "time"
156 internal const val LATENCY = "latency"
157 internal const val PAYLOAD = "payload"
158 internal const val WITHOUT = "without"
159 internal const val ROUTING = "routing"
160 internal val MAX_BUCKET_DURATION = Duration.ofSeconds(300L)
161 internal fun name(vararg name: String) = "$PREFIX.${name.joinToString(".")}"