mirror of https://github.com/hyperledger/besu
Begin capturing metrics to better understand Pantheon's behaviour (#326)
Metrics being captured initially: Total number of peers ever connected to Total number of peers disconnected, by disconnect reason and whether the disconnect was initiated locally or remotely. Current number of peers Timing for processing JSON-RPC requests, broken down by method name. Generic JVM and process metrics (memory used, heap size, thread count, time spent in GC, file descriptors opened, CPU time etc).
Adrian Sutton
6 years ago
committed by
GitHub
parent
25bc82f6ef
commit
081c2f92a6
@ -0,0 +1,72 @@ |
||||
/* |
||||
* Copyright 2018 ConsenSys AG. |
||||
* |
||||
* Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with |
||||
* the License. You may obtain a copy of the License at |
||||
* |
||||
* http://www.apache.org/licenses/LICENSE-2.0
|
||||
* |
||||
* Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on |
||||
* an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the |
||||
* specific language governing permissions and limitations under the License. |
||||
*/ |
||||
package tech.pegasys.pantheon.ethereum.jsonrpc.internal.methods; |
||||
|
||||
import tech.pegasys.pantheon.ethereum.jsonrpc.internal.JsonRpcRequest; |
||||
import tech.pegasys.pantheon.ethereum.jsonrpc.internal.response.JsonRpcResponse; |
||||
import tech.pegasys.pantheon.ethereum.jsonrpc.internal.response.JsonRpcSuccessResponse; |
||||
import tech.pegasys.pantheon.metrics.MetricsSystem; |
||||
import tech.pegasys.pantheon.metrics.Observation; |
||||
|
||||
import java.util.HashMap; |
||||
import java.util.List; |
||||
import java.util.Map; |
||||
|
||||
public class DebugMetrics implements JsonRpcMethod { |
||||
|
||||
private final MetricsSystem metricsSystem; |
||||
|
||||
public DebugMetrics(final MetricsSystem metricsSystem) { |
||||
this.metricsSystem = metricsSystem; |
||||
} |
||||
|
||||
@Override |
||||
public String getName() { |
||||
return "debug_metrics"; |
||||
} |
||||
|
||||
@Override |
||||
public JsonRpcResponse response(final JsonRpcRequest request) { |
||||
final Map<String, Object> observations = new HashMap<>(); |
||||
metricsSystem.getMetrics().forEach(observation -> addObservation(observations, observation)); |
||||
return new JsonRpcSuccessResponse(request.getId(), observations); |
||||
} |
||||
|
||||
private void addObservation( |
||||
final Map<String, Object> observations, final Observation observation) { |
||||
final Map<String, Object> categoryObservations = |
||||
getNextMapLevel(observations, observation.getCategory().getName()); |
||||
if (observation.getLabels().isEmpty()) { |
||||
categoryObservations.put(observation.getMetricName(), observation.getValue()); |
||||
} else { |
||||
addLabelledObservation(categoryObservations, observation); |
||||
} |
||||
} |
||||
|
||||
private void addLabelledObservation( |
||||
final Map<String, Object> categoryObservations, final Observation observation) { |
||||
final List<String> labels = observation.getLabels(); |
||||
Map<String, Object> values = getNextMapLevel(categoryObservations, observation.getMetricName()); |
||||
for (int i = 0; i < labels.size() - 1; i++) { |
||||
values = getNextMapLevel(values, labels.get(i)); |
||||
} |
||||
values.put(labels.get(labels.size() - 1), observation.getValue()); |
||||
} |
||||
|
||||
@SuppressWarnings("unchecked") |
||||
private Map<String, Object> getNextMapLevel( |
||||
final Map<String, Object> current, final String name) { |
||||
return (Map<String, Object>) |
||||
current.computeIfAbsent(name, key -> new HashMap<String, Object>()); |
||||
} |
||||
} |
||||
@ -0,0 +1,88 @@ |
||||
/* |
||||
* Copyright 2018 ConsenSys AG. |
||||
* |
||||
* Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with |
||||
* the License. You may obtain a copy of the License at |
||||
* |
||||
* http://www.apache.org/licenses/LICENSE-2.0
|
||||
* |
||||
* Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on |
||||
* an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the |
||||
* specific language governing permissions and limitations under the License. |
||||
*/ |
||||
package tech.pegasys.pantheon.ethereum.jsonrpc.internal.methods; |
||||
|
||||
import static java.util.Arrays.asList; |
||||
import static org.assertj.core.api.Assertions.assertThat; |
||||
import static org.mockito.Mockito.mock; |
||||
import static org.mockito.Mockito.when; |
||||
import static tech.pegasys.pantheon.metrics.MetricCategory.PEERS; |
||||
import static tech.pegasys.pantheon.metrics.MetricCategory.RPC; |
||||
|
||||
import tech.pegasys.pantheon.ethereum.jsonrpc.internal.JsonRpcRequest; |
||||
import tech.pegasys.pantheon.ethereum.jsonrpc.internal.response.JsonRpcSuccessResponse; |
||||
import tech.pegasys.pantheon.metrics.MetricsSystem; |
||||
import tech.pegasys.pantheon.metrics.Observation; |
||||
|
||||
import java.util.Collections; |
||||
import java.util.stream.Stream; |
||||
|
||||
import com.google.common.collect.ImmutableMap; |
||||
import org.junit.Test; |
||||
|
||||
public class DebugMetricsTest { |
||||
|
||||
private static final JsonRpcRequest REQUEST = |
||||
new JsonRpcRequest("2.0", "debug_metrics", new Object[0]); |
||||
private final MetricsSystem metricsSystem = mock(MetricsSystem.class); |
||||
|
||||
private final DebugMetrics method = new DebugMetrics(metricsSystem); |
||||
|
||||
@Test |
||||
public void shouldHaveCorrectName() { |
||||
assertThat(method.getName()).isEqualTo("debug_metrics"); |
||||
} |
||||
|
||||
@Test |
||||
public void shouldReportUnlabelledObservationsByCategory() { |
||||
when(metricsSystem.getMetrics()) |
||||
.thenReturn( |
||||
Stream.of( |
||||
new Observation(PEERS, "peer1", "peer1Value", Collections.emptyList()), |
||||
new Observation(PEERS, "peer2", "peer2Value", Collections.emptyList()), |
||||
new Observation(RPC, "rpc1", "rpc1Value", Collections.emptyList()))); |
||||
|
||||
assertResponse( |
||||
ImmutableMap.of( |
||||
PEERS.getName(), |
||||
ImmutableMap.<String, Object>of("peer1", "peer1Value", "peer2", "peer2Value"), |
||||
RPC.getName(), |
||||
ImmutableMap.<String, Object>of("rpc1", "rpc1Value"))); |
||||
} |
||||
|
||||
@Test |
||||
public void shouldNestObservationsByLabel() { |
||||
when(metricsSystem.getMetrics()) |
||||
.thenReturn( |
||||
Stream.of( |
||||
new Observation(PEERS, "peer1", "value1", asList("label1A", "label2A")), |
||||
new Observation(PEERS, "peer1", "value2", asList("label1A", "label2B")), |
||||
new Observation(PEERS, "peer1", "value3", asList("label1B", "label2B")))); |
||||
|
||||
assertResponse( |
||||
ImmutableMap.of( |
||||
PEERS.getName(), |
||||
ImmutableMap.<String, Object>of( |
||||
"peer1", |
||||
ImmutableMap.of( |
||||
"label1A", |
||||
ImmutableMap.of("label2A", "value1", "label2B", "value2"), |
||||
"label1B", |
||||
ImmutableMap.of("label2B", "value3"))))); |
||||
} |
||||
|
||||
private void assertResponse(final ImmutableMap<String, Object> expectedResponse) { |
||||
final JsonRpcSuccessResponse response = (JsonRpcSuccessResponse) method.response(REQUEST); |
||||
assertThat(response.getResult()).isEqualTo(expectedResponse); |
||||
} |
||||
} |
||||
@ -0,0 +1,40 @@ |
||||
/* |
||||
* Copyright 2018 ConsenSys AG. |
||||
* |
||||
* Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with |
||||
* the License. You may obtain a copy of the License at |
||||
* |
||||
* http://www.apache.org/licenses/LICENSE-2.0 |
||||
* |
||||
* Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on |
||||
* an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the |
||||
* specific language governing permissions and limitations under the License. |
||||
*/ |
||||
|
||||
apply plugin: 'java-library' |
||||
|
||||
jar { |
||||
baseName 'pantheon-metrics' |
||||
manifest { |
||||
attributes( |
||||
'Specification-Title': baseName, |
||||
'Specification-Version': project.version, |
||||
'Implementation-Title': baseName, |
||||
'Implementation-Version': calculateVersion() |
||||
) |
||||
} |
||||
} |
||||
|
||||
dependencies { |
||||
implementation 'com.google.guava:guava' |
||||
implementation 'org.apache.logging.log4j:log4j-api' |
||||
implementation 'io.prometheus:simpleclient' |
||||
implementation 'io.prometheus:simpleclient_hotspot' |
||||
|
||||
runtime 'org.apache.logging.log4j:log4j-core' |
||||
|
||||
// test dependencies. |
||||
testImplementation 'junit:junit' |
||||
testImplementation "org.mockito:mockito-core" |
||||
testImplementation 'org.assertj:assertj-core' |
||||
} |
||||
@ -0,0 +1,19 @@ |
||||
/* |
||||
* Copyright 2018 ConsenSys AG. |
||||
* |
||||
* Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with |
||||
* the License. You may obtain a copy of the License at |
||||
* |
||||
* http://www.apache.org/licenses/LICENSE-2.0
|
||||
* |
||||
* Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on |
||||
* an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the |
||||
* specific language governing permissions and limitations under the License. |
||||
*/ |
||||
package tech.pegasys.pantheon.metrics; |
||||
|
||||
public interface Counter { |
||||
void inc(); |
||||
|
||||
void inc(long amount); |
||||
} |
||||
@ -0,0 +1,18 @@ |
||||
/* |
||||
* Copyright 2018 ConsenSys AG. |
||||
* |
||||
* Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with |
||||
* the License. You may obtain a copy of the License at |
||||
* |
||||
* http://www.apache.org/licenses/LICENSE-2.0
|
||||
* |
||||
* Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on |
||||
* an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the |
||||
* specific language governing permissions and limitations under the License. |
||||
*/ |
||||
package tech.pegasys.pantheon.metrics; |
||||
|
||||
public interface LabelledMetric<T> { |
||||
|
||||
T labels(String... labels); |
||||
} |
||||
@ -0,0 +1,40 @@ |
||||
/* |
||||
* Copyright 2018 ConsenSys AG. |
||||
* |
||||
* Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with |
||||
* the License. You may obtain a copy of the License at |
||||
* |
||||
* http://www.apache.org/licenses/LICENSE-2.0
|
||||
* |
||||
* Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on |
||||
* an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the |
||||
* specific language governing permissions and limitations under the License. |
||||
*/ |
||||
package tech.pegasys.pantheon.metrics; |
||||
|
||||
public enum MetricCategory { |
||||
PEERS("peers"), |
||||
RPC("rpc"), |
||||
JVM("jvm", false), |
||||
PROCESS("process", false); |
||||
|
||||
private final String name; |
||||
private final boolean pantheonSpecific; |
||||
|
||||
MetricCategory(final String name) { |
||||
this(name, true); |
||||
} |
||||
|
||||
MetricCategory(final String name, final boolean pantheonSpecific) { |
||||
this.name = name; |
||||
this.pantheonSpecific = pantheonSpecific; |
||||
} |
||||
|
||||
public String getName() { |
||||
return name; |
||||
} |
||||
|
||||
public boolean isPantheonSpecific() { |
||||
return pantheonSpecific; |
||||
} |
||||
} |
||||
@ -0,0 +1,44 @@ |
||||
/* |
||||
* Copyright 2018 ConsenSys AG. |
||||
* |
||||
* Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with |
||||
* the License. You may obtain a copy of the License at |
||||
* |
||||
* http://www.apache.org/licenses/LICENSE-2.0
|
||||
* |
||||
* Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on |
||||
* an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the |
||||
* specific language governing permissions and limitations under the License. |
||||
*/ |
||||
package tech.pegasys.pantheon.metrics; |
||||
|
||||
import java.util.function.Supplier; |
||||
import java.util.stream.Stream; |
||||
|
||||
public interface MetricsSystem { |
||||
|
||||
default Counter createCounter( |
||||
final MetricCategory category, final String name, final String help) { |
||||
return createLabelledCounter(category, name, help, new String[0]).labels(); |
||||
} |
||||
|
||||
LabelledMetric<Counter> createLabelledCounter( |
||||
MetricCategory category, String name, String help, String... labelNames); |
||||
|
||||
default OperationTimer createTimer( |
||||
final MetricCategory category, final String name, final String help) { |
||||
return createLabelledTimer(category, name, help, new String[0]).labels(); |
||||
} |
||||
|
||||
LabelledMetric<OperationTimer> createLabelledTimer( |
||||
MetricCategory category, String name, String help, String... labelNames); |
||||
|
||||
void createGauge( |
||||
MetricCategory category, String name, String help, Supplier<Double> valueSupplier); |
||||
|
||||
Stream<Observation> getMetrics(MetricCategory category); |
||||
|
||||
default Stream<Observation> getMetrics() { |
||||
return Stream.of(MetricCategory.values()).flatMap(this::getMetrics); |
||||
} |
||||
} |
||||
@ -0,0 +1,82 @@ |
||||
/* |
||||
* Copyright 2018 ConsenSys AG. |
||||
* |
||||
* Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with |
||||
* the License. You may obtain a copy of the License at |
||||
* |
||||
* http://www.apache.org/licenses/LICENSE-2.0
|
||||
* |
||||
* Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on |
||||
* an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the |
||||
* specific language governing permissions and limitations under the License. |
||||
*/ |
||||
package tech.pegasys.pantheon.metrics; |
||||
|
||||
import java.util.List; |
||||
import java.util.Objects; |
||||
|
||||
import com.google.common.base.MoreObjects; |
||||
|
||||
public class Observation { |
||||
private final MetricCategory category; |
||||
private final String metricName; |
||||
private final List<String> labels; |
||||
private final Object value; |
||||
|
||||
public Observation( |
||||
final MetricCategory category, |
||||
final String metricName, |
||||
final Object value, |
||||
final List<String> labels) { |
||||
this.category = category; |
||||
this.metricName = metricName; |
||||
this.value = value; |
||||
this.labels = labels; |
||||
} |
||||
|
||||
public MetricCategory getCategory() { |
||||
return category; |
||||
} |
||||
|
||||
public String getMetricName() { |
||||
return metricName; |
||||
} |
||||
|
||||
public List<String> getLabels() { |
||||
return labels; |
||||
} |
||||
|
||||
public Object getValue() { |
||||
return value; |
||||
} |
||||
|
||||
@Override |
||||
public boolean equals(final Object o) { |
||||
if (this == o) { |
||||
return true; |
||||
} |
||||
if (o == null || getClass() != o.getClass()) { |
||||
return false; |
||||
} |
||||
final Observation that = (Observation) o; |
||||
return category == that.category |
||||
&& Objects.equals(metricName, that.metricName) |
||||
&& Objects.equals(labels, that.labels) |
||||
&& Objects.equals(value, that.value); |
||||
} |
||||
|
||||
@Override |
||||
public int hashCode() { |
||||
return Objects.hash(category, metricName, labels, value); |
||||
} |
||||
|
||||
@Override |
||||
public String toString() { |
||||
return MoreObjects.toStringHelper(this) |
||||
.add("category", category) |
||||
.add("metricName", metricName) |
||||
.add("labels", labels) |
||||
.add("value", value) |
||||
.toString(); |
||||
} |
||||
} |
||||
@ -0,0 +1,29 @@ |
||||
/* |
||||
* Copyright 2018 ConsenSys AG. |
||||
* |
||||
* Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with |
||||
* the License. You may obtain a copy of the License at |
||||
* |
||||
* http://www.apache.org/licenses/LICENSE-2.0
|
||||
* |
||||
* Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on |
||||
* an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the |
||||
* specific language governing permissions and limitations under the License. |
||||
*/ |
||||
package tech.pegasys.pantheon.metrics; |
||||
|
||||
import java.io.Closeable; |
||||
|
||||
public interface OperationTimer { |
||||
|
||||
TimingContext startTimer(); |
||||
|
||||
interface TimingContext extends Closeable { |
||||
void stopTimer(); |
||||
|
||||
@Override |
||||
default void close() { |
||||
stopTimer(); |
||||
} |
||||
} |
||||
} |
||||
@ -0,0 +1,24 @@ |
||||
/* |
||||
* Copyright 2018 ConsenSys AG. |
||||
* |
||||
* Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with |
||||
* the License. You may obtain a copy of the License at |
||||
* |
||||
* http://www.apache.org/licenses/LICENSE-2.0
|
||||
* |
||||
* Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on |
||||
* an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the |
||||
* specific language governing permissions and limitations under the License. |
||||
*/ |
||||
package tech.pegasys.pantheon.metrics.noop; |
||||
|
||||
import tech.pegasys.pantheon.metrics.Counter; |
||||
|
||||
class NoOpCounter implements Counter { |
||||
|
||||
@Override |
||||
public void inc() {} |
||||
|
||||
@Override |
||||
public void inc(final long amount) {} |
||||
} |
||||
@ -0,0 +1,66 @@ |
||||
/* |
||||
* Copyright 2018 ConsenSys AG. |
||||
* |
||||
* Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with |
||||
* the License. You may obtain a copy of the License at |
||||
* |
||||
* http://www.apache.org/licenses/LICENSE-2.0
|
||||
* |
||||
* Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on |
||||
* an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the |
||||
* specific language governing permissions and limitations under the License. |
||||
*/ |
||||
package tech.pegasys.pantheon.metrics.noop; |
||||
|
||||
import tech.pegasys.pantheon.metrics.Counter; |
||||
import tech.pegasys.pantheon.metrics.LabelledMetric; |
||||
import tech.pegasys.pantheon.metrics.MetricCategory; |
||||
import tech.pegasys.pantheon.metrics.MetricsSystem; |
||||
import tech.pegasys.pantheon.metrics.Observation; |
||||
import tech.pegasys.pantheon.metrics.OperationTimer; |
||||
import tech.pegasys.pantheon.metrics.OperationTimer.TimingContext; |
||||
|
||||
import java.util.function.Supplier; |
||||
import java.util.stream.Stream; |
||||
|
||||
public class NoOpMetricsSystem implements MetricsSystem { |
||||
|
||||
private static final Counter NO_OP_COUNTER = new NoOpCounter(); |
||||
private static final TimingContext NO_OP_TIMING_CONTEXT = () -> {}; |
||||
private static final OperationTimer NO_OP_TIMER = () -> NO_OP_TIMING_CONTEXT; |
||||
|
||||
@Override |
||||
public LabelledMetric<Counter> createLabelledCounter( |
||||
final MetricCategory category, |
||||
final String name, |
||||
final String help, |
||||
final String... labelNames) { |
||||
return labels -> NO_OP_COUNTER; |
||||
} |
||||
|
||||
@Override |
||||
public LabelledMetric<OperationTimer> createLabelledTimer( |
||||
final MetricCategory category, |
||||
final String name, |
||||
final String help, |
||||
final String... labelNames) { |
||||
return labels -> NO_OP_TIMER; |
||||
} |
||||
|
||||
@Override |
||||
public void createGauge( |
||||
final MetricCategory category, |
||||
final String name, |
||||
final String help, |
||||
final Supplier<Double> valueSupplier) {} |
||||
|
||||
@Override |
||||
public Stream<Observation> getMetrics(final MetricCategory category) { |
||||
return Stream.empty(); |
||||
} |
||||
|
||||
@Override |
||||
public Stream<Observation> getMetrics() { |
||||
return Stream.empty(); |
||||
} |
||||
} |
||||
@ -0,0 +1,43 @@ |
||||
/* |
||||
* Copyright 2018 ConsenSys AG. |
||||
* |
||||
* Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with |
||||
* the License. You may obtain a copy of the License at |
||||
* |
||||
* http://www.apache.org/licenses/LICENSE-2.0
|
||||
* |
||||
* Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on |
||||
* an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the |
||||
* specific language governing permissions and limitations under the License. |
||||
*/ |
||||
package tech.pegasys.pantheon.metrics.prometheus; |
||||
|
||||
import static java.util.Collections.emptyList; |
||||
import static java.util.Collections.singletonList; |
||||
|
||||
import java.util.List; |
||||
import java.util.function.Supplier; |
||||
|
||||
import io.prometheus.client.Collector; |
||||
import io.prometheus.client.Collector.MetricFamilySamples.Sample; |
||||
|
||||
class CurrentValueCollector extends Collector { |
||||
|
||||
private final String metricName; |
||||
private final String help; |
||||
private final Supplier<Double> valueSupplier; |
||||
|
||||
public CurrentValueCollector( |
||||
final String metricName, final String help, final Supplier<Double> valueSupplier) { |
||||
this.metricName = metricName; |
||||
this.help = help; |
||||
this.valueSupplier = valueSupplier; |
||||
} |
||||
|
||||
@Override |
||||
public List<MetricFamilySamples> collect() { |
||||
final Sample sample = new Sample(metricName, emptyList(), emptyList(), valueSupplier.get()); |
||||
return singletonList( |
||||
new MetricFamilySamples(metricName, Type.GAUGE, help, singletonList(sample))); |
||||
} |
||||
} |
||||
@ -0,0 +1,48 @@ |
||||
/* |
||||
* Copyright 2018 ConsenSys AG. |
||||
* |
||||
* Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with |
||||
* the License. You may obtain a copy of the License at |
||||
* |
||||
* http://www.apache.org/licenses/LICENSE-2.0
|
||||
* |
||||
* Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on |
||||
* an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the |
||||
* specific language governing permissions and limitations under the License. |
||||
*/ |
||||
package tech.pegasys.pantheon.metrics.prometheus; |
||||
|
||||
import tech.pegasys.pantheon.metrics.Counter; |
||||
import tech.pegasys.pantheon.metrics.LabelledMetric; |
||||
|
||||
class PrometheusCounter implements LabelledMetric<Counter> { |
||||
|
||||
private final io.prometheus.client.Counter counter; |
||||
|
||||
public PrometheusCounter(final io.prometheus.client.Counter counter) { |
||||
this.counter = counter; |
||||
} |
||||
|
||||
@Override |
||||
public Counter labels(final String... labels) { |
||||
return new UnlabelledCounter(counter.labels(labels)); |
||||
} |
||||
|
||||
private static class UnlabelledCounter implements Counter { |
||||
private final io.prometheus.client.Counter.Child counter; |
||||
|
||||
private UnlabelledCounter(final io.prometheus.client.Counter.Child counter) { |
||||
this.counter = counter; |
||||
} |
||||
|
||||
@Override |
||||
public void inc() { |
||||
counter.inc(); |
||||
} |
||||
|
||||
@Override |
||||
public void inc(final long amount) { |
||||
counter.inc(amount); |
||||
} |
||||
} |
||||
} |
||||
@ -0,0 +1,166 @@ |
||||
/* |
||||
* Copyright 2018 ConsenSys AG. |
||||
* |
||||
* Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with |
||||
* the License. You may obtain a copy of the License at |
||||
* |
||||
* http://www.apache.org/licenses/LICENSE-2.0
|
||||
* |
||||
* Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on |
||||
* an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the |
||||
* specific language governing permissions and limitations under the License. |
||||
*/ |
||||
package tech.pegasys.pantheon.metrics.prometheus; |
||||
|
||||
import static java.util.Arrays.asList; |
||||
import static java.util.Collections.singleton; |
||||
|
||||
import tech.pegasys.pantheon.metrics.LabelledMetric; |
||||
import tech.pegasys.pantheon.metrics.MetricCategory; |
||||
import tech.pegasys.pantheon.metrics.MetricsSystem; |
||||
import tech.pegasys.pantheon.metrics.Observation; |
||||
import tech.pegasys.pantheon.metrics.OperationTimer; |
||||
|
||||
import java.util.ArrayList; |
||||
import java.util.Collection; |
||||
import java.util.Collections; |
||||
import java.util.List; |
||||
import java.util.Map; |
||||
import java.util.concurrent.ConcurrentHashMap; |
||||
import java.util.function.Supplier; |
||||
import java.util.stream.Stream; |
||||
|
||||
import io.prometheus.client.Collector; |
||||
import io.prometheus.client.Collector.MetricFamilySamples; |
||||
import io.prometheus.client.Collector.MetricFamilySamples.Sample; |
||||
import io.prometheus.client.Collector.Type; |
||||
import io.prometheus.client.Counter; |
||||
import io.prometheus.client.Histogram; |
||||
import io.prometheus.client.hotspot.BufferPoolsExports; |
||||
import io.prometheus.client.hotspot.ClassLoadingExports; |
||||
import io.prometheus.client.hotspot.GarbageCollectorExports; |
||||
import io.prometheus.client.hotspot.MemoryPoolsExports; |
||||
import io.prometheus.client.hotspot.StandardExports; |
||||
import io.prometheus.client.hotspot.ThreadExports; |
||||
|
||||
public class PrometheusMetricsSystem implements MetricsSystem { |
||||
|
||||
private static final String PANTHEON_PREFIX = "pantheon_"; |
||||
private final Map<MetricCategory, Collection<Collector>> collectors = new ConcurrentHashMap<>(); |
||||
|
||||
PrometheusMetricsSystem() {} |
||||
|
||||
public static MetricsSystem init() { |
||||
final PrometheusMetricsSystem metricsSystem = new PrometheusMetricsSystem(); |
||||
metricsSystem.collectors.put(MetricCategory.PROCESS, singleton(new StandardExports())); |
||||
metricsSystem.collectors.put( |
||||
MetricCategory.JVM, |
||||
asList( |
||||
new MemoryPoolsExports(), |
||||
new BufferPoolsExports(), |
||||
new GarbageCollectorExports(), |
||||
new ThreadExports(), |
||||
new ClassLoadingExports())); |
||||
return metricsSystem; |
||||
} |
||||
|
||||
@Override |
||||
public LabelledMetric<tech.pegasys.pantheon.metrics.Counter> createLabelledCounter( |
||||
final MetricCategory category, |
||||
final String name, |
||||
final String help, |
||||
final String... labelNames) { |
||||
final Counter counter = |
||||
Counter.build(convertToPrometheusName(category, name), help) |
||||
.labelNames(labelNames) |
||||
.create(); |
||||
addCollector(category, counter); |
||||
return new PrometheusCounter(counter); |
||||
} |
||||
|
||||
@Override |
||||
public LabelledMetric<OperationTimer> createLabelledTimer( |
||||
final MetricCategory category, |
||||
final String name, |
||||
final String help, |
||||
final String... labelNames) { |
||||
final Histogram histogram = Histogram.build(name, help).labelNames(labelNames).create(); |
||||
addCollector(category, histogram); |
||||
return new PrometheusTimer(histogram); |
||||
} |
||||
|
||||
@Override |
||||
public void createGauge( |
||||
final MetricCategory category, |
||||
final String name, |
||||
final String help, |
||||
final Supplier<Double> valueSupplier) { |
||||
final String metricName = convertToPrometheusName(category, name); |
||||
addCollector(category, new CurrentValueCollector(metricName, help, valueSupplier)); |
||||
} |
||||
|
||||
private void addCollector(final MetricCategory category, final Collector counter) { |
||||
collectors |
||||
.computeIfAbsent(category, key -> Collections.newSetFromMap(new ConcurrentHashMap<>())) |
||||
.add(counter); |
||||
} |
||||
|
||||
@Override |
||||
public Stream<Observation> getMetrics(final MetricCategory category) { |
||||
return collectors |
||||
.getOrDefault(category, Collections.emptySet()) |
||||
.stream() |
||||
.flatMap(collector -> collector.collect().stream()) |
||||
.flatMap(familySamples -> convertSamplesToObservations(category, familySamples)); |
||||
} |
||||
|
||||
private Stream<Observation> convertSamplesToObservations( |
||||
final MetricCategory category, final MetricFamilySamples familySamples) { |
||||
return familySamples |
||||
.samples |
||||
.stream() |
||||
.map(sample -> createObservationFromSample(category, sample, familySamples)); |
||||
} |
||||
|
||||
private Observation createObservationFromSample( |
||||
final MetricCategory category, final Sample sample, final MetricFamilySamples familySamples) { |
||||
if (familySamples.type == Type.HISTOGRAM) { |
||||
return convertHistogramSampleNamesToLabels(category, sample, familySamples); |
||||
} |
||||
return new Observation( |
||||
category, |
||||
convertFromPrometheusName(category, sample.name), |
||||
sample.value, |
||||
sample.labelValues); |
||||
} |
||||
|
||||
private Observation convertHistogramSampleNamesToLabels( |
||||
final MetricCategory category, final Sample sample, final MetricFamilySamples familySamples) { |
||||
final List<String> labelValues = new ArrayList<>(sample.labelValues); |
||||
if (sample.name.endsWith("_bucket")) { |
||||
labelValues.add(labelValues.size() - 1, "bucket"); |
||||
} else { |
||||
labelValues.add(sample.name.substring(sample.name.lastIndexOf("_") + 1)); |
||||
} |
||||
return new Observation( |
||||
category, |
||||
convertFromPrometheusName(category, familySamples.name), |
||||
sample.value, |
||||
labelValues); |
||||
} |
||||
|
||||
private String convertToPrometheusName(final MetricCategory category, final String name) { |
||||
return prometheusPrefix(category) + name; |
||||
} |
||||
|
||||
private String convertFromPrometheusName(final MetricCategory category, final String metricName) { |
||||
final String prefix = prometheusPrefix(category); |
||||
return metricName.startsWith(prefix) ? metricName.substring(prefix.length()) : metricName; |
||||
} |
||||
|
||||
private String prometheusPrefix(final MetricCategory category) { |
||||
return category.isPantheonSpecific() |
||||
? PANTHEON_PREFIX + category.getName() + "_" |
||||
: category.getName() + "_"; |
||||
} |
||||
} |
||||
@ -0,0 +1,34 @@ |
||||
/* |
||||
* Copyright 2018 ConsenSys AG. |
||||
* |
||||
* Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with |
||||
* the License. You may obtain a copy of the License at |
||||
* |
||||
* http://www.apache.org/licenses/LICENSE-2.0
|
||||
* |
||||
* Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on |
||||
* an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the |
||||
* specific language governing permissions and limitations under the License. |
||||
*/ |
||||
package tech.pegasys.pantheon.metrics.prometheus; |
||||
|
||||
import tech.pegasys.pantheon.metrics.LabelledMetric; |
||||
import tech.pegasys.pantheon.metrics.OperationTimer; |
||||
|
||||
import io.prometheus.client.Histogram; |
||||
import io.prometheus.client.Histogram.Child; |
||||
|
||||
class PrometheusTimer implements LabelledMetric<OperationTimer> { |
||||
|
||||
private final Histogram histogram; |
||||
|
||||
public PrometheusTimer(final Histogram histogram) { |
||||
this.histogram = histogram; |
||||
} |
||||
|
||||
@Override |
||||
public OperationTimer labels(final String... labels) { |
||||
final Child metric = histogram.labels(labels); |
||||
return () -> metric.startTimer()::observeDuration; |
||||
} |
||||
} |
||||
@ -0,0 +1,149 @@ |
||||
/* |
||||
* Copyright 2018 ConsenSys AG. |
||||
* |
||||
* Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with |
||||
* the License. You may obtain a copy of the License at |
||||
* |
||||
* http://www.apache.org/licenses/LICENSE-2.0
|
||||
* |
||||
* Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on |
||||
* an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the |
||||
* specific language governing permissions and limitations under the License. |
||||
*/ |
||||
package tech.pegasys.pantheon.metrics.prometheus; |
||||
|
||||
import static java.util.Arrays.asList; |
||||
import static java.util.Collections.emptyList; |
||||
import static java.util.Collections.singletonList; |
||||
import static org.assertj.core.api.Assertions.assertThat; |
||||
import static tech.pegasys.pantheon.metrics.MetricCategory.JVM; |
||||
import static tech.pegasys.pantheon.metrics.MetricCategory.PEERS; |
||||
import static tech.pegasys.pantheon.metrics.MetricCategory.RPC; |
||||
|
||||
import tech.pegasys.pantheon.metrics.Counter; |
||||
import tech.pegasys.pantheon.metrics.LabelledMetric; |
||||
import tech.pegasys.pantheon.metrics.MetricsSystem; |
||||
import tech.pegasys.pantheon.metrics.Observation; |
||||
import tech.pegasys.pantheon.metrics.OperationTimer; |
||||
import tech.pegasys.pantheon.metrics.OperationTimer.TimingContext; |
||||
|
||||
import java.util.Comparator; |
||||
|
||||
import org.junit.Test; |
||||
|
||||
public class PrometheusMetricsSystemTest { |
||||
|
||||
private static final Comparator<Observation> IGNORE_VALUES = |
||||
Comparator.comparing(Observation::getCategory) |
||||
.thenComparing(Observation::getMetricName) |
||||
.thenComparing((o1, o2) -> o1.getLabels().equals(o2.getLabels()) ? 0 : 1); |
||||
|
||||
private final MetricsSystem metricsSystem = new PrometheusMetricsSystem(); |
||||
|
||||
@Test |
||||
public void shouldCreateObservationFromCounter() { |
||||
final Counter counter = metricsSystem.createCounter(PEERS, "connected", "Some help string"); |
||||
|
||||
counter.inc(); |
||||
assertThat(metricsSystem.getMetrics()) |
||||
.containsExactly(new Observation(PEERS, "connected", 1d, emptyList())); |
||||
|
||||
counter.inc(); |
||||
assertThat(metricsSystem.getMetrics()) |
||||
.containsExactly(new Observation(PEERS, "connected", 2d, emptyList())); |
||||
} |
||||
|
||||
@Test |
||||
public void shouldCreateSeparateObservationsForEachCounterLabelValue() { |
||||
final LabelledMetric<Counter> counter = |
||||
metricsSystem.createLabelledCounter(PEERS, "connected", "Some help string", "labelName"); |
||||
|
||||
counter.labels("value1").inc(); |
||||
counter.labels("value2").inc(); |
||||
counter.labels("value1").inc(); |
||||
|
||||
assertThat(metricsSystem.getMetrics()) |
||||
.containsExactlyInAnyOrder( |
||||
new Observation(PEERS, "connected", 2d, singletonList("value1")), |
||||
new Observation(PEERS, "connected", 1d, singletonList("value2"))); |
||||
} |
||||
|
||||
@Test |
||||
public void shouldIncrementCounterBySpecifiedAmount() { |
||||
final Counter counter = metricsSystem.createCounter(PEERS, "connected", "Some help string"); |
||||
|
||||
counter.inc(5); |
||||
assertThat(metricsSystem.getMetrics()) |
||||
.containsExactly(new Observation(PEERS, "connected", 5d, emptyList())); |
||||
|
||||
counter.inc(6); |
||||
assertThat(metricsSystem.getMetrics()) |
||||
.containsExactly(new Observation(PEERS, "connected", 11d, emptyList())); |
||||
} |
||||
|
||||
@Test |
||||
public void shouldCreateObservationsFromTimer() { |
||||
final OperationTimer timer = metricsSystem.createTimer(RPC, "request", "Some help"); |
||||
|
||||
final TimingContext context = timer.startTimer(); |
||||
context.stopTimer(); |
||||
|
||||
assertThat(metricsSystem.getMetrics()) |
||||
.usingElementComparator(IGNORE_VALUES) |
||||
.containsExactlyInAnyOrder( |
||||
new Observation(RPC, "request", null, asList("bucket", "0.005")), |
||||
new Observation(RPC, "request", null, asList("bucket", "0.01")), |
||||
new Observation(RPC, "request", null, asList("bucket", "0.025")), |
||||
new Observation(RPC, "request", null, asList("bucket", "0.05")), |
||||
new Observation(RPC, "request", null, asList("bucket", "0.075")), |
||||
new Observation(RPC, "request", null, asList("bucket", "0.1")), |
||||
new Observation(RPC, "request", null, asList("bucket", "0.25")), |
||||
new Observation(RPC, "request", null, asList("bucket", "0.5")), |
||||
new Observation(RPC, "request", null, asList("bucket", "0.75")), |
||||
new Observation(RPC, "request", null, asList("bucket", "1.0")), |
||||
new Observation(RPC, "request", null, asList("bucket", "2.5")), |
||||
new Observation(RPC, "request", null, asList("bucket", "5.0")), |
||||
new Observation(RPC, "request", null, asList("bucket", "7.5")), |
||||
new Observation(RPC, "request", null, asList("bucket", "10.0")), |
||||
new Observation(RPC, "request", null, asList("bucket", "+Inf")), |
||||
new Observation(RPC, "request", null, singletonList("sum")), |
||||
new Observation(RPC, "request", 1d, singletonList("count"))); |
||||
} |
||||
|
||||
@Test |
||||
public void shouldCreateObservationsFromTimerWithLabels() { |
||||
final LabelledMetric<OperationTimer> timer = |
||||
metricsSystem.createLabelledTimer(RPC, "request", "Some help", "methodName"); |
||||
|
||||
try (final TimingContext context = timer.labels("method").startTimer()) {} |
||||
|
||||
assertThat(metricsSystem.getMetrics()) |
||||
.usingElementComparator(IGNORE_VALUES) // We don't know how long it will actually take.
|
||||
.containsExactlyInAnyOrder( |
||||
new Observation(RPC, "request", null, asList("method", "bucket", "0.005")), |
||||
new Observation(RPC, "request", null, asList("method", "bucket", "0.01")), |
||||
new Observation(RPC, "request", null, asList("method", "bucket", "0.025")), |
||||
new Observation(RPC, "request", null, asList("method", "bucket", "0.05")), |
||||
new Observation(RPC, "request", null, asList("method", "bucket", "0.075")), |
||||
new Observation(RPC, "request", null, asList("method", "bucket", "0.1")), |
||||
new Observation(RPC, "request", null, asList("method", "bucket", "0.25")), |
||||
new Observation(RPC, "request", null, asList("method", "bucket", "0.5")), |
||||
new Observation(RPC, "request", null, asList("method", "bucket", "0.75")), |
||||
new Observation(RPC, "request", null, asList("method", "bucket", "1.0")), |
||||
new Observation(RPC, "request", null, asList("method", "bucket", "2.5")), |
||||
new Observation(RPC, "request", null, asList("method", "bucket", "5.0")), |
||||
new Observation(RPC, "request", null, asList("method", "bucket", "7.5")), |
||||
new Observation(RPC, "request", null, asList("method", "bucket", "10.0")), |
||||
new Observation(RPC, "request", null, asList("method", "bucket", "+Inf")), |
||||
new Observation(RPC, "request", null, asList("method", "sum")), |
||||
new Observation(RPC, "request", null, asList("method", "count"))); |
||||
} |
||||
|
||||
@Test |
||||
public void shouldCreateObservationFromGauge() { |
||||
metricsSystem.createGauge(JVM, "myValue", "Help", () -> 7d); |
||||
|
||||
assertThat(metricsSystem.getMetrics()) |
||||
.containsExactlyInAnyOrder(new Observation(JVM, "myValue", 7d, emptyList())); |
||||
} |
||||
} |
||||
Loading…
Reference in new issue