RATIS-1712. Add a dropwizard 3 implementation of ratis-metrics-api.#751

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
codings-dan merged 1 commit into from
Sep 27, 2022
Merged

RATIS-1712. Add a dropwizard 3 implementation of ratis-metrics-api. #751

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions pom.xml
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -85,6 +85,7 @@
<module>ratis-replicated-map</module>
<module>ratis-metrics-api</module>
<module>ratis-metrics-default</module>
<module>ratis-metrics-dropwizard3</module>
<module>ratis-tools</module>
<module>ratis-shell</module>
<module>ratis-assembly</module>
Expand DownExpand Up@@ -281,6 +282,11 @@
<groupId>org.apache.ratis</groupId>
<version>${project.version}</version>
</dependency>
<dependency>
<artifactId>ratis-metrics-dropwizard3</artifactId>
<groupId>org.apache.ratis</groupId>
<version>${project.version}</version>
</dependency>
<dependency>
<artifactId>ratis-metrics-default</artifactId>
<groupId>org.apache.ratis</groupId>
Expand Down
1 change: 1 addition & 0 deletions ratis-assembly/src/main/assembly/bin.xml
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -41,6 +41,7 @@
<include>org.apache.ratis:ratis-test</include>
<include>org.apache.ratis:ratis-metrics-api</include>
<include>org.apache.ratis:ratis-metrics-default</include>
<include>org.apache.ratis:ratis-metrics-dropwizard3</include>
<include>org.apache.ratis:ratis-tools</include>
<include>org.apache.ratis:ratis-resource-bundle</include>
</includes>
Expand Down
1 change: 1 addition & 0 deletions ratis-assembly/src/main/assembly/src.xml
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -44,6 +44,7 @@
<include>org.apache.ratis:ratis-test</include>
<include>org.apache.ratis:ratis-metrics-api</include>
<include>org.apache.ratis:ratis-metrics-default</include>
<include>org.apache.ratis:ratis-metrics-dropwizard3</include>
<include>org.apache.ratis:ratis-tools</include>
<include>org.apache.ratis:ratis-resource-bundle</include>
</includes>
Expand Down
21 changes: 14 additions & 7 deletions ratis-metrics-default/src/test/java/org/apache/ratis/metrics/TestMetricRegistriesLoader.java
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -21,20 +21,21 @@
import static org.junit.Assert.assertNotEquals;
import static org.mockito.Mockito.mock;

import org.apache.ratis.thirdparty.com.google.common.collect.Lists;
import org.apache.ratis.metrics.impl.MetricRegistriesImpl;
import org.junit.Assert;
import org.junit.Test;

import java.util.Arrays;
import java.util.Collections;

/**
* Test class for {@link MetricRegistriesLoader}.
*/
public class TestMetricRegistriesLoader {


@Test
public void testLoadSinleInstance() {
public void testLoadSingleInstance() {
MetricRegistries loader = mock(MetricRegistries.class);
MetricRegistries instance = MetricRegistriesLoader.load(Lists.newArrayList(loader));
MetricRegistries instance = MetricRegistriesLoader.load(Collections.singletonList(loader));
assertEquals(loader, instance);
}

Expand All@@ -43,12 +44,18 @@ public void testLoadMultipleInstances() {
MetricRegistries loader1 = mock(MetricRegistries.class);
MetricRegistries loader2 = mock(MetricRegistries.class);
MetricRegistries loader3 = mock(MetricRegistries.class);
MetricRegistries instance = MetricRegistriesLoader.load(Lists.newArrayList(loader1, loader2,
loader3));
MetricRegistries instance = MetricRegistriesLoader.load(Arrays.asList(loader1, loader2, loader3));

// the load() returns the first instance
assertEquals(loader1, instance);
assertNotEquals(loader2, instance);
assertNotEquals(loader3, instance);
}

@Test
public void testLoadDefault() {
final MetricRegistries r = MetricRegistriesLoader.load();
Assert.assertSame(MetricRegistriesImpl.class, r.getClass());
}

}
92 changes: 92 additions & 0 deletions ratis-metrics-dropwizard3/pom.xml
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,92 @@
<?xml version="1.0" encoding="UTF-8"?>
<!--
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. See accompanying LICENSE file.
-->
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
<modelVersion>4.0.0</modelVersion>
<parent>
<artifactId>ratis</artifactId>
<groupId>org.apache.ratis</groupId>
<version>3.0.0-SNAPSHOT</version>
</parent>

<artifactId>ratis-metrics-dropwizard3</artifactId>
<name>Apache Ratis Metrics Dropwizard 3 Implementation</name>

<properties>
<dropwizard3.version>3.2.5</dropwizard3.version>
</properties>

<dependencies>
<dependency>
<artifactId>ratis-metrics-api</artifactId>
<groupId>org.apache.ratis</groupId>
</dependency>
<dependency>
<artifactId>ratis-proto</artifactId>
<groupId>org.apache.ratis</groupId>
</dependency>
<dependency>
<artifactId>ratis-common</artifactId>
<groupId>org.apache.ratis</groupId>
</dependency>
<dependency>
<artifactId>ratis-common</artifactId>
<groupId>org.apache.ratis</groupId>
<scope>test</scope>
<type>test-jar</type>
</dependency>

<dependency>
<groupId>org.slf4j</groupId>
<artifactId>slf4j-api</artifactId>
</dependency>

<dependency>
<groupId>junit</groupId>
<artifactId>junit</artifactId>
<scope>test</scope>
</dependency>
<dependency>
<groupId>org.mockito</groupId>
<artifactId>mockito-core</artifactId>
<scope>test</scope>
</dependency>

<dependency>
<groupId>io.dropwizard.metrics</groupId>
<artifactId>metrics-core</artifactId>
<version>${dropwizard3.version}</version>
</dependency>
<dependency>
<groupId>io.dropwizard.metrics</groupId>
<artifactId>metrics-jvm</artifactId>
<version>${dropwizard3.version}</version>
<optional>true</optional>
</dependency>
<dependency>
<groupId>io.dropwizard.metrics</groupId>
<artifactId>metrics-ganglia</artifactId>
<version>${dropwizard3.version}</version>
<exclusions>
<exclusion>
<groupId>org.acplt</groupId>
<artifactId>oncrpc</artifactId>
</exclusion>
</exclusions>
<optional>true</optional>
</dependency>

</dependencies>
</project>
51 changes: 51 additions & 0 deletions ...metrics-dropwizard3/src/main/java/org/apache/ratis/metrics/dropwizard3/Dm3JvmMetrics.java
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
/*
* 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 licenses this file
* to you 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
* <p>
* http://www.apache.org/licenses/LICENSE-2.0
* <p>
* 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 org.apache.ratis.metrics.dropwizard3;

import org.apache.ratis.metrics.MetricRegistries;
import org.apache.ratis.metrics.MetricRegistryInfo;
import org.apache.ratis.metrics.RatisMetricRegistry;
import org.apache.ratis.util.TimeDuration;
import com.codahale.metrics.jvm.ClassLoadingGaugeSet;
import com.codahale.metrics.jvm.GarbageCollectorMetricSet;
import com.codahale.metrics.jvm.MemoryUsageGaugeSet;
import com.codahale.metrics.jvm.ThreadStatesGaugeSet;

/**
* Helper class to add JVM metrics.
*/
public interface Dm3JvmMetrics {
static void initJvmMetrics(TimeDuration consoleReportRate) {
final MetricRegistries registries = MetricRegistries.global();
Dm3JvmMetrics.addJvmMetrics(registries);
registries.enableConsoleReporter(consoleReportRate);
registries.enableJmxReporter();
}

static void addJvmMetrics(MetricRegistries registries) {
MetricRegistryInfo info = new MetricRegistryInfo("jvm", "ratis_jvm", "jvm", "jvm metrics");

RatisMetricRegistry registry = registries.create(info);

final Dm3RatisMetricRegistryImpl impl = Dm3RatisMetricRegistryImpl.cast(registry);
impl.registerAll("gc", new GarbageCollectorMetricSet());
impl.registerAll("memory", new MemoryUsageGaugeSet());
impl.registerAll("threads", new ThreadStatesGaugeSet());
impl.registerAll("classLoading", new ClassLoadingGaugeSet());
}
}
129 changes: 129 additions & 0 deletions ...opwizard3/src/main/java/org/apache/ratis/metrics/dropwizard3/Dm3MetricRegistriesImpl.java
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,129 @@
/**
* 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 licenses this file
* to you 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
* <p>
* http://www.apache.org/licenses/LICENSE-2.0
* <p>
* 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 org.apache.ratis.metrics.dropwizard3;

import java.util.Collection;
import java.util.Collections;
import java.util.List;
import java.util.Optional;
import java.util.Set;
import java.util.concurrent.CopyOnWriteArrayList;
import java.util.function.Consumer;

import org.apache.ratis.metrics.MetricRegistries;
import org.apache.ratis.metrics.MetricRegistryInfo;
import org.apache.ratis.metrics.RatisMetricRegistry;
import org.apache.ratis.util.TimeDuration;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

/**
* Implementation of MetricRegistries that does ref-counting.
*/
public class Dm3MetricRegistriesImpl extends MetricRegistries {

private static final Logger LOG = LoggerFactory.getLogger(Dm3MetricRegistriesImpl.class);

private final List<Consumer<RatisMetricRegistry>> reporterRegistrations = new CopyOnWriteArrayList<>();

private final List<Consumer<RatisMetricRegistry>> stopReporters = new CopyOnWriteArrayList<>();

private final Dm3MetricRegistryFactoryImpl factory;

private final RefCountingMap<MetricRegistryInfo, RatisMetricRegistry> registries;

public Dm3MetricRegistriesImpl() {
this(new Dm3MetricRegistryFactoryImpl());
}

Dm3MetricRegistriesImpl(Dm3MetricRegistryFactoryImpl factory) {
this.factory = factory;
this.registries = new RefCountingMap<>();
}

@Override
public RatisMetricRegistry create(MetricRegistryInfo info) {
return registries.put(info, () -> {
if (reporterRegistrations.isEmpty()) {
if (LOG.isDebugEnabled()) {
LOG.debug("First MetricRegistry has been created without registering reporters. " +
"Hence registering JMX reporter by default.");
}
enableJmxReporter();
}
RatisMetricRegistry registry = factory.create(info);
reporterRegistrations.forEach(reg -> reg.accept(registry));
return registry;
});
}

@Override
public boolean remove(MetricRegistryInfo key) {
RatisMetricRegistry registry = registries.get(key);
if (registry != null) {
stopReporters.forEach(reg -> reg.accept(registry));
}

return registries.remove(key) == null;
}

@Override
public Optional<RatisMetricRegistry> get(MetricRegistryInfo info) {
return Optional.ofNullable(registries.get(info));
}

@Override
public Collection<RatisMetricRegistry> getMetricRegistries() {
return Collections.unmodifiableCollection(registries.values());
}

@Override
public void clear() {
registries.clear();
}

@Override
public Set<MetricRegistryInfo> getMetricRegistryInfos() {
return Collections.unmodifiableSet(registries.keySet());
}

@Override
public void addReporterRegistration(Consumer<RatisMetricRegistry> reporterRegistration,
Consumer<RatisMetricRegistry> stopReporter) {
if (registries.size() > 0) {
LOG.warn("New reporters are added after registries were created. Some metrics will be missing from the reporter. "
+ "Please add reporter before adding any new registry.");
}
this.reporterRegistrations.add(reporterRegistration);
this.stopReporters.add(stopReporter);
}

@Override
public void enableJmxReporter() {
addReporterRegistration(
Dm3MetricsReporting.jmxReporter(),
Dm3MetricsReporting.stopJmxReporter());
}

@Override
public void enableConsoleReporter(TimeDuration consoleReportRate) {
addReporterRegistration(
Dm3MetricsReporting.consoleReporter(consoleReportRate),
Dm3MetricsReporting.stopConsoleReporter());
}
}
28 changes: 28 additions & 0 deletions ...ard3/src/main/java/org/apache/ratis/metrics/dropwizard3/Dm3MetricRegistryFactoryImpl.java
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
/**
* 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 licenses this file
* to you 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
* <p>
* http://www.apache.org/licenses/LICENSE-2.0
* <p>
* 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 org.apache.ratis.metrics.dropwizard3;

import org.apache.ratis.metrics.MetricRegistryFactory;
import org.apache.ratis.metrics.MetricRegistryInfo;

public class Dm3MetricRegistryFactoryImpl implements MetricRegistryFactory {
@Override
public Dm3RatisMetricRegistryImpl create(MetricRegistryInfo info) {
return new Dm3RatisMetricRegistryImpl(info);
}
}
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Add copy buttons to all 
 blocks\n(function() {\n function addCopyButtons() {\n document.querySelectorAll('pre code').forEach(function(codeBlock) {\n if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;\n codeBlock.parentElement.setAttribute('data-copy-added', 'true');\n \n var btn = document.createElement('button');\n btn.textContent = 'Copy';\n btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';\n btn.onmouseover = function() { this.style.opacity = '1'; };\n btn.onmouseout = function() { this.style.opacity = '0.7'; };\n btn.onclick = function() {\n navigator.clipboard.writeText(codeBlock.textContent).then(function() {\n btn.textContent = 'Copied!';\n setTimeout(function() { btn.textContent = 'Copy'; }, 1500);\n });\n };\n codeBlock.parentElement.style.position = 'relative';\n codeBlock.parentElement.appendChild(btn);\n });\n }\n \n addCopyButtons();\n \n // Re-run on dynamic content\n var observer = new MutationObserver(addCopyButtons);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Add Copy Buttons to Code Blocks");
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '

Skip to content
RATIS-1712. Add a dropwizard 3 implementation of ratis-metrics-api.#751

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

codings-dan
merged 1 commit into

from

Sep 27, 2022
 Merged


RATIS-1712. Add a dropwizard 3 implementation of ratis-metrics-api.
#751
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


6 changes: 6 additions & 0 deletions
pom.xml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -85,6 +85,7 @@
 <module>ratis-replicated-map</module>
 <module>ratis-metrics-api</module>
 <module>ratis-metrics-default</module>
 <module>ratis-metrics-dropwizard3</module>
 <module>ratis-tools</module>
 <module>ratis-shell</module>
 <module>ratis-assembly</module>
Expand DownExpand Up@@ -281,6 +282,11 @@
 <groupId>org.apache.ratis</groupId>
 <version>${project.version}</version>
 </dependency>
 <dependency>
 <artifactId>ratis-metrics-dropwizard3</artifactId>
 <groupId>org.apache.ratis</groupId>
 <version>${project.version}</version>
 </dependency>
 <dependency>
 <artifactId>ratis-metrics-default</artifactId>
 <groupId>org.apache.ratis</groupId>
Expand Down

1 change: 1 addition & 0 deletions
ratis-assembly/src/main/assembly/bin.xml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -41,6 +41,7 @@
 <include>org.apache.ratis:ratis-test</include>
 <include>org.apache.ratis:ratis-metrics-api</include>
 <include>org.apache.ratis:ratis-metrics-default</include>
 <include>org.apache.ratis:ratis-metrics-dropwizard3</include>
 <include>org.apache.ratis:ratis-tools</include>
 <include>org.apache.ratis:ratis-resource-bundle</include>
 </includes>
Expand Down

1 change: 1 addition & 0 deletions
ratis-assembly/src/main/assembly/src.xml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -44,6 +44,7 @@
 <include>org.apache.ratis:ratis-test</include>
 <include>org.apache.ratis:ratis-metrics-api</include>
 <include>org.apache.ratis:ratis-metrics-default</include>
 <include>org.apache.ratis:ratis-metrics-dropwizard3</include>
 <include>org.apache.ratis:ratis-tools</include>
 <include>org.apache.ratis:ratis-resource-bundle</include>
 </includes>
Expand Down

21 changes: 14 additions & 7 deletions
ratis-metrics-default/src/test/java/org/apache/ratis/metrics/TestMetricRegistriesLoader.java

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -21,20 +21,21 @@
import static org.junit.Assert.assertNotEquals;
import static org.mockito.Mockito.mock;

import org.apache.ratis.thirdparty.com.google.common.collect.Lists;
import org.apache.ratis.metrics.impl.MetricRegistriesImpl;
import org.junit.Assert;
import org.junit.Test;

import java.util.Arrays;
import java.util.Collections;

/**
 * Test class for {@link MetricRegistriesLoader}.
 */
public class TestMetricRegistriesLoader {


