/
MetricsConfig.java
111 lines (91 loc) · 2.88 KB
/
MetricsConfig.java
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
/*
* Copyright (c) 2019 Contributors to the Eclipse Foundation
*
* See the NOTICE file(s) distributed with this work for additional
* information regarding copyright ownership.
*
* This program and the accompanying materials are made available under the
* terms of the Eclipse Public License 2.0 which is available at
* http://www.eclipse.org/legal/epl-2.0
*
* SPDX-License-Identifier: EPL-2.0
*/
package org.eclipse.ditto.internal.utils.metrics.config;
import javax.annotation.concurrent.Immutable;
import org.eclipse.ditto.internal.utils.config.KnownConfigValue;
/**
* Provides the configuration settings of metrics.
*/
@Immutable
public interface MetricsConfig {
/**
* Indicates whether system metrics are enabled.
*
* @return {@code true} if system metrics are enabled, {@code false} if not.
*/
boolean isSystemMetricsEnabled();
/**
* Returns the metric prefix to apply for all gathered metrics in Ditto provided to Prometheus.
*
* @return the metric prefix to apply or empty string for no prefix.
*/
String getMetricPrefix();
/**
* Indicates whether Prometheus is enabled.
*
* @return {@code true} if Prometheus is enabled, {@code false} if not.
*/
boolean isPrometheusEnabled();
/**
* Returns the hostname to bind the Prometheus HTTP server to.
*
* @return the hostname.
*/
String getPrometheusHostname();
/**
* Returns the port to bind the Prometheus HTTP server to.
*
* @return the port.
*/
int getPrometheusPort();
/**
* An enumeration of the known config path expressions and their associated default values for
* {@code MetricsConfig}.
*/
enum MetricsConfigValue implements KnownConfigValue {
/**
* Determines whether system metrics are enabled.
*/
SYSTEM_METRICS_ENABLED("systemMetrics.enabled", false),
/**
* The metric prefix to apply for all gathered Metrics in Ditto.
*/
METRIC_PREFIX("metric-prefix", ""),
/**
* Determines whether Prometheus is enabled.
*/
PROMETHEUS_ENABLED("prometheus.enabled", false),
/**
* The hostname to bind the Prometheus HTTP server to.
*/
PROMETHEUS_HOSTNAME("prometheus.hostname", "0.0.0.0"),
/**
* The port to bind the Prometheus HTTP server to.
*/
PROMETHEUS_PORT("prometheus.port", 9095);
private final String path;
private final Object defaultValue;
MetricsConfigValue(final String thePath, final Object theDefaultValue) {
path = thePath;
defaultValue = theDefaultValue;
}
@Override
public String getConfigPath() {
return path;
}
@Override
public Object getDefaultValue() {
return defaultValue;
}
}
}