Introduces example of how to connect to the MetricsRegistry
Shows how to connect a Dropwizard MetricsReporter to Gerrit's
internal MetricsRegistry.
In this example various metric data is shown on the console.
Change-Id: I4a694cf51bcb7c08ca0789b44804274c781cb659
diff --git a/BUCK b/BUCK
index f47a479..7aa2580 100644
--- a/BUCK
+++ b/BUCK
@@ -14,7 +14,10 @@
'Gerrit-SshModule: com.googlesource.gerrit.plugins.cookbook.SshModule',
'Implementation-Title: Cookbook plugin',
'Implementation-URL: https://gerrit-review.googlesource.com/#/admin/projects/plugins/cookbook-plugin',
- ]
+ ],
+ deps = [
+ '//lib/dropwizard:dropwizard-core'
+ ],
)
java_test(
diff --git a/src/main/java/com/googlesource/gerrit/plugins/cookbook/ConsoleMetricReporter.java b/src/main/java/com/googlesource/gerrit/plugins/cookbook/ConsoleMetricReporter.java
new file mode 100644
index 0000000..e10907e
--- /dev/null
+++ b/src/main/java/com/googlesource/gerrit/plugins/cookbook/ConsoleMetricReporter.java
@@ -0,0 +1,55 @@
+// Copyright (C) 2015 The Android Open Source Project
+//
+// 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 com.googlesource.gerrit.plugins.cookbook;
+
+import com.google.gerrit.extensions.annotations.Listen;
+import com.google.gerrit.extensions.events.LifecycleListener;
+import com.google.inject.Inject;
+import com.google.inject.Singleton;
+
+import com.codahale.metrics.ConsoleReporter;
+import com.codahale.metrics.MetricRegistry;
+
+import java.util.concurrent.TimeUnit;
+
+/**
+ * Demonstration of how to add a new Dropwizard Metrics Reporter using
+ * Gerrit's plug-in API.
+ *
+ * @see <a href="https://dropwizard.github.io/metrics/3.1.0/getting-started/#reporting-via-jmx">here</a>
+ * @see <a href="https://dropwizard.github.io/metrics/3.1.0/getting-started/#reporting-via-http">here</a>
+ * @see <a href="https://dropwizard.github.io/metrics/3.1.0/getting-started/#other-reporting">here</a>
+ */
+@Listen
+@Singleton
+public class ConsoleMetricReporter implements LifecycleListener {
+ private ConsoleReporter consoleReporter;
+
+ @Inject
+ public ConsoleMetricReporter(MetricRegistry registry) {
+ this.consoleReporter =
+ ConsoleReporter.forRegistry(registry).convertRatesTo(TimeUnit.SECONDS)
+ .convertDurationsTo(TimeUnit.MILLISECONDS).build();
+ }
+
+ @Override
+ public void start() {
+ consoleReporter.start(1, TimeUnit.MINUTES);
+ }
+
+ @Override
+ public void stop() {
+ consoleReporter.stop();
+ }
+}
diff --git a/src/main/java/com/googlesource/gerrit/plugins/cookbook/Module.java b/src/main/java/com/googlesource/gerrit/plugins/cookbook/Module.java
index b182159..54dcfe9 100644
--- a/src/main/java/com/googlesource/gerrit/plugins/cookbook/Module.java
+++ b/src/main/java/com/googlesource/gerrit/plugins/cookbook/Module.java
@@ -20,6 +20,7 @@
import com.google.common.collect.ImmutableList;
import com.google.gerrit.extensions.annotations.Exports;
import com.google.gerrit.extensions.client.InheritableBoolean;
+import com.google.gerrit.extensions.events.LifecycleListener;
import com.google.gerrit.extensions.events.NewProjectCreatedListener;
import com.google.gerrit.extensions.events.UsageDataPublishedListener;
import com.google.gerrit.extensions.registration.DynamicSet;
@@ -52,7 +53,7 @@
DynamicSet.bind(binder(), ServerPluginProvider.class).to(
HelloSshPluginProvider.class);
DynamicSet.bind(binder(), UsageDataPublishedListener.class).to(UsageDataLogger.class);
-
+ DynamicSet.bind(binder(), LifecycleListener.class).to(ConsoleMetricReporter.class);
install(new RestApiModule() {
@Override
protected void configure() {