 @Test
 public void testLoadSinleInstance() {
 public void testLoadSingleInstance() {
 MetricRegistries loader = mock(MetricRegistries.class);
 MetricRegistries instance = MetricRegistriesLoader.load(Lists.newArrayList(loader));
 MetricRegistries instance = MetricRegistriesLoader.load(Collections.singletonList(loader));
 assertEquals(loader, instance);
 }

Expand All@@ -43,12 +44,18 @@ public void testLoadMultipleInstances() {
 MetricRegistries loader1 = mock(MetricRegistries.class);
 MetricRegistries loader2 = mock(MetricRegistries.class);
 MetricRegistries loader3 = mock(MetricRegistries.class);
 MetricRegistries instance = MetricRegistriesLoader.load(Lists.newArrayList(loader1, loader2,
 loader3));
 MetricRegistries instance = MetricRegistriesLoader.load(Arrays.asList(loader1, loader2, loader3));

 // the load() returns the first instance
 assertEquals(loader1, instance);
 assertNotEquals(loader2, instance);
 assertNotEquals(loader3, instance);
 }

 @Test
 public void testLoadDefault() {
 final MetricRegistries r = MetricRegistriesLoader.load();
 Assert.assertSame(MetricRegistriesImpl.class, r.getClass());
 }

}

92 changes: 92 additions & 0 deletions
ratis-metrics-dropwizard3/pom.xml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,92 @@
<?xml version="1.0" encoding="UTF-8"?>
<!--
 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. See accompanying LICENSE file.
-->
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
 xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
 <modelVersion>4.0.0</modelVersion>
 <parent>
 <artifactId>ratis</artifactId>
 <groupId>org.apache.ratis</groupId>
 <version>3.0.0-SNAPSHOT</version>
 </parent>

 <artifactId>ratis-metrics-dropwizard3</artifactId>
 <name>Apache Ratis Metrics Dropwizard 3 Implementation</name>

 <properties>
 <dropwizard3.version>3.2.5</dropwizard3.version>
 </properties>

 <dependencies>
 <dependency>
 <artifactId>ratis-metrics-api</artifactId>
 <groupId>org.apache.ratis</groupId>
 </dependency>
 <dependency>
 <artifactId>ratis-proto</artifactId>
 <groupId>org.apache.ratis</groupId>
 </dependency>
 <dependency>
 <artifactId>ratis-common</artifactId>
 <groupId>org.apache.ratis</groupId>
 </dependency>
 <dependency>
 <artifactId>ratis-common</artifactId>
 <groupId>org.apache.ratis</groupId>
 <scope>test</scope>
 <type>test-jar</type>
 </dependency>

 <dependency>
 <groupId>org.slf4j</groupId>
 <artifactId>slf4j-api</artifactId>
 </dependency>

 <dependency>
 <groupId>junit</groupId>
 <artifactId>junit</artifactId>
 <scope>test</scope>
 </dependency>
 <dependency>
 <groupId>org.mockito</groupId>
 <artifactId>mockito-core</artifactId>
 <scope>test</scope>
 </dependency>

 <dependency>
 <groupId>io.dropwizard.metrics</groupId>
 <artifactId>metrics-core</artifactId>
 <version>${dropwizard3.version}</version>
 </dependency>
 <dependency>
 <groupId>io.dropwizard.metrics</groupId>
 <artifactId>metrics-jvm</artifactId>
 <version>${dropwizard3.version}</version>
 <optional>true</optional>
 </dependency>
 <dependency>
 <groupId>io.dropwizard.metrics</groupId>
 <artifactId>metrics-ganglia</artifactId>
 <version>${dropwizard3.version}</version>
 <exclusions>
 <exclusion>
 <groupId>org.acplt</groupId>
 <artifactId>oncrpc</artifactId>
 </exclusion>
 </exclusions>
 <optional>true</optional>
 </dependency>

 </dependencies>
</project>

51 changes: 51 additions & 0 deletions
...metrics-dropwizard3/src/main/java/org/apache/ratis/metrics/dropwizard3/Dm3JvmMetrics.java

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
/*
 * 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 licenses this file
 * to you 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
 * <p>
 * http://www.apache.org/licenses/LICENSE-2.0
 * <p>
 * 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 org.apache.ratis.metrics.dropwizard3;

import org.apache.ratis.metrics.MetricRegistries;
import org.apache.ratis.metrics.MetricRegistryInfo;
import org.apache.ratis.metrics.RatisMetricRegistry;
import org.apache.ratis.util.TimeDuration;
import com.codahale.metrics.jvm.ClassLoadingGaugeSet;
import com.codahale.metrics.jvm.GarbageCollectorMetricSet;
import com.codahale.metrics.jvm.MemoryUsageGaugeSet;
import com.codahale.metrics.jvm.ThreadStatesGaugeSet;

/**
 * Helper class to add JVM metrics.
 */
public interface Dm3JvmMetrics {
 static void initJvmMetrics(TimeDuration consoleReportRate) {
 final MetricRegistries registries = MetricRegistries.global();
 Dm3JvmMetrics.addJvmMetrics(registries);
 registries.enableConsoleReporter(consoleReportRate);
 registries.enableJmxReporter();
 }

 static void addJvmMetrics(MetricRegistries registries) {
 MetricRegistryInfo info = new MetricRegistryInfo("jvm", "ratis_jvm", "jvm", "jvm metrics");

 RatisMetricRegistry registry = registries.create(info);

 final Dm3RatisMetricRegistryImpl impl = Dm3RatisMetricRegistryImpl.cast(registry);
 impl.registerAll("gc", new GarbageCollectorMetricSet());
 impl.registerAll("memory", new MemoryUsageGaugeSet());
 impl.registerAll("threads", new ThreadStatesGaugeSet());
 impl.registerAll("classLoading", new ClassLoadingGaugeSet());
 }
}

129 changes: 129 additions & 0 deletions
...opwizard3/src/main/java/org/apache/ratis/metrics/dropwizard3/Dm3MetricRegistriesImpl.java

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,129 @@
/**
 * 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 licenses this file
 * to you 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
 * <p>
 * http://www.apache.org/licenses/LICENSE-2.0
 * <p>
 * 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 org.apache.ratis.metrics.dropwizard3;

import java.util.Collection;
import java.util.Collections;
import java.util.List;
import java.util.Optional;
import java.util.Set;
import java.util.concurrent.CopyOnWriteArrayList;
import java.util.function.Consumer;

import org.apache.ratis.metrics.MetricRegistries;
import org.apache.ratis.metrics.MetricRegistryInfo;
import org.apache.ratis.metrics.RatisMetricRegistry;
import org.apache.ratis.util.TimeDuration;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

/**
 * Implementation of MetricRegistries that does ref-counting.
 */
public class Dm3MetricRegistriesImpl extends MetricRegistries {

 private static final Logger LOG = LoggerFactory.getLogger(Dm3MetricRegistriesImpl.class);

 private final List<Consumer<RatisMetricRegistry>> reporterRegistrations = new CopyOnWriteArrayList<>();

 private final List<Consumer<RatisMetricRegistry>> stopReporters = new CopyOnWriteArrayList<>();

 private final Dm3MetricRegistryFactoryImpl factory;

 private final RefCountingMap<MetricRegistryInfo, RatisMetricRegistry> registries;

 public Dm3MetricRegistriesImpl() {
 this(new Dm3MetricRegistryFactoryImpl());
 }

 Dm3MetricRegistriesImpl(Dm3MetricRegistryFactoryImpl factory) {
 this.factory = factory;
 this.registries = new RefCountingMap<>();
 }

 @Override
 public RatisMetricRegistry create(MetricRegistryInfo info) {
 return registries.put(info, () -> {
 if (reporterRegistrations.isEmpty()) {
 if (LOG.isDebugEnabled()) {
 LOG.debug("First MetricRegistry has been created without registering reporters. " +
 "Hence registering JMX reporter by default.");
 }
 enableJmxReporter();
 }
 RatisMetricRegistry registry = factory.create(info);
 reporterRegistrations.forEach(reg -> reg.accept(registry));
 return registry;
 });
 }

 @Override
 public boolean remove(MetricRegistryInfo key) {
 RatisMetricRegistry registry = registries.get(key);
 if (registry != null) {
 stopReporters.forEach(reg -> reg.accept(registry));
 }

 return registries.remove(key) == null;
 }

 @Override
 public Optional<RatisMetricRegistry> get(MetricRegistryInfo info) {
 return Optional.ofNullable(registries.get(info));
 }

 @Override
 public Collection<RatisMetricRegistry> getMetricRegistries() {
 return Collections.unmodifiableCollection(registries.values());
 }

 @Override
 public void clear() {
 registries.clear();
 }

 @Override
 public Set<MetricRegistryInfo> getMetricRegistryInfos() {
 return Collections.unmodifiableSet(registries.keySet());
 }

 @Override
 public void addReporterRegistration(Consumer<RatisMetricRegistry> reporterRegistration,
 Consumer<RatisMetricRegistry> stopReporter) {
 if (registries.size() > 0) {
 LOG.warn("New reporters are added after registries were created. Some metrics will be missing from the reporter. "
 + "Please add reporter before adding any new registry.");
 }
 this.reporterRegistrations.add(reporterRegistration);
 this.stopReporters.add(stopReporter);
 }

 @Override
 public void enableJmxReporter() {
 addReporterRegistration(
 Dm3MetricsReporting.jmxReporter(),
 Dm3MetricsReporting.stopJmxReporter());
 }

 @Override
 public void enableConsoleReporter(TimeDuration consoleReportRate) {
 addReporterRegistration(
 Dm3MetricsReporting.consoleReporter(consoleReportRate),
 Dm3MetricsReporting.stopConsoleReporter());
 }
}

28 changes: 28 additions & 0 deletions
...ard3/src/main/java/org/apache/ratis/metrics/dropwizard3/Dm3MetricRegistryFactoryImpl.java

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
/**
 * 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 licenses this file
 * to you 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
 * <p>
 * http://www.apache.org/licenses/LICENSE-2.0
 * <p>
 * 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 org.apache.ratis.metrics.dropwizard3;

import org.apache.ratis.metrics.MetricRegistryFactory;
import org.apache.ratis.metrics.MetricRegistryInfo;

public class Dm3MetricRegistryFactoryImpl implements MetricRegistryFactory {
 @Override
 public Dm3RatisMetricRegistryImpl create(MetricRegistryInfo info) {
 return new Dm3RatisMetricRegistryImpl(info);
 }
}
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Force GitHub README to respect dark mode\n(function() {\n var style = document.createElement('style');\n style.textContent = '\n .markdown-body {\n color-scheme: dark light;\n }\n .markdown-body pre { background: #161b22 !important; }\n .markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }\n .markdown-body table th, .markdown-body table td { border-color: #30363d !important; }\n .markdown-body img { background: #0d1117; }\n .markdown-body blockquote { border-left-color: #8b949e; }\n .markdown-body hr { border-color: #30363d; }\n ';\n document.head.appendChild(style);\n})();", "GitHub Dark Mode README Fix");
}
} catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
RATIS-1712. Add a dropwizard 3 implementation of ratis-metrics-api.#751

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

codings-dan
merged 1 commit into

from

Sep 27, 2022
 Merged


RATIS-1712. Add a dropwizard 3 implementation of ratis-metrics-api.
#751
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


6 changes: 6 additions & 0 deletions
pom.xml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -85,6 +85,7 @@
 <module>ratis-replicated-map</module>
 <module>ratis-metrics-api</module>
 <module>ratis-metrics-default</module>
 <module>ratis-metrics-dropwizard3</module>
 <module>ratis-tools</module>
 <module>ratis-shell</module>
 <module>ratis-assembly</module>
Expand DownExpand Up@@ -281,6 +282,11 @@
 <groupId>org.apache.ratis</groupId>
 <version>${project.version}</version>
 </dependency>
 <dependency>
 <artifactId>ratis-metrics-dropwizard3</artifactId>
 <groupId>org.apache.ratis</groupId>
 <version>${project.version}</version>
 </dependency>
 <dependency>
 <artifactId>ratis-metrics-default</artifactId>
 <groupId>org.apache.ratis</groupId>
Expand Down

1 change: 1 addition & 0 deletions
ratis-assembly/src/main/assembly/bin.xml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -41,6 +41,7 @@
 <include>org.apache.ratis:ratis-test</include>
 <include>org.apache.ratis:ratis-metrics-api</include>
 <include>org.apache.ratis:ratis-metrics-default</include>
 <include>org.apache.ratis:ratis-metrics-dropwizard3</include>
 <include>org.apache.ratis:ratis-tools</include>
 <include>org.apache.ratis:ratis-resource-bundle</include>
 </includes>
Expand Down

1 change: 1 addition & 0 deletions
ratis-assembly/src/main/assembly/src.xml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -44,6 +44,7 @@
 <include>org.apache.ratis:ratis-test</include>
 <include>org.apache.ratis:ratis-metrics-api</include>
 <include>org.apache.ratis:ratis-metrics-default</include>
 <include>org.apache.ratis:ratis-metrics-dropwizard3</include>
 <include>org.apache.ratis:ratis-tools</include>
 <include>org.apache.ratis:ratis-resource-bundle</include>
 </includes>
Expand Down

21 changes: 14 additions & 7 deletions
ratis-metrics-default/src/test/java/org/apache/ratis/metrics/TestMetricRegistriesLoader.java

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -21,20 +21,21 @@
import static org.junit.Assert.assertNotEquals;
import static org.mockito.Mockito.mock;

import org.apache.ratis.thirdparty.com.google.common.collect.Lists;
import org.apache.ratis.metrics.impl.MetricRegistriesImpl;
import org.junit.Assert;
import org.junit.Test;

import java.util.Arrays;
import java.util.Collections;

/**
 * Test class for {@link MetricRegistriesLoader}.
 */
public class TestMetricRegistriesLoader {


