summaryrefslogtreecommitdiffstats
path: root/controller-api/src/main/java/com/yahoo/vespa/hosted/controller/api/integration/MetricsService.java
blob: d3e1b881bbd946cd89157ddb783c5600a102c835 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
// Copyright 2017 Yahoo Holdings. Licensed under the terms of the Apache 2.0 license. See LICENSE in the project root.
package com.yahoo.vespa.hosted.controller.api.integration;

import com.yahoo.config.provision.ApplicationId;
import com.yahoo.config.provision.ZoneId;

import java.util.Map;

/**
 * A service which returns metric values on request
 *
 * @author bratseth
 */
public interface MetricsService {

    ApplicationMetrics getApplicationMetrics(ApplicationId application);

    DeploymentMetrics getDeploymentMetrics(ApplicationId application, ZoneId zone);

    Map<String, SystemMetrics> getSystemMetrics(ApplicationId application, ZoneId zone);

    class DeploymentMetrics {

        private final double queriesPerSecond;
        private final double writesPerSecond;
        private final long documentCount;
        private final double queryLatencyMillis;
        private final double writeLatencyMillis;

        public DeploymentMetrics(double queriesPerSecond, double writesPerSecond,
                                 long documentCount,
                                 double queryLatencyMillis, double writeLatencyMillis) {
            this.queriesPerSecond = queriesPerSecond;
            this.writesPerSecond = writesPerSecond;
            this.documentCount = documentCount;
            this.queryLatencyMillis = queryLatencyMillis;
            this.writeLatencyMillis = writeLatencyMillis;
        }

        public double queriesPerSecond() { return queriesPerSecond; }

        public double writesPerSecond() { return writesPerSecond; }

        public long documentCount() { return documentCount; }

        public double queryLatencyMillis() { return queryLatencyMillis; }

        public double writeLatencyMillis() { return writeLatencyMillis; }

    }

    class ApplicationMetrics {

        private final double queryServiceQuality;
        private final double writeServiceQuality;

        public ApplicationMetrics(double queryServiceQuality, double writeServiceQuality) {
            this.queryServiceQuality = queryServiceQuality;
            this.writeServiceQuality = writeServiceQuality;
        }

        /** Returns the quality of service for queries as a number between 1 (perfect) and 0 (none) */
        public double queryServiceQuality() { return queryServiceQuality; }

        /** Returns the quality of service for writes as a number between 1 (perfect) and 0 (none) */
        public double writeServiceQuality() { return writeServiceQuality; }

    }

    class SystemMetrics {

        private final double cpuUtil;
        private final double memUtil;
        private final double diskUtil;

        /**
         * @param cpuUtil  percentage of system cpu utilization
         * @param memUtil  percentage of system memory utilization
         * @param diskUtil percentage of system disk utilization
         */
        public SystemMetrics(double cpuUtil, double memUtil, double diskUtil) {
            this.cpuUtil = cpuUtil;
            this.memUtil = memUtil;
            this.diskUtil = diskUtil;
        }

        /** @return the percentage of cpu utilization **/
        public double cpuUtil() { return cpuUtil; }

        /** @return the percentage of memory utilization **/
        public double memUtil() { return memUtil; }

        /** @return the percentage of disk utilization **/
        public double diskUtil() { return diskUtil; }

        public static class Builder {
            private double cpuUtil;
            private double memUtil;
            private double diskUtil;

            public void setCpuUtil(double cpuUtil) {
                this.cpuUtil = cpuUtil;
            }

            public void setMemUtil(double memUtil) {
                this.memUtil = memUtil;
            }

            public void setDiskUtil(double diskUtil) {
                this.diskUtil = diskUtil;
            }

            public SystemMetrics build() { return new SystemMetrics(cpuUtil, memUtil, diskUtil); }
        }

    }

}