Skip to content
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

Enabled support for mBeans with non-string typed keys #152

Merged
merged 1 commit into from
Feb 3, 2021
Merged

Enabled support for mBeans with non-string typed keys #152

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
7 changes: 4 additions & 3 deletions src/main/java/org/jmxtrans/agent/Query.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -220,11 +220,12 @@ private void collectAndExportAttribute(MBeanServer mbeanServer, OutputWriter out
value = compositeData.get(key);
}
} else if (attributeValue instanceof Map) {
Map<String, Object> mapData = (Map<String, Object>) attributeValue;
//The attribute key could be other types, e.g. Double/int
Map<Object, Object> mapData = (Map<Object, Object>) attributeValue;
if (key == null) {
// Get for all keys
for (Map.Entry<String, Object> entry : mapData.entrySet()) {
String key = entry.getKey();
for (Map.Entry<Object, Object> entry : mapData.entrySet()) {
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Instead of a specific one-off to support doubles, could we instead just toString the key before adding/getting and keep the key as a String? That seems cleaner and would work for other types.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I believe this already supports all types since Java Objects must implement toString(). (Double is just an example type covered in tests)

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ic. we're just casting the mbean map type more generically. I initially thought this change was being exposed more so than it is. My bad.

String key = entry.getKey().toString();
value = entry.getValue();
processAttributeValue(outputWriter, objectName, attribute, key, value);
}
Expand Down
19 changes: 19 additions & 0 deletions src/test/java/org/jmxtrans/agent/Mock.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,8 @@
*/
package org.jmxtrans.agent;

import java.util.HashMap;
import java.util.Map;
import javax.management.openmbean.*;
import java.util.Arrays;
import java.util.List;
Expand Down Expand Up @@ -89,4 +91,21 @@ public Integer[] getIntegerArray() {
public List<Integer> getIntegerList() {
return Arrays.asList(0, 1, 2, 3, 4, 5);
}

@Override
public Map<String, Double> getStringMap() {
Map<String, Double> results = new HashMap<>();
results.put("foo", 0.01);
results.put("bar", 1.0);
return results;
}

@Override
public Map<Double, Double> getDoubleMap() {
Map<Double, Double> results = new HashMap<>();
results.put(0.01, 1.0);
results.put(0.02, 2.0);
results.put(0.03, 3.0);
return results;
}
}
5 changes: 5 additions & 0 deletions src/test/java/org/jmxtrans/agent/MockMBean.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,7 @@
*/
package org.jmxtrans.agent;

import java.util.Map;
import javax.management.openmbean.CompositeData;
import java.util.List;

Expand Down Expand Up @@ -50,4 +51,8 @@ public interface MockMBean {
public Integer[] getIntegerArray();

public List<Integer> getIntegerList();

public Map<String, Double> getStringMap();

public Map<Double, Double> getDoubleMap();
}
34 changes: 32 additions & 2 deletions src/test/java/org/jmxtrans/agent/QueryTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,7 @@
*/
package org.jmxtrans.agent;

import java.util.Map.Entry;
import org.junit.*;

import javax.annotation.Nonnull;
Expand Down Expand Up @@ -130,6 +131,34 @@ public void non_indexed_list_attribute_return_simple_result() throws Exception {
}
}

@Test
public void string_map_attribute_return_simple_result() throws Exception {
Query query = new Query("test:type=Mock,name=mock", "StringMap", null, null, null,
"StringMap_#key#", resultNameStrategy);
query.collectAndExport(mbeanServer, mockOutputWriter);

for (Entry<String, Double> e: mock.getStringMap().entrySet()) {
String name = "StringMap_" + e.getKey();
Object actual = mockOutputWriter.resultsByName.get(name);
assertThat("Result '" + name + "' is missing", actual, notNullValue());
assertThat("Result '" + name + "' type is invalid", actual, instanceOf(Number.class));
}
}

@Test
public void double_map_attribute_return_simple_result() throws Exception {
Query query = new Query("test:type=Mock,name=mock", "DoubleMap", null, null, null,
"DoubleMap_#key#", resultNameStrategy);
query.collectAndExport(mbeanServer, mockOutputWriter);

for (Entry<Double, Double> e: mock.getDoubleMap().entrySet()) {
String name = "DoubleMap_" + e.getKey().toString();
Object actual = mockOutputWriter.resultsByName.get(name);
assertThat("Result '" + name + "' is missing", actual, notNullValue());
assertThat("Result '" + name + "' type is invalid", actual, instanceOf(Number.class));
}
}

@Test
public void indexed_int_array_attribute_return_simple_result() throws Exception {
Query query = new Query("test:type=Mock,name=mock", "IntArray", null, 1, null, "IntArray", resultNameStrategy);
Expand Down Expand Up @@ -189,7 +218,8 @@ public void query_objectname_with_null_attribute_returns_all_attributes() throws
Query query = new Query("test:type=Mock,name=mock", null, null, resultNameStrategy);
query.collectAndExport(mbeanServer, mockOutputWriter);
Integer actualSize = mockOutputWriter.resultsByName.size();
assert (actualSize == 24);
int expectedSize = 24 + mock.getStringMap().size() + mock.getDoubleMap().size();
assert actualSize == expectedSize;
}

@Test
Expand Down Expand Up @@ -225,7 +255,7 @@ public MockOutputWriter(boolean failOnDuplicateResult) {
@Override
public void writeQueryResult(@Nonnull String name, @Nullable String type, @Nullable Object value) throws IOException {
if (failOnDuplicateResult && resultsByName.containsKey(name)) {
fail("Result '" + name + "' already written");
fail("Result '" + name + "' with value '" + value.toString() + "' already written,");
}
resultsByName.put(name, value);
}
Expand Down