 @Test
 public void testLoadSinleInstance() {
 public void testLoadSingleInstance() {
 MetricRegistries loader = mock(MetricRegistries.class);
 MetricRegistries instance = MetricRegistriesLoader.load(Lists.newArrayList(loader));
 MetricRegistries instance = MetricRegistriesLoader.load(Collections.singletonList(loader));
 assertEquals(loader, instance);
 }

Expand All@@ -43,12 +44,18 @@ public void testLoadMultipleInstances() {
 MetricRegistries loader1 = mock(MetricRegistries.class);
 MetricRegistries loader2 = mock(MetricRegistries.class);
 MetricRegistries loader3 = mock(MetricRegistries.class);
 MetricRegistries instance = MetricRegistriesLoader.load(Lists.newArrayList(loader1, loader2,
 loader3));
 MetricRegistries instance = MetricRegistriesLoader.load(Arrays.asList(loader1, loader2, loader3));

 // the load() returns the first instance
 assertEquals(loader1, instance);
 assertNotEquals(loader2, instance);
 assertNotEquals(loader3, instance);
 }

 @Test
 public void testLoadDefault() {
 final MetricRegistries r = MetricRegistriesLoader.load();
 Assert.assertSame(MetricRegistriesImpl.class, r.getClass());
 }

}

92 changes: 92 additions & 0 deletions
ratis-metrics-dropwizard3/pom.xml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,92 @@
<?xml version="1.0" encoding="UTF-8"?>
<!--
 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. See accompanying LICENSE file.
-->
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
 xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
 <modelVersion>4.0.0</modelVersion>
 <parent>
 <artifactId>ratis</artifactId>
 <groupId>org.apache.ratis</groupId>
 <version>3.0.0-SNAPSHOT</version>
 </parent>

 <artifactId>ratis-metrics-dropwizard3</artifactId>
 <name>Apache Ratis Metrics Dropwizard 3 Implementation</name>

 <properties>
 <dropwizard3.version>3.2.5</dropwizard3.version>
 </properties>

 <dependencies>
 <dependency>
 <artifactId>ratis-metrics-api</artifactId>
 <groupId>org.apache.ratis</groupId>
 </dependency>
 <dependency>
 <artifactId>ratis-proto</artifactId>
 <groupId>org.apache.ratis</groupId>
 </dependency>
 <dependency>
 <artifactId>ratis-common</artifactId>
 <groupId>org.apache.ratis</groupId>
 </dependency>
 <dependency>
 <artifactId>ratis-common</artifactId>
 <groupId>org.apache.ratis</groupId>
 <scope>test</scope>
 <type>test-jar</type>
 </dependency>

 <dependency>
 <groupId>org.slf4j</groupId>
 <artifactId>slf4j-api</artifactId>
 </dependency>

 <dependency>
 <groupId>junit</groupId>
 <artifactId>junit</artifactId>
 <scope>test</scope>
 </dependency>
 <dependency>
 <groupId>org.mockito</groupId>
 <artifactId>mockito-core</artifactId>
 <scope>test</scope>
 </dependency>

 <dependency>
 <groupId>io.dropwizard.metrics</groupId>
 <artifactId>metrics-core</artifactId>
 <version>${dropwizard3.version}</version>
 </dependency>
 <dependency>
 <groupId>io.dropwizard.metrics</groupId>
 <artifactId>metrics-jvm</artifactId>
 <version>${dropwizard3.version}</version>
 <optional>true</optional>
 </dependency>
 <dependency>
 <groupId>io.dropwizard.metrics</groupId>
 <artifactId>metrics-ganglia</artifactId>
 <version>${dropwizard3.version}</version>
 <exclusions>
 <exclusion>
 <groupId>org.acplt</groupId>
 <artifactId>oncrpc</artifactId>
 </exclusion>
 </exclusions>
 <optional>true</optional>
 </dependency>

 </dependencies>
</project>

51 changes: 51 additions & 0 deletions
...metrics-dropwizard3/src/main/java/org/apache/ratis/metrics/dropwizard3/Dm3JvmMetrics.java

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
/*
 * 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 licenses this file
 * to you 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
 * <p>
 * http://www.apache.org/licenses/LICENSE-2.0
 * <p>
 * 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 org.apache.ratis.metrics.dropwizard3;

import org.apache.ratis.metrics.MetricRegistries;
import org.apache.ratis.metrics.MetricRegistryInfo;
import org.apache.ratis.metrics.RatisMetricRegistry;
import org.apache.ratis.util.TimeDuration;
import com.codahale.metrics.jvm.ClassLoadingGaugeSet;
import com.codahale.metrics.jvm.GarbageCollectorMetricSet;
import com.codahale.metrics.jvm.MemoryUsageGaugeSet;
import com.codahale.metrics.jvm.ThreadStatesGaugeSet;

/**
 * Helper class to add JVM metrics.
 */
public interface Dm3JvmMetrics {
 static void initJvmMetrics(TimeDuration consoleReportRate) {
 final MetricRegistries registries = MetricRegistries.global();
 Dm3JvmMetrics.addJvmMetrics(registries);
 registries.enableConsoleReporter(consoleReportRate);
 registries.enableJmxReporter();
 }

 static void addJvmMetrics(MetricRegistries registries) {
 MetricRegistryInfo info = new MetricRegistryInfo("jvm", "ratis_jvm", "jvm", "jvm metrics");

 RatisMetricRegistry registry = registries.create(info);

 final Dm3RatisMetricRegistryImpl impl = Dm3RatisMetricRegistryImpl.cast(registry);
 impl.registerAll("gc", new GarbageCollectorMetricSet());
 impl.registerAll("memory", new MemoryUsageGaugeSet());
 impl.registerAll("threads", new ThreadStatesGaugeSet());
 impl.registerAll("classLoading", new ClassLoadingGaugeSet());
 }
}

129 changes: 129 additions & 0 deletions
...opwizard3/src/main/java/org/apache/ratis/metrics/dropwizard3/Dm3MetricRegistriesImpl.java

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,129 @@
/**
 * 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 licenses this file
 * to you 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
 * <p>
 * http://www.apache.org/licenses/LICENSE-2.0
 * <p>
 * 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 org.apache.ratis.metrics.dropwizard3;

import java.util.Collection;
import java.util.Collections;
import java.util.List;
import java.util.Optional;
import java.util.Set;
import java.util.concurrent.CopyOnWriteArrayList;
import java.util.function.Consumer;

import org.apache.ratis.metrics.MetricRegistries;
import org.apache.ratis.metrics.MetricRegistryInfo;
import org.apache.ratis.metrics.RatisMetricRegistry;
import org.apache.ratis.util.TimeDuration;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

/**
 * Implementation of MetricRegistries that does ref-counting.
 */
public class Dm3MetricRegistriesImpl extends MetricRegistries {

 private static final Logger LOG = LoggerFactory.getLogger(Dm3MetricRegistriesImpl.class);

 private final List<Consumer<RatisMetricRegistry>> reporterRegistrations = new CopyOnWriteArrayList<>();

 private final List<Consumer<RatisMetricRegistry>> stopReporters = new CopyOnWriteArrayList<>();

 private final Dm3MetricRegistryFactoryImpl factory;

 private final RefCountingMap<MetricRegistryInfo, RatisMetricRegistry> registries;

 public Dm3MetricRegistriesImpl() {
 this(new Dm3MetricRegistryFactoryImpl());
 }

 Dm3MetricRegistriesImpl(Dm3MetricRegistryFactoryImpl factory) {
 this.factory = factory;
 this.registries = new RefCountingMap<>();
 }

 @Override
 public RatisMetricRegistry create(MetricRegistryInfo info) {
 return registries.put(info, () -> {
 if (reporterRegistrations.isEmpty()) {
 if (LOG.isDebugEnabled()) {
 LOG.debug("First MetricRegistry has been created without registering reporters. " +
 "Hence registering JMX reporter by default.");
 }
 enableJmxReporter();
 }
 RatisMetricRegistry registry = factory.create(info);
 reporterRegistrations.forEach(reg -> reg.accept(registry));
 return registry;
 });
 }

 @Override
 public boolean remove(MetricRegistryInfo key) {
 RatisMetricRegistry registry = registries.get(key);
 if (registry != null) {
 stopReporters.forEach(reg -> reg.accept(registry));
 }

 return registries.remove(key) == null;
 }

 @Override
 public Optional<RatisMetricRegistry> get(MetricRegistryInfo info) {
 return Optional.ofNullable(registries.get(info));
 }

 @Override
 public Collection<RatisMetricRegistry> getMetricRegistries() {
 return Collections.unmodifiableCollection(registries.values());
 }

 @Override
 public void clear() {
 registries.clear();
 }

 @Override
 public Set<MetricRegistryInfo> getMetricRegistryInfos() {
 return Collections.unmodifiableSet(registries.keySet());
 }

 @Override
 public void addReporterRegistration(Consumer<RatisMetricRegistry> reporterRegistration,
 Consumer<RatisMetricRegistry> stopReporter) {
 if (registries.size() > 0) {
 LOG.warn("New reporters are added after registries were created. Some metrics will be missing from the reporter. "
 + "Please add reporter before adding any new registry.");
 }
 this.reporterRegistrations.add(reporterRegistration);
 this.stopReporters.add(stopReporter);
 }

 @Override
 public void enableJmxReporter() {
 addReporterRegistration(
 Dm3MetricsReporting.jmxReporter(),
 Dm3MetricsReporting.stopJmxReporter());
 }

 @Override
 public void enableConsoleReporter(TimeDuration consoleReportRate) {
 addReporterRegistration(
 Dm3MetricsReporting.consoleReporter(consoleReportRate),
 Dm3MetricsReporting.stopConsoleReporter());
 }
}

28 changes: 28 additions & 0 deletions
...ard3/src/main/java/org/apache/ratis/metrics/dropwizard3/Dm3MetricRegistryFactoryImpl.java

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
/**
 * 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 licenses this file
 * to you 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
 * <p>
 * http://www.apache.org/licenses/LICENSE-2.0
 * <p>
 * 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 org.apache.ratis.metrics.dropwizard3;

import org.apache.ratis.metrics.MetricRegistryFactory;
import org.apache.ratis.metrics.MetricRegistryInfo;

public class Dm3MetricRegistryFactoryImpl implements MetricRegistryFactory {
 @Override
 public Dm3RatisMetricRegistryImpl create(MetricRegistryInfo info) {
 return new Dm3RatisMetricRegistryImpl(info);
 }
}
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Highlight search terms from Google/DuckDuckGo/Bing referrer\n(function() {\n var ref = document.referrer;\n var terms = [];\n \n if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {\n var url = new URL(ref);\n var q = url.searchParams.get('q') || url.searchParams.get('p');\n if (q) {\n terms = q.split(/\\s+/).filter(function(t) { return t.length > 2; });\n }\n }\n \n if (terms.length === 0) return;\n \n var style = document.createElement('style');\n style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';\n document.head.appendChild(style);\n \n function highlight(node) {\n if (node.nodeType === 3) { // text node\n var text = node.textContent;\n var found = false;\n terms.forEach(function(term) {\n var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\\]\\\\]/g, '\\\\') + ')', 'gi');\n if (regex.test(text)) {\n found = true;\n var frag = document.createDocumentFragment();\n var parts = text.split(regex);\n parts.forEach(function(part, i) {\n if (i % 2 === 0) {\n frag.appendChild(document.createTextNode(part));\n } else {\n var span = document.createElement('span');\n span.className = 'userscript-highlight';\n span.textContent = part;\n frag.appendChild(span);\n }\n });\n node.parentNode.replaceChild(frag, node);\n }\n });\n } else if (node.nodeType === 1 && node.childNodes) { // element\n var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT'];\n if (!skipTags.includes(node.tagName)) {\n Array.from(node.childNodes).forEach(highlight);\n }\n }\n }\n \n highlight(document.body);\n \n // Re-highlight on dynamic content\n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1 || node.nodeType === 3) highlight(node);\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Highlight Search Terms");
}
} catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
RATIS-1712. Add a dropwizard 3 implementation of ratis-metrics-api.#751

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

codings-dan
merged 1 commit into

from

Sep 27, 2022
 Merged


RATIS-1712. Add a dropwizard 3 implementation of ratis-metrics-api.
#751
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


6 changes: 6 additions & 0 deletions
pom.xml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -85,6 +85,7 @@
 <module>ratis-replicated-map</module>
 <module>ratis-metrics-api</module>
 <module>ratis-metrics-default</module>
 <module>ratis-metrics-dropwizard3</module>
 <module>ratis-tools</module>
 <module>ratis-shell</module>
 <module>ratis-assembly</module>
Expand DownExpand Up@@ -281,6 +282,11 @@
 <groupId>org.apache.ratis</groupId>
 <version>${project.version}</version>
 </dependency>
 <dependency>
 <artifactId>ratis-metrics-dropwizard3</artifactId>
 <groupId>org.apache.ratis</groupId>
 <version>${project.version}</version>
 </dependency>
 <dependency>
 <artifactId>ratis-metrics-default</artifactId>
 <groupId>org.apache.ratis</groupId>
Expand Down

1 change: 1 addition & 0 deletions
ratis-assembly/src/main/assembly/bin.xml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -41,6 +41,7 @@
 <include>org.apache.ratis:ratis-test</include>
 <include>org.apache.ratis:ratis-metrics-api</include>
 <include>org.apache.ratis:ratis-metrics-default</include>
 <include>org.apache.ratis:ratis-metrics-dropwizard3</include>
 <include>org.apache.ratis:ratis-tools</include>
 <include>org.apache.ratis:ratis-resource-bundle</include>
 </includes>
Expand Down

1 change: 1 addition & 0 deletions
ratis-assembly/src/main/assembly/src.xml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -44,6 +44,7 @@
 <include>org.apache.ratis:ratis-test</include>
 <include>org.apache.ratis:ratis-metrics-api</include>
 <include>org.apache.ratis:ratis-metrics-default</include>
 <include>org.apache.ratis:ratis-metrics-dropwizard3</include>
 <include>org.apache.ratis:ratis-tools</include>
 <include>org.apache.ratis:ratis-resource-bundle</include>
 </includes>
Expand Down

21 changes: 14 additions & 7 deletions
ratis-metrics-default/src/test/java/org/apache/ratis/metrics/TestMetricRegistriesLoader.java

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -21,20 +21,21 @@
import static org.junit.Assert.assertNotEquals;
import static org.mockito.Mockito.mock;

import org.apache.ratis.thirdparty.com.google.common.collect.Lists;
import org.apache.ratis.metrics.impl.MetricRegistriesImpl;
import org.junit.Assert;
import org.junit.Test;

import java.util.Arrays;
import java.util.Collections;

/**
 * Test class for {@link MetricRegistriesLoader}.
 */
public class TestMetricRegistriesLoader {


