You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@bookkeeper.apache.org by si...@apache.org on 2018/03/14 18:16:20 UTC
[bookkeeper] branch master updated: ISSUE #762: copy codahale files
to org.apache.bookkeeper.stats.codahale
This is an automated email from the ASF dual-hosted git repository.
sijie pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/bookkeeper.git
The following commit(s) were added to refs/heads/master by this push:
new fc8097f ISSUE #762: copy codahale files to org.apache.bookkeeper.stats.codahale
fc8097f is described below
commit fc8097f33242d6b1a6cbcce10466fb5bfc663b5a
Author: Jia Zhai <zh...@apache.org>
AuthorDate: Wed Mar 14 11:15:54 2018 -0700
ISSUE #762: copy codahale files to org.apache.bookkeeper.stats.codahale
Descriptions of the changes in this PR:
Codahale stats providers are sharing same package name with the stats library org.apache.bookkeeper.stats. We should consider moving them to their own package name.
`org.apache.bookkeeper.stats => org.apache.bookkeeper.stats.codahale`
For BC concerns, we need to do this in two phases:
- in 4.7, we copy the files but still have the old files for BC. but mark the old classes as deprecated.
- in 4.8, we remove the old files.
because the class names are used for reflection.
Master Issue: #762
Author: Jia Zhai <zh...@apache.org>
Reviewers: Enrico Olivelli <eo...@gmail.com>, Sijie Guo <si...@apache.org>
This closes #1257 from jiazhai/issue_762, closes #762
---
.../bookkeeper/stats/CodahaleMetricsProvider.java | 1 +
.../bookkeeper/stats/CodahaleOpStatsLogger.java | 1 +
.../bookkeeper/stats/CodahaleStatsLogger.java | 1 +
.../{ => codahale}/CodahaleMetricsProvider.java | 4 +++-
.../{ => codahale}/CodahaleOpStatsLogger.java | 4 +++-
.../stats/{ => codahale}/CodahaleStatsLogger.java | 6 +++++-
.../bookkeeper/stats/codahale/package-info.java} | 22 +++-------------------
.../stats/{ => codahale}/CodahaleOpStatsTest.java | 6 ++++--
pom.xml | 5 +++--
site/_data/config/bk_server.yaml | 2 +-
10 files changed, 25 insertions(+), 27 deletions(-)
diff --git a/bookkeeper-stats-providers/codahale-metrics-provider/src/main/java/org/apache/bookkeeper/stats/CodahaleMetricsProvider.java b/bookkeeper-stats-providers/codahale-metrics-provider/src/main/java/org/apache/bookkeeper/stats/CodahaleMetricsProvider.java
index dc789ff..01658c7 100644
--- a/bookkeeper-stats-providers/codahale-metrics-provider/src/main/java/org/apache/bookkeeper/stats/CodahaleMetricsProvider.java
+++ b/bookkeeper-stats-providers/codahale-metrics-provider/src/main/java/org/apache/bookkeeper/stats/CodahaleMetricsProvider.java
@@ -40,6 +40,7 @@ import org.slf4j.LoggerFactory;
/**
* A {@link StatsProvider} implemented based on <i>Codahale</i> metrics library.
*/
+@Deprecated
@SuppressWarnings("deprecation")
public class CodahaleMetricsProvider implements StatsProvider {
diff --git a/bookkeeper-stats-providers/codahale-metrics-provider/src/main/java/org/apache/bookkeeper/stats/CodahaleOpStatsLogger.java b/bookkeeper-stats-providers/codahale-metrics-provider/src/main/java/org/apache/bookkeeper/stats/CodahaleOpStatsLogger.java
index 9af35bf..690f2b5 100644
--- a/bookkeeper-stats-providers/codahale-metrics-provider/src/main/java/org/apache/bookkeeper/stats/CodahaleOpStatsLogger.java
+++ b/bookkeeper-stats-providers/codahale-metrics-provider/src/main/java/org/apache/bookkeeper/stats/CodahaleOpStatsLogger.java
@@ -21,6 +21,7 @@ import com.codahale.metrics.Timer;
import java.util.Arrays;
import java.util.concurrent.TimeUnit;
+@Deprecated
class CodahaleOpStatsLogger implements OpStatsLogger {
final Timer success;
final Timer fail;
diff --git a/bookkeeper-stats-providers/codahale-metrics-provider/src/main/java/org/apache/bookkeeper/stats/CodahaleStatsLogger.java b/bookkeeper-stats-providers/codahale-metrics-provider/src/main/java/org/apache/bookkeeper/stats/CodahaleStatsLogger.java
index 7d765ae..7a75258 100644
--- a/bookkeeper-stats-providers/codahale-metrics-provider/src/main/java/org/apache/bookkeeper/stats/CodahaleStatsLogger.java
+++ b/bookkeeper-stats-providers/codahale-metrics-provider/src/main/java/org/apache/bookkeeper/stats/CodahaleStatsLogger.java
@@ -24,6 +24,7 @@ import com.codahale.metrics.Timer;
/**
* A {@link StatsLogger} implemented based on <i>Codahale</i> metrics library.
*/
+@Deprecated
public class CodahaleStatsLogger implements StatsLogger {
protected final String basename;
final MetricRegistry metrics;
diff --git a/bookkeeper-stats-providers/codahale-metrics-provider/src/main/java/org/apache/bookkeeper/stats/CodahaleMetricsProvider.java b/bookkeeper-stats-providers/codahale-metrics-provider/src/main/java/org/apache/bookkeeper/stats/codahale/CodahaleMetricsProvider.java
similarity index 97%
copy from bookkeeper-stats-providers/codahale-metrics-provider/src/main/java/org/apache/bookkeeper/stats/CodahaleMetricsProvider.java
copy to bookkeeper-stats-providers/codahale-metrics-provider/src/main/java/org/apache/bookkeeper/stats/codahale/CodahaleMetricsProvider.java
index dc789ff..f4ca952 100644
--- a/bookkeeper-stats-providers/codahale-metrics-provider/src/main/java/org/apache/bookkeeper/stats/CodahaleMetricsProvider.java
+++ b/bookkeeper-stats-providers/codahale-metrics-provider/src/main/java/org/apache/bookkeeper/stats/codahale/CodahaleMetricsProvider.java
@@ -14,7 +14,7 @@
* License for the specific language governing permissions and limitations under
* the License.
*/
-package org.apache.bookkeeper.stats;
+package org.apache.bookkeeper.stats.codahale;
import com.codahale.metrics.CsvReporter;
import com.codahale.metrics.JmxReporter;
@@ -33,6 +33,8 @@ import java.net.InetSocketAddress;
import java.util.ArrayList;
import java.util.List;
import java.util.concurrent.TimeUnit;
+import org.apache.bookkeeper.stats.StatsLogger;
+import org.apache.bookkeeper.stats.StatsProvider;
import org.apache.commons.configuration.Configuration;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
diff --git a/bookkeeper-stats-providers/codahale-metrics-provider/src/main/java/org/apache/bookkeeper/stats/CodahaleOpStatsLogger.java b/bookkeeper-stats-providers/codahale-metrics-provider/src/main/java/org/apache/bookkeeper/stats/codahale/CodahaleOpStatsLogger.java
similarity index 94%
copy from bookkeeper-stats-providers/codahale-metrics-provider/src/main/java/org/apache/bookkeeper/stats/CodahaleOpStatsLogger.java
copy to bookkeeper-stats-providers/codahale-metrics-provider/src/main/java/org/apache/bookkeeper/stats/codahale/CodahaleOpStatsLogger.java
index 9af35bf..ae97c78 100644
--- a/bookkeeper-stats-providers/codahale-metrics-provider/src/main/java/org/apache/bookkeeper/stats/CodahaleOpStatsLogger.java
+++ b/bookkeeper-stats-providers/codahale-metrics-provider/src/main/java/org/apache/bookkeeper/stats/codahale/CodahaleOpStatsLogger.java
@@ -14,12 +14,14 @@
* License for the specific language governing permissions and limitations under
* the License.
*/
-package org.apache.bookkeeper.stats;
+package org.apache.bookkeeper.stats.codahale;
import com.codahale.metrics.Snapshot;
import com.codahale.metrics.Timer;
import java.util.Arrays;
import java.util.concurrent.TimeUnit;
+import org.apache.bookkeeper.stats.OpStatsData;
+import org.apache.bookkeeper.stats.OpStatsLogger;
class CodahaleOpStatsLogger implements OpStatsLogger {
final Timer success;
diff --git a/bookkeeper-stats-providers/codahale-metrics-provider/src/main/java/org/apache/bookkeeper/stats/CodahaleStatsLogger.java b/bookkeeper-stats-providers/codahale-metrics-provider/src/main/java/org/apache/bookkeeper/stats/codahale/CodahaleStatsLogger.java
similarity index 93%
copy from bookkeeper-stats-providers/codahale-metrics-provider/src/main/java/org/apache/bookkeeper/stats/CodahaleStatsLogger.java
copy to bookkeeper-stats-providers/codahale-metrics-provider/src/main/java/org/apache/bookkeeper/stats/codahale/CodahaleStatsLogger.java
index 7d765ae..1f6bc18 100644
--- a/bookkeeper-stats-providers/codahale-metrics-provider/src/main/java/org/apache/bookkeeper/stats/CodahaleStatsLogger.java
+++ b/bookkeeper-stats-providers/codahale-metrics-provider/src/main/java/org/apache/bookkeeper/stats/codahale/CodahaleStatsLogger.java
@@ -14,12 +14,16 @@
* License for the specific language governing permissions and limitations under
* the License.
*/
-package org.apache.bookkeeper.stats;
+package org.apache.bookkeeper.stats.codahale;
import static com.codahale.metrics.MetricRegistry.name;
import com.codahale.metrics.MetricRegistry;
import com.codahale.metrics.Timer;
+import org.apache.bookkeeper.stats.Counter;
+import org.apache.bookkeeper.stats.Gauge;
+import org.apache.bookkeeper.stats.OpStatsLogger;
+import org.apache.bookkeeper.stats.StatsLogger;
/**
* A {@link StatsLogger} implemented based on <i>Codahale</i> metrics library.
diff --git a/bookkeeper-stats-providers/codahale-metrics-provider/src/test/java/org/apache/bookkeeper/stats/CodahaleOpStatsTest.java b/bookkeeper-stats-providers/codahale-metrics-provider/src/main/java/org/apache/bookkeeper/stats/codahale/package-info.java
similarity index 57%
copy from bookkeeper-stats-providers/codahale-metrics-provider/src/test/java/org/apache/bookkeeper/stats/CodahaleOpStatsTest.java
copy to bookkeeper-stats-providers/codahale-metrics-provider/src/main/java/org/apache/bookkeeper/stats/codahale/package-info.java
index 90c0dd6..1afa438 100644
--- a/bookkeeper-stats-providers/codahale-metrics-provider/src/test/java/org/apache/bookkeeper/stats/CodahaleOpStatsTest.java
+++ b/bookkeeper-stats-providers/codahale-metrics-provider/src/main/java/org/apache/bookkeeper/stats/codahale/package-info.java
@@ -1,4 +1,4 @@
-/**
+/*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with this
* work for additional information regarding copyright ownership. The ASF
@@ -14,23 +14,7 @@
* License for the specific language governing permissions and limitations under
* the License.
*/
-package org.apache.bookkeeper.stats;
-
-import static org.junit.Assert.assertEquals;
-
-import org.junit.Test;
-
/**
- * Unit test of {@link CodahaleOpStatsLogger}.
+ * A lightweight stats library implemention based on <i>Codahale</i> metrics library.
*/
-public class CodahaleOpStatsTest {
-
- @Test
- public void testToOpStatsData() {
- OpStatsLogger logger = new CodahaleMetricsProvider().getStatsLogger("test").getOpStatsLogger("testLogger");
- logger.registerSuccessfulValue(1);
- // the following should not throw any exception
- OpStatsData statsData = logger.toOpStatsData();
- assertEquals(1, statsData.getNumSuccessfulEvents());
- }
-}
+package org.apache.bookkeeper.stats.codahale;
diff --git a/bookkeeper-stats-providers/codahale-metrics-provider/src/test/java/org/apache/bookkeeper/stats/CodahaleOpStatsTest.java b/bookkeeper-stats-providers/codahale-metrics-provider/src/test/java/org/apache/bookkeeper/stats/codahale/CodahaleOpStatsTest.java
similarity index 90%
rename from bookkeeper-stats-providers/codahale-metrics-provider/src/test/java/org/apache/bookkeeper/stats/CodahaleOpStatsTest.java
rename to bookkeeper-stats-providers/codahale-metrics-provider/src/test/java/org/apache/bookkeeper/stats/codahale/CodahaleOpStatsTest.java
index 90c0dd6..54efaee 100644
--- a/bookkeeper-stats-providers/codahale-metrics-provider/src/test/java/org/apache/bookkeeper/stats/CodahaleOpStatsTest.java
+++ b/bookkeeper-stats-providers/codahale-metrics-provider/src/test/java/org/apache/bookkeeper/stats/codahale/CodahaleOpStatsTest.java
@@ -14,17 +14,19 @@
* License for the specific language governing permissions and limitations under
* the License.
*/
-package org.apache.bookkeeper.stats;
+package org.apache.bookkeeper.stats.codahale;
import static org.junit.Assert.assertEquals;
+import org.apache.bookkeeper.stats.OpStatsData;
+import org.apache.bookkeeper.stats.OpStatsLogger;
import org.junit.Test;
/**
* Unit test of {@link CodahaleOpStatsLogger}.
*/
-public class CodahaleOpStatsTest {
+public class CodahaleOpStatsTest {
@Test
public void testToOpStatsData() {
OpStatsLogger logger = new CodahaleMetricsProvider().getStatsLogger("test").getOpStatsLogger("testLogger");
diff --git a/pom.xml b/pom.xml
index db15455..c0f3e9b 100644
--- a/pom.xml
+++ b/pom.xml
@@ -742,12 +742,13 @@
<group>
<title>Bookkeeper Stats API</title>
<!-- currently codahale is placed under `stats` package unfortunately.
- we might consider rename them to their own packages in future. {@link https://github.com/apache/bookkeeper/issues/762} -->
+ we have done a copy to its own package in future in 4.7.0, will remove it in 4.8.0.
+ {@link https://github.com/apache/bookkeeper/issues/762} -->
<packages>org.apache.bookkeeper.stats</packages>
</group>
<group>
<title>Bookkeeper Stats Providers</title>
- <packages>org.apache.bookkeeper.stats.twitter.finagle:org.apache.bookkeeper.stats.twitter.ostrich:org.apache.bookkeeper.stats.twitter.science:org.apache.bookkeeper.stats.prometheus</packages>
+ <packages>org.apache.bookkeeper.stats.codahale:org.apache.bookkeeper.stats.twitter.finagle:org.apache.bookkeeper.stats.twitter.ostrich:org.apache.bookkeeper.stats.twitter.science:org.apache.bookkeeper.stats.prometheus</packages>
</group>
</groups>
<doctitle>BookKeeper Java API (version ${project.version})</doctitle>
diff --git a/site/_data/config/bk_server.yaml b/site/_data/config/bk_server.yaml
index f843dfb..93ba270 100644
--- a/site/_data/config/bk_server.yaml
+++ b/site/_data/config/bk_server.yaml
@@ -341,7 +341,7 @@ groups:
default: true
- param: statsProviderClass
description: Stats provider class.
- default: org.apache.bookkeeper.stats.CodahaleMetricsProvider
+ default: org.apache.bookkeeper.stats.codahale.CodahaleMetricsProvider
- name: Read-only mode support
params:
--
To stop receiving notification emails like this one, please contact
sijie@apache.org.