 @Test
 public void testLoadSinleInstance() {
 public void testLoadSingleInstance() {
 MetricRegistries loader = mock(MetricRegistries.class);
 MetricRegistries instance = MetricRegistriesLoader.load(Lists.newArrayList(loader));
 MetricRegistries instance = MetricRegistriesLoader.load(Collections.singletonList(loader));
 assertEquals(loader, instance);
 }

Expand All@@ -43,12 +44,18 @@ public void testLoadMultipleInstances() {
 MetricRegistries loader1 = mock(MetricRegistries.class);
 MetricRegistries loader2 = mock(MetricRegistries.class);
 MetricRegistries loader3 = mock(MetricRegistries.class);
 MetricRegistries instance = MetricRegistriesLoader.load(Lists.newArrayList(loader1, loader2,
 loader3));
 MetricRegistries instance = MetricRegistriesLoader.load(Arrays.asList(loader1, loader2, loader3));

 // the load() returns the first instance
 assertEquals(loader1, instance);
 assertNotEquals(loader2, instance);
 assertNotEquals(loader3, instance);
 }

 @Test
 public void testLoadDefault() {
 final MetricRegistries r = MetricRegistriesLoader.load();
 Assert.assertSame(MetricRegistriesImpl.class, r.getClass());
 }

}

92 changes: 92 additions & 0 deletions
ratis-metrics-dropwizard3/pom.xml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,92 @@
<?xml version="1.0" encoding="UTF-8"?>
<!--
 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. See accompanying LICENSE file.
-->
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
 xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
 <modelVersion>4.0.0</modelVersion>
 <parent>
 <artifactId>ratis</artifactId>
 <groupId>org.apache.ratis</groupId>
 <version>3.0.0-SNAPSHOT</version>
 </parent>

 <artifactId>ratis-metrics-dropwizard3</artifactId>
 <name>Apache Ratis Metrics Dropwizard 3 Implementation</name>

 <properties>
 <dropwizard3.version>3.2.5</dropwizard3.version>
 </properties>

 <dependencies>
 <dependency>
 <artifactId>ratis-metrics-api</artifactId>
 <groupId>org.apache.ratis</groupId>
 </dependency>
 <dependency>
 <artifactId>ratis-proto</artifactId>
 <groupId>org.apache.ratis</groupId>
 </dependency>
 <dependency>
 <artifactId>ratis-common</artifactId>
 <groupId>org.apache.ratis</groupId>
 </dependency>
 <dependency>
 <artifactId>ratis-common</artifactId>
 <groupId>org.apache.ratis</groupId>
 <scope>test</scope>
 <type>test-jar</type>
 </dependency>

 <dependency>
 <groupId>org.slf4j</groupId>
 <artifactId>slf4j-api</artifactId>
 </dependency>

 <dependency>
 <groupId>junit</groupId>
 <artifactId>junit</artifactId>
 <scope>test</scope>
 </dependency>
 <dependency>
 <groupId>org.mockito</groupId>
 <artifactId>mockito-core</artifactId>
 <scope>test</scope>
 </dependency>

 <dependency>
 <groupId>io.dropwizard.metrics</groupId>
 <artifactId>metrics-core</artifactId>
 <version>${dropwizard3.version}</version>
 </dependency>
 <dependency>
 <groupId>io.dropwizard.metrics</groupId>
 <artifactId>metrics-jvm</artifactId>
 <version>${dropwizard3.version}</version>
 <optional>true</optional>
 </dependency>
 <dependency>
 <groupId>io.dropwizard.metrics</groupId>
 <artifactId>metrics-ganglia</artifactId>
 <version>${dropwizard3.version}</version>
 <exclusions>
 <exclusion>
 <groupId>org.acplt</groupId>
 <artifactId>oncrpc</artifactId>
 </exclusion>
 </exclusions>
 <optional>true</optional>
 </dependency>

 </dependencies>
</project>

51 changes: 51 additions & 0 deletions
...metrics-dropwizard3/src/main/java/org/apache/ratis/metrics/dropwizard3/Dm3JvmMetrics.java

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
/*
 * 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 licenses this file
 * to you 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
 * <p>
 * http://www.apache.org/licenses/LICENSE-2.0
 * <p>
 * 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 org.apache.ratis.metrics.dropwizard3;

import org.apache.ratis.metrics.MetricRegistries;
import org.apache.ratis.metrics.MetricRegistryInfo;
import org.apache.ratis.metrics.RatisMetricRegistry;
import org.apache.ratis.util.TimeDuration;
import com.codahale.metrics.jvm.ClassLoadingGaugeSet;
import com.codahale.metrics.jvm.GarbageCollectorMetricSet;
import com.codahale.metrics.jvm.MemoryUsageGaugeSet;
import com.codahale.metrics.jvm.ThreadStatesGaugeSet;

/**
 * Helper class to add JVM metrics.
 */
public interface Dm3JvmMetrics {
 static void initJvmMetrics(TimeDuration consoleReportRate) {
 final MetricRegistries registries = MetricRegistries.global();
 Dm3JvmMetrics.addJvmMetrics(registries);
 registries.enableConsoleReporter(consoleReportRate);
 registries.enableJmxReporter();
 }

 static void addJvmMetrics(MetricRegistries registries) {
 MetricRegistryInfo info = new MetricRegistryInfo("jvm", "ratis_jvm", "jvm", "jvm metrics");

 RatisMetricRegistry registry = registries.create(info);

 final Dm3RatisMetricRegistryImpl impl = Dm3RatisMetricRegistryImpl.cast(registry);
 impl.registerAll("gc", new GarbageCollectorMetricSet());
 impl.registerAll("memory", new MemoryUsageGaugeSet());
 impl.registerAll("threads", new ThreadStatesGaugeSet());
 impl.registerAll("classLoading", new ClassLoadingGaugeSet());
 }
}

129 changes: 129 additions & 0 deletions
...opwizard3/src/main/java/org/apache/ratis/metrics/dropwizard3/Dm3MetricRegistriesImpl.java

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,129 @@
/**
 * 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 licenses this file
 * to you 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
 * <p>
 * http://www.apache.org/licenses/LICENSE-2.0
 * <p>
 * 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 org.apache.ratis.metrics.dropwizard3;

import java.util.Collection;
import java.util.Collections;
import java.util.List;
import java.util.Optional;
import java.util.Set;
import java.util.concurrent.CopyOnWriteArrayList;
import java.util.function.Consumer;

import org.apache.ratis.metrics.MetricRegistries;
import org.apache.ratis.metrics.MetricRegistryInfo;
import org.apache.ratis.metrics.RatisMetricRegistry;
import org.apache.ratis.util.TimeDuration;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

/**
 * Implementation of MetricRegistries that does ref-counting.
 */
public class Dm3MetricRegistriesImpl extends MetricRegistries {

 private static final Logger LOG = LoggerFactory.getLogger(Dm3MetricRegistriesImpl.class);

 private final List<Consumer<RatisMetricRegistry>> reporterRegistrations = new CopyOnWriteArrayList<>();

 private final List<Consumer<RatisMetricRegistry>> stopReporters = new CopyOnWriteArrayList<>();

 private final Dm3MetricRegistryFactoryImpl factory;

 private final RefCountingMap<MetricRegistryInfo, RatisMetricRegistry> registries;

 public Dm3MetricRegistriesImpl() {
 this(new Dm3MetricRegistryFactoryImpl());
 }

 Dm3MetricRegistriesImpl(Dm3MetricRegistryFactoryImpl factory) {
 this.factory = factory;
 this.registries = new RefCountingMap<>();
 }

 @Override
 public RatisMetricRegistry create(MetricRegistryInfo info) {
 return registries.put(info, () -> {
 if (reporterRegistrations.isEmpty()) {
 if (LOG.isDebugEnabled()) {
 LOG.debug("First MetricRegistry has been created without registering reporters. " +
 "Hence registering JMX reporter by default.");
 }
 enableJmxReporter();
 }
 RatisMetricRegistry registry = factory.create(info);
 reporterRegistrations.forEach(reg -> reg.accept(registry));
 return registry;
 });
 }

 @Override
 public boolean remove(MetricRegistryInfo key) {
 RatisMetricRegistry registry = registries.get(key);
 if (registry != null) {
 stopReporters.forEach(reg -> reg.accept(registry));
 }

 return registries.remove(key) == null;
 }

 @Override
 public Optional<RatisMetricRegistry> get(MetricRegistryInfo info) {
 return Optional.ofNullable(registries.get(info));
 }

 @Override
 public Collection<RatisMetricRegistry> getMetricRegistries() {
 return Collections.unmodifiableCollection(registries.values());
 }

 @Override
 public void clear() {
 registries.clear();
 }

 @Override
 public Set<MetricRegistryInfo> getMetricRegistryInfos() {
 return Collections.unmodifiableSet(registries.keySet());
 }

 @Override
 public void addReporterRegistration(Consumer<RatisMetricRegistry> reporterRegistration,
 Consumer<RatisMetricRegistry> stopReporter) {
 if (registries.size() > 0) {
 LOG.warn("New reporters are added after registries were created. Some metrics will be missing from the reporter. "
 + "Please add reporter before adding any new registry.");
 }
 this.reporterRegistrations.add(reporterRegistration);
 this.stopReporters.add(stopReporter);
 }

 @Override
 public void enableJmxReporter() {
 addReporterRegistration(
 Dm3MetricsReporting.jmxReporter(),
 Dm3MetricsReporting.stopJmxReporter());
 }

 @Override
 public void enableConsoleReporter(TimeDuration consoleReportRate) {
 addReporterRegistration(
 Dm3MetricsReporting.consoleReporter(consoleReportRate),
 Dm3MetricsReporting.stopConsoleReporter());
 }
}

28 changes: 28 additions & 0 deletions
...ard3/src/main/java/org/apache/ratis/metrics/dropwizard3/Dm3MetricRegistryFactoryImpl.java

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
/**
 * 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 licenses this file
 * to you 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
 * <p>
 * http://www.apache.org/licenses/LICENSE-2.0
 * <p>
 * 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 org.apache.ratis.metrics.dropwizard3;

import org.apache.ratis.metrics.MetricRegistryFactory;
import org.apache.ratis.metrics.MetricRegistryInfo;

public class Dm3MetricRegistryFactoryImpl implements MetricRegistryFactory {
 @Override
 public Dm3RatisMetricRegistryImpl create(MetricRegistryInfo info) {
 return new Dm3RatisMetricRegistryImpl(info);
 }
}
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Strip utm_, fbclid, gclid, etc. from all links on page\n(function() {\n var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',\n 'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',\n 'ref', 'ref_src', 'source', 'medium', 'campaign'];\n \n function cleanUrl(url) {\n try {\n var u = new URL(url, window.location.origin);\n var changed = false;\n trackingParams.forEach(function(p) {\n if (u.searchParams.has(p)) {\n u.searchParams.delete(p);\n changed = true;\n }\n });\n return changed ? u.toString() : url;\n } catch (e) {\n return url;\n }\n }\n \n function cleanLinks() {\n document.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n \n cleanLinks();\n \n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1) {\n if (node.tagName === 'A') cleanLinks();\n node.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Remove Tracking Parameters from Links");
}
} catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); }
})();
(function(){
try {
var __m = "youtube.com";
var __re = new RegExp('^' + "youtube\\.com" + '

Skip to content
RATIS-1712. Add a dropwizard 3 implementation of ratis-metrics-api.#751

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

codings-dan
merged 1 commit into

from

Sep 27, 2022
 Merged


RATIS-1712. Add a dropwizard 3 implementation of ratis-metrics-api.
#751
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


6 changes: 6 additions & 0 deletions
pom.xml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -85,6 +85,7 @@
 <module>ratis-replicated-map</module>
 <module>ratis-metrics-api</module>
 <module>ratis-metrics-default</module>
 <module>ratis-metrics-dropwizard3</module>
 <module>ratis-tools</module>
 <module>ratis-shell</module>
 <module>ratis-assembly</module>
Expand DownExpand Up@@ -281,6 +282,11 @@
 <groupId>org.apache.ratis</groupId>
 <version>${project.version}</version>
 </dependency>
 <dependency>
 <artifactId>ratis-metrics-dropwizard3</artifactId>
 <groupId>org.apache.ratis</groupId>
 <version>${project.version}</version>
 </dependency>
 <dependency>
 <artifactId>ratis-metrics-default</artifactId>
 <groupId>org.apache.ratis</groupId>
Expand Down

1 change: 1 addition & 0 deletions
ratis-assembly/src/main/assembly/bin.xml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -41,6 +41,7 @@
 <include>org.apache.ratis:ratis-test</include>
 <include>org.apache.ratis:ratis-metrics-api</include>
 <include>org.apache.ratis:ratis-metrics-default</include>
 <include>org.apache.ratis:ratis-metrics-dropwizard3</include>
 <include>org.apache.ratis:ratis-tools</include>
 <include>org.apache.ratis:ratis-resource-bundle</include>
 </includes>
Expand Down

1 change: 1 addition & 0 deletions
ratis-assembly/src/main/assembly/src.xml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -44,6 +44,7 @@
 <include>org.apache.ratis:ratis-test</include>
 <include>org.apache.ratis:ratis-metrics-api</include>
 <include>org.apache.ratis:ratis-metrics-default</include>
 <include>org.apache.ratis:ratis-metrics-dropwizard3</include>
 <include>org.apache.ratis:ratis-tools</include>
 <include>org.apache.ratis:ratis-resource-bundle</include>
 </includes>
Expand Down

21 changes: 14 additions & 7 deletions
ratis-metrics-default/src/test/java/org/apache/ratis/metrics/TestMetricRegistriesLoader.java

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -21,20 +21,21 @@
import static org.junit.Assert.assertNotEquals;
import static org.mockito.Mockito.mock;

import org.apache.ratis.thirdparty.com.google.common.collect.Lists;
import org.apache.ratis.metrics.impl.MetricRegistriesImpl;
import org.junit.Assert;
import org.junit.Test;

import java.util.Arrays;
import java.util.Collections;

/**
 * Test class for {@link MetricRegistriesLoader}.
 */
public class TestMetricRegistriesLoader {


 @Test
 public void testLoadSinleInstance() {
 public void testLoadSingleInstance() {
 MetricRegistries loader = mock(MetricRegistries.class);
 MetricRegistries instance = MetricRegistriesLoader.load(Lists.newArrayList(loader));
 MetricRegistries instance = MetricRegistriesLoader.load(Collections.singletonList(loader));
 assertEquals(loader, instance);
 }

Expand All@@ -43,12 +44,18 @@ public void testLoadMultipleInstances() {
 MetricRegistries loader1 = mock(MetricRegistries.class);
 MetricRegistries loader2 = mock(MetricRegistries.class);
 MetricRegistries loader3 = mock(MetricRegistries.class);
 MetricRegistries instance = MetricRegistriesLoader.load(Lists.newArrayList(loader1, loader2,
 loader3));
 MetricRegistries instance = MetricRegistriesLoader.load(Arrays.asList(loader1, loader2, loader3));

 // the load() returns the first instance
 assertEquals(loader1, instance);
 assertNotEquals(loader2, instance);
 assertNotEquals(loader3, instance);
 }

 @Test
 public void testLoadDefault() {
 final MetricRegistries r = MetricRegistriesLoader.load();
 Assert.assertSame(MetricRegistriesImpl.class, r.getClass());
 }

}

92 changes: 92 additions & 0 deletions
ratis-metrics-dropwizard3/pom.xml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,92 @@
<?xml version="1.0" encoding="UTF-8"?>
<!--
 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. See accompanying LICENSE file.
-->
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
 xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
 <modelVersion>4.0.0</modelVersion>
 <parent>
 <artifactId>ratis</artifactId>
 <groupId>org.apache.ratis</groupId>
 <version>3.0.0-SNAPSHOT</version>
 </parent>

 <artifactId>ratis-metrics-dropwizard3</artifactId>
 <name>Apache Ratis Metrics Dropwizard 3 Implementation</name>

 <properties>
 <dropwizard3.version>3.2.5</dropwizard3.version>
 </properties>

 <dependencies>
 <dependency>
 <artifactId>ratis-metrics-api</artifactId>
 <groupId>org.apache.ratis</groupId>
 </dependency>
 <dependency>
 <artifactId>ratis-proto</artifactId>
 <groupId>org.apache.ratis</groupId>
 </dependency>
 <dependency>
 <artifactId>ratis-common</artifactId>
 <groupId>org.apache.ratis</groupId>
 </dependency>
 <dependency>
 <artifactId>ratis-common</artifactId>
 <groupId>org.apache.ratis</groupId>
 <scope>test</scope>
 <type>test-jar</type>
 </dependency>

 <dependency>
 <groupId>org.slf4j</groupId>
 <artifactId>slf4j-api</artifactId>
 </dependency>

 <dependency>
 <groupId>junit</groupId>
 <artifactId>junit</artifactId>
 <scope>test</scope>
 </dependency>
 <dependency>
 <groupId>org.mockito</groupId>
 <artifactId>mockito-core</artifactId>
 <scope>test</scope>
 </dependency>

 <dependency>
 <groupId>io.dropwizard.metrics</groupId>
 <artifactId>metrics-core</artifactId>
 <version>${dropwizard3.version}</version>
 </dependency>
 <dependency>
 <groupId>io.dropwizard.metrics</groupId>
 <artifactId>metrics-jvm</artifactId>
 <version>${dropwizard3.version}</version>
 <optional>true</optional>
 </dependency>
 <dependency>
 <groupId>io.dropwizard.metrics</groupId>
 <artifactId>metrics-ganglia</artifactId>
 <version>${dropwizard3.version}</version>
 <exclusions>
 <exclusion>
 <groupId>org.acplt</groupId>
 <artifactId>oncrpc</artifactId>
 </exclusion>
 </exclusions>
 <optional>true</optional>
 </dependency>

 </dependencies>
</project>

51 changes: 51 additions & 0 deletions
...metrics-dropwizard3/src/main/java/org/apache/ratis/metrics/dropwizard3/Dm3JvmMetrics.java

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
/*
 * 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 licenses this file
 * to you 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
 * <p>
 * http://www.apache.org/licenses/LICENSE-2.0
 * <p>
 * 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 org.apache.ratis.metrics.dropwizard3;

import org.apache.ratis.metrics.MetricRegistries;
import org.apache.ratis.metrics.MetricRegistryInfo;
import org.apache.ratis.metrics.RatisMetricRegistry;
import org.apache.ratis.util.TimeDuration;
import com.codahale.metrics.jvm.ClassLoadingGaugeSet;
import com.codahale.metrics.jvm.GarbageCollectorMetricSet;
import com.codahale.metrics.jvm.MemoryUsageGaugeSet;
import com.codahale.metrics.jvm.ThreadStatesGaugeSet;

/**
 * Helper class to add JVM metrics.
 */
public interface Dm3JvmMetrics {
 static void initJvmMetrics(TimeDuration consoleReportRate) {
 final MetricRegistries registries = MetricRegistries.global();
 Dm3JvmMetrics.addJvmMetrics(registries);
 registries.enableConsoleReporter(consoleReportRate);
 registries.enableJmxReporter();
 }

 static void addJvmMetrics(MetricRegistries registries) {
 MetricRegistryInfo info = new MetricRegistryInfo("jvm", "ratis_jvm", "jvm", "jvm metrics");

 RatisMetricRegistry registry = registries.create(info);

 final Dm3RatisMetricRegistryImpl impl = Dm3RatisMetricRegistryImpl.cast(registry);
 impl.registerAll("gc", new GarbageCollectorMetricSet());
 impl.registerAll("memory", new MemoryUsageGaugeSet());
 impl.registerAll("threads", new ThreadStatesGaugeSet());
 impl.registerAll("classLoading", new ClassLoadingGaugeSet());
 }
}

129 changes: 129 additions & 0 deletions
...opwizard3/src/main/java/org/apache/ratis/metrics/dropwizard3/Dm3MetricRegistriesImpl.java

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,129 @@
/**
 * 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 licenses this file
 * to you 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
 * <p>
 * http://www.apache.org/licenses/LICENSE-2.0
 * <p>
 * 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 org.apache.ratis.metrics.dropwizard3;

import java.util.Collection;
import java.util.Collections;
import java.util.List;
import java.util.Optional;
import java.util.Set;
import java.util.concurrent.CopyOnWriteArrayList;
import java.util.function.Consumer;

import org.apache.ratis.metrics.MetricRegistries;
import org.apache.ratis.metrics.MetricRegistryInfo;
import org.apache.ratis.metrics.RatisMetricRegistry;
import org.apache.ratis.util.TimeDuration;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

/**
 * Implementation of MetricRegistries that does ref-counting.
 */
public class Dm3MetricRegistriesImpl extends MetricRegistries {

 private static final Logger LOG = LoggerFactory.getLogger(Dm3MetricRegistriesImpl.class);

 private final List<Consumer<RatisMetricRegistry>> reporterRegistrations = new CopyOnWriteArrayList<>();

 private final List<Consumer<RatisMetricRegistry>> stopReporters = new CopyOnWriteArrayList<>();

 private final Dm3MetricRegistryFactoryImpl factory;

 private final RefCountingMap<MetricRegistryInfo, RatisMetricRegistry> registries;

 public Dm3MetricRegistriesImpl() {
 this(new Dm3MetricRegistryFactoryImpl());
 }

 Dm3MetricRegistriesImpl(Dm3MetricRegistryFactoryImpl factory) {
 this.factory = factory;
 this.registries = new RefCountingMap<>();
 }

 @Override
 public RatisMetricRegistry create(MetricRegistryInfo info) {
 return registries.put(info, () -> {
 if (reporterRegistrations.isEmpty()) {
 if (LOG.isDebugEnabled()) {
 LOG.debug("First MetricRegistry has been created without registering reporters. " +
 "Hence registering JMX reporter by default.");
 }
 enableJmxReporter();
 }
 RatisMetricRegistry registry = factory.create(info);
 reporterRegistrations.forEach(reg -> reg.accept(registry));
 return registry;
 });
 }

 @Override
 public boolean remove(MetricRegistryInfo key) {
 RatisMetricRegistry registry = registries.get(key);
 if (registry != null) {
 stopReporters.forEach(reg -> reg.accept(registry));
 }

 return registries.remove(key) == null;
 }

 @Override
 public Optional<RatisMetricRegistry> get(MetricRegistryInfo info) {
 return Optional.ofNullable(registries.get(info));
 }

 @Override
 public Collection<RatisMetricRegistry> getMetricRegistries() {
 return Collections.unmodifiableCollection(registries.values());
 }

 @Override
 public void clear() {
 registries.clear();
 }

 @Override
 public Set<MetricRegistryInfo> getMetricRegistryInfos() {
 return Collections.unmodifiableSet(registries.keySet());
 }

 @Override
 public void addReporterRegistration(Consumer<RatisMetricRegistry> reporterRegistration,
 Consumer<RatisMetricRegistry> stopReporter) {
 if (registries.size() > 0) {
 LOG.warn("New reporters are added after registries were created. Some metrics will be missing from the reporter. "
 + "Please add reporter before adding any new registry.");
 }
 this.reporterRegistrations.add(reporterRegistration);
 this.stopReporters.add(stopReporter);
 }

 @Override
 public void enableJmxReporter() {
 addReporterRegistration(
 Dm3MetricsReporting.jmxReporter(),
 Dm3MetricsReporting.stopJmxReporter());
 }

 @Override
 public void enableConsoleReporter(TimeDuration consoleReportRate) {
 addReporterRegistration(
 Dm3MetricsReporting.consoleReporter(consoleReportRate),
 Dm3MetricsReporting.stopConsoleReporter());
 }
}

28 changes: 28 additions & 0 deletions
...ard3/src/main/java/org/apache/ratis/metrics/dropwizard3/Dm3MetricRegistryFactoryImpl.java

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
/**
 * 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 licenses this file
 * to you 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
 * <p>
 * http://www.apache.org/licenses/LICENSE-2.0
 * <p>
 * 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 org.apache.ratis.metrics.dropwizard3;

import org.apache.ratis.metrics.MetricRegistryFactory;
import org.apache.ratis.metrics.MetricRegistryInfo;

public class Dm3MetricRegistryFactoryImpl implements MetricRegistryFactory {
 @Override
 public Dm3RatisMetricRegistryImpl create(MetricRegistryInfo info) {
 return new Dm3RatisMetricRegistryImpl(info);
 }
}
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Auto-enable theater mode on YouTube\n(function() {\n function tryTheater() {\n var btn = document.querySelector('button[aria-label=\"Theater mode\"], ytd-player #player button[title=\"Theater mode\"]');\n if (btn && !btn.classList.contains('activated')) {\n btn.click();\n }\n }\n \n // Try immediately\n tryTheater();\n \n // Try after navigation (SPA)\n var lastUrl = location.href;\n setInterval(function() {\n if (location.href !== lastUrl) {\n lastUrl = location.href;\n setTimeout(tryTheater, 500);\n }\n }, 1000);\n \n // Also try on player load\n var observer = new MutationObserver(tryTheater);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "YouTube Theater Mode Default");
}
} catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
RATIS-1712. Add a dropwizard 3 implementation of ratis-metrics-api.#751

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

codings-dan
merged 1 commit into

from

Sep 27, 2022
 Merged


RATIS-1712. Add a dropwizard 3 implementation of ratis-metrics-api.
#751
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


6 changes: 6 additions & 0 deletions
pom.xml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -85,6 +85,7 @@
 <module>ratis-replicated-map</module>
 <module>ratis-metrics-api</module>
 <module>ratis-metrics-default</module>
 <module>ratis-metrics-dropwizard3</module>
 <module>ratis-tools</module>
 <module>ratis-shell</module>
 <module>ratis-assembly</module>
Expand DownExpand Up@@ -281,6 +282,11 @@
 <groupId>org.apache.ratis</groupId>
 <version>${project.version}</version>
 </dependency>
 <dependency>
 <artifactId>ratis-metrics-dropwizard3</artifactId>
 <groupId>org.apache.ratis</groupId>
 <version>${project.version}</version>
 </dependency>
 <dependency>
 <artifactId>ratis-metrics-default</artifactId>
 <groupId>org.apache.ratis</groupId>
Expand Down

1 change: 1 addition & 0 deletions
ratis-assembly/src/main/assembly/bin.xml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -41,6 +41,7 @@
 <include>org.apache.ratis:ratis-test</include>
 <include>org.apache.ratis:ratis-metrics-api</include>
 <include>org.apache.ratis:ratis-metrics-default</include>
 <include>org.apache.ratis:ratis-metrics-dropwizard3</include>
 <include>org.apache.ratis:ratis-tools</include>
 <include>org.apache.ratis:ratis-resource-bundle</include>
 </includes>
Expand Down

1 change: 1 addition & 0 deletions
ratis-assembly/src/main/assembly/src.xml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -44,6 +44,7 @@
 <include>org.apache.ratis:ratis-test</include>
 <include>org.apache.ratis:ratis-metrics-api</include>
 <include>org.apache.ratis:ratis-metrics-default</include>
 <include>org.apache.ratis:ratis-metrics-dropwizard3</include>
 <include>org.apache.ratis:ratis-tools</include>
 <include>org.apache.ratis:ratis-resource-bundle</include>
 </includes>
Expand Down

21 changes: 14 additions & 7 deletions
ratis-metrics-default/src/test/java/org/apache/ratis/metrics/TestMetricRegistriesLoader.java

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -21,20 +21,21 @@
import static org.junit.Assert.assertNotEquals;
import static org.mockito.Mockito.mock;

import org.apache.ratis.thirdparty.com.google.common.collect.Lists;
import org.apache.ratis.metrics.impl.MetricRegistriesImpl;
import org.junit.Assert;
import org.junit.Test;

import java.util.Arrays;
import java.util.Collections;

/**
 * Test class for {@link MetricRegistriesLoader}.
 */
public class TestMetricRegistriesLoader {


 @Test
 public void testLoadSinleInstance() {
 public void testLoadSingleInstance() {
 MetricRegistries loader = mock(MetricRegistries.class);
 MetricRegistries instance = MetricRegistriesLoader.load(Lists.newArrayList(loader));
 MetricRegistries instance = MetricRegistriesLoader.load(Collections.singletonList(loader));
 assertEquals(loader, instance);
 }

Expand All@@ -43,12 +44,18 @@ public void testLoadMultipleInstances() {
 MetricRegistries loader1 = mock(MetricRegistries.class);
 MetricRegistries loader2 = mock(MetricRegistries.class);
 MetricRegistries loader3 = mock(MetricRegistries.class);
 MetricRegistries instance = MetricRegistriesLoader.load(Lists.newArrayList(loader1, loader2,
 loader3));
 MetricRegistries instance = MetricRegistriesLoader.load(Arrays.asList(loader1, loader2, loader3));

 // the load() returns the first instance
 assertEquals(loader1, instance);
 assertNotEquals(loader2, instance);
 assertNotEquals(loader3, instance);
 }

 @Test
 public void testLoadDefault() {
 final MetricRegistries r = MetricRegistriesLoader.load();
 Assert.assertSame(MetricRegistriesImpl.class, r.getClass());
 }

}

92 changes: 92 additions & 0 deletions
ratis-metrics-dropwizard3/pom.xml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,92 @@
<?xml version="1.0" encoding="UTF-8"?>
<!--
 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. See accompanying LICENSE file.
-->
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
 xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
 <modelVersion>4.0.0</modelVersion>
 <parent>
 <artifactId>ratis</artifactId>
 <groupId>org.apache.ratis</groupId>
 <version>3.0.0-SNAPSHOT</version>
 </parent>

 <artifactId>ratis-metrics-dropwizard3</artifactId>
 <name>Apache Ratis Metrics Dropwizard 3 Implementation</name>

 <properties>
 <dropwizard3.version>3.2.5</dropwizard3.version>
 </properties>

 <dependencies>
 <dependency>
 <artifactId>ratis-metrics-api</artifactId>
 <groupId>org.apache.ratis</groupId>
 </dependency>
 <dependency>
 <artifactId>ratis-proto</artifactId>
 <groupId>org.apache.ratis</groupId>
 </dependency>
 <dependency>
 <artifactId>ratis-common</artifactId>
 <groupId>org.apache.ratis</groupId>
 </dependency>
 <dependency>
 <artifactId>ratis-common</artifactId>
 <groupId>org.apache.ratis</groupId>
 <scope>test</scope>
 <type>test-jar</type>
 </dependency>

 <dependency>
 <groupId>org.slf4j</groupId>
 <artifactId>slf4j-api</artifactId>
 </dependency>

 <dependency>
 <groupId>junit</groupId>
 <artifactId>junit</artifactId>
 <scope>test</scope>
 </dependency>
 <dependency>
 <groupId>org.mockito</groupId>
 <artifactId>mockito-core</artifactId>
 <scope>test</scope>
 </dependency>

 <dependency>
 <groupId>io.dropwizard.metrics</groupId>
 <artifactId>metrics-core</artifactId>
 <version>${dropwizard3.version}</version>
 </dependency>
 <dependency>
 <groupId>io.dropwizard.metrics</groupId>
 <artifactId>metrics-jvm</artifactId>
 <version>${dropwizard3.version}</version>
 <optional>true</optional>
 </dependency>
 <dependency>
 <groupId>io.dropwizard.metrics</groupId>
 <artifactId>metrics-ganglia</artifactId>
 <version>${dropwizard3.version}</version>
 <exclusions>
 <exclusion>
 <groupId>org.acplt</groupId>
 <artifactId>oncrpc</artifactId>
 </exclusion>
 </exclusions>
 <optional>true</optional>
 </dependency>

 </dependencies>
</project>

51 changes: 51 additions & 0 deletions
...metrics-dropwizard3/src/main/java/org/apache/ratis/metrics/dropwizard3/Dm3JvmMetrics.java

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
/*
 * 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 licenses this file
 * to you 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
 * <p>
 * http://www.apache.org/licenses/LICENSE-2.0
 * <p>
 * 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 org.apache.ratis.metrics.dropwizard3;

import org.apache.ratis.metrics.MetricRegistries;
import org.apache.ratis.metrics.MetricRegistryInfo;
import org.apache.ratis.metrics.RatisMetricRegistry;
import org.apache.ratis.util.TimeDuration;
import com.codahale.metrics.jvm.ClassLoadingGaugeSet;
import com.codahale.metrics.jvm.GarbageCollectorMetricSet;
import com.codahale.metrics.jvm.MemoryUsageGaugeSet;
import com.codahale.metrics.jvm.ThreadStatesGaugeSet;

/**
 * Helper class to add JVM metrics.
 */
public interface Dm3JvmMetrics {
 static void initJvmMetrics(TimeDuration consoleReportRate) {
 final MetricRegistries registries = MetricRegistries.global();
 Dm3JvmMetrics.addJvmMetrics(registries);
 registries.enableConsoleReporter(consoleReportRate);
 registries.enableJmxReporter();
 }

 static void addJvmMetrics(MetricRegistries registries) {
 MetricRegistryInfo info = new MetricRegistryInfo("jvm", "ratis_jvm", "jvm", "jvm metrics");

 RatisMetricRegistry registry = registries.create(info);

 final Dm3RatisMetricRegistryImpl impl = Dm3RatisMetricRegistryImpl.cast(registry);
 impl.registerAll("gc", new GarbageCollectorMetricSet());
 impl.registerAll("memory", new MemoryUsageGaugeSet());
 impl.registerAll("threads", new ThreadStatesGaugeSet());
 impl.registerAll("classLoading", new ClassLoadingGaugeSet());
 }
}

129 changes: 129 additions & 0 deletions
...opwizard3/src/main/java/org/apache/ratis/metrics/dropwizard3/Dm3MetricRegistriesImpl.java

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,129 @@
/**
 * 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 licenses this file
 * to you 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
 * <p>
 * http://www.apache.org/licenses/LICENSE-2.0
 * <p>
 * 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 org.apache.ratis.metrics.dropwizard3;

import java.util.Collection;
import java.util.Collections;
import java.util.List;
import java.util.Optional;
import java.util.Set;
import java.util.concurrent.CopyOnWriteArrayList;
import java.util.function.Consumer;

import org.apache.ratis.metrics.MetricRegistries;
import org.apache.ratis.metrics.MetricRegistryInfo;
import org.apache.ratis.metrics.RatisMetricRegistry;
import org.apache.ratis.util.TimeDuration;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

/**
 * Implementation of MetricRegistries that does ref-counting.
 */
public class Dm3MetricRegistriesImpl extends MetricRegistries {

 private static final Logger LOG = LoggerFactory.getLogger(Dm3MetricRegistriesImpl.class);

 private final List<Consumer<RatisMetricRegistry>> reporterRegistrations = new CopyOnWriteArrayList<>();

 private final List<Consumer<RatisMetricRegistry>> stopReporters = new CopyOnWriteArrayList<>();

 private final Dm3MetricRegistryFactoryImpl factory;

 private final RefCountingMap<MetricRegistryInfo, RatisMetricRegistry> registries;

 public Dm3MetricRegistriesImpl() {
 this(new Dm3MetricRegistryFactoryImpl());
 }

 Dm3MetricRegistriesImpl(Dm3MetricRegistryFactoryImpl factory) {
 this.factory = factory;
 this.registries = new RefCountingMap<>();
 }

 @Override
 public RatisMetricRegistry create(MetricRegistryInfo info) {
 return registries.put(info, () -> {
 if (reporterRegistrations.isEmpty()) {
 if (LOG.isDebugEnabled()) {
 LOG.debug("First MetricRegistry has been created without registering reporters. " +
 "Hence registering JMX reporter by default.");
 }
 enableJmxReporter();
 }
 RatisMetricRegistry registry = factory.create(info);
 reporterRegistrations.forEach(reg -> reg.accept(registry));
 return registry;
 });
 }

 @Override
 public boolean remove(MetricRegistryInfo key) {
 RatisMetricRegistry registry = registries.get(key);
 if (registry != null) {
 stopReporters.forEach(reg -> reg.accept(registry));
 }

 return registries.remove(key) == null;
 }

 @Override
 public Optional<RatisMetricRegistry> get(MetricRegistryInfo info) {
 return Optional.ofNullable(registries.get(info));
 }

 @Override
 public Collection<RatisMetricRegistry> getMetricRegistries() {
 return Collections.unmodifiableCollection(registries.values());
 }

 @Override
 public void clear() {
 registries.clear();
 }

 @Override
 public Set<MetricRegistryInfo> getMetricRegistryInfos() {
 return Collections.unmodifiableSet(registries.keySet());
 }

 @Override
 public void addReporterRegistration(Consumer<RatisMetricRegistry> reporterRegistration,
 Consumer<RatisMetricRegistry> stopReporter) {
 if (registries.size() > 0) {
 LOG.warn("New reporters are added after registries were created. Some metrics will be missing from the reporter. "
 + "Please add reporter before adding any new registry.");
 }
 this.reporterRegistrations.add(reporterRegistration);
 this.stopReporters.add(stopReporter);
 }

 @Override
 public void enableJmxReporter() {
 addReporterRegistration(
 Dm3MetricsReporting.jmxReporter(),
 Dm3MetricsReporting.stopJmxReporter());
 }

 @Override
 public void enableConsoleReporter(TimeDuration consoleReportRate) {
 addReporterRegistration(
 Dm3MetricsReporting.consoleReporter(consoleReportRate),
 Dm3MetricsReporting.stopConsoleReporter());
 }
}

28 changes: 28 additions & 0 deletions
...ard3/src/main/java/org/apache/ratis/metrics/dropwizard3/Dm3MetricRegistryFactoryImpl.java

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
/**
 * 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 licenses this file
 * to you 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
 * <p>
 * http://www.apache.org/licenses/LICENSE-2.0
 * <p>
 * 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 org.apache.ratis.metrics.dropwizard3;

import org.apache.ratis.metrics.MetricRegistryFactory;
import org.apache.ratis.metrics.MetricRegistryInfo;

public class Dm3MetricRegistryFactoryImpl implements MetricRegistryFactory {
 @Override
 public Dm3RatisMetricRegistryImpl create(MetricRegistryInfo info) {
 return new Dm3RatisMetricRegistryImpl(info);
 }
}
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Remove or un-stick sticky/fixed headers that block content\n(function() {\n function unstick() {\n document.querySelectorAll('header, nav, [role=\"banner\"], .header, .navbar, .sticky, .fixed-top, [style*=\"position: fixed\"], [style*=\"position:sticky\"]').forEach(function(el) {\n if (el.style.position === 'fixed' || el.style.position === 'sticky' || \n getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {\n el.style.position = 'static';\n el.style.top = 'auto';\n el.style.zIndex = 'auto';\n }\n });\n }\n \n unstick();\n \n var observer = new MutationObserver(unstick);\n observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });\n})();", "Kill Sticky Headers");
}
} catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
RATIS-1712. Add a dropwizard 3 implementation of ratis-metrics-api.#751

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

codings-dan
merged 1 commit into

from

Sep 27, 2022
 Merged


RATIS-1712. Add a dropwizard 3 implementation of ratis-metrics-api.
#751
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


6 changes: 6 additions & 0 deletions
pom.xml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -85,6 +85,7 @@
 <module>ratis-replicated-map</module>
 <module>ratis-metrics-api</module>
 <module>ratis-metrics-default</module>
 <module>ratis-metrics-dropwizard3</module>
 <module>ratis-tools</module>
 <module>ratis-shell</module>
 <module>ratis-assembly</module>
Expand DownExpand Up@@ -281,6 +282,11 @@
 <groupId>org.apache.ratis</groupId>
 <version>${project.version}</version>
 </dependency>
 <dependency>
 <artifactId>ratis-metrics-dropwizard3</artifactId>
 <groupId>org.apache.ratis</groupId>
 <version>${project.version}</version>
 </dependency>
 <dependency>
 <artifactId>ratis-metrics-default</artifactId>
 <groupId>org.apache.ratis</groupId>
Expand Down

1 change: 1 addition & 0 deletions
ratis-assembly/src/main/assembly/bin.xml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -41,6 +41,7 @@
 <include>org.apache.ratis:ratis-test</include>
 <include>org.apache.ratis:ratis-metrics-api</include>
 <include>org.apache.ratis:ratis-metrics-default</include>
 <include>org.apache.ratis:ratis-metrics-dropwizard3</include>
 <include>org.apache.ratis:ratis-tools</include>
 <include>org.apache.ratis:ratis-resource-bundle</include>
 </includes>
Expand Down

1 change: 1 addition & 0 deletions
ratis-assembly/src/main/assembly/src.xml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -44,6 +44,7 @@
 <include>org.apache.ratis:ratis-test</include>
 <include>org.apache.ratis:ratis-metrics-api</include>
 <include>org.apache.ratis:ratis-metrics-default</include>
 <include>org.apache.ratis:ratis-metrics-dropwizard3</include>
 <include>org.apache.ratis:ratis-tools</include>
 <include>org.apache.ratis:ratis-resource-bundle</include>
 </includes>
Expand Down

21 changes: 14 additions & 7 deletions
ratis-metrics-default/src/test/java/org/apache/ratis/metrics/TestMetricRegistriesLoader.java

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -21,20 +21,21 @@
import static org.junit.Assert.assertNotEquals;
import static org.mockito.Mockito.mock;

import org.apache.ratis.thirdparty.com.google.common.collect.Lists;
import org.apache.ratis.metrics.impl.MetricRegistriesImpl;
import org.junit.Assert;
import org.junit.Test;

import java.util.Arrays;
import java.util.Collections;

/**
 * Test class for {@link MetricRegistriesLoader}.
 */
public class TestMetricRegistriesLoader {


 @Test
 public void testLoadSinleInstance() {
 public void testLoadSingleInstance() {
 MetricRegistries loader = mock(MetricRegistries.class);
 MetricRegistries instance = MetricRegistriesLoader.load(Lists.newArrayList(loader));
 MetricRegistries instance = MetricRegistriesLoader.load(Collections.singletonList(loader));
 assertEquals(loader, instance);
 }

Expand All@@ -43,12 +44,18 @@ public void testLoadMultipleInstances() {
 MetricRegistries loader1 = mock(MetricRegistries.class);
 MetricRegistries loader2 = mock(MetricRegistries.class);
 MetricRegistries loader3 = mock(MetricRegistries.class);
 MetricRegistries instance = MetricRegistriesLoader.load(Lists.newArrayList(loader1, loader2,
 loader3));
 MetricRegistries instance = MetricRegistriesLoader.load(Arrays.asList(loader1, loader2, loader3));

 // the load() returns the first instance
 assertEquals(loader1, instance);
 assertNotEquals(loader2, instance);
 assertNotEquals(loader3, instance);
 }

 @Test
 public void testLoadDefault() {
 final MetricRegistries r = MetricRegistriesLoader.load();
 Assert.assertSame(MetricRegistriesImpl.class, r.getClass());
 }

}

92 changes: 92 additions & 0 deletions
ratis-metrics-dropwizard3/pom.xml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,92 @@
<?xml version="1.0" encoding="UTF-8"?>
<!--
 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. See accompanying LICENSE file.
-->
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
 xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
 <modelVersion>4.0.0</modelVersion>
 <parent>
 <artifactId>ratis</artifactId>
 <groupId>org.apache.ratis</groupId>
 <version>3.0.0-SNAPSHOT</version>
 </parent>

 <artifactId>ratis-metrics-dropwizard3</artifactId>
 <name>Apache Ratis Metrics Dropwizard 3 Implementation</name>

 <properties>
 <dropwizard3.version>3.2.5</dropwizard3.version>
 </properties>

 <dependencies>
 <dependency>
 <artifactId>ratis-metrics-api</artifactId>
 <groupId>org.apache.ratis</groupId>
 </dependency>
 <dependency>
 <artifactId>ratis-proto</artifactId>
 <groupId>org.apache.ratis</groupId>
 </dependency>
 <dependency>
 <artifactId>ratis-common</artifactId>
 <groupId>org.apache.ratis</groupId>
 </dependency>
 <dependency>
 <artifactId>ratis-common</artifactId>
 <groupId>org.apache.ratis</groupId>
 <scope>test</scope>
 <type>test-jar</type>
 </dependency>

 <dependency>
 <groupId>org.slf4j</groupId>
 <artifactId>slf4j-api</artifactId>
 </dependency>

 <dependency>
 <groupId>junit</groupId>
 <artifactId>junit</artifactId>
 <scope>test</scope>
 </dependency>
 <dependency>
 <groupId>org.mockito</groupId>
 <artifactId>mockito-core</artifactId>
 <scope>test</scope>
 </dependency>

 <dependency>
 <groupId>io.dropwizard.metrics</groupId>
 <artifactId>metrics-core</artifactId>
 <version>${dropwizard3.version}</version>
 </dependency>
 <dependency>
 <groupId>io.dropwizard.metrics</groupId>
 <artifactId>metrics-jvm</artifactId>
 <version>${dropwizard3.version}</version>
 <optional>true</optional>
 </dependency>
 <dependency>
 <groupId>io.dropwizard.metrics</groupId>
 <artifactId>metrics-ganglia</artifactId>
 <version>${dropwizard3.version}</version>
 <exclusions>
 <exclusion>
 <groupId>org.acplt</groupId>
 <artifactId>oncrpc</artifactId>
 </exclusion>
 </exclusions>
 <optional>true</optional>
 </dependency>

 </dependencies>
</project>

51 changes: 51 additions & 0 deletions
...metrics-dropwizard3/src/main/java/org/apache/ratis/metrics/dropwizard3/Dm3JvmMetrics.java

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
/*
 * 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 licenses this file
 * to you 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
 * <p>
 * http://www.apache.org/licenses/LICENSE-2.0
 * <p>
 * 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 org.apache.ratis.metrics.dropwizard3;

import org.apache.ratis.metrics.MetricRegistries;
import org.apache.ratis.metrics.MetricRegistryInfo;
import org.apache.ratis.metrics.RatisMetricRegistry;
import org.apache.ratis.util.TimeDuration;
import com.codahale.metrics.jvm.ClassLoadingGaugeSet;
import com.codahale.metrics.jvm.GarbageCollectorMetricSet;
import com.codahale.metrics.jvm.MemoryUsageGaugeSet;
import com.codahale.metrics.jvm.ThreadStatesGaugeSet;

/**
 * Helper class to add JVM metrics.
 */
public interface Dm3JvmMetrics {
 static void initJvmMetrics(TimeDuration consoleReportRate) {
 final MetricRegistries registries = MetricRegistries.global();
 Dm3JvmMetrics.addJvmMetrics(registries);
 registries.enableConsoleReporter(consoleReportRate);
 registries.enableJmxReporter();
 }

 static void addJvmMetrics(MetricRegistries registries) {
 MetricRegistryInfo info = new MetricRegistryInfo("jvm", "ratis_jvm", "jvm", "jvm metrics");

 RatisMetricRegistry registry = registries.create(info);

 final Dm3RatisMetricRegistryImpl impl = Dm3RatisMetricRegistryImpl.cast(registry);
 impl.registerAll("gc", new GarbageCollectorMetricSet());
 impl.registerAll("memory", new MemoryUsageGaugeSet());
 impl.registerAll("threads", new ThreadStatesGaugeSet());
 impl.registerAll("classLoading", new ClassLoadingGaugeSet());
 }
}

129 changes: 129 additions & 0 deletions
...opwizard3/src/main/java/org/apache/ratis/metrics/dropwizard3/Dm3MetricRegistriesImpl.java

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,129 @@
/**
 * 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 licenses this file
 * to you 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
 * <p>
 * http://www.apache.org/licenses/LICENSE-2.0
 * <p>
 * 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 org.apache.ratis.metrics.dropwizard3;

import java.util.Collection;
import java.util.Collections;
import java.util.List;
import java.util.Optional;
import java.util.Set;
import java.util.concurrent.CopyOnWriteArrayList;
import java.util.function.Consumer;

import org.apache.ratis.metrics.MetricRegistries;
import org.apache.ratis.metrics.MetricRegistryInfo;
import org.apache.ratis.metrics.RatisMetricRegistry;
import org.apache.ratis.util.TimeDuration;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

/**
 * Implementation of MetricRegistries that does ref-counting.
 */
public class Dm3MetricRegistriesImpl extends MetricRegistries {

 private static final Logger LOG = LoggerFactory.getLogger(Dm3MetricRegistriesImpl.class);

 private final List<Consumer<RatisMetricRegistry>> reporterRegistrations = new CopyOnWriteArrayList<>();

 private final List<Consumer<RatisMetricRegistry>> stopReporters = new CopyOnWriteArrayList<>();

 private final Dm3MetricRegistryFactoryImpl factory;

 private final RefCountingMap<MetricRegistryInfo, RatisMetricRegistry> registries;

 public Dm3MetricRegistriesImpl() {
 this(new Dm3MetricRegistryFactoryImpl());
 }

 Dm3MetricRegistriesImpl(Dm3MetricRegistryFactoryImpl factory) {
 this.factory = factory;
 this.registries = new RefCountingMap<>();
 }

 @Override
 public RatisMetricRegistry create(MetricRegistryInfo info) {
 return registries.put(info, () -> {
 if (reporterRegistrations.isEmpty()) {
 if (LOG.isDebugEnabled()) {
 LOG.debug("First MetricRegistry has been created without registering reporters. " +
 "Hence registering JMX reporter by default.");
 }
 enableJmxReporter();
 }
 RatisMetricRegistry registry = factory.create(info);
 reporterRegistrations.forEach(reg -> reg.accept(registry));
 return registry;
 });
 }

 @Override
 public boolean remove(MetricRegistryInfo key) {
 RatisMetricRegistry registry = registries.get(key);
 if (registry != null) {
 stopReporters.forEach(reg -> reg.accept(registry));
 }

 return registries.remove(key) == null;
 }

 @Override
 public Optional<RatisMetricRegistry> get(MetricRegistryInfo info) {
 return Optional.ofNullable(registries.get(info));
 }

 @Override
 public Collection<RatisMetricRegistry> getMetricRegistries() {
 return Collections.unmodifiableCollection(registries.values());
 }

 @Override
 public void clear() {
 registries.clear();
 }

 @Override
 public Set<MetricRegistryInfo> getMetricRegistryInfos() {
 return Collections.unmodifiableSet(registries.keySet());
 }

 @Override
 public void addReporterRegistration(Consumer<RatisMetricRegistry> reporterRegistration,
 Consumer<RatisMetricRegistry> stopReporter) {
 if (registries.size() > 0) {
 LOG.warn("New reporters are added after registries were created. Some metrics will be missing from the reporter. "
 + "Please add reporter before adding any new registry.");
 }
 this.reporterRegistrations.add(reporterRegistration);
 this.stopReporters.add(stopReporter);
 }

 @Override
 public void enableJmxReporter() {
 addReporterRegistration(
 Dm3MetricsReporting.jmxReporter(),
 Dm3MetricsReporting.stopJmxReporter());
 }

 @Override
 public void enableConsoleReporter(TimeDuration consoleReportRate) {
 addReporterRegistration(
 Dm3MetricsReporting.consoleReporter(consoleReportRate),
 Dm3MetricsReporting.stopConsoleReporter());
 }
}

28 changes: 28 additions & 0 deletions
...ard3/src/main/java/org/apache/ratis/metrics/dropwizard3/Dm3MetricRegistryFactoryImpl.java

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
/**
 * 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 licenses this file
 * to you 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
 * <p>
 * http://www.apache.org/licenses/LICENSE-2.0
 * <p>
 * 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 org.apache.ratis.metrics.dropwizard3;

import org.apache.ratis.metrics.MetricRegistryFactory;
import org.apache.ratis.metrics.MetricRegistryInfo;

public class Dm3MetricRegistryFactoryImpl implements MetricRegistryFactory {
 @Override
 public Dm3RatisMetricRegistryImpl create(MetricRegistryInfo info) {
 return new Dm3RatisMetricRegistryImpl(info);
 }
}
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Universal Dark Mode - works on any site\n(function() {\n var enabled = true;\n \n function applyDarkMode() {\n if (!enabled) return;\n \n // Create style element if it doesn't exist\n var style = document.getElementById('universal-dark-mode-style');\n if (!style) {\n style = document.createElement('style');\n style.id = 'universal-dark-mode-style';\n document.head.appendChild(style);\n }\n \n // Dark mode CSS - inverts colors but preserves images/video\n style.textContent = '\n /* Invert everything except media */\n html {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #1a1a2e !important;\n }\n \n /* Restore images, videos, iframes, canvas */\n img, video, iframe, canvas, svg, picture, [style*=\"background-image\"] {\n filter: invert(1) hue-rotate(180deg) !important;\n }\n \n /* Preserve specific elements that should not be inverted */\n .no-dark-mode, .no-dark-mode *,\n [data-theme=\"light\"], [data-theme=\"light\"],\n .ace_editor, .ace_editor *,\n .CodeMirror, .CodeMirror *,\n .monaco-editor, .monaco-editor *,\n .markdown-body pre, .markdown-body pre *,\n .highlight, .highlight *,\n pre code, pre code * {\n filter: none !important;\n }\n \n /* Fix common UI elements */\n .modal, .popup, .dropdown-menu, .tooltip, .popover {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #2d2d44 !important;\n border-color: #444 !important;\n }\n \n /* Scrollbars */\n ::-webkit-scrollbar { background: #1a1a2e !important; }\n ::-webkit-scrollbar-thumb { background: #444 !important; }\n ::-webkit-scrollbar-thumb:hover { background: #555 !important; }\n \n /* Selection */\n ::selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ';\n }\n \n function removeDarkMode() {\n var style = document.getElementById('universal-dark-mode-style');\n if (style) style.remove();\n }\n \n // Toggle with Alt+Shift+D\n document.addEventListener('keydown', function(e) {\n if (e.altKey && e.shiftKey && e.key === 'D') {\n e.preventDefault();\n enabled = !enabled;\n if (enabled) {\n applyDarkMode();\n console.log('[Universal Dark Mode] Enabled');\n } else {\n removeDarkMode();\n console.log('[Universal Dark Mode] Disabled');\n }\n }\n });\n \n // Apply on load\n applyDarkMode();\n \n // Re-apply on dynamic content\n var observer = new MutationObserver(function(mutations) {\n if (enabled && !document.getElementById('universal-dark-mode-style')) {\n applyDarkMode();\n }\n });\n observer.observe(document.head, { childList: true });\n \n console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle');\n})();", "Universal Dark Mode");
}
} catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); }
})();
})();

Skip to content
RATIS-1712. Add a dropwizard 3 implementation of ratis-metrics-api.#751

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

codings-dan
merged 1 commit into

from

Sep 27, 2022
 Merged


RATIS-1712. Add a dropwizard 3 implementation of ratis-metrics-api.
#751
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


6 changes: 6 additions & 0 deletions
pom.xml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -85,6 +85,7 @@
 <module>ratis-replicated-map</module>
 <module>ratis-metrics-api</module>
 <module>ratis-metrics-default</module>
 <module>ratis-metrics-dropwizard3</module>
 <module>ratis-tools</module>
 <module>ratis-shell</module>
 <module>ratis-assembly</module>
Expand DownExpand Up@@ -281,6 +282,11 @@
 <groupId>org.apache.ratis</groupId>
 <version>${project.version}</version>
 </dependency>
 <dependency>
 <artifactId>ratis-metrics-dropwizard3</artifactId>
 <groupId>org.apache.ratis</groupId>
 <version>${project.version}</version>
 </dependency>
 <dependency>
 <artifactId>ratis-metrics-default</artifactId>
 <groupId>org.apache.ratis</groupId>
Expand Down

1 change: 1 addition & 0 deletions
ratis-assembly/src/main/assembly/bin.xml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -41,6 +41,7 @@
 <include>org.apache.ratis:ratis-test</include>
 <include>org.apache.ratis:ratis-metrics-api</include>
 <include>org.apache.ratis:ratis-metrics-default</include>
 <include>org.apache.ratis:ratis-metrics-dropwizard3</include>
 <include>org.apache.ratis:ratis-tools</include>
 <include>org.apache.ratis:ratis-resource-bundle</include>
 </includes>
Expand Down

1 change: 1 addition & 0 deletions
ratis-assembly/src/main/assembly/src.xml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -44,6 +44,7 @@
 <include>org.apache.ratis:ratis-test</include>
 <include>org.apache.ratis:ratis-metrics-api</include>
 <include>org.apache.ratis:ratis-metrics-default</include>
 <include>org.apache.ratis:ratis-metrics-dropwizard3</include>
 <include>org.apache.ratis:ratis-tools</include>
 <include>org.apache.ratis:ratis-resource-bundle</include>
 </includes>
Expand Down

21 changes: 14 additions & 7 deletions
ratis-metrics-default/src/test/java/org/apache/ratis/metrics/TestMetricRegistriesLoader.java

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -21,20 +21,21 @@
import static org.junit.Assert.assertNotEquals;
import static org.mockito.Mockito.mock;

import org.apache.ratis.thirdparty.com.google.common.collect.Lists;
import org.apache.ratis.metrics.impl.MetricRegistriesImpl;
import org.junit.Assert;
import org.junit.Test;

import java.util.Arrays;
import java.util.Collections;

/**
 * Test class for {@link MetricRegistriesLoader}.
 */
public class TestMetricRegistriesLoader {


 @Test
 public void testLoadSinleInstance() {
 public void testLoadSingleInstance() {
 MetricRegistries loader = mock(MetricRegistries.class);
 MetricRegistries instance = MetricRegistriesLoader.load(Lists.newArrayList(loader));
 MetricRegistries instance = MetricRegistriesLoader.load(Collections.singletonList(loader));
 assertEquals(loader, instance);
 }

Expand All@@ -43,12 +44,18 @@ public void testLoadMultipleInstances() {
 MetricRegistries loader1 = mock(MetricRegistries.class);
 MetricRegistries loader2 = mock(MetricRegistries.class);
 MetricRegistries loader3 = mock(MetricRegistries.class);
 MetricRegistries instance = MetricRegistriesLoader.load(Lists.newArrayList(loader1, loader2,
 loader3));
 MetricRegistries instance = MetricRegistriesLoader.load(Arrays.asList(loader1, loader2, loader3));

 // the load() returns the first instance
 assertEquals(loader1, instance);
 assertNotEquals(loader2, instance);
 assertNotEquals(loader3, instance);
 }

 @Test
 public void testLoadDefault() {
 final MetricRegistries r = MetricRegistriesLoader.load();
 Assert.assertSame(MetricRegistriesImpl.class, r.getClass());
 }

}

92 changes: 92 additions & 0 deletions
ratis-metrics-dropwizard3/pom.xml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,92 @@
<?xml version="1.0" encoding="UTF-8"?>
<!--
 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. See accompanying LICENSE file.
-->
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
 xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
 <modelVersion>4.0.0</modelVersion>
 <parent>
 <artifactId>ratis</artifactId>
 <groupId>org.apache.ratis</groupId>
 <version>3.0.0-SNAPSHOT</version>
 </parent>

 <artifactId>ratis-metrics-dropwizard3</artifactId>
 <name>Apache Ratis Metrics Dropwizard 3 Implementation</name>

 <properties>
 <dropwizard3.version>3.2.5</dropwizard3.version>
 </properties>

 <dependencies>
 <dependency>
 <artifactId>ratis-metrics-api</artifactId>
 <groupId>org.apache.ratis</groupId>
 </dependency>
 <dependency>
 <artifactId>ratis-proto</artifactId>
 <groupId>org.apache.ratis</groupId>
 </dependency>
 <dependency>
 <artifactId>ratis-common</artifactId>
 <groupId>org.apache.ratis</groupId>
 </dependency>
 <dependency>
 <artifactId>ratis-common</artifactId>
 <groupId>org.apache.ratis</groupId>
 <scope>test</scope>
 <type>test-jar</type>
 </dependency>

 <dependency>
 <groupId>org.slf4j</groupId>
 <artifactId>slf4j-api</artifactId>
 </dependency>

 <dependency>
 <groupId>junit</groupId>
 <artifactId>junit</artifactId>
 <scope>test</scope>
 </dependency>
 <dependency>
 <groupId>org.mockito</groupId>
 <artifactId>mockito-core</artifactId>
 <scope>test</scope>
 </dependency>

 <dependency>
 <groupId>io.dropwizard.metrics</groupId>
 <artifactId>metrics-core</artifactId>
 <version>${dropwizard3.version}</version>
 </dependency>
 <dependency>
 <groupId>io.dropwizard.metrics</groupId>
 <artifactId>metrics-jvm</artifactId>
 <version>${dropwizard3.version}</version>
 <optional>true</optional>
 </dependency>
 <dependency>
 <groupId>io.dropwizard.metrics</groupId>
 <artifactId>metrics-ganglia</artifactId>
 <version>${dropwizard3.version}</version>
 <exclusions>
 <exclusion>
 <groupId>org.acplt</groupId>
 <artifactId>oncrpc</artifactId>
 </exclusion>
 </exclusions>
 <optional>true</optional>
 </dependency>

 </dependencies>
</project>

51 changes: 51 additions & 0 deletions
...metrics-dropwizard3/src/main/java/org/apache/ratis/metrics/dropwizard3/Dm3JvmMetrics.java

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
/*
 * 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 licenses this file
 * to you 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
 * <p>
 * http://www.apache.org/licenses/LICENSE-2.0
 * <p>
 * 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 org.apache.ratis.metrics.dropwizard3;

import org.apache.ratis.metrics.MetricRegistries;
import org.apache.ratis.metrics.MetricRegistryInfo;
import org.apache.ratis.metrics.RatisMetricRegistry;
import org.apache.ratis.util.TimeDuration;
import com.codahale.metrics.jvm.ClassLoadingGaugeSet;
import com.codahale.metrics.jvm.GarbageCollectorMetricSet;
import com.codahale.metrics.jvm.MemoryUsageGaugeSet;
import com.codahale.metrics.jvm.ThreadStatesGaugeSet;

/**
 * Helper class to add JVM metrics.
 */
public interface Dm3JvmMetrics {
 static void initJvmMetrics(TimeDuration consoleReportRate) {
 final MetricRegistries registries = MetricRegistries.global();
 Dm3JvmMetrics.addJvmMetrics(registries);
 registries.enableConsoleReporter(consoleReportRate);
 registries.enableJmxReporter();
 }

 static void addJvmMetrics(MetricRegistries registries) {
 MetricRegistryInfo info = new MetricRegistryInfo("jvm", "ratis_jvm", "jvm", "jvm metrics");

 RatisMetricRegistry registry = registries.create(info);

 final Dm3RatisMetricRegistryImpl impl = Dm3RatisMetricRegistryImpl.cast(registry);
 impl.registerAll("gc", new GarbageCollectorMetricSet());
 impl.registerAll("memory", new MemoryUsageGaugeSet());
 impl.registerAll("threads", new ThreadStatesGaugeSet());
 impl.registerAll("classLoading", new ClassLoadingGaugeSet());
 }
}

129 changes: 129 additions & 0 deletions
...opwizard3/src/main/java/org/apache/ratis/metrics/dropwizard3/Dm3MetricRegistriesImpl.java

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,129 @@
/**
 * 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 licenses this file
 * to you 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
 * <p>
 * http://www.apache.org/licenses/LICENSE-2.0
 * <p>
 * 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 org.apache.ratis.metrics.dropwizard3;

import java.util.Collection;
import java.util.Collections;
import java.util.List;
import java.util.Optional;
import java.util.Set;
import java.util.concurrent.CopyOnWriteArrayList;
import java.util.function.Consumer;

import org.apache.ratis.metrics.MetricRegistries;
import org.apache.ratis.metrics.MetricRegistryInfo;
import org.apache.ratis.metrics.RatisMetricRegistry;
import org.apache.ratis.util.TimeDuration;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

/**
 * Implementation of MetricRegistries that does ref-counting.
 */
public class Dm3MetricRegistriesImpl extends MetricRegistries {

 private static final Logger LOG = LoggerFactory.getLogger(Dm3MetricRegistriesImpl.class);

 private final List<Consumer<RatisMetricRegistry>> reporterRegistrations = new CopyOnWriteArrayList<>();

 private final List<Consumer<RatisMetricRegistry>> stopReporters = new CopyOnWriteArrayList<>();

 private final Dm3MetricRegistryFactoryImpl factory;

 private final RefCountingMap<MetricRegistryInfo, RatisMetricRegistry> registries;

 public Dm3MetricRegistriesImpl() {
 this(new Dm3MetricRegistryFactoryImpl());
 }

 Dm3MetricRegistriesImpl(Dm3MetricRegistryFactoryImpl factory) {
 this.factory = factory;
 this.registries = new RefCountingMap<>();
 }

 @Override
 public RatisMetricRegistry create(MetricRegistryInfo info) {
 return registries.put(info, () -> {
 if (reporterRegistrations.isEmpty()) {
 if (LOG.isDebugEnabled()) {
 LOG.debug("First MetricRegistry has been created without registering reporters. " +
 "Hence registering JMX reporter by default.");
 }
 enableJmxReporter();
 }
 RatisMetricRegistry registry = factory.create(info);
 reporterRegistrations.forEach(reg -> reg.accept(registry));
 return registry;
 });
 }

 @Override
 public boolean remove(MetricRegistryInfo key) {
 RatisMetricRegistry registry = registries.get(key);
 if (registry != null) {
 stopReporters.forEach(reg -> reg.accept(registry));
 }

 return registries.remove(key) == null;
 }

 @Override
 public Optional<RatisMetricRegistry> get(MetricRegistryInfo info) {
 return Optional.ofNullable(registries.get(info));
 }

 @Override
 public Collection<RatisMetricRegistry> getMetricRegistries() {
 return Collections.unmodifiableCollection(registries.values());
 }

 @Override
 public void clear() {
 registries.clear();
 }

 @Override
 public Set<MetricRegistryInfo> getMetricRegistryInfos() {
 return Collections.unmodifiableSet(registries.keySet());
 }

 @Override
 public void addReporterRegistration(Consumer<RatisMetricRegistry> reporterRegistration,
 Consumer<RatisMetricRegistry> stopReporter) {
 if (registries.size() > 0) {
 LOG.warn("New reporters are added after registries were created. Some metrics will be missing from the reporter. "
 + "Please add reporter before adding any new registry.");
 }
 this.reporterRegistrations.add(reporterRegistration);
 this.stopReporters.add(stopReporter);
 }

 @Override
 public void enableJmxReporter() {
 addReporterRegistration(
 Dm3MetricsReporting.jmxReporter(),
 Dm3MetricsReporting.stopJmxReporter());
 }

 @Override
 public void enableConsoleReporter(TimeDuration consoleReportRate) {
 addReporterRegistration(
 Dm3MetricsReporting.consoleReporter(consoleReportRate),
 Dm3MetricsReporting.stopConsoleReporter());
 }
}

28 changes: 28 additions & 0 deletions
...ard3/src/main/java/org/apache/ratis/metrics/dropwizard3/Dm3MetricRegistryFactoryImpl.java

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
/**
 * 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 licenses this file
 * to you 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
 * <p>
 * http://www.apache.org/licenses/LICENSE-2.0
 * <p>
 * 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 org.apache.ratis.metrics.dropwizard3;

import org.apache.ratis.metrics.MetricRegistryFactory;
import org.apache.ratis.metrics.MetricRegistryInfo;

public class Dm3MetricRegistryFactoryImpl implements MetricRegistryFactory {
 @Override
 public Dm3RatisMetricRegistryImpl create(MetricRegistryInfo info) {
 return new Dm3RatisMetricRegistryImpl(info);
 }
}
Loading